483aa965648f294b6bdd24e4e39bd3a09af04fb3
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.92"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2018, 2019
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part$&"
1403 .vindex "&$local_part_suffix$&"
1404 .cindex affix "router precondition"
1405 If the &%local_parts%& option is set, the local part of the address must be in
1406 the set of local parts that it defines. If &%local_part_prefix%& or
1407 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1408 part before this check. If you want to do precondition tests on local parts
1409 that include affixes, you can do so by using a &%condition%& option (see below)
1410 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1411 &$local_part_suffix$& as necessary.
1412 .next
1413 .vindex "&$local_user_uid$&"
1414 .vindex "&$local_user_gid$&"
1415 .vindex "&$home$&"
1416 If the &%check_local_user%& option is set, the local part must be the name of
1417 an account on the local host. If this check succeeds, the uid and gid of the
1418 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1419 user's home directory is placed in &$home$&; these values can be used in the
1420 remaining preconditions.
1421 .next
1422 If the &%router_home_directory%& option is set, it is expanded at this point,
1423 because it overrides the value of &$home$&. If this expansion were left till
1424 later, the value of &$home$& as set by &%check_local_user%& would be used in
1425 subsequent tests. Having two different values of &$home$& in the same router
1426 could lead to confusion.
1427 .next
1428 If the &%senders%& option is set, the envelope sender address must be in the
1429 set of addresses that it defines.
1430 .next
1431 If the &%require_files%& option is set, the existence or non-existence of
1432 specified files is tested.
1433 .next
1434 .cindex "customizing" "precondition"
1435 If the &%condition%& option is set, it is evaluated and tested. This option
1436 uses an expanded string to allow you to set up your own custom preconditions.
1437 Expanded strings are described in chapter &<<CHAPexpand>>&.
1438 .endlist
1439
1440
1441 Note that &%require_files%& comes near the end of the list, so you cannot use
1442 it to check for the existence of a file in which to lookup up a domain, local
1443 part, or sender. However, as these options are all expanded, you can use the
1444 &%exists%& expansion condition to make such tests within each condition. The
1445 &%require_files%& option is intended for checking files that the router may be
1446 going to use internally, or which are needed by a specific transport (for
1447 example, &_.procmailrc_&).
1448
1449
1450
1451 .section "Delivery in detail" "SECID18"
1452 .cindex "delivery" "in detail"
1453 When a message is to be delivered, the sequence of events is as follows:
1454
1455 .ilist
1456 If a system-wide filter file is specified, the message is passed to it. The
1457 filter may add recipients to the message, replace the recipients, discard the
1458 message, cause a new message to be generated, or cause the message delivery to
1459 fail. The format of the system filter file is the same as for Exim user filter
1460 files, described in the separate document entitled &'Exim's interfaces to mail
1461 filtering'&.
1462 .cindex "Sieve filter" "not available for system filter"
1463 (&*Note*&: Sieve cannot be used for system filter files.)
1464
1465 Some additional features are available in system filters &-- see chapter
1466 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1467 filter only once per delivery attempt, however many recipients it has. However,
1468 if there are several delivery attempts because one or more addresses could not
1469 be immediately delivered, the system filter is run each time. The filter
1470 condition &%first_delivery%& can be used to detect the first run of the system
1471 filter.
1472 .next
1473 Each recipient address is offered to each configured router, in turn, subject to
1474 its preconditions, until one is able to handle it. If no router can handle the
1475 address, that is, if they all decline, the address is failed. Because routers
1476 can be targeted at particular domains, several locally handled domains can be
1477 processed entirely independently of each other.
1478 .next
1479 .cindex "routing" "loops in"
1480 .cindex "loop" "while routing"
1481 A router that accepts an address may assign it to a local or a remote
1482 transport. However, the transport is not run at this time. Instead, the address
1483 is placed on a list for the particular transport, which will be run later.
1484 Alternatively, the router may generate one or more new addresses (typically
1485 from alias, forward, or filter files). New addresses are fed back into this
1486 process from the top, but in order to avoid loops, a router ignores any address
1487 which has an identically-named ancestor that was processed by itself.
1488 .next
1489 When all the routing has been done, addresses that have been successfully
1490 handled are passed to their assigned transports. When local transports are
1491 doing real local deliveries, they handle only one address at a time, but if a
1492 local transport is being used as a pseudo-remote transport (for example, to
1493 collect batched SMTP messages for transmission by some other means) multiple
1494 addresses can be handled. Remote transports can always handle more than one
1495 address at a time, but can be configured not to do so, or to restrict multiple
1496 addresses to the same domain.
1497 .next
1498 Each local delivery to a file or a pipe runs in a separate process under a
1499 non-privileged uid, and these deliveries are run one at a time. Remote
1500 deliveries also run in separate processes, normally under a uid that is private
1501 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1502 run in parallel. The maximum number of simultaneous remote deliveries for any
1503 one message is set by the &%remote_max_parallel%& option.
1504 The order in which deliveries are done is not defined, except that all local
1505 deliveries happen before any remote deliveries.
1506 .next
1507 .cindex "queue runner"
1508 When it encounters a local delivery during a queue run, Exim checks its retry
1509 database to see if there has been a previous temporary delivery failure for the
1510 address before running the local transport. If there was a previous failure,
1511 Exim does not attempt a new delivery until the retry time for the address is
1512 reached. However, this happens only for delivery attempts that are part of a
1513 queue run. Local deliveries are always attempted when delivery immediately
1514 follows message reception, even if retry times are set for them. This makes for
1515 better behaviour if one particular message is causing problems (for example,
1516 causing quota overflow, or provoking an error in a filter file).
1517 .next
1518 .cindex "delivery" "retry in remote transports"
1519 Remote transports do their own retry handling, since an address may be
1520 deliverable to one of a number of hosts, each of which may have a different
1521 retry time. If there have been previous temporary failures and no host has
1522 reached its retry time, no delivery is attempted, whether in a queue run or
1523 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1524 .next
1525 If there were any permanent errors, a bounce message is returned to an
1526 appropriate address (the sender in the common case), with details of the error
1527 for each failing address. Exim can be configured to send copies of bounce
1528 messages to other addresses.
1529 .next
1530 .cindex "delivery" "deferral"
1531 If one or more addresses suffered a temporary failure, the message is left on
1532 the queue, to be tried again later. Delivery of these addresses is said to be
1533 &'deferred'&.
1534 .next
1535 When all the recipient addresses have either been delivered or bounced,
1536 handling of the message is complete. The spool files and message log are
1537 deleted, though the message log can optionally be preserved if required.
1538 .endlist
1539
1540
1541
1542
1543 .section "Retry mechanism" "SECID19"
1544 .cindex "delivery" "retry mechanism"
1545 .cindex "retry" "description of mechanism"
1546 .cindex "queue runner"
1547 Exim's mechanism for retrying messages that fail to get delivered at the first
1548 attempt is the queue runner process. You must either run an Exim daemon that
1549 uses the &%-q%& option with a time interval to start queue runners at regular
1550 intervals or use some other means (such as &'cron'&) to start them. If you do
1551 not arrange for queue runners to be run, messages that fail temporarily at the
1552 first attempt will remain in your queue forever. A queue runner process works
1553 its way through the queue, one message at a time, trying each delivery that has
1554 passed its retry time.
1555 You can run several queue runners at once.
1556
1557 Exim uses a set of configured rules to determine when next to retry the failing
1558 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1559 should give up trying to deliver to the address, at which point it generates a
1560 bounce message. If no retry rules are set for a particular host, address, and
1561 error combination, no retries are attempted, and temporary errors are treated
1562 as permanent.
1563
1564
1565
1566 .section "Temporary delivery failure" "SECID20"
1567 .cindex "delivery" "temporary failure"
1568 There are many reasons why a message may not be immediately deliverable to a
1569 particular address. Failure to connect to a remote machine (because it, or the
1570 connection to it, is down) is one of the most common. Temporary failures may be
1571 detected during routing as well as during the transport stage of delivery.
1572 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1573 is on a file system where the user is over quota. Exim can be configured to
1574 impose its own quotas on local mailboxes; where system quotas are set they will
1575 also apply.
1576
1577 If a host is unreachable for a period of time, a number of messages may be
1578 waiting for it by the time it recovers, and sending them in a single SMTP
1579 connection is clearly beneficial. Whenever a delivery to a remote host is
1580 deferred,
1581 .cindex "hints database" "deferred deliveries"
1582 Exim makes a note in its hints database, and whenever a successful
1583 SMTP delivery has happened, it looks to see if any other messages are waiting
1584 for the same host. If any are found, they are sent over the same SMTP
1585 connection, subject to a configuration limit as to the maximum number in any
1586 one connection.
1587
1588
1589
1590 .section "Permanent delivery failure" "SECID21"
1591 .cindex "delivery" "permanent failure"
1592 .cindex "bounce message" "when generated"
1593 When a message cannot be delivered to some or all of its intended recipients, a
1594 bounce message is generated. Temporary delivery failures turn into permanent
1595 errors when their timeout expires. All the addresses that fail in a given
1596 delivery attempt are listed in a single message. If the original message has
1597 many recipients, it is possible for some addresses to fail in one delivery
1598 attempt and others to fail subsequently, giving rise to more than one bounce
1599 message. The wording of bounce messages can be customized by the administrator.
1600 See chapter &<<CHAPemsgcust>>& for details.
1601
1602 .cindex "&'X-Failed-Recipients:'& header line"
1603 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1604 failed addresses, for the benefit of programs that try to analyse such messages
1605 automatically.
1606
1607 .cindex "bounce message" "recipient of"
1608 A bounce message is normally sent to the sender of the original message, as
1609 obtained from the message's envelope. For incoming SMTP messages, this is the
1610 address given in the MAIL command. However, when an address is expanded via a
1611 forward or alias file, an alternative address can be specified for delivery
1612 failures of the generated addresses. For a mailing list expansion (see section
1613 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1614 of the list.
1615
1616
1617
1618 .section "Failures to deliver bounce messages" "SECID22"
1619 .cindex "bounce message" "failure to deliver"
1620 If a bounce message (either locally generated or received from a remote host)
1621 itself suffers a permanent delivery failure, the message is left in the queue,
1622 but it is frozen, awaiting the attention of an administrator. There are options
1623 that can be used to make Exim discard such failed messages, or to keep them
1624 for only a short time (see &%timeout_frozen_after%& and
1625 &%ignore_bounce_errors_after%&).
1626
1627
1628
1629
1630
1631 . ////////////////////////////////////////////////////////////////////////////
1632 . ////////////////////////////////////////////////////////////////////////////
1633
1634 .chapter "Building and installing Exim" "CHID3"
1635 .scindex IIDbuex "building Exim"
1636
1637 .section "Unpacking" "SECID23"
1638 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1639 creates a directory with the name of the current release (for example,
1640 &_exim-&version()_&) into which the following files are placed:
1641
1642 .table2 140pt
1643 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1644 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1645   documented"
1646 .irow &_LICENCE_&         "the GNU General Public Licence"
1647 .irow &_Makefile_&        "top-level make file"
1648 .irow &_NOTICE_&          "conditions for the use of Exim"
1649 .irow &_README_&          "list of files, directories and simple build &&&
1650   instructions"
1651 .endtable
1652
1653 Other files whose names begin with &_README_& may also be present. The
1654 following subdirectories are created:
1655
1656 .table2 140pt
1657 .irow &_Local_&           "an empty directory for local configuration files"
1658 .irow &_OS_&              "OS-specific files"
1659 .irow &_doc_&             "documentation files"
1660 .irow &_exim_monitor_&    "source files for the Exim monitor"
1661 .irow &_scripts_&         "scripts used in the build process"
1662 .irow &_src_&             "remaining source files"
1663 .irow &_util_&            "independent utilities"
1664 .endtable
1665
1666 The main utility programs are contained in the &_src_& directory and are built
1667 with the Exim binary. The &_util_& directory contains a few optional scripts
1668 that may be useful to some sites.
1669
1670
1671 .section "Multiple machine architectures and operating systems" "SECID24"
1672 .cindex "building Exim" "multiple OS/architectures"
1673 The building process for Exim is arranged to make it easy to build binaries for
1674 a number of different architectures and operating systems from the same set of
1675 source files. Compilation does not take place in the &_src_& directory.
1676 Instead, a &'build directory'& is created for each architecture and operating
1677 system.
1678 .cindex "symbolic link" "to build directory"
1679 Symbolic links to the sources are installed in this directory, which is where
1680 the actual building takes place. In most cases, Exim can discover the machine
1681 architecture and operating system for itself, but the defaults can be
1682 overridden if necessary.
1683 .cindex compiler requirements
1684 .cindex compiler version
1685 A C99-capable compiler will be required for the build.
1686
1687
1688 .section "PCRE library" "SECTpcre"
1689 .cindex "PCRE library"
1690 Exim no longer has an embedded PCRE library as the vast majority of
1691 modern systems include PCRE as a system library, although you may need to
1692 install the PCRE package or the PCRE development package for your operating
1693 system. If your system has a normal PCRE installation the Exim build
1694 process will need no further configuration. If the library or the
1695 headers are in an unusual location you will need to either set the PCRE_LIBS
1696 and INCLUDE directives appropriately,
1697 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1698 If your operating system has no
1699 PCRE support then you will need to obtain and build the current PCRE
1700 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1701 More information on PCRE is available at &url(https://www.pcre.org/).
1702
1703 .section "DBM libraries" "SECTdb"
1704 .cindex "DBM libraries" "discussion of"
1705 .cindex "hints database" "DBM files used for"
1706 Even if you do not use any DBM files in your configuration, Exim still needs a
1707 DBM library in order to operate, because it uses indexed files for its hints
1708 databases. Unfortunately, there are a number of DBM libraries in existence, and
1709 different operating systems often have different ones installed.
1710
1711 .cindex "Solaris" "DBM library for"
1712 .cindex "IRIX, DBM library for"
1713 .cindex "BSD, DBM library for"
1714 .cindex "Linux, DBM library for"
1715 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1716 Linux distribution, the DBM configuration should happen automatically, and you
1717 may be able to ignore this section. Otherwise, you may have to learn more than
1718 you would like about DBM libraries from what follows.
1719
1720 .cindex "&'ndbm'& DBM library"
1721 Licensed versions of Unix normally contain a library of DBM functions operating
1722 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1723 versions of Unix seem to vary in what they contain as standard. In particular,
1724 some early versions of Linux have no default DBM library, and different
1725 distributors have chosen to bundle different libraries with their packaged
1726 versions. However, the more recent releases seem to have standardized on the
1727 Berkeley DB library.
1728
1729 Different DBM libraries have different conventions for naming the files they
1730 use. When a program opens a file called &_dbmfile_&, there are several
1731 possibilities:
1732
1733 .olist
1734 A traditional &'ndbm'& implementation, such as that supplied as part of
1735 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1736 .next
1737 .cindex "&'gdbm'& DBM library"
1738 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1739 compatibility interface it makes two different hard links to it with names
1740 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1741 filename is used unmodified.
1742 .next
1743 .cindex "Berkeley DB library"
1744 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1745 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1746 programmer exactly the same as the traditional &'ndbm'& implementation.
1747 .next
1748 If the Berkeley package is used in its native mode, it operates on a single
1749 file called &_dbmfile_&; the programmer's interface is somewhat different to
1750 the traditional &'ndbm'& interface.
1751 .next
1752 To complicate things further, there are several very different versions of the
1753 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1754 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1755 Maintenance of some of the earlier releases has ceased. All versions of
1756 Berkeley DB could be obtained from
1757 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1758 page with far newer versions listed.
1759 It is probably wise to plan to move your storage configurations away from
1760 Berkeley DB format, as today there are smaller and simpler alternatives more
1761 suited to Exim's usage model.
1762 .next
1763 .cindex "&'tdb'& DBM library"
1764 Yet another DBM library, called &'tdb'&, is available from
1765 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1766 operates on a single file.
1767 .endlist
1768
1769 .cindex "USE_DB"
1770 .cindex "DBM libraries" "configuration for building"
1771 Exim and its utilities can be compiled to use any of these interfaces. In order
1772 to use any version of the Berkeley DB package in native mode, you must set
1773 USE_DB in an appropriate configuration file (typically
1774 &_Local/Makefile_&). For example:
1775 .code
1776 USE_DB=yes
1777 .endd
1778 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1779 error is diagnosed if you set more than one of these.
1780
1781 At the lowest level, the build-time configuration sets none of these options,
1782 thereby assuming an interface of type (1). However, some operating system
1783 configuration files (for example, those for the BSD operating systems and
1784 Linux) assume type (4) by setting USE_DB as their default, and the
1785 configuration files for Cygwin set USE_GDBM. Anything you set in
1786 &_Local/Makefile_&, however, overrides these system defaults.
1787
1788 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1789 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1790 in one of these lines:
1791 .code
1792 DBMLIB = -ldb
1793 DBMLIB = -ltdb
1794 .endd
1795 Settings like that will work if the DBM library is installed in the standard
1796 place. Sometimes it is not, and the library's header file may also not be in
1797 the default path. You may need to set INCLUDE to specify where the header
1798 file is, and to specify the path to the library more fully in DBMLIB, as in
1799 this example:
1800 .code
1801 INCLUDE=-I/usr/local/include/db-4.1
1802 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1803 .endd
1804 There is further detailed discussion about the various DBM libraries in the
1805 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1806
1807
1808
1809 .section "Pre-building configuration" "SECID25"
1810 .cindex "building Exim" "pre-building configuration"
1811 .cindex "configuration for building Exim"
1812 .cindex "&_Local/Makefile_&"
1813 .cindex "&_src/EDITME_&"
1814 Before building Exim, a local configuration file that specifies options
1815 independent of any operating system has to be created with the name
1816 &_Local/Makefile_&. A template for this file is supplied as the file
1817 &_src/EDITME_&, and it contains full descriptions of all the option settings
1818 therein. These descriptions are therefore not repeated here. If you are
1819 building Exim for the first time, the simplest thing to do is to copy
1820 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1821
1822 There are three settings that you must supply, because Exim will not build
1823 without them. They are the location of the runtime configuration file
1824 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1825 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1826 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1827 a colon-separated list of filenames; Exim uses the first of them that exists.
1828
1829 There are a few other parameters that can be specified either at build time or
1830 at runtime, to enable the same binary to be used on a number of different
1831 machines. However, if the locations of Exim's spool directory and log file
1832 directory (if not within the spool directory) are fixed, it is recommended that
1833 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1834 detected early in Exim's execution (such as a malformed configuration file) can
1835 be logged.
1836
1837 .cindex "content scanning" "specifying at build time"
1838 Exim's interfaces for calling virus and spam scanning software directly from
1839 access control lists are not compiled by default. If you want to include these
1840 facilities, you need to set
1841 .code
1842 WITH_CONTENT_SCAN=yes
1843 .endd
1844 in your &_Local/Makefile_&. For details of the facilities themselves, see
1845 chapter &<<CHAPexiscan>>&.
1846
1847
1848 .cindex "&_Local/eximon.conf_&"
1849 .cindex "&_exim_monitor/EDITME_&"
1850 If you are going to build the Exim monitor, a similar configuration process is
1851 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1852 your installation and saved under the name &_Local/eximon.conf_&. If you are
1853 happy with the default settings described in &_exim_monitor/EDITME_&,
1854 &_Local/eximon.conf_& can be empty, but it must exist.
1855
1856 This is all the configuration that is needed in straightforward cases for known
1857 operating systems. However, the building process is set up so that it is easy
1858 to override options that are set by default or by operating-system-specific
1859 configuration files, for example, to change the C compiler, which
1860 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1861 do this.
1862
1863
1864
1865 .section "Support for iconv()" "SECID26"
1866 .cindex "&[iconv()]& support"
1867 .cindex "RFC 2047"
1868 The contents of header lines in messages may be encoded according to the rules
1869 described RFC 2047. This makes it possible to transmit characters that are not
1870 in the ASCII character set, and to label them as being in a particular
1871 character set. When Exim is inspecting header lines by means of the &%$h_%&
1872 mechanism, it decodes them, and translates them into a specified character set
1873 (default is set at build time). The translation is possible only if the operating system
1874 supports the &[iconv()]& function.
1875
1876 However, some of the operating systems that supply &[iconv()]& do not support
1877 very many conversions. The GNU &%libiconv%& library (available from
1878 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1879 systems to remedy this deficiency, as well as on systems that do not supply
1880 &[iconv()]& at all. After installing &%libiconv%&, you should add
1881 .code
1882 HAVE_ICONV=yes
1883 .endd
1884 to your &_Local/Makefile_& and rebuild Exim.
1885
1886
1887
1888 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1889 .cindex "TLS" "including support for TLS"
1890 .cindex "encryption" "including support for"
1891 .cindex "OpenSSL" "building Exim with"
1892 .cindex "GnuTLS" "building Exim with"
1893 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1894 command as per RFC 2487. It can also support clients that expect to
1895 start a TLS session immediately on connection to a non-standard port (see the
1896 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1897 line option).
1898
1899 If you want to build Exim with TLS support, you must first install either the
1900 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1901 implementing SSL.
1902
1903 .new
1904 If you do not want TLS support you should set
1905 .code
1906 DISABLE_TLS=yes
1907 .endd
1908 in &_Local/Makefile_&.
1909 .wen
1910
1911 .new
1912 If OpenSSL is installed, you should set
1913 .code
1914 USE_OPENSL=yes
1915 TLS_LIBS=-lssl -lcrypto
1916 .endd
1917 in &_Local/Makefile_&. You may also need to specify the locations of the
1918 OpenSSL library and include files. For example:
1919 .code
1920 USE_OPENSSL=yes
1921 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1922 TLS_INCLUDE=-I/usr/local/openssl/include/
1923 .endd
1924 .cindex "pkg-config" "OpenSSL"
1925 If you have &'pkg-config'& available, then instead you can just use:
1926 .code
1927 USE_OPENSSL=yes
1928 USE_OPENSSL_PC=openssl
1929 .endd
1930 .wen
1931 .cindex "USE_GNUTLS"
1932 If GnuTLS is installed, you should set
1933 .code
1934 USE_GNUTLS=yes
1935 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1936 .endd
1937 in &_Local/Makefile_&, and again you may need to specify the locations of the
1938 library and include files. For example:
1939 .code
1940 USE_GNUTLS=yes
1941 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1942 TLS_INCLUDE=-I/usr/gnu/include
1943 .endd
1944 .cindex "pkg-config" "GnuTLS"
1945 If you have &'pkg-config'& available, then instead you can just use:
1946 .code
1947 USE_GNUTLS=yes
1948 USE_GNUTLS_PC=gnutls
1949 .endd
1950
1951 You do not need to set TLS_INCLUDE if the relevant directory is already
1952 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1953 given in chapter &<<CHAPTLS>>&.
1954
1955
1956
1957
1958 .section "Use of tcpwrappers" "SECID27"
1959
1960 .cindex "tcpwrappers, building Exim to support"
1961 .cindex "USE_TCP_WRAPPERS"
1962 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1963 .cindex "tcp_wrappers_daemon_name"
1964 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1965 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1966 alternative to Exim's own checking facilities for installations that are
1967 already making use of &'tcpwrappers'& for other purposes. To do this, you
1968 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1969 &_tcpd.h_& to be available at compile time, and also ensure that the library
1970 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1971 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1972 you might have
1973 .code
1974 USE_TCP_WRAPPERS=yes
1975 CFLAGS=-O -I/usr/local/include
1976 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1977 .endd
1978 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1979 files is &"exim"&. For example, the line
1980 .code
1981 exim : LOCAL  192.168.1.  .friendly.domain.example
1982 .endd
1983 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1984 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1985 All other connections are denied. The daemon name used by &'tcpwrappers'&
1986 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1987 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1988 configure file. Consult the &'tcpwrappers'& documentation for
1989 further details.
1990
1991
1992 .section "Including support for IPv6" "SECID28"
1993 .cindex "IPv6" "including support for"
1994 Exim contains code for use on systems that have IPv6 support. Setting
1995 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1996 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1997 where the IPv6 support is not fully integrated into the normal include and
1998 library files.
1999
2000 Two different types of DNS record for handling IPv6 addresses have been
2001 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2002 currently seen as the mainstream. Another record type called A6 was proposed
2003 as better than AAAA because it had more flexibility. However, it was felt to be
2004 over-complex, and its status was reduced to &"experimental"&.
2005 Exim used to
2006 have a compile option for including A6 record support but this has now been
2007 withdrawn.
2008
2009
2010
2011 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2012 .cindex "lookup modules"
2013 .cindex "dynamic modules"
2014 .cindex ".so building"
2015 On some platforms, Exim supports not compiling all lookup types directly into
2016 the main binary, instead putting some into external modules which can be loaded
2017 on demand.
2018 This permits packagers to build Exim with support for lookups with extensive
2019 library dependencies without requiring all users to install all of those
2020 dependencies.
2021 Most, but not all, lookup types can be built this way.
2022
2023 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2024 installed; Exim will only load modules from that directory, as a security
2025 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2026 for your OS; see &_OS/Makefile-Linux_& for an example.
2027 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2028 see &_src/EDITME_& for details.
2029
2030 Then, for each module to be loaded dynamically, define the relevant
2031 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2032 For example, this will build in lsearch but load sqlite and mysql support
2033 on demand:
2034 .code
2035 LOOKUP_LSEARCH=yes
2036 LOOKUP_SQLITE=2
2037 LOOKUP_MYSQL=2
2038 .endd
2039
2040
2041 .section "The building process" "SECID29"
2042 .cindex "build directory"
2043 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2044 created, run &'make'& at the top level. It determines the architecture and
2045 operating system types, and creates a build directory if one does not exist.
2046 For example, on a Sun system running Solaris 8, the directory
2047 &_build-SunOS5-5.8-sparc_& is created.
2048 .cindex "symbolic link" "to source files"
2049 Symbolic links to relevant source files are installed in the build directory.
2050
2051 If this is the first time &'make'& has been run, it calls a script that builds
2052 a make file inside the build directory, using the configuration files from the
2053 &_Local_& directory. The new make file is then passed to another instance of
2054 &'make'&. This does the real work, building a number of utility scripts, and
2055 then compiling and linking the binaries for the Exim monitor (if configured), a
2056 number of utility programs, and finally Exim itself. The command &`make
2057 makefile`& can be used to force a rebuild of the make file in the build
2058 directory, should this ever be necessary.
2059
2060 If you have problems building Exim, check for any comments there may be in the
2061 &_README_& file concerning your operating system, and also take a look at the
2062 FAQ, where some common problems are covered.
2063
2064
2065
2066 .section 'Output from &"make"&' "SECID283"
2067 The output produced by the &'make'& process for compile lines is often very
2068 unreadable, because these lines can be very long. For this reason, the normal
2069 output is suppressed by default, and instead output similar to that which
2070 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2071 each module that is being compiled or linked. However, it is still possible to
2072 get the full output, by calling &'make'& like this:
2073 .code
2074 FULLECHO='' make -e
2075 .endd
2076 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2077 command reflection in &'make'&. When you ask for the full output, it is
2078 given in addition to the short output.
2079
2080
2081
2082 .section "Overriding build-time options for Exim" "SECToverride"
2083 .cindex "build-time options, overriding"
2084 The main make file that is created at the beginning of the building process
2085 consists of the concatenation of a number of files which set configuration
2086 values, followed by a fixed set of &'make'& instructions. If a value is set
2087 more than once, the last setting overrides any previous ones. This provides a
2088 convenient way of overriding defaults. The files that are concatenated are, in
2089 order:
2090 .display
2091 &_OS/Makefile-Default_&
2092 &_OS/Makefile-_&<&'ostype'&>
2093 &_Local/Makefile_&
2094 &_Local/Makefile-_&<&'ostype'&>
2095 &_Local/Makefile-_&<&'archtype'&>
2096 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2097 &_OS/Makefile-Base_&
2098 .endd
2099 .cindex "&_Local/Makefile_&"
2100 .cindex "building Exim" "operating system type"
2101 .cindex "building Exim" "architecture type"
2102 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2103 architecture type. &_Local/Makefile_& is required to exist, and the building
2104 process fails if it is absent. The other three &_Local_& files are optional,
2105 and are often not needed.
2106
2107 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2108 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2109 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2110 values are used, thereby providing a means of forcing particular settings.
2111 Otherwise, the scripts try to get values from the &%uname%& command. If this
2112 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2113 of &'ad hoc'& transformations are then applied, to produce the standard names
2114 that Exim expects. You can run these scripts directly from the shell in order
2115 to find out what values are being used on your system.
2116
2117
2118 &_OS/Makefile-Default_& contains comments about the variables that are set
2119 therein. Some (but not all) are mentioned below. If there is something that
2120 needs changing, review the contents of this file and the contents of the make
2121 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2122 default values are.
2123
2124
2125 .cindex "building Exim" "overriding default settings"
2126 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2127 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2128 need to change the original files. Instead, you should make the changes by
2129 putting the new values in an appropriate &_Local_& file. For example,
2130 .cindex "Tru64-Unix build-time settings"
2131 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2132 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2133 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2134 called with the option &%-std1%&, to make it recognize some of the features of
2135 Standard C that Exim uses. (Most other compilers recognize Standard C by
2136 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2137 containing the lines
2138 .code
2139 CC=cc
2140 CFLAGS=-std1
2141 .endd
2142 If you are compiling for just one operating system, it may be easier to put
2143 these lines directly into &_Local/Makefile_&.
2144
2145 Keeping all your local configuration settings separate from the distributed
2146 files makes it easy to transfer them to new versions of Exim simply by copying
2147 the contents of the &_Local_& directory.
2148
2149
2150 .cindex "NIS lookup type" "including support for"
2151 .cindex "NIS+ lookup type" "including support for"
2152 .cindex "LDAP" "including support for"
2153 .cindex "lookup" "inclusion in binary"
2154 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2155 lookup, but not all systems have these components installed, so the default is
2156 not to include the relevant code in the binary. All the different kinds of file
2157 and database lookup that Exim supports are implemented as separate code modules
2158 which are included only if the relevant compile-time options are set. In the
2159 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2160 .code
2161 LOOKUP_LDAP=yes
2162 LOOKUP_NIS=yes
2163 LOOKUP_NISPLUS=yes
2164 .endd
2165 and similar settings apply to the other lookup types. They are all listed in
2166 &_src/EDITME_&. In many cases the relevant include files and interface
2167 libraries need to be installed before compiling Exim.
2168 .cindex "cdb" "including support for"
2169 However, there are some optional lookup types (such as cdb) for which
2170 the code is entirely contained within Exim, and no external include
2171 files or libraries are required. When a lookup type is not included in the
2172 binary, attempts to configure Exim to use it cause runtime configuration
2173 errors.
2174
2175 .cindex "pkg-config" "lookups"
2176 .cindex "pkg-config" "authenticators"
2177 Many systems now use a tool called &'pkg-config'& to encapsulate information
2178 about how to compile against a library; Exim has some initial support for
2179 being able to use pkg-config for lookups and authenticators.  For any given
2180 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2181 variable with the &`_PC`& suffix in the name and assign as the value the
2182 name of the package to be queried.  The results of querying via the
2183 &'pkg-config'& command will be added to the appropriate Makefile variables
2184 with &`+=`& directives, so your version of &'make'& will need to support that
2185 syntax.  For instance:
2186 .code
2187 LOOKUP_SQLITE=yes
2188 LOOKUP_SQLITE_PC=sqlite3
2189 AUTH_GSASL=yes
2190 AUTH_GSASL_PC=libgsasl
2191 AUTH_HEIMDAL_GSSAPI=yes
2192 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2193 .endd
2194
2195 .cindex "Perl" "including support for"
2196 Exim can be linked with an embedded Perl interpreter, allowing Perl
2197 subroutines to be called during string expansion. To enable this facility,
2198 .code
2199 EXIM_PERL=perl.o
2200 .endd
2201 must be defined in &_Local/Makefile_&. Details of this facility are given in
2202 chapter &<<CHAPperl>>&.
2203
2204 .cindex "X11 libraries, location of"
2205 The location of the X11 libraries is something that varies a lot between
2206 operating systems, and there may be different versions of X11 to cope
2207 with. Exim itself makes no use of X11, but if you are compiling the Exim
2208 monitor, the X11 libraries must be available.
2209 The following three variables are set in &_OS/Makefile-Default_&:
2210 .code
2211 X11=/usr/X11R6
2212 XINCLUDE=-I$(X11)/include
2213 XLFLAGS=-L$(X11)/lib
2214 .endd
2215 These are overridden in some of the operating-system configuration files. For
2216 example, in &_OS/Makefile-SunOS5_& there is
2217 .code
2218 X11=/usr/openwin
2219 XINCLUDE=-I$(X11)/include
2220 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2221 .endd
2222 If you need to override the default setting for your operating system, place a
2223 definition of all three of these variables into your
2224 &_Local/Makefile-<ostype>_& file.
2225
2226 .cindex "EXTRALIBS"
2227 If you need to add any extra libraries to the link steps, these can be put in a
2228 variable called EXTRALIBS, which appears in all the link commands, but by
2229 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2230 command for linking the main Exim binary, and not for any associated utilities.
2231
2232 .cindex "DBM libraries" "configuration for building"
2233 There is also DBMLIB, which appears in the link commands for binaries that
2234 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2235 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2236 binary, and which can be used, for example, to include additional X11
2237 libraries.
2238
2239 .cindex "configuration file" "editing"
2240 The make file copes with rebuilding Exim correctly if any of the configuration
2241 files are edited. However, if an optional configuration file is deleted, it is
2242 necessary to touch the associated non-optional file (that is,
2243 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2244
2245
2246 .section "OS-specific header files" "SECID30"
2247 .cindex "&_os.h_&"
2248 .cindex "building Exim" "OS-specific C header files"
2249 The &_OS_& directory contains a number of files with names of the form
2250 &_os.h-<ostype>_&. These are system-specific C header files that should not
2251 normally need to be changed. There is a list of macro settings that are
2252 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2253 are porting Exim to a new operating system.
2254
2255
2256
2257 .section "Overriding build-time options for the monitor" "SECID31"
2258 .cindex "building Eximon"
2259 A similar process is used for overriding things when building the Exim monitor,
2260 where the files that are involved are
2261 .display
2262 &_OS/eximon.conf-Default_&
2263 &_OS/eximon.conf-_&<&'ostype'&>
2264 &_Local/eximon.conf_&
2265 &_Local/eximon.conf-_&<&'ostype'&>
2266 &_Local/eximon.conf-_&<&'archtype'&>
2267 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2268 .endd
2269 .cindex "&_Local/eximon.conf_&"
2270 As with Exim itself, the final three files need not exist, and in this case the
2271 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2272 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2273 variables of the same name, preceded by EXIMON_. For example, setting
2274 EXIMON_LOG_DEPTH in the environment overrides the value of
2275 LOG_DEPTH at runtime.
2276 .ecindex IIDbuex
2277
2278
2279 .section "Installing Exim binaries and scripts" "SECID32"
2280 .cindex "installing Exim"
2281 .cindex "BIN_DIRECTORY"
2282 The command &`make install`& runs the &(exim_install)& script with no
2283 arguments. The script copies binaries and utility scripts into the directory
2284 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2285 .cindex "setuid" "installing Exim with"
2286 The install script copies files only if they are newer than the files they are
2287 going to replace. The Exim binary is required to be owned by root and have the
2288 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2289 install`& as root so that it can set up the Exim binary in this way. However, in
2290 some special situations (for example, if a host is doing no local deliveries)
2291 it may be possible to run Exim without making the binary setuid root (see
2292 chapter &<<CHAPsecurity>>& for details).
2293
2294 .cindex "CONFIGURE_FILE"
2295 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2296 in &_Local/Makefile_&. If this names a single file, and the file does not
2297 exist, the default configuration file &_src/configure.default_& is copied there
2298 by the installation script. If a runtime configuration file already exists, it
2299 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2300 alternative files, no default is installed.
2301
2302 .cindex "system aliases file"
2303 .cindex "&_/etc/aliases_&"
2304 One change is made to the default configuration file when it is installed: the
2305 default configuration contains a router that references a system aliases file.
2306 The path to this file is set to the value specified by
2307 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2308 If the system aliases file does not exist, the installation script creates it,
2309 and outputs a comment to the user.
2310
2311 The created file contains no aliases, but it does contain comments about the
2312 aliases a site should normally have. Mail aliases have traditionally been
2313 kept in &_/etc/aliases_&. However, some operating systems are now using
2314 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2315 Exim's configuration if necessary.
2316
2317 The default configuration uses the local host's name as the only local domain,
2318 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2319 running as the local user. System aliases and &_.forward_& files in users' home
2320 directories are supported, but no NIS or NIS+ support is configured. Domains
2321 other than the name of the local host are routed using the DNS, with delivery
2322 over SMTP.
2323
2324 It is possible to install Exim for special purposes (such as building a binary
2325 distribution) in a private part of the file system. You can do this by a
2326 command such as
2327 .code
2328 make DESTDIR=/some/directory/ install
2329 .endd
2330 This has the effect of pre-pending the specified directory to all the file
2331 paths, except the name of the system aliases file that appears in the default
2332 configuration. (If a default alias file is created, its name &'is'& modified.)
2333 For backwards compatibility, ROOT is used if DESTDIR is not set,
2334 but this usage is deprecated.
2335
2336 .cindex "installing Exim" "what is not installed"
2337 Running &'make install'& does not copy the Exim 4 conversion script
2338 &'convert4r4'&. You will probably run this only once if you are
2339 upgrading from Exim 3. None of the documentation files in the &_doc_&
2340 directory are copied, except for the info files when you have set
2341 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2342
2343 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2344 to their names. The Exim binary itself, however, is handled differently. It is
2345 installed under a name that includes the version number and the compile number,
2346 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2347 called &_exim_& to point to the binary. If you are updating a previous version
2348 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2349 from the directory (as seen by other processes).
2350
2351 .cindex "installing Exim" "testing the script"
2352 If you want to see what the &'make install'& will do before running it for
2353 real, you can pass the &%-n%& option to the installation script by this
2354 command:
2355 .code
2356 make INSTALL_ARG=-n install
2357 .endd
2358 The contents of the variable INSTALL_ARG are passed to the installation
2359 script. You do not need to be root to run this test. Alternatively, you can run
2360 the installation script directly, but this must be from within the build
2361 directory. For example, from the top-level Exim directory you could use this
2362 command:
2363 .code
2364 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2365 .endd
2366 .cindex "installing Exim" "install script options"
2367 There are two other options that can be supplied to the installation script.
2368
2369 .ilist
2370 &%-no_chown%& bypasses the call to change the owner of the installed binary
2371 to root, and the call to make it a setuid binary.
2372 .next
2373 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2374 installed binary.
2375 .endlist
2376
2377 INSTALL_ARG can be used to pass these options to the script. For example:
2378 .code
2379 make INSTALL_ARG=-no_symlink install
2380 .endd
2381 The installation script can also be given arguments specifying which files are
2382 to be copied. For example, to install just the Exim binary, and nothing else,
2383 without creating the symbolic link, you could use:
2384 .code
2385 make INSTALL_ARG='-no_symlink exim' install
2386 .endd
2387
2388
2389
2390 .section "Installing info documentation" "SECTinsinfdoc"
2391 .cindex "installing Exim" "&'info'& documentation"
2392 Not all systems use the GNU &'info'& system for documentation, and for this
2393 reason, the Texinfo source of Exim's documentation is not included in the main
2394 distribution. Instead it is available separately from the FTP site (see section
2395 &<<SECTavail>>&).
2396
2397 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2398 source of the documentation is found in the source tree, running &`make
2399 install`& automatically builds the info files and installs them.
2400
2401
2402
2403 .section "Setting up the spool directory" "SECID33"
2404 .cindex "spool directory" "creating"
2405 When it starts up, Exim tries to create its spool directory if it does not
2406 exist. The Exim uid and gid are used for the owner and group of the spool
2407 directory. Sub-directories are automatically created in the spool directory as
2408 necessary.
2409
2410
2411
2412
2413 .section "Testing" "SECID34"
2414 .cindex "testing" "installation"
2415 Having installed Exim, you can check that the runtime configuration file is
2416 syntactically valid by running the following command, which assumes that the
2417 Exim binary directory is within your PATH environment variable:
2418 .code
2419 exim -bV
2420 .endd
2421 If there are any errors in the configuration file, Exim outputs error messages.
2422 Otherwise it outputs the version number and build date,
2423 the DBM library that is being used, and information about which drivers and
2424 other optional code modules are included in the binary.
2425 Some simple routing tests can be done by using the address testing option. For
2426 example,
2427 .display
2428 &`exim -bt`& <&'local username'&>
2429 .endd
2430 should verify that it recognizes a local mailbox, and
2431 .display
2432 &`exim -bt`& <&'remote address'&>
2433 .endd
2434 a remote one. Then try getting it to deliver mail, both locally and remotely.
2435 This can be done by passing messages directly to Exim, without going through a
2436 user agent. For example:
2437 .code
2438 exim -v postmaster@your.domain.example
2439 From: user@your.domain.example
2440 To: postmaster@your.domain.example
2441 Subject: Testing Exim
2442
2443 This is a test message.
2444 ^D
2445 .endd
2446 The &%-v%& option causes Exim to output some verification of what it is doing.
2447 In this case you should see copies of three log lines, one for the message's
2448 arrival, one for its delivery, and one containing &"Completed"&.
2449
2450 .cindex "delivery" "problems with"
2451 If you encounter problems, look at Exim's log files (&'mainlog'& and
2452 &'paniclog'&) to see if there is any relevant information there. Another source
2453 of information is running Exim with debugging turned on, by specifying the
2454 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2455 with debugging turned on by a command of the form
2456 .display
2457 &`exim -d -M`& <&'exim-message-id'&>
2458 .endd
2459 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2460 produces rather a lot of output, but you can cut this down to specific areas.
2461 For example, if you use &%-d-all+route%& only the debugging information
2462 relevant to routing is included. (See the &%-d%& option in chapter
2463 &<<CHAPcommandline>>& for more details.)
2464
2465 .cindex '&"sticky"& bit'
2466 .cindex "lock files"
2467 One specific problem that has shown up on some sites is the inability to do
2468 local deliveries into a shared mailbox directory, because it does not have the
2469 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2470 writing to a mailbox file, and if it cannot create the lock file, the delivery
2471 is deferred. You can get round this either by setting the &"sticky bit"& on the
2472 directory, or by setting a specific group for local deliveries and allowing
2473 that group to create files in the directory (see the comments above the
2474 &(local_delivery)& transport in the default configuration file). Another
2475 approach is to configure Exim not to use lock files, but just to rely on
2476 &[fcntl()]& locking instead. However, you should do this only if all user
2477 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2478 see chapter &<<CHAPappendfile>>&.
2479
2480 One thing that cannot be tested on a system that is already running an MTA is
2481 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2482 &%-oX%& option can be used to run an Exim daemon that listens on some other
2483 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2484 &'exim_checkaccess'& utility can be used to check out policy controls on
2485 incoming SMTP mail.
2486
2487 Testing a new version on a system that is already running Exim can most easily
2488 be done by building a binary with a different CONFIGURE_FILE setting. From
2489 within the runtime configuration, all other file and directory names
2490 that Exim uses can be altered, in order to keep it entirely clear of the
2491 production version.
2492
2493
2494 .section "Replacing another MTA with Exim" "SECID35"
2495 .cindex "replacing another MTA"
2496 Building and installing Exim for the first time does not of itself put it in
2497 general use. The name by which the system's MTA is called by mail user agents
2498 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2499 operating system), and it is necessary to make this name point to the &'exim'&
2500 binary in order to get the user agents to pass messages to Exim. This is
2501 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2502 or &_/usr/lib/sendmail_&
2503 .cindex "symbolic link" "to &'exim'& binary"
2504 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2505 privilege and executable status from the old MTA. It is then necessary to stop
2506 and restart the mailer daemon, if one is running.
2507
2508 .cindex "FreeBSD, MTA indirection"
2509 .cindex "&_/etc/mail/mailer.conf_&"
2510 Some operating systems have introduced alternative ways of switching MTAs. For
2511 example, if you are running FreeBSD, you need to edit the file
2512 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2513 described. A typical example of the contents of this file for running Exim is
2514 as follows:
2515 .code
2516 sendmail            /usr/exim/bin/exim
2517 send-mail           /usr/exim/bin/exim
2518 mailq               /usr/exim/bin/exim -bp
2519 newaliases          /usr/bin/true
2520 .endd
2521 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2522 your Exim installation is &"live"&. Check it by sending a message from your
2523 favourite user agent.
2524
2525 You should consider what to tell your users about the change of MTA. Exim may
2526 have different capabilities to what was previously running, and there are
2527 various operational differences such as the text of messages produced by
2528 command line options and in bounce messages. If you allow your users to make
2529 use of Exim's filtering capabilities, you should make the document entitled
2530 &'Exim's interface to mail filtering'& available to them.
2531
2532
2533
2534 .section "Upgrading Exim" "SECID36"
2535 .cindex "upgrading Exim"
2536 If you are already running Exim on your host, building and installing a new
2537 version automatically makes it available to MUAs, or any other programs that
2538 call the MTA directly. However, if you are running an Exim daemon, you do need
2539 .cindex restart "on HUP signal"
2540 .cindex signal "HUP, to restart"
2541 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2542 new binary. You do not need to stop processing mail in order to install a new
2543 version of Exim. The install script does not modify an existing runtime
2544 configuration file.
2545
2546
2547
2548
2549 .section "Stopping the Exim daemon on Solaris" "SECID37"
2550 .cindex "Solaris" "stopping Exim on"
2551 The standard command for stopping the mailer daemon on Solaris is
2552 .code
2553 /etc/init.d/sendmail stop
2554 .endd
2555 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2556 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2557 for the text &"sendmail"&; this is not present because the actual program name
2558 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2559 solution is to replace the line that finds the process id with something like
2560 .code
2561 pid=`cat /var/spool/exim/exim-daemon.pid`
2562 .endd
2563 to obtain the daemon's pid directly from the file that Exim saves it in.
2564
2565 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2566 still be received from local processes, and if automatic delivery is configured
2567 (the normal case), deliveries will still occur.
2568
2569
2570
2571
2572 . ////////////////////////////////////////////////////////////////////////////
2573 . ////////////////////////////////////////////////////////////////////////////
2574
2575 .chapter "The Exim command line" "CHAPcommandline"
2576 .scindex IIDclo1 "command line" "options"
2577 .scindex IIDclo2 "options" "command line"
2578 Exim's command line takes the standard Unix form of a sequence of options,
2579 each starting with a hyphen character, followed by a number of arguments. The
2580 options are compatible with the main options of Sendmail, and there are also
2581 some additional options, some of which are compatible with Smail 3. Certain
2582 combinations of options do not make sense, and provoke an error if used.
2583 The form of the arguments depends on which options are set.
2584
2585
2586 .section "Setting options by program name" "SECID38"
2587 .cindex "&'mailq'&"
2588 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2589 were present before any other options.
2590 The &%-bp%& option requests a listing of the contents of the mail queue on the
2591 standard output.
2592 This feature is for compatibility with some systems that contain a command of
2593 that name in one of the standard libraries, symbolically linked to
2594 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2595
2596 .cindex "&'rsmtp'&"
2597 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2598 were present before any other options, for compatibility with Smail. The
2599 &%-bS%& option is used for reading in a number of messages in batched SMTP
2600 format.
2601
2602 .cindex "&'rmail'&"
2603 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2604 &%-oee%& options were present before any other options, for compatibility with
2605 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2606
2607 .cindex "&'runq'&"
2608 .cindex "queue runner"
2609 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2610 were present before any other options, for compatibility with Smail. The &%-q%&
2611 option causes a single queue runner process to be started.
2612
2613 .cindex "&'newaliases'&"
2614 .cindex "alias file" "building"
2615 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2616 If Exim is called under the name &'newaliases'& it behaves as if the option
2617 &%-bi%& were present before any other options, for compatibility with Sendmail.
2618 This option is used for rebuilding Sendmail's alias file. Exim does not have
2619 the concept of a single alias file, but can be configured to run a given
2620 command if called with the &%-bi%& option.
2621
2622
2623 .section "Trusted and admin users" "SECTtrustedadmin"
2624 Some Exim options are available only to &'trusted users'& and others are
2625 available only to &'admin users'&. In the description below, the phrases &"Exim
2626 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2627 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2628 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2629
2630 .ilist
2631 .cindex "trusted users" "definition of"
2632 .cindex "user" "trusted definition of"
2633 The trusted users are root, the Exim user, any user listed in the
2634 &%trusted_users%& configuration option, and any user whose current group or any
2635 supplementary group is one of those listed in the &%trusted_groups%&
2636 configuration option. Note that the Exim group is not automatically trusted.
2637
2638 .cindex '&"From"& line'
2639 .cindex "envelope from"
2640 .cindex "envelope sender"
2641 Trusted users are always permitted to use the &%-f%& option or a leading
2642 &"From&~"& line to specify the envelope sender of a message that is passed to
2643 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2644 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2645 users to set envelope senders.
2646
2647 .cindex "&'From:'& header line"
2648 .cindex "&'Sender:'& header line"
2649 .cindex "header lines" "From:"
2650 .cindex "header lines" "Sender:"
2651 For a trusted user, there is never any check on the contents of the &'From:'&
2652 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2653 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2654
2655 Trusted users may also specify a host name, host address, interface address,
2656 protocol name, ident value, and authentication data when submitting a message
2657 locally. Thus, they are able to insert messages into Exim's queue locally that
2658 have the characteristics of messages received from a remote host. Untrusted
2659 users may in some circumstances use &%-f%&, but can never set the other values
2660 that are available to trusted users.
2661 .next
2662 .cindex "user" "admin definition of"
2663 .cindex "admin user" "definition of"
2664 The admin users are root, the Exim user, and any user that is a member of the
2665 Exim group or of any group listed in the &%admin_groups%& configuration option.
2666 The current group does not have to be one of these groups.
2667
2668 Admin users are permitted to list the queue, and to carry out certain
2669 operations on messages, for example, to force delivery failures. It is also
2670 necessary to be an admin user in order to see the full information provided by
2671 the Exim monitor, and full debugging output.
2672
2673 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2674 Exim to attempt delivery of messages on its queue is restricted to admin users.
2675 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2676 option false (that is, specifying &%no_prod_requires_admin%&).
2677
2678 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2679 is restricted to admin users unless &%queue_list_requires_admin%& is set
2680 false.
2681 .endlist
2682
2683
2684 &*Warning*&: If you configure your system so that admin users are able to
2685 edit Exim's configuration file, you are giving those users an easy way of
2686 getting root. There is further discussion of this issue at the start of chapter
2687 &<<CHAPconf>>&.
2688
2689
2690
2691
2692 .section "Command line options" "SECID39"
2693 Exim's command line options are described in alphabetical order below. If none
2694 of the options that specifies a specific action (such as starting the daemon or
2695 a queue runner, or testing an address, or receiving a message in a specific
2696 format, or listing the queue) are present, and there is at least one argument
2697 on the command line, &%-bm%& (accept a local message on the standard input,
2698 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2699 outputs a brief message about itself and exits.
2700
2701 . ////////////////////////////////////////////////////////////////////////////
2702 . Insert a stylized XML comment here, to identify the start of the command line
2703 . options. This is for the benefit of the Perl script that automatically
2704 . creates a man page for the options.
2705 . ////////////////////////////////////////////////////////////////////////////
2706
2707 .literal xml
2708 <!-- === Start of command line options === -->
2709 .literal off
2710
2711
2712 .vlist
2713 .vitem &%--%&
2714 .oindex "--"
2715 .cindex "options" "command line; terminating"
2716 This is a pseudo-option whose only purpose is to terminate the options and
2717 therefore to cause subsequent command line items to be treated as arguments
2718 rather than options, even if they begin with hyphens.
2719
2720 .vitem &%--help%&
2721 .oindex "&%--help%&"
2722 This option causes Exim to output a few sentences stating what it is.
2723 The same output is generated if the Exim binary is called with no options and
2724 no arguments.
2725
2726 .vitem &%--version%&
2727 .oindex "&%--version%&"
2728 This option is an alias for &%-bV%& and causes version information to be
2729 displayed.
2730
2731 .vitem &%-Ac%& &&&
2732        &%-Am%&
2733 .oindex "&%-Ac%&"
2734 .oindex "&%-Am%&"
2735 These options are used by Sendmail for selecting configuration files and are
2736 ignored by Exim.
2737
2738 .vitem &%-B%&<&'type'&>
2739 .oindex "&%-B%&"
2740 .cindex "8-bit characters"
2741 .cindex "Sendmail compatibility" "8-bit characters"
2742 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2743 clean; it ignores this option.
2744
2745 .vitem &%-bd%&
2746 .oindex "&%-bd%&"
2747 .cindex "daemon"
2748 .cindex "SMTP" "listener"
2749 .cindex "queue runner"
2750 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2751 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2752 that the daemon should also initiate periodic queue runs.
2753
2754 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2755 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2756 disconnect from the controlling terminal. When running this way, it can be
2757 stopped by pressing ctrl-C.
2758
2759 By default, Exim listens for incoming connections to the standard SMTP port on
2760 all the host's running interfaces. However, it is possible to listen on other
2761 ports, on multiple ports, and only on specific interfaces. Chapter
2762 &<<CHAPinterfaces>>& contains a description of the options that control this.
2763
2764 When a listening daemon
2765 .cindex "daemon" "process id (pid)"
2766 .cindex "pid (process id)" "of daemon"
2767 is started without the use of &%-oX%& (that is, without overriding the normal
2768 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2769 in Exim's spool directory. This location can be overridden by setting
2770 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2771 running as root.
2772
2773 When &%-oX%& is used on the command line to start a listening daemon, the
2774 process id is not written to the normal pid file path. However, &%-oP%& can be
2775 used to specify a path on the command line if a pid file is required.
2776
2777 The SIGHUP signal
2778 .cindex "SIGHUP"
2779 .cindex restart "on HUP signal"
2780 .cindex signal "HUP, to restart"
2781 .cindex "daemon" "restarting"
2782 .cindex signal "to reload configuration"
2783 .cindex daemon "reload configuration"
2784 .cindex reload configuration
2785 can be used to cause the daemon to re-execute itself. This should be done
2786 whenever Exim's configuration file, or any file that is incorporated into it by
2787 means of the &%.include%& facility, is changed, and also whenever a new version
2788 of Exim is installed. It is not necessary to do this when other files that are
2789 referenced from the configuration (for example, alias files) are changed,
2790 because these are reread each time they are used.
2791
2792 .vitem &%-bdf%&
2793 .oindex "&%-bdf%&"
2794 This option has the same effect as &%-bd%& except that it never disconnects
2795 from the controlling terminal, even when no debugging is specified.
2796
2797 .vitem &%-be%&
2798 .oindex "&%-be%&"
2799 .cindex "testing" "string expansion"
2800 .cindex "expansion" "testing"
2801 Run Exim in expansion testing mode. Exim discards its root privilege, to
2802 prevent ordinary users from using this mode to read otherwise inaccessible
2803 files. If no arguments are given, Exim runs interactively, prompting for lines
2804 of data. Otherwise, it processes each argument in turn.
2805
2806 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2807 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2808 used without command line arguments. If successful, it uses the &[readline()]&
2809 function, which provides extensive line-editing facilities, for reading the
2810 test data. A line history is supported.
2811
2812 Long expansion expressions can be split over several lines by using backslash
2813 continuations. As in Exim's runtime configuration, white space at the start of
2814 continuation lines is ignored. Each argument or data line is passed through the
2815 string expansion mechanism, and the result is output. Variable values from the
2816 configuration file (for example, &$qualify_domain$&) are available, but no
2817 message-specific values (such as &$message_exim_id$&) are set, because no message
2818 is being processed (but see &%-bem%& and &%-Mset%&).
2819
2820 &*Note*&: If you use this mechanism to test lookups, and you change the data
2821 files or databases you are using, you must exit and restart Exim before trying
2822 the same lookup again. Otherwise, because each Exim process caches the results
2823 of lookups, you will just get the same result as before.
2824
2825 Macro processing is done on lines before string-expansion: new macros can be
2826 defined and macros will be expanded.
2827 Because macros in the config file are often used for secrets, those are only
2828 available to admin users.
2829
2830 .vitem &%-bem%&&~<&'filename'&>
2831 .oindex "&%-bem%&"
2832 .cindex "testing" "string expansion"
2833 .cindex "expansion" "testing"
2834 This option operates like &%-be%& except that it must be followed by the name
2835 of a file. For example:
2836 .code
2837 exim -bem /tmp/testmessage
2838 .endd
2839 The file is read as a message (as if receiving a locally-submitted non-SMTP
2840 message) before any of the test expansions are done. Thus, message-specific
2841 variables such as &$message_size$& and &$header_from:$& are available. However,
2842 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2843 recipients are read from the headers in the normal way, and are shown in the
2844 &$recipients$& variable. Note that recipients cannot be given on the command
2845 line, because further arguments are taken as strings to expand (just like
2846 &%-be%&).
2847
2848 .vitem &%-bF%&&~<&'filename'&>
2849 .oindex "&%-bF%&"
2850 .cindex "system filter" "testing"
2851 .cindex "testing" "system filter"
2852 This option is the same as &%-bf%& except that it assumes that the filter being
2853 tested is a system filter. The additional commands that are available only in
2854 system filters are recognized.
2855
2856 .vitem &%-bf%&&~<&'filename'&>
2857 .oindex "&%-bf%&"
2858 .cindex "filter" "testing"
2859 .cindex "testing" "filter file"
2860 .cindex "forward file" "testing"
2861 .cindex "testing" "forward file"
2862 .cindex "Sieve filter" "testing"
2863 This option runs Exim in user filter testing mode; the file is the filter file
2864 to be tested, and a test message must be supplied on the standard input. If
2865 there are no message-dependent tests in the filter, an empty file can be
2866 supplied.
2867
2868 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2869 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2870 filter and a user filter in the same run. For example:
2871 .code
2872 exim -bF /system/filter -bf /user/filter </test/message
2873 .endd
2874 This is helpful when the system filter adds header lines or sets filter
2875 variables that are used by the user filter.
2876
2877 If the test filter file does not begin with one of the special lines
2878 .code
2879 # Exim filter
2880 # Sieve filter
2881 .endd
2882 it is taken to be a normal &_.forward_& file, and is tested for validity under
2883 that interpretation. See sections &<<SECTitenonfilred>>& to
2884 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2885 redirection lists.
2886
2887 The result of an Exim command that uses &%-bf%&, provided no errors are
2888 detected, is a list of the actions that Exim would try to take if presented
2889 with the message for real. More details of filter testing are given in the
2890 separate document entitled &'Exim's interfaces to mail filtering'&.
2891
2892 When testing a filter file,
2893 .cindex "&""From""& line"
2894 .cindex "envelope from"
2895 .cindex "envelope sender"
2896 .oindex "&%-f%&" "for filter testing"
2897 the envelope sender can be set by the &%-f%& option,
2898 or by a &"From&~"& line at the start of the test message. Various parameters
2899 that would normally be taken from the envelope recipient address of the message
2900 can be set by means of additional command line options (see the next four
2901 options).
2902
2903 .vitem &%-bfd%&&~<&'domain'&>
2904 .oindex "&%-bfd%&"
2905 .vindex "&$qualify_domain$&"
2906 This sets the domain of the recipient address when a filter file is being
2907 tested by means of the &%-bf%& option. The default is the value of
2908 &$qualify_domain$&.
2909
2910 .vitem &%-bfl%&&~<&'local&~part'&>
2911 .oindex "&%-bfl%&"
2912 This sets the local part of the recipient address when a filter file is being
2913 tested by means of the &%-bf%& option. The default is the username of the
2914 process that calls Exim. A local part should be specified with any prefix or
2915 suffix stripped, because that is how it appears to the filter when a message is
2916 actually being delivered.
2917
2918 .vitem &%-bfp%&&~<&'prefix'&>
2919 .oindex "&%-bfp%&"
2920 .cindex affix "filter testing"
2921 This sets the prefix of the local part of the recipient address when a filter
2922 file is being tested by means of the &%-bf%& option. The default is an empty
2923 prefix.
2924
2925 .vitem &%-bfs%&&~<&'suffix'&>
2926 .oindex "&%-bfs%&"
2927 .cindex affix "filter testing"
2928 This sets the suffix of the local part of the recipient address when a filter
2929 file is being tested by means of the &%-bf%& option. The default is an empty
2930 suffix.
2931
2932 .vitem &%-bh%&&~<&'IP&~address'&>
2933 .oindex "&%-bh%&"
2934 .cindex "testing" "incoming SMTP"
2935 .cindex "SMTP" "testing incoming"
2936 .cindex "testing" "relay control"
2937 .cindex "relaying" "testing configuration"
2938 .cindex "policy control" "testing"
2939 .cindex "debugging" "&%-bh%& option"
2940 This option runs a fake SMTP session as if from the given IP address, using the
2941 standard input and output. The IP address may include a port number at the end,
2942 after a full stop. For example:
2943 .code
2944 exim -bh 10.9.8.7.1234
2945 exim -bh fe80::a00:20ff:fe86:a061.5678
2946 .endd
2947 When an IPv6 address is given, it is converted into canonical form. In the case
2948 of the second example above, the value of &$sender_host_address$& after
2949 conversion to the canonical form is
2950 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2951
2952 Comments as to what is going on are written to the standard error file. These
2953 include lines beginning with &"LOG"& for anything that would have been logged.
2954 This facility is provided for testing configuration options for incoming
2955 messages, to make sure they implement the required policy. For example, you can
2956 test your relay controls using &%-bh%&.
2957
2958 &*Warning 1*&:
2959 .cindex "RFC 1413"
2960 You can test features of the configuration that rely on ident (RFC 1413)
2961 information by using the &%-oMt%& option. However, Exim cannot actually perform
2962 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2963 connection.
2964
2965 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2966 are also skipped when testing using &%-bh%&. If you want these callouts to
2967 occur, use &%-bhc%& instead.
2968
2969 Messages supplied during the testing session are discarded, and nothing is
2970 written to any of the real log files. There may be pauses when DNS (and other)
2971 lookups are taking place, and of course these may time out. The &%-oMi%& option
2972 can be used to specify a specific IP interface and port if this is important,
2973 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2974 session were authenticated.
2975
2976 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2977 output just states whether a given recipient address from a given host is
2978 acceptable or not. See section &<<SECTcheckaccess>>&.
2979
2980 Features such as authentication and encryption, where the client input is not
2981 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2982 specialized SMTP test program such as
2983 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2984
2985 .vitem &%-bhc%&&~<&'IP&~address'&>
2986 .oindex "&%-bhc%&"
2987 This option operates in the same way as &%-bh%&, except that address
2988 verification callouts are performed if required. This includes consulting and
2989 updating the callout cache database.
2990
2991 .vitem &%-bi%&
2992 .oindex "&%-bi%&"
2993 .cindex "alias file" "building"
2994 .cindex "building alias file"
2995 .cindex "Sendmail compatibility" "&%-bi%& option"
2996 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2997 Exim does not have the concept of a single alias file, and so it cannot mimic
2998 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2999 tend to appear in various scripts such as NIS make files, so the option must be
3000 recognized.
3001
3002 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3003 configuration option is run, under the uid and gid of the caller of Exim. If
3004 the &%-oA%& option is used, its value is passed to the command as an argument.
3005 The command set by &%bi_command%& may not contain arguments. The command can
3006 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3007 if this is required. If the &%bi_command%& option is not set, calling Exim with
3008 &%-bi%& is a no-op.
3009
3010 . // Keep :help first, then the rest in alphabetical order
3011 .vitem &%-bI:help%&
3012 .oindex "&%-bI:help%&"
3013 .cindex "querying exim information"
3014 We shall provide various options starting &`-bI:`& for querying Exim for
3015 information.  The output of many of these will be intended for machine
3016 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3017 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3018 options shall cause Exim to exit after producing the requested output.
3019
3020 .vitem &%-bI:dscp%&
3021 .oindex "&%-bI:dscp%&"
3022 .cindex "DSCP" "values"
3023 This option causes Exim to emit an alphabetically sorted list of all
3024 recognised DSCP names.
3025
3026 .vitem &%-bI:sieve%&
3027 .oindex "&%-bI:sieve%&"
3028 .cindex "Sieve filter" "capabilities"
3029 This option causes Exim to emit an alphabetically sorted list of all supported
3030 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3031 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3032 &`SIEVE`& capability response line.  As the precise list may depend upon
3033 compile-time build options, which this option will adapt to, this is the only
3034 way to guarantee a correct response.
3035
3036 .vitem &%-bm%&
3037 .oindex "&%-bm%&"
3038 .cindex "local message reception"
3039 This option runs an Exim receiving process that accepts an incoming,
3040 locally-generated message on the standard input. The recipients are given as the
3041 command arguments (except when &%-t%& is also present &-- see below). Each
3042 argument can be a comma-separated list of RFC 2822 addresses. This is the
3043 default option for selecting the overall action of an Exim call; it is assumed
3044 if no other conflicting option is present.
3045
3046 If any addresses in the message are unqualified (have no domain), they are
3047 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3048 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3049 suppressing this for special cases.
3050
3051 Policy checks on the contents of local messages can be enforced by means of
3052 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3053
3054 .cindex "return code" "for &%-bm%&"
3055 The return code is zero if the message is successfully accepted. Otherwise, the
3056 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3057
3058 The format
3059 .cindex "message" "format"
3060 .cindex "format" "message"
3061 .cindex "&""From""& line"
3062 .cindex "UUCP" "&""From""& line"
3063 .cindex "Sendmail compatibility" "&""From""& line"
3064 of the message must be as defined in RFC 2822, except that, for
3065 compatibility with Sendmail and Smail, a line in one of the forms
3066 .code
3067 From sender Fri Jan  5 12:55 GMT 1997
3068 From sender Fri, 5 Jan 97 12:55:01
3069 .endd
3070 (with the weekday optional, and possibly with additional text after the date)
3071 is permitted to appear at the start of the message. There appears to be no
3072 authoritative specification of the format of this line. Exim recognizes it by
3073 matching against the regular expression defined by the &%uucp_from_pattern%&
3074 option, which can be changed if necessary.
3075
3076 .oindex "&%-f%&" "overriding &""From""& line"
3077 The specified sender is treated as if it were given as the argument to the
3078 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3079 preference to the address taken from the message. The caller of Exim must be a
3080 trusted user for the sender of a message to be set in this way.
3081
3082 .vitem &%-bmalware%&&~<&'filename'&>
3083 .oindex "&%-bmalware%&"
3084 .cindex "testing", "malware"
3085 .cindex "malware scan test"
3086 This debugging option causes Exim to scan the given file or directory
3087 (depending on the used scanner interface),
3088 using the malware scanning framework.  The option of &%av_scanner%& influences
3089 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3090 the expansion should have defaults which apply to this invocation.  ACLs are
3091 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3092 will never be populated and &%-bmalware%& will fail.
3093
3094 Exim will have changed working directory before resolving the filename, so
3095 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3096 user when it tries to open the file, rather than as the invoking user.
3097 This option requires admin privileges.
3098
3099 The &%-bmalware%& option will not be extended to be more generally useful,
3100 there are better tools for file-scanning.  This option exists to help
3101 administrators verify their Exim and AV scanner configuration.
3102
3103 .vitem &%-bnq%&
3104 .oindex "&%-bnq%&"
3105 .cindex "address qualification, suppressing"
3106 By default, Exim automatically qualifies unqualified addresses (those
3107 without domains) that appear in messages that are submitted locally (that
3108 is, not over TCP/IP). This qualification applies both to addresses in
3109 envelopes, and addresses in header lines. Sender addresses are qualified using
3110 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3111 defaults to the value of &%qualify_domain%&).
3112
3113 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3114 being used to re-submit messages that originally came from remote hosts after
3115 content scanning, you probably do not want to qualify unqualified addresses in
3116 header lines. (Such lines will be present only if you have not enabled a header
3117 syntax check in the appropriate ACL.)
3118
3119 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3120 messages that originate on the local host. When this is used, unqualified
3121 addresses in the envelope provoke errors (causing message rejection) and
3122 unqualified addresses in header lines are left alone.
3123
3124
3125 .vitem &%-bP%&
3126 .oindex "&%-bP%&"
3127 .cindex "configuration options" "extracting"
3128 .cindex "options" "configuration &-- extracting"
3129 If this option is given with no arguments, it causes the values of all Exim's
3130 main configuration options to be written to the standard output. The values
3131 of one or more specific options can be requested by giving their names as
3132 arguments, for example:
3133 .code
3134 exim -bP qualify_domain hold_domains
3135 .endd
3136 .cindex "hiding configuration option values"
3137 .cindex "configuration options" "hiding value of"
3138 .cindex "options" "hiding value of"
3139 However, any option setting that is preceded by the word &"hide"& in the
3140 configuration file is not shown in full, except to an admin user. For other
3141 users, the output is as in this example:
3142 .code
3143 mysql_servers = <value not displayable>
3144 .endd
3145 If &%config%& is given as an argument, the config is
3146 output, as it was parsed, any include file resolved, any comment removed.
3147
3148 If &%config_file%& is given as an argument, the name of the runtime
3149 configuration file is output. (&%configure_file%& works too, for
3150 backward compatibility.)
3151 If a list of configuration files was supplied, the value that is output here
3152 is the name of the file that was actually used.
3153
3154 .cindex "options" "hiding name of"
3155 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3156 name will not be output.
3157
3158 .cindex "daemon" "process id (pid)"
3159 .cindex "pid (process id)" "of daemon"
3160 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3161 directories where log files and daemon pid files are written are output,
3162 respectively. If these values are unset, log files are written in a
3163 sub-directory of the spool directory called &%log%&, and the pid file is
3164 written directly into the spool directory.
3165
3166 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3167 .code
3168 exim -bP +local_domains
3169 .endd
3170 it searches for a matching named list of any type (domain, host, address, or
3171 local part) and outputs what it finds.
3172
3173 .cindex "options" "router &-- extracting"
3174 .cindex "options" "transport &-- extracting"
3175 .cindex "options" "authenticator &-- extracting"
3176 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3177 followed by the name of an appropriate driver instance, the option settings for
3178 that driver are output. For example:
3179 .code
3180 exim -bP transport local_delivery
3181 .endd
3182 The generic driver options are output first, followed by the driver's private
3183 options. A list of the names of drivers of a particular type can be obtained by
3184 using one of the words &%router_list%&, &%transport_list%&, or
3185 &%authenticator_list%&, and a complete list of all drivers with their option
3186 settings can be obtained by using &%routers%&, &%transports%&, or
3187 &%authenticators%&.
3188
3189 .cindex "environment"
3190 If &%environment%& is given as an argument, the set of environment
3191 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3192 variables.
3193
3194 .cindex "options" "macro &-- extracting"
3195 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3196 are available, similarly to the drivers.  Because macros are sometimes used
3197 for storing passwords, this option is restricted.
3198 The output format is one item per line.
3199 For the "-bP macro <name>" form, if no such macro is found
3200 the exit status will be nonzero.
3201
3202 .vitem &%-bp%&
3203 .oindex "&%-bp%&"
3204 .cindex "queue" "listing messages in"
3205 .cindex "listing" "messages in the queue"
3206 This option requests a listing of the contents of the mail queue on the
3207 standard output. If the &%-bp%& option is followed by a list of message ids,
3208 just those messages are listed. By default, this option can be used only by an
3209 admin user. However, the &%queue_list_requires_admin%& option can be set false
3210 to allow any user to see the queue.
3211
3212 Each message in the queue is displayed as in the following example:
3213 .code
3214 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3215           red.king@looking-glass.fict.example
3216           <other addresses>
3217 .endd
3218 .cindex "message" "size in queue listing"
3219 .cindex "size" "of message"
3220 The first line contains the length of time the message has been in the queue
3221 (in this case 25 minutes), the size of the message (2.9K), the unique local
3222 identifier for the message, and the message sender, as contained in the
3223 envelope. For bounce messages, the sender address is empty, and appears as
3224 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3225 the default sender address, the user's login name is shown in parentheses
3226 before the sender address.
3227
3228 .cindex "frozen messages" "in queue listing"
3229 If the message is frozen (attempts to deliver it are suspended) then the text
3230 &"*** frozen ***"& is displayed at the end of this line.
3231
3232 The recipients of the message (taken from the envelope, not the headers) are
3233 displayed on subsequent lines. Those addresses to which the message has already
3234 been delivered are marked with the letter D. If an original address gets
3235 expanded into several addresses via an alias or forward file, the original is
3236 displayed with a D only when deliveries for all of its child addresses are
3237 complete.
3238
3239
3240 .vitem &%-bpa%&
3241 .oindex "&%-bpa%&"
3242 This option operates like &%-bp%&, but in addition it shows delivered addresses
3243 that were generated from the original top level address(es) in each message by
3244 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3245 of just &"D"&.
3246
3247
3248 .vitem &%-bpc%&
3249 .oindex "&%-bpc%&"
3250 .cindex "queue" "count of messages on"
3251 This option counts the number of messages in the queue, and writes the total
3252 to the standard output. It is restricted to admin users, unless
3253 &%queue_list_requires_admin%& is set false.
3254
3255
3256 .vitem &%-bpr%&
3257 .oindex "&%-bpr%&"
3258 This option operates like &%-bp%&, but the output is not sorted into
3259 chronological order of message arrival. This can speed it up when there are
3260 lots of messages in the queue, and is particularly useful if the output is
3261 going to be post-processed in a way that doesn't need the sorting.
3262
3263 .vitem &%-bpra%&
3264 .oindex "&%-bpra%&"
3265 This option is a combination of &%-bpr%& and &%-bpa%&.
3266
3267 .vitem &%-bpru%&
3268 .oindex "&%-bpru%&"
3269 This option is a combination of &%-bpr%& and &%-bpu%&.
3270
3271
3272 .vitem &%-bpu%&
3273 .oindex "&%-bpu%&"
3274 This option operates like &%-bp%& but shows only undelivered top-level
3275 addresses for each message displayed. Addresses generated by aliasing or
3276 forwarding are not shown, unless the message was deferred after processing by a
3277 router with the &%one_time%& option set.
3278
3279
3280 .vitem &%-brt%&
3281 .oindex "&%-brt%&"
3282 .cindex "testing" "retry configuration"
3283 .cindex "retry" "configuration testing"
3284 This option is for testing retry rules, and it must be followed by up to three
3285 arguments. It causes Exim to look for a retry rule that matches the values
3286 and to write it to the standard output. For example:
3287 .code
3288 exim -brt bach.comp.mus.example
3289 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3290 .endd
3291 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3292 argument, which is required, can be a complete address in the form
3293 &'local_part@domain'&, or it can be just a domain name. If the second argument
3294 contains a dot, it is interpreted as an optional second domain name; if no
3295 retry rule is found for the first argument, the second is tried. This ties in
3296 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3297 rule is found that matches the host, one that matches the mail domain is
3298 sought. Finally, an argument that is the name of a specific delivery error, as
3299 used in setting up retry rules, can be given. For example:
3300 .code
3301 exim -brt haydn.comp.mus.example quota_3d
3302 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3303 .endd
3304
3305 .vitem &%-brw%&
3306 .oindex "&%-brw%&"
3307 .cindex "testing" "rewriting"
3308 .cindex "rewriting" "testing"
3309 This option is for testing address rewriting rules, and it must be followed by
3310 a single argument, consisting of either a local part without a domain, or a
3311 complete address with a fully qualified domain. Exim outputs how this address
3312 would be rewritten for each possible place it might appear. See chapter
3313 &<<CHAPrewrite>>& for further details.
3314
3315 .vitem &%-bS%&
3316 .oindex "&%-bS%&"
3317 .cindex "SMTP" "batched incoming"
3318 .cindex "batched SMTP input"
3319 This option is used for batched SMTP input, which is an alternative interface
3320 for non-interactive local message submission. A number of messages can be
3321 submitted in a single run. However, despite its name, this is not really SMTP
3322 input. Exim reads each message's envelope from SMTP commands on the standard
3323 input, but generates no responses. If the caller is trusted, or
3324 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3325 believed; otherwise the sender is always the caller of Exim.
3326
3327 The message itself is read from the standard input, in SMTP format (leading
3328 dots doubled), terminated by a line containing just a single dot. An error is
3329 provoked if the terminating dot is missing. A further message may then follow.
3330
3331 As for other local message submissions, the contents of incoming batch SMTP
3332 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3333 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3334 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3335
3336 Some other SMTP commands are recognized in the input. HELO and EHLO act
3337 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3338 QUIT quits, ignoring the rest of the standard input.
3339
3340 .cindex "return code" "for &%-bS%&"
3341 If any error is encountered, reports are written to the standard output and
3342 error streams, and Exim gives up immediately. The return code is 0 if no error
3343 was detected; it is 1 if one or more messages were accepted before the error
3344 was detected; otherwise it is 2.
3345
3346 More details of input using batched SMTP are given in section
3347 &<<SECTincomingbatchedSMTP>>&.
3348
3349 .vitem &%-bs%&
3350 .oindex "&%-bs%&"
3351 .cindex "SMTP" "local input"
3352 .cindex "local SMTP input"
3353 This option causes Exim to accept one or more messages by reading SMTP commands
3354 on the standard input, and producing SMTP replies on the standard output. SMTP
3355 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3356 Some user agents use this interface as a way of passing locally-generated
3357 messages to the MTA.
3358
3359 In
3360 .cindex "sender" "source of"
3361 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3362 set, the senders of messages are taken from the SMTP MAIL commands.
3363 Otherwise the content of these commands is ignored and the sender is set up as
3364 the calling user. Unqualified addresses are automatically qualified using
3365 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3366 &%-bnq%& option is used.
3367
3368 .cindex "inetd"
3369 The
3370 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3371 using a listening daemon. Exim can distinguish the two cases by checking
3372 whether the standard input is a TCP/IP socket. When Exim is called from
3373 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3374 above concerning senders and qualification do not apply. In this situation,
3375 Exim behaves in exactly the same way as it does when receiving a message via
3376 the listening daemon.
3377
3378 .vitem &%-bt%&
3379 .oindex "&%-bt%&"
3380 .cindex "testing" "addresses"
3381 .cindex "address" "testing"
3382 This option runs Exim in address testing mode, in which each argument is taken
3383 as a recipient address to be tested for deliverability. The results are
3384 written to the standard output. If a test fails, and the caller is not an admin
3385 user, no details of the failure are output, because these might contain
3386 sensitive information such as usernames and passwords for database lookups.
3387
3388 If no arguments are given, Exim runs in an interactive manner, prompting with a
3389 right angle bracket for addresses to be tested.
3390
3391 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3392 &[readline()]& function, because it is running as &'root'& and there are
3393 security issues.
3394
3395 Each address is handled as if it were the recipient address of a message
3396 (compare the &%-bv%& option). It is passed to the routers and the result is
3397 written to the standard output. However, any router that has
3398 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3399 genuine routing tests if your first router passes everything to a scanner
3400 program.
3401
3402 .cindex "return code" "for &%-bt%&"
3403 The return code is 2 if any address failed outright; it is 1 if no address
3404 failed outright but at least one could not be resolved for some reason. Return
3405 code 0 is given only when all addresses succeed.
3406
3407 .cindex "duplicate addresses"
3408 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3409 addresses after routing is complete, so that only one delivery takes place.
3410 This does not happen when testing with &%-bt%&; the full results of routing are
3411 always shown.
3412
3413 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3414 routers in the configuration makes any tests on the sender address of a
3415 message,
3416 .oindex "&%-f%&" "for address testing"
3417 you can use the &%-f%& option to set an appropriate sender when running
3418 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3419 default qualifying domain. However, if you have set up (for example) routers
3420 whose behaviour depends on the contents of an incoming message, you cannot test
3421 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3422 doing such tests.
3423
3424 .vitem &%-bV%&
3425 .oindex "&%-bV%&"
3426 .cindex "version number of Exim"
3427 This option causes Exim to write the current version number, compilation
3428 number, and compilation date of the &'exim'& binary to the standard output.
3429 It also lists the DBM library that is being used, the optional modules (such as
3430 specific lookup types), the drivers that are included in the binary, and the
3431 name of the runtime configuration file that is in use.
3432
3433 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3434 configuration file. However, this is a static check only. It cannot check
3435 values that are to be expanded. For example, although a misspelt ACL verb is
3436 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3437 alone to discover (for example) all the typos in the configuration; some
3438 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3439 dynamic testing facilities.
3440
3441 .vitem &%-bv%&
3442 .oindex "&%-bv%&"
3443 .cindex "verifying address" "using &%-bv%&"
3444 .cindex "address" "verification"
3445 This option runs Exim in address verification mode, in which each argument is
3446 taken as a recipient address to be verified by the routers. (This does
3447 not involve any verification callouts). During normal operation, verification
3448 happens mostly as a consequence processing a &%verify%& condition in an ACL
3449 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3450 including callouts, see the &%-bh%& and &%-bhc%& options.
3451
3452 If verification fails, and the caller is not an admin user, no details of the
3453 failure are output, because these might contain sensitive information such as
3454 usernames and passwords for database lookups.
3455
3456 If no arguments are given, Exim runs in an interactive manner, prompting with a
3457 right angle bracket for addresses to be verified.
3458
3459 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3460 &[readline()]& function, because it is running as &'exim'& and there are
3461 security issues.
3462
3463 Verification differs from address testing (the &%-bt%& option) in that routers
3464 that have &%no_verify%& set are skipped, and if the address is accepted by a
3465 router that has &%fail_verify%& set, verification fails. The address is
3466 verified as a recipient if &%-bv%& is used; to test verification for a sender
3467 address, &%-bvs%& should be used.
3468
3469 If the &%-v%& option is not set, the output consists of a single line for each
3470 address, stating whether it was verified or not, and giving a reason in the
3471 latter case. Without &%-v%&, generating more than one address by redirection
3472 causes verification to end successfully, without considering the generated
3473 addresses. However, if just one address is generated, processing continues,
3474 and the generated address must verify successfully for the overall verification
3475 to succeed.
3476
3477 When &%-v%& is set, more details are given of how the address has been handled,
3478 and in the case of address redirection, all the generated addresses are also
3479 considered. Verification may succeed for some and fail for others.
3480
3481 The
3482 .cindex "return code" "for &%-bv%&"
3483 return code is 2 if any address failed outright; it is 1 if no address
3484 failed outright but at least one could not be resolved for some reason. Return
3485 code 0 is given only when all addresses succeed.
3486
3487 If any of the routers in the configuration makes any tests on the sender
3488 address of a message, you should use the &%-f%& option to set an appropriate
3489 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3490 calling user at the default qualifying domain.
3491
3492 .vitem &%-bvs%&
3493 .oindex "&%-bvs%&"
3494 This option acts like &%-bv%&, but verifies the address as a sender rather
3495 than a recipient address. This affects any rewriting and qualification that
3496 might happen.
3497
3498 .vitem &%-bw%&
3499 .oindex "&%-bw%&"
3500 .cindex "daemon"
3501 .cindex "inetd"
3502 .cindex "inetd" "wait mode"
3503 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3504 similarly to the &%-bd%& option.  All port specifications on the command-line
3505 and in the configuration file are ignored.  Queue-running may not be specified.
3506
3507 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3508 listening for connections.  This permits the system to start up and have
3509 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3510 each port only when the first connection is received.
3511
3512 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3513 which the daemon will exit, which should cause inetd to listen once more.
3514
3515 .vitem &%-C%&&~<&'filelist'&>
3516 .oindex "&%-C%&"
3517 .cindex "configuration file" "alternate"
3518 .cindex "CONFIGURE_FILE"
3519 .cindex "alternate configuration file"
3520 This option causes Exim to find the runtime configuration file from the given
3521 list instead of from the list specified by the CONFIGURE_FILE
3522 compile-time setting. Usually, the list will consist of just a single filename,
3523 but it can be a colon-separated list of names. In this case, the first
3524 file that exists is used. Failure to open an existing file stops Exim from
3525 proceeding any further along the list, and an error is generated.
3526
3527 When this option is used by a caller other than root, and the list is different
3528 from the compiled-in list, Exim gives up its root privilege immediately, and
3529 runs with the real and effective uid and gid set to those of the caller.
3530 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3531 file contains a list of full pathnames, one per line, for configuration files
3532 which are trusted. Root privilege is retained for any configuration file so
3533 listed, as long as the caller is the Exim user (or the user specified in the
3534 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3535 not writeable by inappropriate users or groups.
3536
3537 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3538 configuration using &%-C%& right through message reception and delivery,
3539 even if the caller is root. The reception works, but by that time, Exim is
3540 running as the Exim user, so when it re-executes to regain privilege for the
3541 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3542 test reception and delivery using two separate commands (one to put a message
3543 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3544
3545 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3546 prefix string with which any file named in a &%-C%& command line option
3547 must start. In addition, the filename must not contain the sequence &`/../`&.
3548 However, if the value of the &%-C%& option is identical to the value of
3549 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3550 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3551 unset, any filename can be used with &%-C%&.
3552
3553 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3554 to a directory to which only root has access. This prevents someone who has
3555 broken into the Exim account from running a privileged Exim with an arbitrary
3556 configuration file.
3557
3558 The &%-C%& facility is useful for ensuring that configuration files are
3559 syntactically correct, but cannot be used for test deliveries, unless the
3560 caller is privileged, or unless it is an exotic configuration that does not
3561 require privilege. No check is made on the owner or group of the files
3562 specified by this option.
3563
3564
3565 .vitem &%-D%&<&'macro'&>=<&'value'&>
3566 .oindex "&%-D%&"
3567 .cindex "macro" "setting on command line"
3568 This option can be used to override macro definitions in the configuration file
3569 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3570 unprivileged caller, it causes Exim to give up its root privilege.
3571 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3572 completely disabled, and its use causes an immediate error exit.
3573
3574 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3575 colon-separated list of macros which are considered safe and, if &%-D%& only
3576 supplies macros from this list, and the values are acceptable, then Exim will
3577 not give up root privilege if the caller is root, the Exim run-time user, or
3578 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3579 to be removed in the future.  Acceptable values for the macros satisfy the
3580 regexp: &`^[A-Za-z0-9_/.-]*$`&
3581
3582 The entire option (including equals sign if present) must all be within one
3583 command line item. &%-D%& can be used to set the value of a macro to the empty
3584 string, in which case the equals sign is optional. These two commands are
3585 synonymous:
3586 .code
3587 exim -DABC  ...
3588 exim -DABC= ...
3589 .endd
3590 To include spaces in a macro definition item, quotes must be used. If you use
3591 quotes, spaces are permitted around the macro name and the equals sign. For
3592 example:
3593 .code
3594 exim '-D ABC = something' ...
3595 .endd
3596 &%-D%& may be repeated up to 10 times on a command line.
3597 Only macro names up to 22 letters long can be set.
3598
3599
3600 .vitem &%-d%&<&'debug&~options'&>
3601 .oindex "&%-d%&"
3602 .cindex "debugging" "list of selectors"
3603 .cindex "debugging" "&%-d%& option"
3604 This option causes debugging information to be written to the standard
3605 error stream. It is restricted to admin users because debugging output may show
3606 database queries that contain password information. Also, the details of users'
3607 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3608 writes an error message to the standard error stream and exits with a non-zero
3609 return code.
3610
3611 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3612 standard debugging data is output. This can be reduced, or increased to include
3613 some more rarely needed information, by directly following &%-d%& with a string
3614 made up of names preceded by plus or minus characters. These add or remove sets
3615 of debugging data, respectively. For example, &%-d+filter%& adds filter
3616 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3617 no spaces are allowed in the debug setting. The available debugging categories
3618 are:
3619 .display
3620 &`acl            `& ACL interpretation
3621 &`auth           `& authenticators
3622 &`deliver        `& general delivery logic
3623 &`dns            `& DNS lookups (see also resolver)
3624 &`dnsbl          `& DNS black list (aka RBL) code
3625 &`exec           `& arguments for &[execv()]& calls
3626 &`expand         `& detailed debugging for string expansions
3627 &`filter         `& filter handling
3628 &`hints_lookup   `& hints data lookups
3629 &`host_lookup    `& all types of name-to-IP address handling
3630 &`ident          `& ident lookup
3631 &`interface      `& lists of local interfaces
3632 &`lists          `& matching things in lists
3633 &`load           `& system load checks
3634 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3635                     &<<CHAPlocalscan>>&)
3636 &`lookup         `& general lookup code and all lookups
3637 &`memory         `& memory handling
3638 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3639 &`pid            `& modifier: add pid to debug output lines
3640 &`process_info   `& setting info for the process log
3641 &`queue_run      `& queue runs
3642 &`receive        `& general message reception logic
3643 &`resolver       `& turn on the DNS resolver's debugging output
3644 &`retry          `& retry handling
3645 &`rewrite        `& address rewriting
3646 &`route          `& address routing
3647 &`timestamp      `& modifier: add timestamp to debug output lines
3648 &`tls            `& TLS logic
3649 &`transport      `& transports
3650 &`uid            `& changes of uid/gid and looking up uid/gid
3651 &`verify         `& address verification logic
3652 &`all            `& almost all of the above (see below), and also &%-v%&
3653 .endd
3654 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3655 for &`-all`&. The reason for this is that &`+all`& is something that people
3656 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3657 is included, an awful lot of output that is very rarely of interest is
3658 generated, so it now has to be explicitly requested. However, &`-all`& does
3659 turn everything off.
3660
3661 .cindex "resolver, debugging output"
3662 .cindex "DNS resolver, debugging output"
3663 The &`resolver`& option produces output only if the DNS resolver was compiled
3664 with DEBUG enabled. This is not the case in some operating systems. Also,
3665 unfortunately, debugging output from the DNS resolver is written to stdout
3666 rather than stderr.
3667
3668 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3669 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3670 However, the &`pid`& selector is forced when debugging is turned on for a
3671 daemon, which then passes it on to any re-executed Exims. Exim also
3672 automatically adds the pid to debug lines when several remote deliveries are
3673 run in parallel.
3674
3675 The &`timestamp`& selector causes the current time to be inserted at the start
3676 of all debug output lines. This can be useful when trying to track down delays
3677 in processing.
3678
3679 .cindex debugging "UTF-8 in"
3680 .cindex UTF-8 "in debug output"
3681 The &`noutf8`& selector disables the use of
3682 UTF-8 line-drawing characters to group related information.
3683 When disabled. ascii-art is used instead.
3684 Using the &`+all`& option does not set this modifier,
3685
3686 If the &%debug_print%& option is set in any driver, it produces output whenever
3687 any debugging is selected, or if &%-v%& is used.
3688
3689 .vitem &%-dd%&<&'debug&~options'&>
3690 .oindex "&%-dd%&"
3691 This option behaves exactly like &%-d%& except when used on a command that
3692 starts a daemon process. In that case, debugging is turned off for the
3693 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3694 behaviour of the daemon without creating as much output as full debugging does.
3695
3696 .vitem &%-dropcr%&
3697 .oindex "&%-dropcr%&"
3698 This is an obsolete option that is now a no-op. It used to affect the way Exim
3699 handled CR and LF characters in incoming messages. What happens now is
3700 described in section &<<SECTlineendings>>&.
3701
3702 .vitem &%-E%&
3703 .oindex "&%-E%&"
3704 .cindex "bounce message" "generating"
3705 This option specifies that an incoming message is a locally-generated delivery
3706 failure report. It is used internally by Exim when handling delivery failures
3707 and is not intended for external use. Its only effect is to stop Exim
3708 generating certain messages to the postmaster, as otherwise message cascades
3709 could occur in some situations. As part of the same option, a message id may
3710 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3711 new message contains the id, following &"R="&, as a cross-reference.
3712
3713 .vitem &%-e%&&'x'&
3714 .oindex "&%-e%&&'x'&"
3715 There are a number of Sendmail options starting with &%-oe%& which seem to be
3716 called by various programs without the leading &%o%& in the option. For
3717 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3718 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3719
3720 .vitem &%-F%&&~<&'string'&>
3721 .oindex "&%-F%&"
3722 .cindex "sender" "name"
3723 .cindex "name" "of sender"
3724 This option sets the sender's full name for use when a locally-generated
3725 message is being accepted. In the absence of this option, the user's &'gecos'&
3726 entry from the password data is used. As users are generally permitted to alter
3727 their &'gecos'& entries, no security considerations are involved. White space
3728 between &%-F%& and the <&'string'&> is optional.
3729
3730 .vitem &%-f%&&~<&'address'&>
3731 .oindex "&%-f%&"
3732 .cindex "sender" "address"
3733 .cindex "address" "sender"
3734 .cindex "trusted users"
3735 .cindex "envelope from"
3736 .cindex "envelope sender"
3737 .cindex "user" "trusted"
3738 This option sets the address of the envelope sender of a locally-generated
3739 message (also known as the return path). The option can normally be used only
3740 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3741 users to use it.
3742
3743 Processes running as root or the Exim user are always trusted. Other
3744 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3745 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3746 of a local message is set to the caller's login name at the default qualify
3747 domain.
3748
3749 There is one exception to the restriction on the use of &%-f%&: an empty sender
3750 can be specified by any user, trusted or not, to create a message that can
3751 never provoke a bounce. An empty sender can be specified either as an empty
3752 string, or as a pair of angle brackets with nothing between them, as in these
3753 examples of shell commands:
3754 .code
3755 exim -f '<>' user@domain
3756 exim -f "" user@domain
3757 .endd
3758 In addition, the use of &%-f%& is not restricted when testing a filter file
3759 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3760 &%-bv%& options.
3761
3762 Allowing untrusted users to change the sender address does not of itself make
3763 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3764 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3765 though this can be overridden by setting &%no_local_from_check%&.
3766
3767 White
3768 .cindex "&""From""& line"
3769 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3770 given as two arguments or one combined argument). The sender of a
3771 locally-generated message can also be set (when permitted) by an initial
3772 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3773 if &%-f%& is also present, it overrides &"From&~"&.
3774
3775 .vitem &%-G%&
3776 .oindex "&%-G%&"
3777 .cindex "submission fixups, suppressing (command-line)"
3778 This option is equivalent to an ACL applying:
3779 .code
3780 control = suppress_local_fixups
3781 .endd
3782 for every message received.  Note that Sendmail will complain about such
3783 bad formatting, where Exim silently just does not fix it up.  This may change
3784 in future.
3785
3786 As this affects audit information, the caller must be a trusted user to use
3787 this option.
3788
3789 .vitem &%-h%&&~<&'number'&>
3790 .oindex "&%-h%&"
3791 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3792 This option is accepted for compatibility with Sendmail, but has no effect. (In
3793 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3794 headers.)
3795
3796 .vitem &%-i%&
3797 .oindex "&%-i%&"
3798 .cindex "Solaris" "&'mail'& command"
3799 .cindex "dot" "in incoming non-SMTP message"
3800 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3801 line by itself should not terminate an incoming, non-SMTP message. I can find
3802 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3803 command in Solaris 2.4 uses it. See also &%-ti%&.
3804
3805 .vitem &%-L%&&~<&'tag'&>
3806 .oindex "&%-L%&"
3807 .cindex "syslog" "process name; set with flag"
3808 This option is equivalent to setting &%syslog_processname%& in the config
3809 file and setting &%log_file_path%& to &`syslog`&.
3810 Its use is restricted to administrators.  The configuration file has to be
3811 read and parsed, to determine access rights, before this is set and takes
3812 effect, so early configuration file errors will not honour this flag.
3813
3814 The tag should not be longer than 32 characters.
3815
3816 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3817 .oindex "&%-M%&"
3818 .cindex "forcing delivery"
3819 .cindex "delivery" "forcing attempt"
3820 .cindex "frozen messages" "forcing delivery"
3821 This option requests Exim to run a delivery attempt on each message in turn. If
3822 any of the messages are frozen, they are automatically thawed before the
3823 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3824 and &%hold_domains%& are ignored.
3825
3826 Retry
3827 .cindex "hints database" "overriding retry hints"
3828 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3829 the normal retry time has not yet been reached. This option requires the caller
3830 to be an admin user. However, there is an option called &%prod_requires_admin%&
3831 which can be set false to relax this restriction (and also the same requirement
3832 for the &%-q%&, &%-R%&, and &%-S%& options).
3833
3834 The deliveries happen synchronously, that is, the original Exim process does
3835 not terminate until all the delivery attempts have finished. No output is
3836 produced unless there is a serious error. If you want to see what is happening,
3837 use the &%-v%& option as well, or inspect Exim's main log.
3838
3839 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3840 .oindex "&%-Mar%&"
3841 .cindex "message" "adding recipients"
3842 .cindex "recipient" "adding"
3843 This option requests Exim to add the addresses to the list of recipients of the
3844 message (&"ar"& for &"add recipients"&). The first argument must be a message
3845 id, and the remaining ones must be email addresses. However, if the message is
3846 active (in the middle of a delivery attempt), it is not altered. This option
3847 can be used only by an admin user.
3848
3849 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3850         &~<&'message&~id'&>"
3851 .oindex "&%-MC%&"
3852 .cindex "SMTP" "passed connection"
3853 .cindex "SMTP" "multiple deliveries"
3854 .cindex "multiple SMTP deliveries"
3855 This option is not intended for use by external callers. It is used internally
3856 by Exim to invoke another instance of itself to deliver a waiting message using
3857 an existing SMTP connection, which is passed as the standard input. Details are
3858 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3859 must be root or the Exim user in order to use it.
3860
3861 .vitem &%-MCA%&
3862 .oindex "&%-MCA%&"
3863 This option is not intended for use by external callers. It is used internally
3864 by Exim in conjunction with the &%-MC%& option. It signifies that the
3865 connection to the remote host has been authenticated.
3866
3867 .vitem &%-MCD%&
3868 .oindex "&%-MCD%&"
3869 This option is not intended for use by external callers. It is used internally
3870 by Exim in conjunction with the &%-MC%& option. It signifies that the
3871 remote host supports the ESMTP &_DSN_& extension.
3872
3873 .vitem &%-MCG%&&~<&'queue&~name'&>
3874 .oindex "&%-MCG%&"
3875 This option is not intended for use by external callers. It is used internally
3876 by Exim in conjunction with the &%-MC%& option. It signifies that an
3877 alternate queue is used, named by the following argument.
3878
3879 .vitem &%-MCK%&
3880 .oindex "&%-MCK%&"
3881 This option is not intended for use by external callers. It is used internally
3882 by Exim in conjunction with the &%-MC%& option. It signifies that a
3883 remote host supports the ESMTP &_CHUNKING_& extension.
3884
3885 .vitem &%-MCP%&
3886 .oindex "&%-MCP%&"
3887 This option is not intended for use by external callers. It is used internally
3888 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3889 which Exim is connected supports pipelining.
3890
3891 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3892 .oindex "&%-MCQ%&"
3893 This option is not intended for use by external callers. It is used internally
3894 by Exim in conjunction with the &%-MC%& option when the original delivery was
3895 started by a queue runner. It passes on the process id of the queue runner,
3896 together with the file descriptor number of an open pipe. Closure of the pipe
3897 signals the final completion of the sequence of processes that are passing
3898 messages through the same SMTP connection.
3899
3900 .vitem &%-MCS%&
3901 .oindex "&%-MCS%&"
3902 This option is not intended for use by external callers. It is used internally
3903 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3904 SMTP SIZE option should be used on messages delivered down the existing
3905 connection.
3906
3907 .vitem &%-MCT%&
3908 .oindex "&%-MCT%&"
3909 This option is not intended for use by external callers. It is used internally
3910 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3911 host to which Exim is connected supports TLS encryption.
3912
3913 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3914 .oindex "&%-MCt%&"
3915 This option is not intended for use by external callers. It is used internally
3916 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3917 connection is being proxied by a parent process for handling TLS encryption.
3918 The arguments give the local address and port being proxied, and the TLS cipher.
3919
3920 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3921 .oindex "&%-Mc%&"
3922 .cindex "hints database" "not overridden by &%-Mc%&"
3923 .cindex "delivery" "manually started &-- not forced"
3924 This option requests Exim to run a delivery attempt on each message, in turn,
3925 but unlike the &%-M%& option, it does check for retry hints, and respects any
3926 that are found. This option is not very useful to external callers. It is
3927 provided mainly for internal use by Exim when it needs to re-invoke itself in
3928 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3929 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3930 respects retry times and other options such as &%hold_domains%& that are
3931 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3932 If you want to run a specific delivery as if in a queue run, you should use
3933 &%-q%& with a message id argument. A distinction between queue run deliveries
3934 and other deliveries is made in one or two places.
3935
3936 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3937 .oindex "&%-Mes%&"
3938 .cindex "message" "changing sender"
3939 .cindex "sender" "changing"
3940 This option requests Exim to change the sender address in the message to the
3941 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3942 &"edit sender"&). There must be exactly two arguments. The first argument must
3943 be a message id, and the second one an email address. However, if the message
3944 is active (in the middle of a delivery attempt), its status is not altered.
3945 This option can be used only by an admin user.
3946
3947 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3948 .oindex "&%-Mf%&"
3949 .cindex "freezing messages"
3950 .cindex "message" "manually freezing"
3951 This option requests Exim to mark each listed message as &"frozen"&. This
3952 prevents any delivery attempts taking place until the message is &"thawed"&,
3953 either manually or as a result of the &%auto_thaw%& configuration option.
3954 However, if any of the messages are active (in the middle of a delivery
3955 attempt), their status is not altered. This option can be used only by an admin
3956 user.
3957
3958 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3959 .oindex "&%-Mg%&"
3960 .cindex "giving up on messages"
3961 .cindex "message" "abandoning delivery attempts"
3962 .cindex "delivery" "abandoning further attempts"
3963 This option requests Exim to give up trying to deliver the listed messages,
3964 including any that are frozen. However, if any of the messages are active,
3965 their status is not altered. For non-bounce messages, a delivery error message
3966 is sent to the sender, containing the text &"cancelled by administrator"&.
3967 Bounce messages are just discarded. This option can be used only by an admin
3968 user.
3969
3970 .new
3971 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3972 .oindex "&%-MG%&"
3973 .cindex queue named
3974 .cindex "named queues"
3975 .cindex "queue" "moving messages"
3976 This option requests that each listed message be moved from its current
3977 queue to the given named queue.
3978 The destination queue name argument is required, but can be an empty
3979 string to define the default queue.
3980 If the messages are not currently located in the default queue,
3981 a &%-qG<name>%& option will be required to define the source queue.
3982 .wen
3983
3984 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3985 .oindex "&%-Mmad%&"
3986 .cindex "delivery" "cancelling all"
3987 This option requests Exim to mark all the recipient addresses in the messages
3988 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3989 message is active (in the middle of a delivery attempt), its status is not
3990 altered. This option can be used only by an admin user.
3991
3992 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3993 .oindex "&%-Mmd%&"
3994 .cindex "delivery" "cancelling by address"
3995 .cindex "recipient" "removing"
3996 .cindex "removing recipients"
3997 This option requests Exim to mark the given addresses as already delivered
3998 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3999 the remaining ones must be email addresses. These are matched to recipient
4000 addresses in the message in a case-sensitive manner. If the message is active
4001 (in the middle of a delivery attempt), its status is not altered. This option
4002 can be used only by an admin user.
4003
4004 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4005 .oindex "&%-Mrm%&"
4006 .cindex "removing messages"
4007 .cindex "abandoning mail"
4008 .cindex "message" "manually discarding"
4009 This option requests Exim to remove the given messages from the queue. No
4010 bounce messages are sent; each message is simply forgotten. However, if any of
4011 the messages are active, their status is not altered. This option can be used
4012 only by an admin user or by the user who originally caused the message to be
4013 placed in the queue.
4014
4015 . .new
4016 . .vitem &%-MS%&
4017 . .oindex "&%-MS%&"
4018 . .cindex REQUIRETLS
4019 . This option is used to request REQUIRETLS processing on the message.
4020 . It is used internally by Exim in conjunction with -E when generating
4021 . a bounce message.
4022 . .wen
4023
4024 .vitem &%-Mset%&&~<&'message&~id'&>
4025 .oindex "&%-Mset%&"
4026 .cindex "testing" "string expansion"
4027 .cindex "expansion" "testing"
4028 This option is useful only in conjunction with &%-be%& (that is, when testing
4029 string expansions). Exim loads the given message from its spool before doing
4030 the test expansions, thus setting message-specific variables such as
4031 &$message_size$& and the header variables. The &$recipients$& variable is made
4032 available. This feature is provided to make it easier to test expansions that
4033 make use of these variables. However, this option can be used only by an admin
4034 user. See also &%-bem%&.
4035
4036 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4037 .oindex "&%-Mt%&"
4038 .cindex "thawing messages"
4039 .cindex "unfreezing messages"
4040 .cindex "frozen messages" "thawing"
4041 .cindex "message" "thawing frozen"
4042 This option requests Exim to &"thaw"& any of the listed messages that are
4043 &"frozen"&, so that delivery attempts can resume. However, if any of the
4044 messages are active, their status is not altered. This option can be used only
4045 by an admin user.
4046
4047 .vitem &%-Mvb%&&~<&'message&~id'&>
4048 .oindex "&%-Mvb%&"
4049 .cindex "listing" "message body"
4050 .cindex "message" "listing body of"
4051 This option causes the contents of the message body (-D) spool file to be
4052 written to the standard output. This option can be used only by an admin user.
4053
4054 .vitem &%-Mvc%&&~<&'message&~id'&>
4055 .oindex "&%-Mvc%&"
4056 .cindex "message" "listing in RFC 2822 format"
4057 .cindex "listing" "message in RFC 2822 format"
4058 This option causes a copy of the complete message (header lines plus body) to
4059 be written to the standard output in RFC 2822 format. This option can be used
4060 only by an admin user.
4061
4062 .vitem &%-Mvh%&&~<&'message&~id'&>
4063 .oindex "&%-Mvh%&"
4064 .cindex "listing" "message headers"
4065 .cindex "header lines" "listing"
4066 .cindex "message" "listing header lines"
4067 This option causes the contents of the message headers (-H) spool file to be
4068 written to the standard output. This option can be used only by an admin user.
4069
4070 .vitem &%-Mvl%&&~<&'message&~id'&>
4071 .oindex "&%-Mvl%&"
4072 .cindex "listing" "message log"
4073 .cindex "message" "listing message log"
4074 This option causes the contents of the message log spool file to be written to
4075 the standard output. This option can be used only by an admin user.
4076
4077 .vitem &%-m%&
4078 .oindex "&%-m%&"
4079 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4080 treats it that way too.
4081
4082 .vitem &%-N%&
4083 .oindex "&%-N%&"
4084 .cindex "debugging" "&%-N%& option"
4085 .cindex "debugging" "suppressing delivery"
4086 This is a debugging option that inhibits delivery of a message at the transport
4087 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4088 it just doesn't actually transport the message, but instead behaves as if it
4089 had successfully done so. However, it does not make any updates to the retry
4090 database, and the log entries for deliveries are flagged with &"*>"& rather
4091 than &"=>"&.
4092
4093 Because &%-N%& discards any message to which it applies, only root or the Exim
4094 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4095 words, an ordinary user can use it only when supplying an incoming message to
4096 which it will apply. Although transportation never fails when &%-N%& is set, an
4097 address may be deferred because of a configuration problem on a transport, or a
4098 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4099 the message, and applies to any subsequent delivery attempts that may happen
4100 for that message.
4101
4102 .vitem &%-n%&
4103 .oindex "&%-n%&"
4104 This option is interpreted by Sendmail to mean &"no aliasing"&.
4105 For normal modes of operation, it is ignored by Exim.
4106 When combined with &%-bP%& it makes the output more terse (suppresses
4107 option names, environment values and config pretty printing).
4108
4109 .vitem &%-O%&&~<&'data'&>
4110 .oindex "&%-O%&"
4111 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4112 Exim.
4113
4114 .vitem &%-oA%&&~<&'file&~name'&>
4115 .oindex "&%-oA%&"
4116 .cindex "Sendmail compatibility" "&%-oA%& option"
4117 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4118 alternative alias filename. Exim handles &%-bi%& differently; see the
4119 description above.
4120
4121 .vitem &%-oB%&&~<&'n'&>
4122 .oindex "&%-oB%&"
4123 .cindex "SMTP" "passed connection"
4124 .cindex "SMTP" "multiple deliveries"
4125 .cindex "multiple SMTP deliveries"
4126 This is a debugging option which limits the maximum number of messages that can
4127 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4128 transport. If <&'n'&> is omitted, the limit is set to 1.
4129
4130 .vitem &%-odb%&
4131 .oindex "&%-odb%&"
4132 .cindex "background delivery"
4133 .cindex "delivery" "in the background"
4134 This option applies to all modes in which Exim accepts incoming messages,
4135 including the listening daemon. It requests &"background"& delivery of such
4136 messages, which means that the accepting process automatically starts a
4137 delivery process for each message received, but does not wait for the delivery
4138 processes to finish.
4139
4140 When all the messages have been received, the reception process exits,
4141 leaving the delivery processes to finish in their own time. The standard output
4142 and error streams are closed at the start of each delivery process.
4143 This is the default action if none of the &%-od%& options are present.
4144
4145 If one of the queueing options in the configuration file
4146 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4147 overrides it if &%queue_only_override%& is set true, which is the default
4148 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4149
4150 .vitem &%-odf%&
4151 .oindex "&%-odf%&"
4152 .cindex "foreground delivery"
4153 .cindex "delivery" "in the foreground"
4154 This option requests &"foreground"& (synchronous) delivery when Exim has
4155 accepted a locally-generated message. (For the daemon it is exactly the same as
4156 &%-odb%&.) A delivery process is automatically started to deliver the message,
4157 and Exim waits for it to complete before proceeding.
4158
4159 The original Exim reception process does not finish until the delivery
4160 process for the final message has ended. The standard error stream is left open
4161 during deliveries.
4162
4163 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4164 false and one of the queueing options in the configuration file is in effect.
4165
4166 If there is a temporary delivery error during foreground delivery, the
4167 message is left in the queue for later delivery, and the original reception
4168 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4169 restricted configuration that never queues messages.
4170
4171
4172 .vitem &%-odi%&
4173 .oindex "&%-odi%&"
4174 This option is synonymous with &%-odf%&. It is provided for compatibility with
4175 Sendmail.
4176
4177 .vitem &%-odq%&
4178 .oindex "&%-odq%&"
4179 .cindex "non-immediate delivery"
4180 .cindex "delivery" "suppressing immediate"
4181 .cindex "queueing incoming messages"
4182 This option applies to all modes in which Exim accepts incoming messages,
4183 including the listening daemon. It specifies that the accepting process should
4184 not automatically start a delivery process for each message received. Messages
4185 are placed in the queue, and remain there until a subsequent queue runner
4186 process encounters them. There are several configuration options (such as
4187 &%queue_only%&) that can be used to queue incoming messages under certain
4188 conditions. This option overrides all of them and also &%-odqs%&. It always
4189 forces queueing.
4190
4191 .vitem &%-odqs%&
4192 .oindex "&%-odqs%&"
4193 .cindex "SMTP" "delaying delivery"
4194 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4195 However, like &%-odb%& and &%-odi%&, this option has no effect if
4196 &%queue_only_override%& is false and one of the queueing options in the
4197 configuration file is in effect.
4198
4199 When &%-odqs%& does operate, a delivery process is started for each incoming
4200 message, in the background by default, but in the foreground if &%-odi%& is
4201 also present. The recipient addresses are routed, and local deliveries are done
4202 in the normal way. However, if any SMTP deliveries are required, they are not
4203 done at this time, so the message remains in the queue until a subsequent queue
4204 runner process encounters it. Because routing was done, Exim knows which
4205 messages are waiting for which hosts, and so a number of messages for the same
4206 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4207 configuration option has the same effect for specific domains. See also the
4208 &%-qq%& option.
4209
4210 .vitem &%-oee%&
4211 .oindex "&%-oee%&"
4212 .cindex "error" "reporting"
4213 If an error is detected while a non-SMTP message is being received (for
4214 example, a malformed address), the error is reported to the sender in a mail
4215 message.
4216
4217 .cindex "return code" "for &%-oee%&"
4218 Provided
4219 this error message is successfully sent, the Exim receiving process
4220 exits with a return code of zero. If not, the return code is 2 if the problem
4221 is that the original message has no recipients, or 1 for any other error.
4222 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4223
4224 .vitem &%-oem%&
4225 .oindex "&%-oem%&"
4226 .cindex "error" "reporting"
4227 .cindex "return code" "for &%-oem%&"
4228 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4229 return code, whether or not the error message was successfully sent.
4230 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4231
4232 .vitem &%-oep%&
4233 .oindex "&%-oep%&"
4234 .cindex "error" "reporting"
4235 If an error is detected while a non-SMTP message is being received, the
4236 error is reported by writing a message to the standard error file (stderr).
4237 .cindex "return code" "for &%-oep%&"
4238 The return code is 1 for all errors.
4239
4240 .vitem &%-oeq%&
4241 .oindex "&%-oeq%&"
4242 .cindex "error" "reporting"
4243 This option is supported for compatibility with Sendmail, but has the same
4244 effect as &%-oep%&.
4245
4246 .vitem &%-oew%&
4247 .oindex "&%-oew%&"
4248 .cindex "error" "reporting"
4249 This option is supported for compatibility with Sendmail, but has the same
4250 effect as &%-oem%&.
4251
4252 .vitem &%-oi%&
4253 .oindex "&%-oi%&"
4254 .cindex "dot" "in incoming non-SMTP message"
4255 This option, which has the same effect as &%-i%&, specifies that a dot on a
4256 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4257 single dot does terminate, though Exim does no special processing for other
4258 lines that start with a dot. This option is set by default if Exim is called as
4259 &'rmail'&. See also &%-ti%&.
4260
4261 .vitem &%-oitrue%&
4262 .oindex "&%-oitrue%&"
4263 This option is treated as synonymous with &%-oi%&.
4264
4265 .vitem &%-oMa%&&~<&'host&~address'&>
4266 .oindex "&%-oMa%&"
4267 .cindex "sender" "host address, specifying for local message"
4268 A number of options starting with &%-oM%& can be used to set values associated
4269 with remote hosts on locally-submitted messages (that is, messages not received
4270 over TCP/IP). These options can be used by any caller in conjunction with the
4271 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4272 other circumstances, they are ignored unless the caller is trusted.
4273
4274 The &%-oMa%& option sets the sender host address. This may include a port
4275 number at the end, after a full stop (period). For example:
4276 .code
4277 exim -bs -oMa 10.9.8.7.1234
4278 .endd
4279 An alternative syntax is to enclose the IP address in square brackets,
4280 followed by a colon and the port number:
4281 .code
4282 exim -bs -oMa [10.9.8.7]:1234
4283 .endd
4284 The IP address is placed in the &$sender_host_address$& variable, and the
4285 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4286 are present on the command line, the sender host IP address is taken from
4287 whichever one is last.
4288
4289 .vitem &%-oMaa%&&~<&'name'&>
4290 .oindex "&%-oMaa%&"
4291 .cindex "authentication" "name, specifying for local message"
4292 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4293 option sets the value of &$sender_host_authenticated$& (the authenticator
4294 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4295 This option can be used with &%-bh%& and &%-bs%& to set up an
4296 authenticated SMTP session without actually using the SMTP AUTH command.
4297
4298 .vitem &%-oMai%&&~<&'string'&>
4299 .oindex "&%-oMai%&"
4300 .cindex "authentication" "id, specifying for local message"
4301 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4302 option sets the value of &$authenticated_id$& (the id that was authenticated).
4303 This overrides the default value (the caller's login id, except with &%-bh%&,
4304 where there is no default) for messages from local sources. See chapter
4305 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4306
4307 .vitem &%-oMas%&&~<&'address'&>
4308 .oindex "&%-oMas%&"
4309 .cindex "authentication" "sender, specifying for local message"
4310 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4311 option sets the authenticated sender value in &$authenticated_sender$&. It
4312 overrides the sender address that is created from the caller's login id for
4313 messages from local sources, except when &%-bh%& is used, when there is no
4314 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4315 specified on a MAIL command overrides this value. See chapter
4316 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4317
4318 .vitem &%-oMi%&&~<&'interface&~address'&>
4319 .oindex "&%-oMi%&"
4320 .cindex "interface" "address, specifying for local message"
4321 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4322 option sets the IP interface address value. A port number may be included,
4323 using the same syntax as for &%-oMa%&. The interface address is placed in
4324 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4325
4326 .vitem &%-oMm%&&~<&'message&~reference'&>
4327 .oindex "&%-oMm%&"
4328 .cindex "message reference" "message reference, specifying for local message"
4329 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4330 option sets the message reference, e.g. message-id, and is logged during
4331 delivery. This is useful when some kind of audit trail is required to tie
4332 messages together. The format of the message reference is checked and will
4333 abort if the format is invalid. The option will only be accepted if exim is
4334 running in trusted mode, not as any regular user.
4335
4336 The best example of a message reference is when Exim sends a bounce message.
4337 The message reference is the message-id of the original message for which Exim
4338 is sending the bounce.
4339
4340 .vitem &%-oMr%&&~<&'protocol&~name'&>
4341 .oindex "&%-oMr%&"
4342 .cindex "protocol, specifying for local message"
4343 .vindex "&$received_protocol$&"
4344 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4345 option sets the received protocol value that is stored in
4346 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4347 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4348 SMTP protocol names (see the description of &$received_protocol$& in section
4349 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4350 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4351 be set by &%-oMr%&. Repeated use of this option is not supported.
4352
4353 .vitem &%-oMs%&&~<&'host&~name'&>
4354 .oindex "&%-oMs%&"
4355 .cindex "sender" "host name, specifying for local message"
4356 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4357 option sets the sender host name in &$sender_host_name$&. When this option is
4358 present, Exim does not attempt to look up a host name from an IP address; it
4359 uses the name it is given.
4360
4361 .vitem &%-oMt%&&~<&'ident&~string'&>
4362 .oindex "&%-oMt%&"
4363 .cindex "sender" "ident string, specifying for local message"
4364 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4365 option sets the sender ident value in &$sender_ident$&. The default setting for
4366 local callers is the login id of the calling process, except when &%-bh%& is
4367 used, when there is no default.
4368
4369 .vitem &%-om%&
4370 .oindex "&%-om%&"
4371 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4372 In Sendmail, this option means &"me too"&, indicating that the sender of a
4373 message should receive a copy of the message if the sender appears in an alias
4374 expansion. Exim always does this, so the option does nothing.
4375
4376 .vitem &%-oo%&
4377 .oindex "&%-oo%&"
4378 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4379 This option is ignored. In Sendmail it specifies &"old style headers"&,
4380 whatever that means.
4381
4382 .vitem &%-oP%&&~<&'path'&>
4383 .oindex "&%-oP%&"
4384 .cindex "pid (process id)" "of daemon"
4385 .cindex "daemon" "process id (pid)"
4386 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4387 value. The option specifies the file to which the process id of the daemon is
4388 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4389 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4390 because in those cases, the normal pid file is not used.
4391
4392 .vitem &%-or%&&~<&'time'&>
4393 .oindex "&%-or%&"
4394 .cindex "timeout" "for non-SMTP input"
4395 This option sets a timeout value for incoming non-SMTP messages. If it is not
4396 set, Exim will wait forever for the standard input. The value can also be set
4397 by the &%receive_timeout%& option. The format used for specifying times is
4398 described in section &<<SECTtimeformat>>&.
4399
4400 .vitem &%-os%&&~<&'time'&>
4401 .oindex "&%-os%&"
4402 .cindex "timeout" "for SMTP input"
4403 .cindex "SMTP" "input timeout"
4404 This option sets a timeout value for incoming SMTP messages. The timeout
4405 applies to each SMTP command and block of data. The value can also be set by
4406 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4407 for specifying times is described in section &<<SECTtimeformat>>&.
4408
4409 .vitem &%-ov%&
4410 .oindex "&%-ov%&"
4411 This option has exactly the same effect as &%-v%&.
4412
4413 .vitem &%-oX%&&~<&'number&~or&~string'&>
4414 .oindex "&%-oX%&"
4415 .cindex "TCP/IP" "setting listening ports"
4416 .cindex "TCP/IP" "setting listening interfaces"
4417 .cindex "port" "receiving TCP/IP"
4418 This option is relevant only when the &%-bd%& (start listening daemon) option
4419 is also given. It controls which ports and interfaces the daemon uses. Details
4420 of the syntax, and how it interacts with configuration file options, are given
4421 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4422 file is written unless &%-oP%& is also present to specify a pid filename.
4423
4424 .vitem &%-pd%&
4425 .oindex "&%-pd%&"
4426 .cindex "Perl" "starting the interpreter"
4427 This option applies when an embedded Perl interpreter is linked with Exim (see
4428 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4429 option, forcing the starting of the interpreter to be delayed until it is
4430 needed.
4431
4432 .vitem &%-ps%&
4433 .oindex "&%-ps%&"
4434 .cindex "Perl" "starting the interpreter"
4435 This option applies when an embedded Perl interpreter is linked with Exim (see
4436 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4437 option, forcing the starting of the interpreter to occur as soon as Exim is
4438 started.
4439
4440 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4441 .oindex "&%-p%&"
4442 For compatibility with Sendmail, this option is equivalent to
4443 .display
4444 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4445 .endd
4446 It sets the incoming protocol and host name (for trusted callers). The
4447 host name and its colon can be omitted when only the protocol is to be set.
4448 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4449 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4450 or &`s`& using this option (but that does not seem a real limitation).
4451 Repeated use of this option is not supported.
4452
4453 .vitem &%-q%&
4454 .oindex "&%-q%&"
4455 .cindex "queue runner" "starting manually"
4456 This option is normally restricted to admin users. However, there is a
4457 configuration option called &%prod_requires_admin%& which can be set false to
4458 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4459 and &%-S%& options).
4460
4461 .cindex "queue runner" "description of operation"
4462 If other commandline options do not specify an action,
4463 the &%-q%& option starts one queue runner process. This scans the queue of
4464 waiting messages, and runs a delivery process for each one in turn. It waits
4465 for each delivery process to finish before starting the next one. A delivery
4466 process may not actually do any deliveries if the retry times for the addresses
4467 have not been reached. Use &%-qf%& (see below) if you want to override this.
4468
4469 If
4470 .cindex "SMTP" "passed connection"
4471 .cindex "SMTP" "multiple deliveries"
4472 .cindex "multiple SMTP deliveries"
4473 the delivery process spawns other processes to deliver other messages down
4474 passed SMTP connections, the queue runner waits for these to finish before
4475 proceeding.
4476
4477 When all the queued messages have been considered, the original queue runner
4478 process terminates. In other words, a single pass is made over the waiting
4479 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4480 this to be repeated periodically.
4481
4482 Exim processes the waiting messages in an unpredictable order. It isn't very
4483 random, but it is likely to be different each time, which is all that matters.
4484 If one particular message screws up a remote MTA, other messages to the same
4485 MTA have a chance of getting through if they get tried first.
4486
4487 It is possible to cause the messages to be processed in lexical message id
4488 order, which is essentially the order in which they arrived, by setting the
4489 &%queue_run_in_order%& option, but this is not recommended for normal use.
4490
4491 .vitem &%-q%&<&'qflags'&>
4492 The &%-q%& option may be followed by one or more flag letters that change its
4493 behaviour. They are all optional, but if more than one is present, they must
4494 appear in the correct order. Each flag is described in a separate item below.
4495
4496 .vitem &%-qq...%&
4497 .oindex "&%-qq%&"
4498 .cindex "queue" "double scanning"
4499 .cindex "queue" "routing"
4500 .cindex "routing" "whole queue before delivery"
4501 An option starting with &%-qq%& requests a two-stage queue run. In the first
4502 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4503 every domain. Addresses are routed, local deliveries happen, but no remote
4504 transports are run.
4505
4506 .cindex "hints database" "remembering routing"
4507 The hints database that remembers which messages are waiting for specific hosts
4508 is updated, as if delivery to those hosts had been deferred. After this is
4509 complete, a second, normal queue scan happens, with routing and delivery taking
4510 place as normal. Messages that are routed to the same host should mostly be
4511 delivered down a single SMTP
4512 .cindex "SMTP" "passed connection"
4513 .cindex "SMTP" "multiple deliveries"
4514 .cindex "multiple SMTP deliveries"
4515 connection because of the hints that were set up during the first queue scan.
4516 This option may be useful for hosts that are connected to the Internet
4517 intermittently.
4518
4519 .vitem &%-q[q]i...%&
4520 .oindex "&%-qi%&"
4521 .cindex "queue" "initial delivery"
4522 If the &'i'& flag is present, the queue runner runs delivery processes only for
4523 those messages that haven't previously been tried. (&'i'& stands for &"initial
4524 delivery"&.) This can be helpful if you are putting messages in the queue using
4525 &%-odq%& and want a queue runner just to process the new messages.
4526
4527 .vitem &%-q[q][i]f...%&
4528 .oindex "&%-qf%&"
4529 .cindex "queue" "forcing delivery"
4530 .cindex "delivery" "forcing in queue run"
4531 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4532 message, whereas without &'f'& only those non-frozen addresses that have passed
4533 their retry times are tried.
4534
4535 .vitem &%-q[q][i]ff...%&
4536 .oindex "&%-qff%&"
4537 .cindex "frozen messages" "forcing delivery"
4538 If &'ff'& is present, a delivery attempt is forced for every message, whether
4539 frozen or not.
4540
4541 .vitem &%-q[q][i][f[f]]l%&
4542 .oindex "&%-ql%&"
4543 .cindex "queue" "local deliveries only"
4544 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4545 be done. If a message requires any remote deliveries, it remains in the queue
4546 for later delivery.
4547
4548 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4549 .oindex "&%-qG%&"
4550 .cindex queue named
4551 .cindex "named queues"
4552 .cindex "queue" "delivering specific messages"
4553 If the &'G'& flag and a name is present, the queue runner operates on the
4554 queue with the given name rather than the default queue.
4555 The name should not contain a &'/'& character.
4556 For a periodic queue run (see below)
4557 append to the name a slash and a time value.
4558
4559 If other commandline options specify an action, a &'-qG<name>'& option
4560 will specify a queue to operate on.
4561 For example:
4562 .code
4563 exim -bp -qGquarantine
4564 mailq -qGquarantine
4565 exim -qGoffpeak -Rf @special.domain.example
4566 .endd
4567
4568 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4569 When scanning the queue, Exim can be made to skip over messages whose ids are
4570 lexically less than a given value by following the &%-q%& option with a
4571 starting message id. For example:
4572 .code
4573 exim -q 0t5C6f-0000c8-00
4574 .endd
4575 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4576 second message id is given, messages whose ids are lexically greater than it
4577 are also skipped. If the same id is given twice, for example,
4578 .code
4579 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4580 .endd
4581 just one delivery process is started, for that message. This differs from
4582 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4583 that it counts as a delivery from a queue run. Note that the selection
4584 mechanism does not affect the order in which the messages are scanned. There
4585 are also other ways of selecting specific sets of messages for delivery in a
4586 queue run &-- see &%-R%& and &%-S%&.
4587
4588 .vitem &%-q%&<&'qflags'&><&'time'&>
4589 .cindex "queue runner" "starting periodically"
4590 .cindex "periodic queue running"
4591 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4592 starting a queue runner process at intervals specified by the given time value
4593 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4594 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4595 single daemon process handles both functions. A common way of starting up a
4596 combined daemon at system boot time is to use a command such as
4597 .code
4598 /usr/exim/bin/exim -bd -q30m
4599 .endd
4600 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4601 process every 30 minutes.
4602
4603 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4604 pid file is written unless one is explicitly requested by the &%-oP%& option.
4605
4606 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4607 .oindex "&%-qR%&"
4608 This option is synonymous with &%-R%&. It is provided for Sendmail
4609 compatibility.
4610
4611 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4612 .oindex "&%-qS%&"
4613 This option is synonymous with &%-S%&.
4614
4615 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4616 .oindex "&%-R%&"
4617 .cindex "queue runner" "for specific recipients"
4618 .cindex "delivery" "to given domain"
4619 .cindex "domain" "delivery to"
4620 The <&'rsflags'&> may be empty, in which case the white space before the string
4621 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4622 which are the possible values for <&'rsflags'&>. White space is required if
4623 <&'rsflags'&> is not empty.
4624
4625 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4626 perform a single queue run, except that, when scanning the messages on the
4627 queue, Exim processes only those that have at least one undelivered recipient
4628 address containing the given string, which is checked in a case-independent
4629 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4630 regular expression; otherwise it is a literal string.
4631
4632 If you want to do periodic queue runs for messages with specific recipients,
4633 you can combine &%-R%& with &%-q%& and a time value. For example:
4634 .code
4635 exim -q25m -R @special.domain.example
4636 .endd
4637 This example does a queue run for messages with recipients in the given domain
4638 every 25 minutes. Any additional flags that are specified with &%-q%& are
4639 applied to each queue run.
4640
4641 Once a message is selected for delivery by this mechanism, all its addresses
4642 are processed. For the first selected message, Exim overrides any retry
4643 information and forces a delivery attempt for each undelivered address. This
4644 means that if delivery of any address in the first message is successful, any
4645 existing retry information is deleted, and so delivery attempts for that
4646 address in subsequently selected messages (which are processed without forcing)
4647 will run. However, if delivery of any address does not succeed, the retry
4648 information is updated, and in subsequently selected messages, the failing
4649 address will be skipped.
4650
4651 .cindex "frozen messages" "forcing delivery"
4652 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4653 all selected messages, not just the first; frozen messages are included when
4654 &'ff'& is present.
4655
4656 The &%-R%& option makes it straightforward to initiate delivery of all messages
4657 to a given domain after a host has been down for some time. When the SMTP
4658 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4659 effect is to run Exim with the &%-R%& option, but it can be configured to run
4660 an arbitrary command instead.
4661
4662 .vitem &%-r%&
4663 .oindex "&%-r%&"
4664 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4665
4666 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4667 .oindex "&%-S%&"
4668 .cindex "delivery" "from given sender"
4669 .cindex "queue runner" "for specific senders"
4670 This option acts like &%-R%& except that it checks the string against each
4671 message's sender instead of against the recipients. If &%-R%& is also set, both
4672 conditions must be met for a message to be selected. If either of the options
4673 has &'f'& or &'ff'& in its flags, the associated action is taken.
4674
4675 .vitem &%-Tqt%&&~<&'times'&>
4676 .oindex "&%-Tqt%&"
4677 This is an option that is exclusively for use by the Exim testing suite. It is not
4678 recognized when Exim is run normally. It allows for the setting up of explicit
4679 &"queue times"& so that various warning/retry features can be tested.
4680
4681 .vitem &%-t%&
4682 .oindex "&%-t%&"
4683 .cindex "recipient" "extracting from header lines"
4684 .cindex "&'Bcc:'& header line"
4685 .cindex "&'Cc:'& header line"
4686 .cindex "&'To:'& header line"
4687 When Exim is receiving a locally-generated, non-SMTP message on its standard
4688 input, the &%-t%& option causes the recipients of the message to be obtained
4689 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4690 from the command arguments. The addresses are extracted before any rewriting
4691 takes place and the &'Bcc:'& header line, if present, is then removed.
4692
4693 .cindex "Sendmail compatibility" "&%-t%& option"
4694 If the command has any arguments, they specify addresses to which the message
4695 is &'not'& to be delivered. That is, the argument addresses are removed from
4696 the recipients list obtained from the headers. This is compatible with Smail 3
4697 and in accordance with the documented behaviour of several versions of
4698 Sendmail, as described in man pages on a number of operating systems (e.g.
4699 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4700 argument addresses to those obtained from the headers, and the O'Reilly
4701 Sendmail book documents it that way. Exim can be made to add argument addresses
4702 instead of subtracting them by setting the option
4703 &%extract_addresses_remove_arguments%& false.
4704
4705 .cindex "&%Resent-%& header lines" "with &%-t%&"
4706 If there are any &%Resent-%& header lines in the message, Exim extracts
4707 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4708 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4709 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4710 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4711
4712 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4713 message is resent several times). The RFC also specifies that they should be
4714 added at the front of the message, and separated by &'Received:'& lines. It is
4715 not at all clear how &%-t%& should operate in the present of multiple sets,
4716 nor indeed exactly what constitutes a &"set"&.
4717 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4718 are often added at the end of the header, and if a message is resent more than
4719 once, it is common for the original set of &%Resent-%& headers to be renamed as
4720 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4721
4722 .vitem &%-ti%&
4723 .oindex "&%-ti%&"
4724 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4725 compatibility with Sendmail.
4726
4727 .vitem &%-tls-on-connect%&
4728 .oindex "&%-tls-on-connect%&"
4729 .cindex "TLS" "use without STARTTLS"
4730 .cindex "TLS" "automatic start"
4731 This option is available when Exim is compiled with TLS support. It forces all
4732 incoming SMTP connections to behave as if the incoming port is listed in the
4733 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4734 &<<CHAPTLS>>& for further details.
4735
4736
4737 .vitem &%-U%&
4738 .oindex "&%-U%&"
4739 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4740 Sendmail uses this option for &"initial message submission"&, and its
4741 documentation states that in future releases, it may complain about
4742 syntactically invalid messages rather than fixing them when this flag is not
4743 set. Exim ignores this option.
4744
4745 .vitem &%-v%&
4746 .oindex "&%-v%&"
4747 This option causes Exim to write information to the standard error stream,
4748 describing what it is doing. In particular, it shows the log lines for
4749 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4750 dialogue is shown. Some of the log lines shown may not actually be written to
4751 the log if the setting of &%log_selector%& discards them. Any relevant
4752 selectors are shown with each log line. If none are shown, the logging is
4753 unconditional.
4754
4755 .vitem &%-x%&
4756 .oindex "&%-x%&"
4757 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4758 National Language Support extended characters in the body of the mail item"&).
4759 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4760 this option.
4761
4762 .vitem &%-X%&&~<&'logfile'&>
4763 .oindex "&%-X%&"
4764 This option is interpreted by Sendmail to cause debug information to be sent
4765 to the named file.  It is ignored by Exim.
4766
4767 .vitem &%-z%&&~<&'log-line'&>
4768 .oindex "&%-z%&"
4769 This option writes its argument to Exim's logfile.
4770 Use is restricted to administrators; the intent is for operational notes.
4771 Quotes should be used to maintain a multi-word item as a single argument,
4772 under most shells.
4773 .endlist
4774
4775 .ecindex IIDclo1
4776 .ecindex IIDclo2
4777
4778
4779 . ////////////////////////////////////////////////////////////////////////////
4780 . Insert a stylized DocBook comment here, to identify the end of the command
4781 . line options. This is for the benefit of the Perl script that automatically
4782 . creates a man page for the options.
4783 . ////////////////////////////////////////////////////////////////////////////
4784
4785 .literal xml
4786 <!-- === End of command line options === -->
4787 .literal off
4788
4789
4790
4791
4792
4793 . ////////////////////////////////////////////////////////////////////////////
4794 . ////////////////////////////////////////////////////////////////////////////
4795
4796
4797 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4798          "The runtime configuration file"
4799
4800 .cindex "runtime configuration"
4801 .cindex "configuration file" "general description"
4802 .cindex "CONFIGURE_FILE"
4803 .cindex "configuration file" "errors in"
4804 .cindex "error" "in configuration file"
4805 .cindex "return code" "for bad configuration"
4806 Exim uses a single runtime configuration file that is read whenever an Exim
4807 binary is executed. Note that in normal operation, this happens frequently,
4808 because Exim is designed to operate in a distributed manner, without central
4809 control.
4810
4811 If a syntax error is detected while reading the configuration file, Exim
4812 writes a message on the standard error, and exits with a non-zero return code.
4813 The message is also written to the panic log. &*Note*&: Only simple syntax
4814 errors can be detected at this time. The values of any expanded options are
4815 not checked until the expansion happens, even when the expansion does not
4816 actually alter the string.
4817
4818 The name of the configuration file is compiled into the binary for security
4819 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4820 most configurations, this specifies a single file. However, it is permitted to
4821 give a colon-separated list of filenames, in which case Exim uses the first
4822 existing file in the list.
4823
4824 .cindex "EXIM_USER"
4825 .cindex "EXIM_GROUP"
4826 .cindex "CONFIGURE_OWNER"
4827 .cindex "CONFIGURE_GROUP"
4828 .cindex "configuration file" "ownership"
4829 .cindex "ownership" "configuration file"
4830 The runtime configuration file must be owned by root or by the user that is
4831 specified at compile time by the CONFIGURE_OWNER option (if set). The
4832 configuration file must not be world-writeable, or group-writeable unless its
4833 group is the root group or the one specified at compile time by the
4834 CONFIGURE_GROUP option.
4835
4836 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4837 to root, anybody who is able to edit the runtime configuration file has an
4838 easy way to run commands as root. If you specify a user or group in the
4839 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4840 who are members of that group will trivially be able to obtain root privileges.
4841
4842 Up to Exim version 4.72, the runtime configuration file was also permitted to
4843 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4844 since it offered a simple privilege escalation for any attacker who managed to
4845 compromise the Exim user account.
4846
4847 A default configuration file, which will work correctly in simple situations,
4848 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4849 defines just one filename, the installation process copies the default
4850 configuration to a new file of that name if it did not previously exist. If
4851 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4852 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4853 configuration.
4854
4855
4856
4857 .section "Using a different configuration file" "SECID40"
4858 .cindex "configuration file" "alternate"
4859 A one-off alternate configuration can be specified by the &%-C%& command line
4860 option, which may specify a single file or a list of files. However, when
4861 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4862 unless the argument for &%-C%& is identical to the built-in value from
4863 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4864 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4865 is useful mainly for checking the syntax of configuration files before
4866 installing them. No owner or group checks are done on a configuration file
4867 specified by &%-C%&, if root privilege has been dropped.
4868
4869 Even the Exim user is not trusted to specify an arbitrary configuration file
4870 with the &%-C%& option to be used with root privileges, unless that file is
4871 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4872 testing a configuration using &%-C%& right through message reception and
4873 delivery, even if the caller is root. The reception works, but by that time,
4874 Exim is running as the Exim user, so when it re-execs to regain privilege for
4875 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4876 can test reception and delivery using two separate commands (one to put a
4877 message in the queue, using &%-odq%&, and another to do the delivery, using
4878 &%-M%&).
4879
4880 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4881 prefix string with which any file named in a &%-C%& command line option must
4882 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4883 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4884 filename can be used with &%-C%&.
4885
4886 One-off changes to a configuration can be specified by the &%-D%& command line
4887 option, which defines and overrides values for macros used inside the
4888 configuration file. However, like &%-C%&, the use of this option by a
4889 non-privileged user causes Exim to discard its root privilege.
4890 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4891 completely disabled, and its use causes an immediate error exit.
4892
4893 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4894 to declare certain macro names trusted, such that root privilege will not
4895 necessarily be discarded.
4896 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4897 considered safe and, if &%-D%& only supplies macros from this list, and the
4898 values are acceptable, then Exim will not give up root privilege if the caller
4899 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4900 transition mechanism and is expected to be removed in the future.  Acceptable
4901 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4902
4903 Some sites may wish to use the same Exim binary on different machines that
4904 share a file system, but to use different configuration files on each machine.
4905 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4906 looks for a file whose name is the configuration filename followed by a dot
4907 and the machine's node name, as obtained from the &[uname()]& function. If this
4908 file does not exist, the standard name is tried. This processing occurs for
4909 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4910
4911 In some esoteric situations different versions of Exim may be run under
4912 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4913 help with this. See the comments in &_src/EDITME_& for details.
4914
4915
4916
4917 .section "Configuration file format" "SECTconffilfor"
4918 .cindex "configuration file" "format of"
4919 .cindex "format" "configuration file"
4920 Exim's configuration file is divided into a number of different parts. General
4921 option settings must always appear at the start of the file. The other parts
4922 are all optional, and may appear in any order. Each part other than the first
4923 is introduced by the word &"begin"& followed by at least one literal
4924 space, and the name of the part. The optional parts are:
4925
4926 .ilist
4927 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4928 &<<CHAPACL>>&).
4929 .next
4930 .cindex "AUTH" "configuration"
4931 &'authenticators'&: Configuration settings for the authenticator drivers. These
4932 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4933 .next
4934 &'routers'&: Configuration settings for the router drivers. Routers process
4935 addresses and determine how the message is to be delivered (see chapters
4936 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4937 .next
4938 &'transports'&: Configuration settings for the transport drivers. Transports
4939 define mechanisms for copying messages to destinations (see chapters
4940 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4941 .next
4942 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4943 If there is no retry section, or if it is empty (that is, no retry rules are
4944 defined), Exim will not retry deliveries. In this situation, temporary errors
4945 are treated the same as permanent errors. Retry rules are discussed in chapter
4946 &<<CHAPretry>>&.
4947 .next
4948 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4949 when new addresses are generated during delivery. Rewriting is discussed in
4950 chapter &<<CHAPrewrite>>&.
4951 .next
4952 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4953 want to use this feature, you must set
4954 .code
4955 LOCAL_SCAN_HAS_OPTIONS=yes
4956 .endd
4957 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4958 facility are given in chapter &<<CHAPlocalscan>>&.
4959 .endlist
4960
4961 .cindex "configuration file" "leading white space in"
4962 .cindex "configuration file" "trailing white space in"
4963 .cindex "white space" "in configuration file"
4964 Leading and trailing white space in configuration lines is always ignored.
4965
4966 Blank lines in the file, and lines starting with a # character (ignoring
4967 leading white space) are treated as comments and are ignored. &*Note*&: A
4968 # character other than at the beginning of a line is not treated specially,
4969 and does not introduce a comment.
4970
4971 Any non-comment line can be continued by ending it with a backslash. Note that
4972 the general rule for white space means that trailing white space after the
4973 backslash and leading white space at the start of continuation
4974 lines is ignored. Comment lines beginning with # (but not empty lines) may
4975 appear in the middle of a sequence of continuation lines.
4976
4977 A convenient way to create a configuration file is to start from the
4978 default, which is supplied in &_src/configure.default_&, and add, delete, or
4979 change settings as required.
4980
4981 The ACLs, retry rules, and rewriting rules have their own syntax which is
4982 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4983 respectively. The other parts of the configuration file have some syntactic
4984 items in common, and these are described below, from section &<<SECTcos>>&
4985 onwards. Before that, the inclusion, macro, and conditional facilities are
4986 described.
4987
4988
4989
4990 .section "File inclusions in the configuration file" "SECID41"
4991 .cindex "inclusions in configuration file"
4992 .cindex "configuration file" "including other files"
4993 .cindex "&`.include`& in configuration file"
4994 .cindex "&`.include_if_exists`& in configuration file"
4995 You can include other files inside Exim's runtime configuration file by
4996 using this syntax:
4997 .display
4998 &`.include`& <&'filename'&>
4999 &`.include_if_exists`& <&'filename'&>
5000 .endd
5001 on a line by itself. Double quotes round the filename are optional. If you use
5002 the first form, a configuration error occurs if the file does not exist; the
5003 second form does nothing for non-existent files.
5004 The first form allows a relative name. It is resolved relative to
5005 the directory of the including file. For the second form an absolute filename
5006 is required.
5007
5008 Includes may be nested to any depth, but remember that Exim reads its
5009 configuration file often, so it is a good idea to keep them to a minimum.
5010 If you change the contents of an included file, you must HUP the daemon,
5011 because an included file is read only when the configuration itself is read.
5012
5013 The processing of inclusions happens early, at a physical line level, so, like
5014 comment lines, an inclusion can be used in the middle of an option setting,
5015 for example:
5016 .code
5017 hosts_lookup = a.b.c \
5018                .include /some/file
5019 .endd
5020 Include processing happens after macro processing (see below). Its effect is to
5021 process the lines of the included file as if they occurred inline where the
5022 inclusion appears.
5023
5024
5025
5026 .section "Macros in the configuration file" "SECTmacrodefs"
5027 .cindex "macro" "description of"
5028 .cindex "configuration file" "macros"
5029 If a line in the main part of the configuration (that is, before the first
5030 &"begin"& line) begins with an upper case letter, it is taken as a macro
5031 definition, and must be of the form
5032 .display
5033 <&'name'&> = <&'rest of line'&>
5034 .endd
5035 The name must consist of letters, digits, and underscores, and need not all be
5036 in upper case, though that is recommended. The rest of the line, including any
5037 continuations, is the replacement text, and has leading and trailing white
5038 space removed. Quotes are not removed. The replacement text can never end with
5039 a backslash character, but this doesn't seem to be a serious limitation.
5040
5041 Macros may also be defined between router, transport, authenticator, or ACL
5042 definitions. They may not, however, be defined within an individual driver or
5043 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5044
5045 .section "Macro substitution" "SECID42"
5046 Once a macro is defined, all subsequent lines in the file (and any included
5047 files) are scanned for the macro name; if there are several macros, the line is
5048 scanned for each, in turn, in the order in which the macros are defined. The
5049 replacement text is not re-scanned for the current macro, though it is scanned
5050 for subsequently defined macros. For this reason, a macro name may not contain
5051 the name of a previously defined macro as a substring. You could, for example,
5052 define
5053 .display
5054 &`ABCD_XYZ = `&<&'something'&>
5055 &`ABCD = `&<&'something else'&>
5056 .endd
5057 but putting the definitions in the opposite order would provoke a configuration
5058 error. Macro expansion is applied to individual physical lines from the file,
5059 before checking for line continuation or file inclusion (see above). If a line
5060 consists solely of a macro name, and the expansion of the macro is empty, the
5061 line is ignored. A macro at the start of a line may turn the line into a
5062 comment line or a &`.include`& line.
5063
5064
5065 .section "Redefining macros" "SECID43"
5066 Once defined, the value of a macro can be redefined later in the configuration
5067 (or in an included file). Redefinition is specified by using &'=='& instead of
5068 &'='&. For example:
5069 .code
5070 MAC =  initial value
5071 ...
5072 MAC == updated value
5073 .endd
5074 Redefinition does not alter the order in which the macros are applied to the
5075 subsequent lines of the configuration file. It is still the same order in which
5076 the macros were originally defined. All that changes is the macro's value.
5077 Redefinition makes it possible to accumulate values. For example:
5078 .code
5079 MAC =  initial value
5080 ...
5081 MAC == MAC and something added
5082 .endd
5083 This can be helpful in situations where the configuration file is built
5084 from a number of other files.
5085
5086 .section "Overriding macro values" "SECID44"
5087 The values set for macros in the configuration file can be overridden by the
5088 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5089 used, unless called by root or the Exim user. A definition on the command line
5090 using the &%-D%& option causes all definitions and redefinitions within the
5091 file to be ignored.
5092
5093
5094
5095 .section "Example of macro usage" "SECID45"
5096 As an example of macro usage, consider a configuration where aliases are looked
5097 up in a MySQL database. It helps to keep the file less cluttered if long
5098 strings such as SQL statements are defined separately as macros, for example:
5099 .code
5100 ALIAS_QUERY = select mailbox from user where \
5101               login='${quote_mysql:$local_part}';
5102 .endd
5103 This can then be used in a &(redirect)& router setting like this:
5104 .code
5105 data = ${lookup mysql{ALIAS_QUERY}}
5106 .endd
5107 In earlier versions of Exim macros were sometimes used for domain, host, or
5108 address lists. In Exim 4 these are handled better by named lists &-- see
5109 section &<<SECTnamedlists>>&.
5110
5111
5112 .section "Builtin macros" "SECTbuiltinmacros"
5113 Exim defines some macros depending on facilities available, which may
5114 differ due to build-time definitions and from one release to another.
5115 All of these macros start with an underscore.
5116 They can be used to conditionally include parts of a configuration
5117 (see below).
5118
5119 The following classes of macros are defined:
5120 .display
5121 &` _HAVE_*                    `&  build-time defines
5122 &` _DRIVER_ROUTER_*           `&  router drivers
5123 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5124 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5125 &` _LOG_*                     `&  log_selector values
5126 &` _OPT_MAIN_*                `&  main config options
5127 &` _OPT_ROUTERS_*             `&  generic router options
5128 &` _OPT_TRANSPORTS_*          `&  generic transport options
5129 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5130 &` _OPT_ROUTER_*_*            `&  private router options
5131 &` _OPT_TRANSPORT_*_*         `&  private transport options
5132 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5133 .endd
5134
5135 Use an &"exim -bP macros"& command to get the list of macros.
5136
5137
5138 .section "Conditional skips in the configuration file" "SECID46"
5139 .cindex "configuration file" "conditional skips"
5140 .cindex "&`.ifdef`&"
5141 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5142 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5143 portions of the configuration file. The processing happens whenever the file is
5144 read (that is, when an Exim binary starts to run).
5145
5146 The implementation is very simple. Instances of the first four directives must
5147 be followed by text that includes the names of one or macros. The condition
5148 that is tested is whether or not any macro substitution has taken place in the
5149 line. Thus:
5150 .code
5151 .ifdef AAA
5152 message_size_limit = 50M
5153 .else
5154 message_size_limit = 100M
5155 .endif
5156 .endd
5157 sets a message size limit of 50M if the macro &`AAA`& is defined
5158 (or &`A`& or &`AA`&), and 100M
5159 otherwise. If there is more than one macro named on the line, the condition
5160 is true if any of them are defined. That is, it is an &"or"& condition. To
5161 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5162
5163 Although you can use a macro expansion to generate one of these directives,
5164 it is not very useful, because the condition &"there was a macro substitution
5165 in this line"& will always be true.
5166
5167 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5168 to clarify complicated nestings.
5169
5170
5171
5172 .section "Common option syntax" "SECTcos"
5173 .cindex "common option syntax"
5174 .cindex "syntax of common options"
5175 .cindex "configuration file" "common option syntax"
5176 For the main set of options, driver options, and &[local_scan()]& options,
5177 each setting is on a line by itself, and starts with a name consisting of
5178 lower-case letters and underscores. Many options require a data value, and in
5179 these cases the name must be followed by an equals sign (with optional white
5180 space) and then the value. For example:
5181 .code
5182 qualify_domain = mydomain.example.com
5183 .endd
5184 .cindex "hiding configuration option values"
5185 .cindex "configuration options" "hiding value of"
5186 .cindex "options" "hiding value of"
5187 Some option settings may contain sensitive data, for example, passwords for
5188 accessing databases. To stop non-admin users from using the &%-bP%& command
5189 line option to read these values, you can precede the option settings with the
5190 word &"hide"&. For example:
5191 .code
5192 hide mysql_servers = localhost/users/admin/secret-password
5193 .endd
5194 For non-admin users, such options are displayed like this:
5195 .code
5196 mysql_servers = <value not displayable>
5197 .endd
5198 If &"hide"& is used on a driver option, it hides the value of that option on
5199 all instances of the same driver.
5200
5201 The following sections describe the syntax used for the different data types
5202 that are found in option settings.
5203
5204
5205 .section "Boolean options" "SECID47"
5206 .cindex "format" "boolean"
5207 .cindex "boolean configuration values"
5208 .oindex "&%no_%&&'xxx'&"
5209 .oindex "&%not_%&&'xxx'&"
5210 Options whose type is given as boolean are on/off switches. There are two
5211 different ways of specifying such options: with and without a data value. If
5212 the option name is specified on its own without data, the switch is turned on;
5213 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5214 boolean options may be followed by an equals sign and one of the words
5215 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5216 the following two settings have exactly the same effect:
5217 .code
5218 queue_only
5219 queue_only = true
5220 .endd
5221 The following two lines also have the same (opposite) effect:
5222 .code
5223 no_queue_only
5224 queue_only = false
5225 .endd
5226 You can use whichever syntax you prefer.
5227
5228
5229
5230
5231 .section "Integer values" "SECID48"
5232 .cindex "integer configuration values"
5233 .cindex "format" "integer"
5234 If an option's type is given as &"integer"&, the value can be given in decimal,
5235 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5236 number is assumed. Otherwise, it is treated as an octal number unless it starts
5237 with the characters &"0x"&, in which case the remainder is interpreted as a
5238 hexadecimal number.
5239
5240 If an integer value is followed by the letter K, it is multiplied by 1024; if
5241 it is followed by the letter M, it is multiplied by 1024x1024;
5242 if by the letter G, 1024x1024x1024.
5243 When the values
5244 of integer option settings are output, values which are an exact multiple of
5245 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5246 and M. The printing style is independent of the actual input format that was
5247 used.
5248
5249
5250 .section "Octal integer values" "SECID49"
5251 .cindex "integer format"
5252 .cindex "format" "octal integer"
5253 If an option's type is given as &"octal integer"&, its value is always
5254 interpreted as an octal number, whether or not it starts with the digit zero.
5255 Such options are always output in octal.
5256
5257
5258 .section "Fixed point numbers" "SECID50"
5259 .cindex "fixed point configuration values"
5260 .cindex "format" "fixed point"
5261 If an option's type is given as &"fixed-point"&, its value must be a decimal
5262 integer, optionally followed by a decimal point and up to three further digits.
5263
5264
5265
5266 .section "Time intervals" "SECTtimeformat"
5267 .cindex "time interval" "specifying in configuration"
5268 .cindex "format" "time interval"
5269 A time interval is specified as a sequence of numbers, each followed by one of
5270 the following letters, with no intervening white space:
5271
5272 .table2 30pt
5273 .irow &%s%& seconds
5274 .irow &%m%& minutes
5275 .irow &%h%& hours
5276 .irow &%d%& days
5277 .irow &%w%& weeks
5278 .endtable
5279
5280 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5281 intervals are output in the same format. Exim does not restrict the values; it
5282 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5283
5284
5285
5286 .section "String values" "SECTstrings"
5287 .cindex "string" "format of configuration values"
5288 .cindex "format" "string"
5289 If an option's type is specified as &"string"&, the value can be specified with
5290 or without double-quotes. If it does not start with a double-quote, the value
5291 consists of the remainder of the line plus any continuation lines, starting at
5292 the first character after any leading white space, with trailing white space
5293 removed, and with no interpretation of the characters in the string. Because
5294 Exim removes comment lines (those beginning with #) at an early stage, they can
5295 appear in the middle of a multi-line string. The following two settings are
5296 therefore equivalent:
5297 .code
5298 trusted_users = uucp:mail
5299 trusted_users = uucp:\
5300                 # This comment line is ignored
5301                 mail
5302 .endd
5303 .cindex "string" "quoted"
5304 .cindex "escape characters in quoted strings"
5305 If a string does start with a double-quote, it must end with a closing
5306 double-quote, and any backslash characters other than those used for line
5307 continuation are interpreted as escape characters, as follows:
5308
5309 .table2 100pt
5310 .irow &`\\`&                     "single backslash"
5311 .irow &`\n`&                     "newline"
5312 .irow &`\r`&                     "carriage return"
5313 .irow &`\t`&                     "tab"
5314 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5315 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5316                                    character"
5317 .endtable
5318
5319 If a backslash is followed by some other character, including a double-quote
5320 character, that character replaces the pair.
5321
5322 Quoting is necessary only if you want to make use of the backslash escapes to
5323 insert special characters, or if you need to specify a value with leading or
5324 trailing spaces. These cases are rare, so quoting is almost never needed in
5325 current versions of Exim. In versions of Exim before 3.14, quoting was required
5326 in order to continue lines, so you may come across older configuration files
5327 and examples that apparently quote unnecessarily.
5328
5329
5330 .section "Expanded strings" "SECID51"
5331 .cindex "expansion" "definition of"
5332 Some strings in the configuration file are subjected to &'string expansion'&,
5333 by which means various parts of the string may be changed according to the
5334 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5335 is as just described; in particular, the handling of backslashes in quoted
5336 strings is done as part of the input process, before expansion takes place.
5337 However, backslash is also an escape character for the expander, so any
5338 backslashes that are required for that reason must be doubled if they are
5339 within a quoted configuration string.
5340
5341
5342 .section "User and group names" "SECID52"
5343 .cindex "user name" "format of"
5344 .cindex "format" "user name"
5345 .cindex "groups" "name format"
5346 .cindex "format" "group name"
5347 User and group names are specified as strings, using the syntax described
5348 above, but the strings are interpreted specially. A user or group name must
5349 either consist entirely of digits, or be a name that can be looked up using the
5350 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5351
5352
5353 .section "List construction" "SECTlistconstruct"
5354 .cindex "list" "syntax of in configuration"
5355 .cindex "format" "list item in configuration"
5356 .cindex "string" "list, definition of"
5357 The data for some configuration options is a list of items, with colon as the
5358 default separator. Many of these options are shown with type &"string list"& in
5359 the descriptions later in this document. Others are listed as &"domain list"&,
5360 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5361 are all the same; however, those other than &"string list"& are subject to
5362 particular kinds of interpretation, as described in chapter
5363 &<<CHAPdomhosaddlists>>&.
5364
5365 In all these cases, the entire list is treated as a single string as far as the
5366 input syntax is concerned. The &%trusted_users%& setting in section
5367 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5368 in a list, it must be entered as two colons. Leading and trailing white space
5369 on each item in a list is ignored. This makes it possible to include items that
5370 start with a colon, and in particular, certain forms of IPv6 address. For
5371 example, the list
5372 .code
5373 local_interfaces = 127.0.0.1 : ::::1
5374 .endd
5375 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5376
5377 &*Note*&: Although leading and trailing white space is ignored in individual
5378 list items, it is not ignored when parsing the list. The space after the first
5379 colon in the example above is necessary. If it were not there, the list would
5380 be interpreted as the two items 127.0.0.1:: and 1.
5381
5382 .section "Changing list separators" "SECTlistsepchange"
5383 .cindex "list separator" "changing"
5384 .cindex "IPv6" "addresses in lists"
5385 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5386 introduced to allow the separator character to be changed. If a list begins
5387 with a left angle bracket, followed by any punctuation character, that
5388 character is used instead of colon as the list separator. For example, the list
5389 above can be rewritten to use a semicolon separator like this:
5390 .code
5391 local_interfaces = <; 127.0.0.1 ; ::1
5392 .endd
5393 This facility applies to all lists, with the exception of the list in
5394 &%log_file_path%&. It is recommended that the use of non-colon separators be
5395 confined to circumstances where they really are needed.
5396
5397 .cindex "list separator" "newline as"
5398 .cindex "newline" "as list separator"
5399 It is also possible to use newline and other control characters (those with
5400 code values less than 32, plus DEL) as separators in lists. Such separators
5401 must be provided literally at the time the list is processed. For options that
5402 are string-expanded, you can write the separator using a normal escape
5403 sequence. This will be processed by the expander before the string is
5404 interpreted as a list. For example, if a newline-separated list of domains is
5405 generated by a lookup, you can process it directly by a line such as this:
5406 .code
5407 domains = <\n ${lookup mysql{.....}}
5408 .endd
5409 This avoids having to change the list separator in such data. You are unlikely
5410 to want to use a control character as a separator in an option that is not
5411 expanded, because the value is literal text. However, it can be done by giving
5412 the value in quotes. For example:
5413 .code
5414 local_interfaces = "<\n 127.0.0.1 \n ::1"
5415 .endd
5416 Unlike printing character separators, which can be included in list items by
5417 doubling, it is not possible to include a control character as data when it is
5418 set as the separator. Two such characters in succession are interpreted as
5419 enclosing an empty list item.
5420
5421
5422
5423 .section "Empty items in lists" "SECTempitelis"
5424 .cindex "list" "empty item in"
5425 An empty item at the end of a list is always ignored. In other words, trailing
5426 separator characters are ignored. Thus, the list in
5427 .code
5428 senders = user@domain :
5429 .endd
5430 contains only a single item. If you want to include an empty string as one item
5431 in a list, it must not be the last item. For example, this list contains three
5432 items, the second of which is empty:
5433 .code
5434 senders = user1@domain : : user2@domain
5435 .endd
5436 &*Note*&: There must be white space between the two colons, as otherwise they
5437 are interpreted as representing a single colon data character (and the list
5438 would then contain just one item). If you want to specify a list that contains
5439 just one, empty item, you can do it as in this example:
5440 .code
5441 senders = :
5442 .endd
5443 In this case, the first item is empty, and the second is discarded because it
5444 is at the end of the list.
5445
5446
5447
5448
5449 .section "Format of driver configurations" "SECTfordricon"
5450 .cindex "drivers" "configuration format"
5451 There are separate parts in the configuration for defining routers, transports,
5452 and authenticators. In each part, you are defining a number of driver
5453 instances, each with its own set of options. Each driver instance is defined by
5454 a sequence of lines like this:
5455 .display
5456 <&'instance name'&>:
5457   <&'option'&>
5458   ...
5459   <&'option'&>
5460 .endd
5461 In the following example, the instance name is &(localuser)&, and it is
5462 followed by three options settings:
5463 .code
5464 localuser:
5465   driver = accept
5466   check_local_user
5467   transport = local_delivery
5468 .endd
5469 For each driver instance, you specify which Exim code module it uses &-- by the
5470 setting of the &%driver%& option &-- and (optionally) some configuration
5471 settings. For example, in the case of transports, if you want a transport to
5472 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5473 a local file you would use the &(appendfile)& driver. Each of the drivers is
5474 described in detail in its own separate chapter later in this manual.
5475
5476 You can have several routers, transports, or authenticators that are based on
5477 the same underlying driver (each must have a different instance name).
5478
5479 The order in which routers are defined is important, because addresses are
5480 passed to individual routers one by one, in order. The order in which
5481 transports are defined does not matter at all. The order in which
5482 authenticators are defined is used only when Exim, as a client, is searching
5483 them to find one that matches an authentication mechanism offered by the
5484 server.
5485
5486 .cindex "generic options"
5487 .cindex "options" "generic &-- definition of"
5488 Within a driver instance definition, there are two kinds of option: &'generic'&
5489 and &'private'&. The generic options are those that apply to all drivers of the
5490 same type (that is, all routers, all transports or all authenticators). The
5491 &%driver%& option is a generic option that must appear in every definition.
5492 .cindex "private options"
5493 The private options are special for each driver, and none need appear, because
5494 they all have default values.
5495
5496 The options may appear in any order, except that the &%driver%& option must
5497 precede any private options, since these depend on the particular driver. For
5498 this reason, it is recommended that &%driver%& always be the first option.
5499
5500 Driver instance names, which are used for reference in log entries and
5501 elsewhere, can be any sequence of letters, digits, and underscores (starting
5502 with a letter) and must be unique among drivers of the same type. A router and
5503 a transport (for example) can each have the same name, but no two router
5504 instances can have the same name. The name of a driver instance should not be
5505 confused with the name of the underlying driver module. For example, the
5506 configuration lines:
5507 .code
5508 remote_smtp:
5509   driver = smtp
5510 .endd
5511 create an instance of the &(smtp)& transport driver whose name is
5512 &(remote_smtp)&. The same driver code can be used more than once, with
5513 different instance names and different option settings each time. A second
5514 instance of the &(smtp)& transport, with different options, might be defined
5515 thus:
5516 .code
5517 special_smtp:
5518   driver = smtp
5519   port = 1234
5520   command_timeout = 10s
5521 .endd
5522 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5523 these transport instances from routers, and these names would appear in log
5524 lines.
5525
5526 Comment lines may be present in the middle of driver specifications. The full
5527 list of option settings for any particular driver instance, including all the
5528 defaulted values, can be extracted by making use of the &%-bP%& command line
5529 option.
5530
5531
5532
5533
5534
5535
5536 . ////////////////////////////////////////////////////////////////////////////
5537 . ////////////////////////////////////////////////////////////////////////////
5538
5539 .chapter "The default configuration file" "CHAPdefconfil"
5540 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5541 .cindex "default" "configuration file &""walk through""&"
5542 The default configuration file supplied with Exim as &_src/configure.default_&
5543 is sufficient for a host with simple mail requirements. As an introduction to
5544 the way Exim is configured, this chapter &"walks through"& the default
5545 configuration, giving brief explanations of the settings. Detailed descriptions
5546 of the options are given in subsequent chapters. The default configuration file
5547 itself contains extensive comments about ways you might want to modify the
5548 initial settings. However, note that there are many options that are not
5549 mentioned at all in the default configuration.
5550
5551
5552
5553 .section "Macros" "SECTdefconfmacros"
5554 All macros should be defined before any options.
5555
5556 One macro is specified, but commented out, in the default configuration:
5557 .code
5558 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5559 .endd
5560 If all off-site mail is expected to be delivered to a "smarthost", then set the
5561 hostname here and uncomment the macro.  This will affect which router is used
5562 later on.  If this is left commented out, then Exim will perform direct-to-MX
5563 deliveries using a &(dnslookup)& router.
5564
5565 In addition to macros defined here, Exim includes a number of built-in macros
5566 to enable configuration to be guarded by a binary built with support for a
5567 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5568
5569
5570 .section "Main configuration settings" "SECTdefconfmain"
5571 The main (global) configuration option settings section must always come first
5572 in the file, after the macros.
5573 The first thing you'll see in the file, after some initial comments, is the line
5574 .code
5575 # primary_hostname =
5576 .endd
5577 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5578 to know the official, fully qualified name of your host, and this is where you
5579 can specify it. However, in most cases you do not need to set this option. When
5580 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5581
5582 The first three non-comment configuration lines are as follows:
5583 .code
5584 domainlist local_domains    = @
5585 domainlist relay_to_domains =
5586 hostlist   relay_from_hosts = 127.0.0.1
5587 .endd
5588 These are not, in fact, option settings. They are definitions of two named
5589 domain lists and one named host list. Exim allows you to give names to lists of
5590 domains, hosts, and email addresses, in order to make it easier to manage the
5591 configuration file (see section &<<SECTnamedlists>>&).
5592
5593 The first line defines a domain list called &'local_domains'&; this is used
5594 later in the configuration to identify domains that are to be delivered
5595 on the local host.
5596
5597 .cindex "@ in a domain list"
5598 There is just one item in this list, the string &"@"&. This is a special form
5599 of entry which means &"the name of the local host"&. Thus, if the local host is
5600 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5601 be delivered locally. Because the local host's name is referenced indirectly,
5602 the same configuration file can be used on different hosts.
5603
5604 The second line defines a domain list called &'relay_to_domains'&, but the
5605 list itself is empty. Later in the configuration we will come to the part that
5606 controls mail relaying through the local host; it allows relaying to any
5607 domains in this list. By default, therefore, no relaying on the basis of a mail
5608 domain is permitted.
5609
5610 The third line defines a host list called &'relay_from_hosts'&. This list is
5611 used later in the configuration to permit relaying from any host or IP address
5612 that matches the list. The default contains just the IP address of the IPv4
5613 loopback interface, which means that processes on the local host are able to
5614 submit mail for relaying by sending it over TCP/IP to that interface. No other
5615 hosts are permitted to submit messages for relaying.
5616
5617 Just to be sure there's no misunderstanding: at this point in the configuration
5618 we aren't actually setting up any controls. We are just defining some domains
5619 and hosts that will be used in the controls that are specified later.
5620
5621 The next two configuration lines are genuine option settings:
5622 .code
5623 acl_smtp_rcpt = acl_check_rcpt
5624 acl_smtp_data = acl_check_data
5625 .endd
5626 These options specify &'Access Control Lists'& (ACLs) that are to be used
5627 during an incoming SMTP session for every recipient of a message (every RCPT
5628 command), and after the contents of the message have been received,
5629 respectively. The names of the lists are &'acl_check_rcpt'& and
5630 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5631 section of the configuration. The RCPT ACL controls which recipients are
5632 accepted for an incoming message &-- if a configuration does not provide an ACL
5633 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5634 contents of a message to be checked.
5635
5636 Two commented-out option settings are next:
5637 .code
5638 # av_scanner = clamd:/tmp/clamd
5639 # spamd_address = 127.0.0.1 783
5640 .endd
5641 These are example settings that can be used when Exim is compiled with the
5642 content-scanning extension. The first specifies the interface to the virus
5643 scanner, and the second specifies the interface to SpamAssassin. Further
5644 details are given in chapter &<<CHAPexiscan>>&.
5645
5646 Three more commented-out option settings follow:
5647 .code
5648 # tls_advertise_hosts = *
5649 # tls_certificate = /etc/ssl/exim.crt
5650 # tls_privatekey = /etc/ssl/exim.pem
5651 .endd
5652 These are example settings that can be used when Exim is compiled with
5653 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5654 first one specifies the list of clients that are allowed to use TLS when
5655 connecting to this server; in this case, the wildcard means all clients. The
5656 other options specify where Exim should find its TLS certificate and private
5657 key, which together prove the server's identity to any clients that connect.
5658 More details are given in chapter &<<CHAPTLS>>&.
5659
5660 Another two commented-out option settings follow:
5661 .code
5662 # daemon_smtp_ports = 25 : 465 : 587
5663 # tls_on_connect_ports = 465
5664 .endd
5665 .cindex "port" "465 and 587"
5666 .cindex "port" "for message submission"
5667 .cindex "message" "submission, ports for"
5668 .cindex "submissions protocol"
5669 .cindex "smtps protocol"
5670 .cindex "ssmtp protocol"
5671 .cindex "SMTP" "submissions protocol"
5672 .cindex "SMTP" "ssmtp protocol"
5673 .cindex "SMTP" "smtps protocol"
5674 These options provide better support for roaming users who wish to use this
5675 server for message submission. They are not much use unless you have turned on
5676 TLS (as described in the previous paragraph) and authentication (about which
5677 more in section &<<SECTdefconfauth>>&).
5678 Mail submission from mail clients (MUAs) should be separate from inbound mail
5679 to your domain (MX delivery) for various good reasons (eg, ability to impose
5680 much saner TLS protocol and ciphersuite requirements without unintended
5681 consequences).
5682 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5683 which uses STARTTLS, so this is the &"submission"& port.
5684 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5685 which should be used in preference to 587.
5686 You should also consider deploying SRV records to help clients find
5687 these ports.
5688 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5689
5690 Two more commented-out options settings follow:
5691 .code
5692 # qualify_domain =
5693 # qualify_recipient =
5694 .endd
5695 The first of these specifies a domain that Exim uses when it constructs a
5696 complete email address from a local login name. This is often needed when Exim
5697 receives a message from a local process. If you do not set &%qualify_domain%&,
5698 the value of &%primary_hostname%& is used. If you set both of these options,
5699 you can have different qualification domains for sender and recipient
5700 addresses. If you set only the first one, its value is used in both cases.
5701
5702 .cindex "domain literal" "recognizing format"
5703 The following line must be uncommented if you want Exim to recognize
5704 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5705 (an IP address within square brackets) instead of a named domain.
5706 .code
5707 # allow_domain_literals
5708 .endd
5709 The RFCs still require this form, but many people think that in the modern
5710 Internet it makes little sense to permit mail to be sent to specific hosts by
5711 quoting their IP addresses. This ancient format has been used by people who
5712 try to abuse hosts by using them for unwanted relaying. However, some
5713 people believe there are circumstances (for example, messages addressed to
5714 &'postmaster'&) where domain literals are still useful.
5715
5716 The next configuration line is a kind of trigger guard:
5717 .code
5718 never_users = root
5719 .endd
5720 It specifies that no delivery must ever be run as the root user. The normal
5721 convention is to set up &'root'& as an alias for the system administrator. This
5722 setting is a guard against slips in the configuration.
5723 The list of users specified by &%never_users%& is not, however, the complete
5724 list; the build-time configuration in &_Local/Makefile_& has an option called
5725 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5726 contents of &%never_users%& are added to this list. By default
5727 FIXED_NEVER_USERS also specifies root.
5728
5729 When a remote host connects to Exim in order to send mail, the only information
5730 Exim has about the host's identity is its IP address. The next configuration
5731 line,
5732 .code
5733 host_lookup = *
5734 .endd
5735 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5736 in order to get a host name. This improves the quality of the logging
5737 information, but if you feel it is too expensive, you can remove it entirely,
5738 or restrict the lookup to hosts on &"nearby"& networks.
5739 Note that it is not always possible to find a host name from an IP address,
5740 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5741 unreachable.
5742
5743 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5744 1413 (hence their names):
5745 .code
5746 rfc1413_hosts = *
5747 rfc1413_query_timeout = 0s
5748 .endd
5749 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5750 Few hosts offer RFC1413 service these days; calls have to be
5751 terminated by a timeout and this needlessly delays the startup
5752 of an incoming SMTP connection.
5753 If you have hosts for which you trust RFC1413 and need this
5754 information, you can change this.
5755
5756 This line enables an efficiency SMTP option.  It is negotiated by clients
5757 and not expected to cause problems but can be disabled if needed.
5758 .code
5759 prdr_enable = true
5760 .endd
5761
5762 When Exim receives messages over SMTP connections, it expects all addresses to
5763 be fully qualified with a domain, as required by the SMTP definition. However,
5764 if you are running a server to which simple clients submit messages, you may
5765 find that they send unqualified addresses. The two commented-out options:
5766 .code
5767 # sender_unqualified_hosts =
5768 # recipient_unqualified_hosts =
5769 .endd
5770 show how you can specify hosts that are permitted to send unqualified sender
5771 and recipient addresses, respectively.
5772
5773 The &%log_selector%& option is used to increase the detail of logging
5774 over the default:
5775 .code
5776 log_selector = +smtp_protocol_error +smtp_syntax_error \
5777                +tls_certificate_verified
5778 .endd
5779
5780 The &%percent_hack_domains%& option is also commented out:
5781 .code
5782 # percent_hack_domains =
5783 .endd
5784 It provides a list of domains for which the &"percent hack"& is to operate.
5785 This is an almost obsolete form of explicit email routing. If you do not know
5786 anything about it, you can safely ignore this topic.
5787
5788 The next two settings in the main part of the default configuration are
5789 concerned with messages that have been &"frozen"& on Exim's queue. When a
5790 message is frozen, Exim no longer continues to try to deliver it. Freezing
5791 occurs when a bounce message encounters a permanent failure because the sender
5792 address of the original message that caused the bounce is invalid, so the
5793 bounce cannot be delivered. This is probably the most common case, but there
5794 are also other conditions that cause freezing, and frozen messages are not
5795 always bounce messages.
5796 .code
5797 ignore_bounce_errors_after = 2d
5798 timeout_frozen_after = 7d
5799 .endd
5800 The first of these options specifies that failing bounce messages are to be
5801 discarded after 2 days in the queue. The second specifies that any frozen
5802 message (whether a bounce message or not) is to be timed out (and discarded)
5803 after a week. In this configuration, the first setting ensures that no failing
5804 bounce message ever lasts a week.
5805
5806 Exim queues it's messages in a spool directory. If you expect to have
5807 large queues, you may consider using this option. It splits the spool
5808 directory into subdirectories to avoid file system degradation from
5809 many files in a single directory, resulting in better performance.
5810 Manual manipulation of queued messages becomes more complex (though fortunately
5811 not often needed).
5812 .code
5813 # split_spool_directory = true
5814 .endd
5815
5816 In an ideal world everybody follows the standards. For non-ASCII
5817 messages RFC 2047 is a standard, allowing a maximum line length of 76
5818 characters. Exim adheres that standard and won't process messages which
5819 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5820 In particular, the Exim maintainers have had multiple reports of
5821 problems from Russian administrators of issues until they disable this
5822 check, because of some popular, yet buggy, mail composition software.
5823 .code
5824 # check_rfc2047_length = false
5825 .endd
5826
5827 If you need to be strictly RFC compliant you may wish to disable the
5828 8BITMIME advertisement. Use this, if you exchange mails with systems
5829 that are not 8-bit clean.
5830 .code
5831 # accept_8bitmime = false
5832 .endd
5833
5834 Libraries you use may depend on specific environment settings.  This
5835 imposes a security risk (e.g. PATH). There are two lists:
5836 &%keep_environment%& for the variables to import as they are, and
5837 &%add_environment%& for variables we want to set to a fixed value.
5838 Note that TZ is handled separately, by the $%timezone%$ runtime
5839 option and by the TIMEZONE_DEFAULT buildtime option.
5840 .code
5841 # keep_environment = ^LDAP
5842 # add_environment = PATH=/usr/bin::/bin
5843 .endd
5844
5845
5846 .section "ACL configuration" "SECID54"
5847 .cindex "default" "ACLs"
5848 .cindex "&ACL;" "default configuration"
5849 In the default configuration, the ACL section follows the main configuration.
5850 It starts with the line
5851 .code
5852 begin acl
5853 .endd
5854 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5855 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5856 and &%acl_smtp_data%& above.
5857
5858 .cindex "RCPT" "ACL for"
5859 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5860 RCPT command specifies one of the message's recipients. The ACL statements
5861 are considered in order, until the recipient address is either accepted or
5862 rejected. The RCPT command is then accepted or rejected, according to the
5863 result of the ACL processing.
5864 .code
5865 acl_check_rcpt:
5866 .endd
5867 This line, consisting of a name terminated by a colon, marks the start of the
5868 ACL, and names it.
5869 .code
5870 accept  hosts = :
5871 .endd
5872 This ACL statement accepts the recipient if the sending host matches the list.
5873 But what does that strange list mean? It doesn't actually contain any host
5874 names or IP addresses. The presence of the colon puts an empty item in the
5875 list; Exim matches this only if the incoming message did not come from a remote
5876 host, because in that case, the remote hostname is empty. The colon is
5877 important. Without it, the list itself is empty, and can never match anything.
5878
5879 What this statement is doing is to accept unconditionally all recipients in
5880 messages that are submitted by SMTP from local processes using the standard
5881 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5882 manner.
5883 .code
5884 deny    message       = Restricted characters in address
5885         domains       = +local_domains
5886         local_parts   = ^[.] : ^.*[@%!/|]
5887
5888 deny    message       = Restricted characters in address
5889         domains       = !+local_domains
5890         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5891 .endd
5892 These statements are concerned with local parts that contain any of the
5893 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5894 Although these characters are entirely legal in local parts (in the case of
5895 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5896 in Internet mail addresses.
5897
5898 The first three have in the past been associated with explicitly routed
5899 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5900 option). Addresses containing these characters are regularly tried by spammers
5901 in an attempt to bypass relaying restrictions, and also by open relay testing
5902 programs. Unless you really need them it is safest to reject these characters
5903 at this early stage. This configuration is heavy-handed in rejecting these
5904 characters for all messages it accepts from remote hosts. This is a deliberate
5905 policy of being as safe as possible.
5906
5907 The first rule above is stricter, and is applied to messages that are addressed
5908 to one of the local domains handled by this host. This is implemented by the
5909 first condition, which restricts it to domains that are listed in the
5910 &'local_domains'& domain list. The &"+"& character is used to indicate a
5911 reference to a named list. In this configuration, there is just one domain in
5912 &'local_domains'&, but in general there may be many.
5913
5914 The second condition on the first statement uses two regular expressions to
5915 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5916 or &"|"&. If you have local accounts that include these characters, you will
5917 have to modify this rule.
5918
5919 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5920 allows them because they have been encountered in practice. (Consider the
5921 common convention of local parts constructed as
5922 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5923 the author of Exim, who has no second initial.) However, a local part starting
5924 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5925 filename (for example, for a mailing list). This is also true for local parts
5926 that contain slashes. A pipe symbol can also be troublesome if the local part
5927 is incorporated unthinkingly into a shell command line.
5928
5929 The second rule above applies to all other domains, and is less strict. This
5930 allows your own users to send outgoing messages to sites that use slashes
5931 and vertical bars in their local parts. It blocks local parts that begin
5932 with a dot, slash, or vertical bar, but allows these characters within the
5933 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5934 and &"!"& is blocked, as before. The motivation here is to prevent your users
5935 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5936 .code
5937 accept  local_parts   = postmaster
5938         domains       = +local_domains
5939 .endd
5940 This statement, which has two conditions, accepts an incoming address if the
5941 local part is &'postmaster'& and the domain is one of those listed in the
5942 &'local_domains'& domain list. The &"+"& character is used to indicate a
5943 reference to a named list. In this configuration, there is just one domain in
5944 &'local_domains'&, but in general there may be many.
5945
5946 The presence of this statement means that mail to postmaster is never blocked
5947 by any of the subsequent tests. This can be helpful while sorting out problems
5948 in cases where the subsequent tests are incorrectly denying access.
5949 .code
5950 require verify        = sender
5951 .endd
5952 This statement requires the sender address to be verified before any subsequent
5953 ACL statement can be used. If verification fails, the incoming recipient
5954 address is refused. Verification consists of trying to route the address, to
5955 see if a bounce message could be delivered to it. In the case of remote
5956 addresses, basic verification checks only the domain, but &'callouts'& can be
5957 used for more verification if required. Section &<<SECTaddressverification>>&
5958 discusses the details of address verification.
5959 .code
5960 accept  hosts         = +relay_from_hosts
5961         control       = submission
5962 .endd
5963 This statement accepts the address if the message is coming from one of the
5964 hosts that are defined as being allowed to relay through this host. Recipient
5965 verification is omitted here, because in many cases the clients are dumb MUAs
5966 that do not cope well with SMTP error responses. For the same reason, the
5967 second line specifies &"submission mode"& for messages that are accepted. This
5968 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5969 messages that are deficient in some way, for example, because they lack a
5970 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5971 probably add recipient verification here, and disable submission mode.
5972 .code
5973 accept  authenticated = *
5974         control       = submission
5975 .endd
5976 This statement accepts the address if the client host has authenticated itself.
5977 Submission mode is again specified, on the grounds that such messages are most
5978 likely to come from MUAs. The default configuration does not define any
5979 authenticators, though it does include some nearly complete commented-out
5980 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5981 fact authenticate until you complete the authenticator definitions.
5982 .code
5983 require message = relay not permitted
5984         domains = +local_domains : +relay_to_domains
5985 .endd
5986 This statement rejects the address if its domain is neither a local domain nor
5987 one of the domains for which this host is a relay.
5988 .code
5989 require verify = recipient
5990 .endd
5991 This statement requires the recipient address to be verified; if verification
5992 fails, the address is rejected.
5993 .code
5994 # deny    message     = rejected because $sender_host_address \
5995 #                       is in a black list at $dnslist_domain\n\
5996 #                       $dnslist_text
5997 #         dnslists    = black.list.example
5998 #
5999 # warn    dnslists    = black.list.example
6000 #         add_header  = X-Warning: $sender_host_address is in \
6001 #                       a black list at $dnslist_domain
6002 #         log_message = found in $dnslist_domain
6003 .endd
6004 These commented-out lines are examples of how you could configure Exim to check
6005 sending hosts against a DNS black list. The first statement rejects messages
6006 from blacklisted hosts, whereas the second just inserts a warning header
6007 line.
6008 .code
6009 # require verify = csa
6010 .endd
6011 This commented-out line is an example of how you could turn on client SMTP
6012 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6013 records.
6014 .code
6015 accept
6016 .endd
6017 The final statement in the first ACL unconditionally accepts any recipient
6018 address that has successfully passed all the previous tests.
6019 .code
6020 acl_check_data:
6021 .endd
6022 This line marks the start of the second ACL, and names it. Most of the contents
6023 of this ACL are commented out:
6024 .code
6025 # deny    malware   = *
6026 #         message   = This message contains a virus \
6027 #                     ($malware_name).
6028 .endd
6029 These lines are examples of how to arrange for messages to be scanned for
6030 viruses when Exim has been compiled with the content-scanning extension, and a
6031 suitable virus scanner is installed. If the message is found to contain a
6032 virus, it is rejected with the given custom error message.
6033 .code
6034 # warn    spam      = nobody
6035 #         message   = X-Spam_score: $spam_score\n\
6036 #                     X-Spam_score_int: $spam_score_int\n\
6037 #                     X-Spam_bar: $spam_bar\n\
6038 #                     X-Spam_report: $spam_report
6039 .endd
6040 These lines are an example of how to arrange for messages to be scanned by
6041 SpamAssassin when Exim has been compiled with the content-scanning extension,
6042 and SpamAssassin has been installed. The SpamAssassin check is run with
6043 &`nobody`& as its user parameter, and the results are added to the message as a
6044 series of extra header line. In this case, the message is not rejected,
6045 whatever the spam score.
6046 .code
6047 accept
6048 .endd
6049 This final line in the DATA ACL accepts the message unconditionally.
6050
6051
6052 .section "Router configuration" "SECID55"
6053 .cindex "default" "routers"
6054 .cindex "routers" "default"
6055 The router configuration comes next in the default configuration, introduced
6056 by the line
6057 .code
6058 begin routers
6059 .endd
6060 Routers are the modules in Exim that make decisions about where to send
6061 messages. An address is passed to each router, in turn, until it is either
6062 accepted, or failed. This means that the order in which you define the routers
6063 matters. Each router is fully described in its own chapter later in this
6064 manual. Here we give only brief overviews.
6065 .code
6066 # domain_literal:
6067 #   driver = ipliteral
6068 #   domains = !+local_domains
6069 #   transport = remote_smtp
6070 .endd
6071 .cindex "domain literal" "default router"
6072 This router is commented out because the majority of sites do not want to
6073 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6074 you uncomment this router, you also need to uncomment the setting of
6075 &%allow_domain_literals%& in the main part of the configuration.
6076
6077 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6078 macro has been defined, per
6079 .code
6080 .ifdef ROUTER_SMARTHOST
6081 smarthost:
6082 #...
6083 .else
6084 dnslookup:
6085 #...
6086 .endif
6087 .endd
6088
6089 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6090 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6091 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6092 skip these routers because of the &%domains%& option.
6093
6094 .code
6095 smarthost:
6096   driver = manualroute
6097   domains = ! +local_domains
6098   transport = smarthost_smtp
6099   route_data = ROUTER_SMARTHOST
6100   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6101   no_more
6102 .endd
6103 This router only handles mail which is not to any local domains; this is
6104 specified by the line
6105 .code
6106 domains = ! +local_domains
6107 .endd
6108 The &%domains%& option lists the domains to which this router applies, but the
6109 exclamation mark is a negation sign, so the router is used only for domains
6110 that are not in the domain list called &'local_domains'& (which was defined at
6111 the start of the configuration). The plus sign before &'local_domains'&
6112 indicates that it is referring to a named list. Addresses in other domains are
6113 passed on to the following routers.
6114
6115 The name of the router driver is &(manualroute)& because we are manually
6116 specifying how mail should be routed onwards, instead of using DNS MX.
6117 While the name of this router instance is arbitrary, the &%driver%& option must
6118 be one of the driver modules that is in the Exim binary.
6119
6120 With no pre-conditions other than &%domains%&, all mail for non-local domains
6121 will be handled by this router, and the &%no_more%& setting will ensure that no
6122 other routers will be used for messages matching the pre-conditions.  See
6123 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6124 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6125 and the macro supplies the value; the address is then queued for the
6126 &(smarthost_smtp)& transport.
6127
6128 .code
6129 dnslookup:
6130   driver = dnslookup
6131   domains = ! +local_domains
6132   transport = remote_smtp
6133   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6134   no_more
6135 .endd
6136 The &%domains%& option behaves as per smarthost, above.
6137
6138 The name of the router driver is &(dnslookup)&,
6139 and is specified by the &%driver%& option. Do not be confused by the fact that
6140 the name of this router instance is the same as the name of the driver. The
6141 instance name is arbitrary, but the name set in the &%driver%& option must be
6142 one of the driver modules that is in the Exim binary.
6143
6144 The &(dnslookup)& router routes addresses by looking up their domains in the
6145 DNS in order to obtain a list of hosts to which the address is routed. If the
6146 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6147 specified by the &%transport%& option. If the router does not find the domain
6148 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6149 the address fails and is bounced.
6150
6151 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6152 be entirely ignored. This option is present because a number of cases have been
6153 encountered where MX records in the DNS point to host names
6154 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6155 Completely ignoring these IP addresses causes Exim to fail to route the
6156 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6157 continue to try to deliver the message periodically until the address timed
6158 out.
6159 .code
6160 system_aliases:
6161   driver = redirect
6162   allow_fail
6163   allow_defer
6164   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6165 # user = exim
6166   file_transport = address_file
6167   pipe_transport = address_pipe
6168 .endd
6169 Control reaches this and subsequent routers only for addresses in the local
6170 domains. This router checks to see whether the local part is defined as an
6171 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6172 data that it looks up from that file. If no data is found for the local part,
6173 the value of the &%data%& option is empty, causing the address to be passed to
6174 the next router.
6175
6176 &_/etc/aliases_& is a conventional name for the system aliases file that is
6177 often used. That is why it is referenced by from the default configuration
6178 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6179 &_Local/Makefile_& before building Exim.
6180 .code
6181 userforward:
6182   driver = redirect
6183   check_local_user
6184 # local_part_suffix = +* : -*
6185 # local_part_suffix_optional
6186   file = $home/.forward
6187 # allow_filter
6188   no_verify
6189   no_expn
6190   check_ancestor
6191   file_transport = address_file
6192   pipe_transport = address_pipe
6193   reply_transport = address_reply
6194 .endd
6195 This is the most complicated router in the default configuration. It is another
6196 redirection router, but this time it is looking for forwarding data set up by
6197 individual users. The &%check_local_user%& setting specifies a check that the
6198 local part of the address is the login name of a local user. If it is not, the
6199 router is skipped. The two commented options that follow &%check_local_user%&,
6200 namely:
6201 .code
6202 # local_part_suffix = +* : -*
6203 # local_part_suffix_optional
6204 .endd
6205 .vindex "&$local_part_suffix$&"
6206 show how you can specify the recognition of local part suffixes. If the first
6207 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6208 by any sequence of characters, is removed from the local part and placed in the
6209 variable &$local_part_suffix$&. The second suffix option specifies that the
6210 presence of a suffix in the local part is optional. When a suffix is present,
6211 the check for a local login uses the local part with the suffix removed.
6212
6213 When a local user account is found, the file called &_.forward_& in the user's
6214 home directory is consulted. If it does not exist, or is empty, the router
6215 declines. Otherwise, the contents of &_.forward_& are interpreted as
6216 redirection data (see chapter &<<CHAPredirect>>& for more details).
6217
6218 .cindex "Sieve filter" "enabling in default router"
6219 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6220 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6221 is commented out by default), the contents of the file are interpreted as a set
6222 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6223 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6224 separate document entitled &'Exim's interfaces to mail filtering'&.
6225
6226 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6227 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6228 There are two reasons for doing this:
6229
6230 .olist
6231 Whether or not a local user has a &_.forward_& file is not really relevant when
6232 checking an address for validity; it makes sense not to waste resources doing
6233 unnecessary work.
6234 .next
6235 More importantly, when Exim is verifying addresses or handling an EXPN
6236 command during an SMTP session, it is running as the Exim user, not as root.
6237 The group is the Exim group, and no additional groups are set up.
6238 It may therefore not be possible for Exim to read users' &_.forward_& files at
6239 this time.
6240 .endlist
6241
6242 The setting of &%check_ancestor%& prevents the router from generating a new
6243 address that is the same as any previous address that was redirected. (This
6244 works round a problem concerning a bad interaction between aliasing and
6245 forwarding &-- see section &<<SECTredlocmai>>&).
6246
6247 The final three option settings specify the transports that are to be used when
6248 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6249 auto-reply, respectively. For example, if a &_.forward_& file contains
6250 .code
6251 a.nother@elsewhere.example, /home/spqr/archive
6252 .endd
6253 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6254 transport.
6255 .code
6256 localuser:
6257   driver = accept
6258   check_local_user
6259 # local_part_suffix = +* : -*
6260 # local_part_suffix_optional
6261   transport = local_delivery
6262 .endd
6263 The final router sets up delivery into local mailboxes, provided that the local
6264 part is the name of a local login, by accepting the address and assigning it to
6265 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6266 routers, so the address is bounced. The commented suffix settings fulfil the
6267 same purpose as they do for the &(userforward)& router.
6268
6269
6270 .section "Transport configuration" "SECID56"
6271 .cindex "default" "transports"
6272 .cindex "transports" "default"
6273 Transports define mechanisms for actually delivering messages. They operate
6274 only when referenced from routers, so the order in which they are defined does
6275 not matter. The transports section of the configuration starts with
6276 .code
6277 begin transports
6278 .endd
6279 Two remote transports and four local transports are defined.
6280 .code
6281 remote_smtp:
6282   driver = smtp
6283   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6284 .ifdef _HAVE_PRDR
6285   hosts_try_prdr = *
6286 .endif
6287 .endd
6288 This transport is used for delivering messages over SMTP connections.
6289 The list of remote hosts comes from the router.
6290 The &%message_size_limit%& usage is a hack to avoid sending on messages
6291 with over-long lines.
6292
6293 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6294 negotiated between client and server and not expected to cause problems
6295 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6296 use of the &%hosts_try_prdr%& configuration option.
6297
6298 The other remote transport is used when delivering to a specific smarthost
6299 with whom there must be some kind of existing relationship, instead of the
6300 usual federated system.
6301
6302 .code
6303 smarthost_smtp:
6304   driver = smtp
6305   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6306   multi_domain
6307   #
6308 .ifdef _HAVE_TLS
6309   # Comment out any of these which you have to, then file a Support
6310   # request with your smarthost provider to get things fixed:
6311   hosts_require_tls = *
6312   tls_verify_hosts = *
6313   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6314   # have to comment it out then this will at least log whether you succeed
6315   # or not:
6316   tls_try_verify_hosts = *
6317   #
6318   # The SNI name should match the name which we'll expect to verify;
6319   # many mail systems don't use SNI and this doesn't matter, but if it does,
6320   # we need to send a name which the remote site will recognize.
6321   # This _should_ be the name which the smarthost operators specified as
6322   # the hostname for sending your mail to.
6323   tls_sni = ROUTER_SMARTHOST
6324   #
6325 .ifdef _HAVE_OPENSSL
6326   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6327 .endif
6328 .ifdef _HAVE_GNUTLS
6329   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6330 .endif
6331 .endif
6332 .ifdef _HAVE_PRDR
6333   hosts_try_prdr = *
6334 .endif
6335 .endd
6336 After the same &%message_size_limit%& hack, we then specify that this Transport
6337 can handle messages to multiple domains in one run.  The assumption here is
6338 that you're routing all non-local mail to the same place and that place is
6339 happy to take all messages from you as quickly as possible.
6340 All other options depend upon built-in macros; if Exim was built without TLS support
6341 then no other options are defined.
6342 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6343 and versions using the &%tls_require_ciphers%& option, where the value to be
6344 used depends upon the library providing TLS.
6345 Beyond that, the options adopt the stance that you should have TLS support available
6346 from your smarthost on today's Internet, so we turn on requiring TLS for the
6347 mail to be delivered, and requiring that the certificate be valid, and match
6348 the expected hostname.  The &%tls_sni%& option can be used by service providers
6349 to select an appropriate certificate to present to you and here we re-use the
6350 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6351 You want to specify the hostname which you'll expect to validate for, and that
6352 should not be subject to insecure tampering via DNS results.
6353
6354 For the &%hosts_try_prdr%& option see the previous transport.
6355
6356 All other options are defaulted.
6357 .code
6358 local_delivery:
6359   driver = appendfile
6360   file = /var/mail/$local_part
6361   delivery_date_add
6362   envelope_to_add
6363   return_path_add
6364 # group = mail
6365 # mode = 0660
6366 .endd
6367 This &(appendfile)& transport is used for local delivery to user mailboxes in
6368 traditional BSD mailbox format. By default it runs under the uid and gid of the
6369 local user, which requires the sticky bit to be set on the &_/var/mail_&
6370 directory. Some systems use the alternative approach of running mail deliveries
6371 under a particular group instead of using the sticky bit. The commented options
6372 show how this can be done.
6373
6374 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6375 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6376 similarly-named options above.
6377 .code
6378 address_pipe:
6379   driver = pipe
6380   return_output
6381 .endd
6382 This transport is used for handling deliveries to pipes that are generated by
6383 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6384 option specifies that any output on stdout or stderr generated by the pipe is to
6385 be returned to the sender.
6386 .code
6387 address_file:
6388   driver = appendfile
6389   delivery_date_add
6390   envelope_to_add
6391   return_path_add
6392 .endd
6393 This transport is used for handling deliveries to files that are generated by
6394 redirection. The name of the file is not specified in this instance of
6395 &(appendfile)&, because it comes from the &(redirect)& router.
6396 .code
6397 address_reply:
6398   driver = autoreply
6399 .endd
6400 This transport is used for handling automatic replies generated by users'
6401 filter files.
6402
6403
6404
6405 .section "Default retry rule" "SECID57"
6406 .cindex "retry" "default rule"
6407 .cindex "default" "retry rule"
6408 The retry section of the configuration file contains rules which affect the way
6409 Exim retries deliveries that cannot be completed at the first attempt. It is
6410 introduced by the line
6411 .code
6412 begin retry
6413 .endd
6414 In the default configuration, there is just one rule, which applies to all
6415 errors:
6416 .code
6417 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6418 .endd
6419 This causes any temporarily failing address to be retried every 15 minutes for
6420 2 hours, then at intervals starting at one hour and increasing by a factor of
6421 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6422 is not delivered after 4 days of temporary failure, it is bounced. The time is
6423 measured from first failure, not from the time the message was received.
6424
6425 If the retry section is removed from the configuration, or is empty (that is,
6426 if no retry rules are defined), Exim will not retry deliveries. This turns
6427 temporary errors into permanent errors.
6428
6429
6430 .section "Rewriting configuration" "SECID58"
6431 The rewriting section of the configuration, introduced by
6432 .code
6433 begin rewrite
6434 .endd
6435 contains rules for rewriting addresses in messages as they arrive. There are no
6436 rewriting rules in the default configuration file.
6437
6438
6439
6440 .section "Authenticators configuration" "SECTdefconfauth"
6441 .cindex "AUTH" "configuration"
6442 The authenticators section of the configuration, introduced by
6443 .code
6444 begin authenticators
6445 .endd
6446 defines mechanisms for the use of the SMTP AUTH command. The default
6447 configuration file contains two commented-out example authenticators
6448 which support plaintext username/password authentication using the
6449 standard PLAIN mechanism and the traditional but non-standard LOGIN
6450 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6451 to support most MUA software.
6452
6453 The example PLAIN authenticator looks like this:
6454 .code
6455 #PLAIN:
6456 #  driver                  = plaintext
6457 #  server_set_id           = $auth2
6458 #  server_prompts          = :
6459 #  server_condition        = Authentication is not yet configured
6460 #  server_advertise_condition = ${if def:tls_in_cipher }
6461 .endd
6462 And the example LOGIN authenticator looks like this:
6463 .code
6464 #LOGIN:
6465 #  driver                  = plaintext
6466 #  server_set_id           = $auth1
6467 #  server_prompts          = <| Username: | Password:
6468 #  server_condition        = Authentication is not yet configured
6469 #  server_advertise_condition = ${if def:tls_in_cipher }
6470 .endd
6471
6472 The &%server_set_id%& option makes Exim remember the authenticated username
6473 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6474 &%server_prompts%& option configures the &(plaintext)& authenticator so
6475 that it implements the details of the specific authentication mechanism,
6476 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6477 when Exim offers authentication to clients; in the examples, this is only
6478 when TLS or SSL has been started, so to enable the authenticators you also
6479 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6480
6481 The &%server_condition%& setting defines how to verify that the username and
6482 password are correct. In the examples it just produces an error message.
6483 To make the authenticators work, you can use a string expansion
6484 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6485
6486 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6487 usercode and password are in different positions.
6488 Chapter &<<CHAPplaintext>>& covers both.
6489
6490 .ecindex IIDconfiwal
6491
6492
6493
6494 . ////////////////////////////////////////////////////////////////////////////
6495 . ////////////////////////////////////////////////////////////////////////////
6496
6497 .chapter "Regular expressions" "CHAPregexp"
6498
6499 .cindex "regular expressions" "library"
6500 .cindex "PCRE"
6501 Exim supports the use of regular expressions in many of its options. It
6502 uses the PCRE regular expression library; this provides regular expression
6503 matching that is compatible with Perl 5. The syntax and semantics of
6504 regular expressions is discussed in
6505 online Perl manpages, in
6506 many Perl reference books, and also in
6507 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6508 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6509 . --- the http: URL here redirects to another page with the ISBN in the URL
6510 . --- where trying to use https: just redirects back to http:, so sticking
6511 . --- to the old URL for now.  2018-09-07.
6512
6513 The documentation for the syntax and semantics of the regular expressions that
6514 are supported by PCRE is included in the PCRE distribution, and no further
6515 description is included here. The PCRE functions are called from Exim using
6516 the default option settings (that is, with no PCRE options set), except that
6517 the PCRE_CASELESS option is set when the matching is required to be
6518 case-insensitive.
6519
6520 In most cases, when a regular expression is required in an Exim configuration,
6521 it has to start with a circumflex, in order to distinguish it from plain text
6522 or an &"ends with"& wildcard. In this example of a configuration setting, the
6523 second item in the colon-separated list is a regular expression.
6524 .code
6525 domains = a.b.c : ^\\d{3} : *.y.z : ...
6526 .endd
6527 The doubling of the backslash is required because of string expansion that
6528 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6529 of this issue, and a way of avoiding the need for doubling backslashes. The
6530 regular expression that is eventually used in this example contains just one
6531 backslash. The circumflex is included in the regular expression, and has the
6532 normal effect of &"anchoring"& it to the start of the string that is being
6533 matched.
6534
6535 There are, however, two cases where a circumflex is not required for the
6536 recognition of a regular expression: these are the &%match%& condition in a
6537 string expansion, and the &%matches%& condition in an Exim filter file. In
6538 these cases, the relevant string is always treated as a regular expression; if
6539 it does not start with a circumflex, the expression is not anchored, and can
6540 match anywhere in the subject string.
6541
6542 In all cases, if you want a regular expression to match at the end of a string,
6543 you must code the $ metacharacter to indicate this. For example:
6544 .code
6545 domains = ^\\d{3}\\.example
6546 .endd
6547 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6548 You need to use:
6549 .code
6550 domains = ^\\d{3}\\.example\$
6551 .endd
6552 if you want &'example'& to be the top-level domain. The backslash before the
6553 $ is needed because string expansion also interprets dollar characters.
6554
6555
6556
6557 . ////////////////////////////////////////////////////////////////////////////
6558 . ////////////////////////////////////////////////////////////////////////////
6559
6560 .chapter "File and database lookups" "CHAPfdlookup"
6561 .scindex IIDfidalo1 "file" "lookups"
6562 .scindex IIDfidalo2 "database" "lookups"
6563 .cindex "lookup" "description of"
6564 Exim can be configured to look up data in files or databases as it processes
6565 messages. Two different kinds of syntax are used:
6566
6567 .olist
6568 A string that is to be expanded may contain explicit lookup requests. These
6569 cause parts of the string to be replaced by data that is obtained from the
6570 lookup. Lookups of this type are conditional expansion items. Different results
6571 can be defined for the cases of lookup success and failure. See chapter
6572 &<<CHAPexpand>>&, where string expansions are described in detail.
6573 The key for the lookup is specified as part of the string expansion.
6574 .next
6575 Lists of domains, hosts, and email addresses can contain lookup requests as a
6576 way of avoiding excessively long linear lists. In this case, the data that is
6577 returned by the lookup is often (but not always) discarded; whether the lookup
6578 succeeds or fails is what really counts. These kinds of list are described in
6579 chapter &<<CHAPdomhosaddlists>>&.
6580 The key for the lookup is given by the context in which the list is expanded.
6581 .endlist
6582
6583 String expansions, lists, and lookups interact with each other in such a way
6584 that there is no order in which to describe any one of them that does not
6585 involve references to the others. Each of these three chapters makes more sense
6586 if you have read the other two first. If you are reading this for the first
6587 time, be aware that some of it will make a lot more sense after you have read
6588 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6589
6590 .section "Examples of different lookup syntax" "SECID60"
6591 It is easy to confuse the two different kinds of lookup, especially as the
6592 lists that may contain the second kind are always expanded before being
6593 processed as lists. Therefore, they may also contain lookups of the first kind.
6594 Be careful to distinguish between the following two examples:
6595 .code
6596 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6597 domains = lsearch;/some/file
6598 .endd
6599 The first uses a string expansion, the result of which must be a domain list.
6600 No strings have been specified for a successful or a failing lookup; the
6601 defaults in this case are the looked-up data and an empty string, respectively.
6602 The expansion takes place before the string is processed as a list, and the
6603 file that is searched could contain lines like this:
6604 .code
6605 192.168.3.4: domain1:domain2:...
6606 192.168.1.9: domain3:domain4:...
6607 .endd
6608 When the lookup succeeds, the result of the expansion is a list of domains (and
6609 possibly other types of item that are allowed in domain lists).
6610
6611 In the second example, the lookup is a single item in a domain list. It causes
6612 Exim to use a lookup to see if the domain that is being processed can be found
6613 in the file. The file could contains lines like this:
6614 .code
6615 domain1:
6616 domain2:
6617 .endd
6618 Any data that follows the keys is not relevant when checking that the domain
6619 matches the list item.
6620
6621 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6622 Consider a file containing lines like this:
6623 .code
6624 192.168.5.6: lsearch;/another/file
6625 .endd
6626 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6627 first &%domains%& setting above generates the second setting, which therefore
6628 causes a second lookup to occur.
6629
6630 The rest of this chapter describes the different lookup types that are
6631 available. Any of them can be used in any part of the configuration where a
6632 lookup is permitted.
6633
6634
6635 .section "Lookup types" "SECID61"
6636 .cindex "lookup" "types of"
6637 .cindex "single-key lookup" "definition of"
6638 Two different types of data lookup are implemented:
6639
6640 .ilist
6641 The &'single-key'& type requires the specification of a file in which to look,
6642 and a single key to search for. The key must be a non-empty string for the
6643 lookup to succeed. The lookup type determines how the file is searched.
6644 .next
6645 .cindex "query-style lookup" "definition of"
6646 The &'query-style'& type accepts a generalized database query. No particular
6647 key value is assumed by Exim for query-style lookups. You can use whichever
6648 Exim variables you need to construct the database query.
6649 .endlist
6650
6651 The code for each lookup type is in a separate source file that is included in
6652 the binary of Exim only if the corresponding compile-time option is set. The
6653 default settings in &_src/EDITME_& are:
6654 .code
6655 LOOKUP_DBM=yes
6656 LOOKUP_LSEARCH=yes
6657 .endd
6658 which means that only linear searching and DBM lookups are included by default.
6659 For some types of lookup (e.g. SQL databases), you need to install appropriate
6660 libraries and header files before building Exim.
6661
6662
6663
6664
6665 .section "Single-key lookup types" "SECTsinglekeylookups"
6666 .cindex "lookup" "single-key types"
6667 .cindex "single-key lookup" "list of types"
6668 The following single-key lookup types are implemented:
6669
6670 .ilist
6671 .cindex "cdb" "description of"
6672 .cindex "lookup" "cdb"
6673 .cindex "binary zero" "in lookup key"
6674 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6675 string without a terminating binary zero. The cdb format is designed for
6676 indexed files that are read frequently and never updated, except by total
6677 re-creation. As such, it is particularly suitable for large files containing
6678 aliases or other indexed data referenced by an MTA. Information about cdb and
6679 tools for building the files can be found in several places:
6680 .display
6681 &url(https://cr.yp.to/cdb.html)
6682 &url(https://www.corpit.ru/mjt/tinycdb.html)
6683 &url(https://packages.debian.org/stable/utils/freecdb)
6684 &url(https://github.com/philpennock/cdbtools) (in Go)
6685 .endd
6686 A cdb distribution is not needed in order to build Exim with cdb support,
6687 because the code for reading cdb files is included directly in Exim itself.
6688 However, no means of building or testing cdb files is provided with Exim, so
6689 you need to obtain a cdb distribution in order to do this.
6690 .next
6691 .cindex "DBM" "lookup type"
6692 .cindex "lookup" "dbm"
6693 .cindex "binary zero" "in lookup key"
6694 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6695 DBM file by looking up the record with the given key. A terminating binary
6696 zero is included in the key that is passed to the DBM library. See section
6697 &<<SECTdb>>& for a discussion of DBM libraries.
6698
6699 .cindex "Berkeley DB library" "file format"
6700 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6701 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6702 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6703 the DB_UNKNOWN option. This enables it to handle any of the types of database
6704 that the library supports, and can be useful for accessing DBM files created by
6705 other applications. (For earlier DB versions, DB_HASH is always used.)
6706 .next
6707 .cindex "lookup" "dbmjz"
6708 .cindex "lookup" "dbm &-- embedded NULs"
6709 .cindex "sasldb2"
6710 .cindex "dbmjz lookup type"
6711 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6712 interpreted as an Exim list; the elements of the list are joined together with
6713 ASCII NUL characters to form the lookup key.  An example usage would be to
6714 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6715 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6716 &(cram_md5)& authenticator.
6717 .next
6718 .cindex "lookup" "dbmnz"
6719 .cindex "lookup" "dbm &-- terminating zero"
6720 .cindex "binary zero" "in lookup key"
6721 .cindex "Courier"
6722 .cindex "&_/etc/userdbshadow.dat_&"
6723 .cindex "dbmnz lookup type"
6724 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6725 is not included in the key that is passed to the DBM library. You may need this
6726 if you want to look up data in files that are created by or shared with some
6727 other application that does not use terminating zeros. For example, you need to
6728 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6729 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6730 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6731 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6732 .next
6733 .cindex "lookup" "dsearch"
6734 .cindex "dsearch lookup type"
6735 &(dsearch)&: The given file must be a directory; this is searched for an entry
6736 whose name is the key by calling the &[lstat()]& function. The key may not
6737 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6738 the lookup is the name of the entry, which may be a file, directory,
6739 symbolic link, or any other kind of directory entry. An example of how this
6740 lookup can be used to support virtual domains is given in section
6741 &<<SECTvirtualdomains>>&.
6742 .next
6743 .cindex "lookup" "iplsearch"
6744 .cindex "iplsearch lookup type"
6745 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6746 terminated by a colon or white space or the end of the line. The keys in the
6747 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6748 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6749 being interpreted as a key terminator. For example:
6750 .code
6751 1.2.3.4:           data for 1.2.3.4
6752 192.168.0.0/16:    data for 192.168.0.0/16
6753 "abcd::cdab":      data for abcd::cdab
6754 "abcd:abcd::/32"   data for abcd:abcd::/32
6755 .endd
6756 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6757 file is searched linearly, using the CIDR masks where present, until a matching
6758 key is found. The first key that matches is used; there is no attempt to find a
6759 &"best"& match. Apart from the way the keys are matched, the processing for
6760 &(iplsearch)& is the same as for &(lsearch)&.
6761
6762 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6763 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6764 lookup types support only literal keys.
6765
6766 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6767 the implicit key is the host's IP address rather than its name (see section
6768 &<<SECThoslispatsikey>>&).
6769
6770 .new
6771 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6772 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6773 notation before executing the lookup.)
6774 .wen
6775 .next
6776 .new
6777 .cindex lookup json
6778 .cindex json "lookup type"
6779 .cindex JSON expansions
6780 &(json)&: The given file is a text file with a JSON structure.
6781 An element of the structure is extracted, defined by the search key.
6782 The key is a list of subelement selectors
6783 (colon-separated by default but changeable in the usual way)
6784 which are applied in turn to select smaller and smaller portions
6785 of the JSON structure.
6786 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6787 nunbered array element is selected.
6788 Otherwise it must apply to a JSON object; the named element is selected.
6789 The final resulting element can be a simple JSON type or a JSON object
6790 or array; for the latter two a string-representation os the JSON
6791 is returned.
6792 For elements of type string, the returned value is de-quoted.
6793 .wen
6794 .next
6795 .cindex "linear search"
6796 .cindex "lookup" "lsearch"
6797 .cindex "lsearch lookup type"
6798 .cindex "case sensitivity" "in lsearch lookup"
6799 &(lsearch)&: The given file is a text file that is searched linearly for a
6800 line beginning with the search key, terminated by a colon or white space or the
6801 end of the line. The search is case-insensitive; that is, upper and lower case
6802 letters are treated as the same. The first occurrence of the key that is found
6803 in the file is used.
6804
6805 White space between the key and the colon is permitted. The remainder of the
6806 line, with leading and trailing white space removed, is the data. This can be
6807 continued onto subsequent lines by starting them with any amount of white
6808 space, but only a single space character is included in the data at such a
6809 junction. If the data begins with a colon, the key must be terminated by a
6810 colon, for example:
6811 .code
6812 baduser:  :fail:
6813 .endd
6814 Empty lines and lines beginning with # are ignored, even if they occur in the
6815 middle of an item. This is the traditional textual format of alias files. Note
6816 that the keys in an &(lsearch)& file are literal strings. There is no
6817 wildcarding of any kind.
6818
6819 .cindex "lookup" "lsearch &-- colons in keys"
6820 .cindex "white space" "in lsearch key"
6821 In most &(lsearch)& files, keys are not required to contain colons or #
6822 characters, or white space. However, if you need this feature, it is available.
6823 If a key begins with a doublequote character, it is terminated only by a
6824 matching quote (or end of line), and the normal escaping rules apply to its
6825 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6826 quoted keys (exactly as for unquoted keys). There is no special handling of
6827 quotes for the data part of an &(lsearch)& line.
6828
6829 .next
6830 .cindex "NIS lookup type"
6831 .cindex "lookup" "NIS"
6832 .cindex "binary zero" "in lookup key"
6833 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6834 the given key, without a terminating binary zero. There is a variant called
6835 &(nis0)& which does include the terminating binary zero in the key. This is
6836 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6837 aliases; the full map names must be used.
6838
6839 .next
6840 .cindex "wildlsearch lookup type"
6841 .cindex "lookup" "wildlsearch"
6842 .cindex "nwildlsearch lookup type"
6843 .cindex "lookup" "nwildlsearch"
6844 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6845 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6846 the file may be wildcarded. The difference between these two lookup types is
6847 that for &(wildlsearch)&, each key in the file is string-expanded before being
6848 used, whereas for &(nwildlsearch)&, no expansion takes place.
6849
6850 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6851 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6852 file that are regular expressions can be made case-sensitive by the use of
6853 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6854
6855 . ==== As this is a nested list, any displays it contains must be indented
6856 . ==== as otherwise they are too far to the left.
6857
6858 .olist
6859 The string may begin with an asterisk to mean &"ends with"&. For example:
6860 .code
6861     *.a.b.c       data for anything.a.b.c
6862     *fish         data for anythingfish
6863 .endd
6864 .next
6865 The string may begin with a circumflex to indicate a regular expression. For
6866 example, for &(wildlsearch)&:
6867 .code
6868     ^\N\d+\.a\.b\N    data for <digits>.a.b
6869 .endd
6870 Note the use of &`\N`& to disable expansion of the contents of the regular
6871 expression. If you are using &(nwildlsearch)&, where the keys are not
6872 string-expanded, the equivalent entry is:
6873 .code
6874     ^\d+\.a\.b        data for <digits>.a.b
6875 .endd
6876 The case-insensitive flag is set at the start of compiling the regular
6877 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6878 For example, to make the entire pattern case-sensitive:
6879 .code
6880     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6881 .endd
6882
6883 If the regular expression contains white space or colon characters, you must
6884 either quote it (see &(lsearch)& above), or represent these characters in other
6885 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6886 colon. This may be easier than quoting, because if you quote, you have to
6887 escape all the backslashes inside the quotes.
6888
6889 &*Note*&: It is not possible to capture substrings in a regular expression
6890 match for later use, because the results of all lookups are cached. If a lookup
6891 is repeated, the result is taken from the cache, and no actual pattern matching
6892 takes place. The values of all the numeric variables are unset after a
6893 &((n)wildlsearch)& match.
6894
6895 .next
6896 Although I cannot see it being of much use, the general matching function that
6897 is used to implement &((n)wildlsearch)& means that the string may begin with a
6898 lookup name terminated by a semicolon, and followed by lookup data. For
6899 example:
6900 .code
6901     cdb;/some/file  data for keys that match the file
6902 .endd
6903 The data that is obtained from the nested lookup is discarded.
6904 .endlist olist
6905
6906 Keys that do not match any of these patterns are interpreted literally. The
6907 continuation rules for the data are the same as for &(lsearch)&, and keys may
6908 be followed by optional colons.
6909
6910 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6911 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6912 lookup types support only literal keys.
6913
6914 .next
6915 .cindex "lookup" "spf"
6916 If Exim is built with SPF support, manual lookups can be done
6917 (as opposed to the standard ACL condition method.
6918 For details see section &<<SECSPF>>&.
6919 .endlist ilist
6920
6921
6922 .section "Query-style lookup types" "SECTquerystylelookups"
6923 .cindex "lookup" "query-style types"
6924 .cindex "query-style lookup" "list of types"
6925 The supported query-style lookup types are listed below. Further details about
6926 many of them are given in later sections.
6927
6928 .ilist
6929 .cindex "DNS" "as a lookup type"
6930 .cindex "lookup" "DNS"
6931 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6932 are given in the supplied query. The resulting data is the contents of the
6933 records. See section &<<SECTdnsdb>>&.
6934 .next
6935 .cindex "InterBase lookup type"
6936 .cindex "lookup" "InterBase"
6937 &(ibase)&: This does a lookup in an InterBase database.
6938 .next
6939 .cindex "LDAP" "lookup type"
6940 .cindex "lookup" "LDAP"
6941 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6942 returns attributes from a single entry. There is a variant called &(ldapm)&
6943 that permits values from multiple entries to be returned. A third variant
6944 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6945 any attribute values. See section &<<SECTldap>>&.
6946 .next
6947 .cindex "MySQL" "lookup type"
6948 .cindex "lookup" "MySQL"
6949 &(mysql)&: The format of the query is an SQL statement that is passed to a
6950 MySQL database. See section &<<SECTsql>>&.
6951 .next
6952 .cindex "NIS+ lookup type"
6953 .cindex "lookup" "NIS+"
6954 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6955 the field to be returned. See section &<<SECTnisplus>>&.
6956 .next
6957 .cindex "Oracle" "lookup type"
6958 .cindex "lookup" "Oracle"
6959 &(oracle)&: The format of the query is an SQL statement that is passed to an
6960 Oracle database. See section &<<SECTsql>>&.
6961 .next
6962 .cindex "lookup" "passwd"
6963 .cindex "passwd lookup type"
6964 .cindex "&_/etc/passwd_&"
6965 &(passwd)& is a query-style lookup with queries that are just user names. The
6966 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6967 success, the result string is the same as you would get from an &(lsearch)&
6968 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6969 password value. For example:
6970 .code
6971 *:42:42:King Rat:/home/kr:/bin/bash
6972 .endd
6973 .next
6974 .cindex "PostgreSQL lookup type"
6975 .cindex "lookup" "PostgreSQL"
6976 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6977 PostgreSQL database. See section &<<SECTsql>>&.
6978
6979 .next
6980 .cindex "Redis lookup type"
6981 .cindex lookup Redis
6982 &(redis)&: The format of the query is either a simple get or simple set,
6983 passed to a Redis database. See section &<<SECTsql>>&.
6984
6985 .next
6986 .cindex "sqlite lookup type"
6987 .cindex "lookup" "sqlite"
6988 &(sqlite)&: The format of the query is a filename followed by an SQL statement
6989 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6990
6991 .next
6992 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6993 not likely to be useful in normal operation.
6994 .next
6995 .cindex "whoson lookup type"
6996 .cindex "lookup" "whoson"
6997 . --- still http:-only, 2018-09-07
6998 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6999 allows a server to check whether a particular (dynamically allocated) IP
7000 address is currently allocated to a known (trusted) user and, optionally, to
7001 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7002 at one time for &"POP before SMTP"& authentication, but that approach has been
7003 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7004 &"POP before SMTP"& checking using ACL statements such as
7005 .code
7006 require condition = \
7007   ${lookup whoson {$sender_host_address}{yes}{no}}
7008 .endd
7009 The query consists of a single IP address. The value returned is the name of
7010 the authenticated user, which is stored in the variable &$value$&. However, in
7011 this example, the data in &$value$& is not used; the result of the lookup is
7012 one of the fixed strings &"yes"& or &"no"&.
7013 .endlist
7014
7015
7016
7017 .section "Temporary errors in lookups" "SECID63"
7018 .cindex "lookup" "temporary error in"
7019 Lookup functions can return temporary error codes if the lookup cannot be
7020 completed. For example, an SQL or LDAP database might be unavailable. For this
7021 reason, it is not advisable to use a lookup that might do this for critical
7022 options such as a list of local domains.
7023
7024 When a lookup cannot be completed in a router or transport, delivery
7025 of the message (to the relevant address) is deferred, as for any other
7026 temporary error. In other circumstances Exim may assume the lookup has failed,
7027 or may give up altogether.
7028
7029
7030
7031 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7032 .cindex "wildcard lookups"
7033 .cindex "lookup" "default values"
7034 .cindex "lookup" "wildcard"
7035 .cindex "lookup" "* added to type"
7036 .cindex "default" "in single-key lookups"
7037 In this context, a &"default value"& is a value specified by the administrator
7038 that is to be used if a lookup fails.
7039
7040 &*Note:*& This section applies only to single-key lookups. For query-style
7041 lookups, the facilities of the query language must be used. An attempt to
7042 specify a default for a query-style lookup provokes an error.
7043
7044 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7045 and the initial lookup fails, the key &"*"& is looked up in the file to
7046 provide a default value. See also the section on partial matching below.
7047
7048 .cindex "*@ with single-key lookup"
7049 .cindex "lookup" "*@ added to type"
7050 .cindex "alias file" "per-domain default"
7051 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7052 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7053 character, a second lookup is done with everything before the last @ replaced
7054 by *. This makes it possible to provide per-domain defaults in alias files
7055 that include the domains in the keys. If the second lookup fails (or doesn't
7056 take place because there is no @ in the key), &"*"& is looked up.
7057 For example, a &(redirect)& router might contain:
7058 .code
7059 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7060 .endd
7061 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7062 looks up these keys, in this order:
7063 .code
7064 jane@eyre.example
7065 *@eyre.example
7066 *
7067 .endd
7068 The data is taken from whichever key it finds first. &*Note*&: In an
7069 &(lsearch)& file, this does not mean the first of these keys in the file. A
7070 complete scan is done for each key, and only if it is not found at all does
7071 Exim move on to try the next key.
7072
7073
7074
7075 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7076 .cindex "partial matching"
7077 .cindex "wildcard lookups"
7078 .cindex "lookup" "partial matching"
7079 .cindex "lookup" "wildcard"
7080 .cindex "asterisk" "in search type"
7081 The normal operation of a single-key lookup is to search the file for an exact
7082 match with the given key. However, in a number of situations where domains are
7083 being looked up, it is useful to be able to do partial matching. In this case,
7084 information in the file that has a key starting with &"*."& is matched by any
7085 domain that ends with the components that follow the full stop. For example, if
7086 a key in a DBM file is
7087 .code
7088 *.dates.fict.example
7089 .endd
7090 then when partial matching is enabled this is matched by (amongst others)
7091 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7092 by &'dates.fict.example'&, if that does not appear as a separate key in the
7093 file.
7094
7095 &*Note*&: Partial matching is not available for query-style lookups. It is
7096 also not available for any lookup items in address lists (see section
7097 &<<SECTaddresslist>>&).
7098
7099 Partial matching is implemented by doing a series of separate lookups using
7100 keys constructed by modifying the original subject key. This means that it can
7101 be used with any of the single-key lookup types, provided that
7102 partial matching keys
7103 beginning with a special prefix (default &"*."&) are included in the data file.
7104 Keys in the file that do not begin with the prefix are matched only by
7105 unmodified subject keys when partial matching is in use.
7106
7107 Partial matching is requested by adding the string &"partial-"& to the front of
7108 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7109 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7110 is added at the start of the subject key, and it is looked up again. If that
7111 fails, further lookups are tried with dot-separated components removed from the
7112 start of the subject key, one-by-one, and &"*."& added on the front of what
7113 remains.
7114
7115 A minimum number of two non-* components are required. This can be adjusted
7116 by including a number before the hyphen in the search type. For example,
7117 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7118 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7119 subject key is &'2250.dates.fict.example'& then the following keys are looked
7120 up when the minimum number of non-* components is two:
7121 .code
7122 2250.dates.fict.example
7123 *.2250.dates.fict.example
7124 *.dates.fict.example
7125 *.fict.example
7126 .endd
7127 As soon as one key in the sequence is successfully looked up, the lookup
7128 finishes.
7129
7130 .cindex "lookup" "partial matching &-- changing prefix"
7131 .cindex "prefix" "for partial matching"
7132 The use of &"*."& as the partial matching prefix is a default that can be
7133 changed. The motivation for this feature is to allow Exim to operate with file
7134 formats that are used by other MTAs. A different prefix can be supplied in
7135 parentheses instead of the hyphen after &"partial"&. For example:
7136 .code
7137 domains = partial(.)lsearch;/some/file
7138 .endd
7139 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7140 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7141 components is unchanged). The prefix may consist of any punctuation characters
7142 other than a closing parenthesis. It may be empty, for example:
7143 .code
7144 domains = partial1()cdb;/some/file
7145 .endd
7146 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7147 &`a.b.c`&, &`b.c`&, and &`c`&.
7148
7149 If &"partial0"& is specified, what happens at the end (when the lookup with
7150 just one non-wild component has failed, and the original key is shortened right
7151 down to the null string) depends on the prefix:
7152
7153 .ilist
7154 If the prefix has zero length, the whole lookup fails.
7155 .next
7156 If the prefix has length 1, a lookup for just the prefix is done. For
7157 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7158 .next
7159 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7160 remainder is looked up. With the default prefix, therefore, the final lookup is
7161 for &"*"& on its own.
7162 .next
7163 Otherwise, the whole prefix is looked up.
7164 .endlist
7165
7166
7167 If the search type ends in &"*"& or &"*@"& (see section
7168 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7169 this implies happens after all partial lookups have failed. If &"partial0"& is
7170 specified, adding &"*"& to the search type has no effect with the default
7171 prefix, because the &"*"& key is already included in the sequence of partial
7172 lookups. However, there might be a use for lookup types such as
7173 &"partial0(.)lsearch*"&.
7174
7175 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7176 in domain lists and the like. Partial matching works only in terms of
7177 dot-separated components; a key such as &`*fict.example`&
7178 in a database file is useless, because the asterisk in a partial matching
7179 subject key is always followed by a dot.
7180
7181
7182
7183
7184 .section "Lookup caching" "SECID64"
7185 .cindex "lookup" "caching"
7186 .cindex "caching" "lookup data"
7187 Exim caches all lookup results in order to avoid needless repetition of
7188 lookups. However, because (apart from the daemon) Exim operates as a collection
7189 of independent, short-lived processes, this caching applies only within a
7190 single Exim process. There is no inter-process lookup caching facility.
7191
7192 For single-key lookups, Exim keeps the relevant files open in case there is
7193 another lookup that needs them. In some types of configuration this can lead to
7194 many files being kept open for messages with many recipients. To avoid hitting
7195 the operating system limit on the number of simultaneously open files, Exim
7196 closes the least recently used file when it needs to open more files than its
7197 own internal limit, which can be changed via the &%lookup_open_max%& option.
7198
7199 The single-key lookup files are closed and the lookup caches are flushed at
7200 strategic points during delivery &-- for example, after all routing is
7201 complete.
7202
7203
7204
7205
7206 .section "Quoting lookup data" "SECID65"
7207 .cindex "lookup" "quoting"
7208 .cindex "quoting" "in lookups"
7209 When data from an incoming message is included in a query-style lookup, there
7210 is the possibility of special characters in the data messing up the syntax of
7211 the query. For example, a NIS+ query that contains
7212 .code
7213 [name=$local_part]
7214 .endd
7215 will be broken if the local part happens to contain a closing square bracket.
7216 For NIS+, data can be enclosed in double quotes like this:
7217 .code
7218 [name="$local_part"]
7219 .endd
7220 but this still leaves the problem of a double quote in the data. The rule for
7221 NIS+ is that double quotes must be doubled. Other lookup types have different
7222 rules, and to cope with the differing requirements, an expansion operator
7223 of the following form is provided:
7224 .code
7225 ${quote_<lookup-type>:<string>}
7226 .endd
7227 For example, the safest way to write the NIS+ query is
7228 .code
7229 [name="${quote_nisplus:$local_part}"]
7230 .endd
7231 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7232 operator can be used for all lookup types, but has no effect for single-key
7233 lookups, since no quoting is ever needed in their key strings.
7234
7235
7236
7237
7238 .section "More about dnsdb" "SECTdnsdb"
7239 .cindex "dnsdb lookup"
7240 .cindex "lookup" "dnsdb"
7241 .cindex "DNS" "as a lookup type"
7242 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7243 of a record type and a domain name, separated by an equals sign. For example,
7244 an expansion string could contain:
7245 .code
7246 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7247 .endd
7248 If the lookup succeeds, the result is placed in &$value$&, which in this case
7249 is used on its own as the result. If the lookup does not succeed, the
7250 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7251 &<<SECTforexpfai>>& for an explanation of what this means.
7252
7253 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7254 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7255 If no type is given, TXT is assumed.
7256
7257 For any record type, if multiple records are found, the data is returned as a
7258 concatenation, with newline as the default separator. The order, of course,
7259 depends on the DNS resolver. You can specify a different separator character
7260 between multiple records by putting a right angle-bracket followed immediately
7261 by the new separator at the start of the query. For example:
7262 .code
7263 ${lookup dnsdb{>: a=host1.example}}
7264 .endd
7265 It is permitted to specify a space as the separator character. Further
7266 white space is ignored.
7267 For lookup types that return multiple fields per record,
7268 an alternate field separator can be specified using a comma after the main
7269 separator character, followed immediately by the field separator.
7270
7271 .cindex "PTR record" "in &(dnsdb)& lookup"
7272 When the type is PTR,
7273 the data can be an IP address, written as normal; inversion and the addition of
7274 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7275 .code
7276 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7277 .endd
7278 If the data for a PTR record is not a syntactically valid IP address, it is not
7279 altered and nothing is added.
7280
7281 .cindex "MX record" "in &(dnsdb)& lookup"
7282 .cindex "SRV record" "in &(dnsdb)& lookup"
7283 For an MX lookup, both the preference value and the host name are returned for
7284 each record, separated by a space. For an SRV lookup, the priority, weight,
7285 port, and host name are returned for each record, separated by spaces.
7286 The field separator can be modified as above.
7287
7288 .cindex "TXT record" "in &(dnsdb)& lookup"
7289 .cindex "SPF record" "in &(dnsdb)& lookup"
7290 For TXT records with multiple items of data, only the first item is returned,
7291 unless a field separator is specified.
7292 To concatenate items without a separator, use a semicolon instead.
7293 For SPF records the
7294 default behaviour is to concatenate multiple items without using a separator.
7295 .code
7296 ${lookup dnsdb{>\n,: txt=a.b.example}}
7297 ${lookup dnsdb{>\n; txt=a.b.example}}
7298 ${lookup dnsdb{spf=example.org}}
7299 .endd
7300 It is permitted to specify a space as the separator character. Further
7301 white space is ignored.
7302
7303 .cindex "SOA record" "in &(dnsdb)& lookup"
7304 For an SOA lookup, while no result is obtained the lookup is redone with
7305 successively more leading components dropped from the given domain.
7306 Only the primary-nameserver field is returned unless a field separator is
7307 specified.
7308 .code
7309 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7310 .endd
7311
7312 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7313 .cindex "dnsdb modifiers"
7314 .cindex "modifiers" "dnsdb"
7315 .cindex "options" "dnsdb"
7316 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7317 each followed by a comma,
7318 that may appear before the record type.
7319
7320 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7321 temporary DNS error for any of them, the behaviour is controlled by
7322 a defer-option modifier.
7323 The possible keywords are
7324 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7325 With &"strict"& behaviour, any temporary DNS error causes the
7326 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7327 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7328 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7329 error causes the whole lookup to defer only if none of the other lookups
7330 succeed. The default is &"lax"&, so the following lookups are equivalent:
7331 .code
7332 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7333 ${lookup dnsdb{a=one.host.com:two.host.com}}
7334 .endd
7335 Thus, in the default case, as long as at least one of the DNS lookups
7336 yields some data, the lookup succeeds.
7337
7338 .cindex "DNSSEC" "dns lookup"
7339 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7340 The possible keywords are
7341 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7342 With &"strict"& or &"lax"& DNSSEC information is requested
7343 with the lookup.
7344 With &"strict"& a response from the DNS resolver that
7345 is not labelled as authenticated data
7346 is treated as equivalent to a temporary DNS error.
7347 .new
7348 The default is &"lax"&.
7349 .wen
7350
7351 See also the &$lookup_dnssec_authenticated$& variable.
7352
7353 .cindex timeout "dns lookup"
7354 .cindex "DNS" timeout
7355 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7356 The form is &"retrans_VAL"& where VAL is an Exim time specification
7357 (e.g. &"5s"&).
7358 The default value is set by the main configuration option &%dns_retrans%&.
7359
7360 Retries for the dnsdb lookup can be controlled by a retry modifier.
7361 The form if &"retry_VAL"& where VAL is an integer.
7362 The default count is set by the main configuration option &%dns_retry%&.
7363
7364 .cindex caching "of dns lookup"
7365 .cindex TTL "of dns lookup"
7366 .cindex DNS TTL
7367 Dnsdb lookup results are cached within a single process (and its children).
7368 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7369 value of the set of returned DNS records.
7370
7371
7372 .section "Pseudo dnsdb record types" "SECID66"
7373 .cindex "MX record" "in &(dnsdb)& lookup"
7374 By default, both the preference value and the host name are returned for
7375 each MX record, separated by a space. If you want only host names, you can use
7376 the pseudo-type MXH:
7377 .code
7378 ${lookup dnsdb{mxh=a.b.example}}
7379 .endd
7380 In this case, the preference values are omitted, and just the host names are
7381 returned.
7382
7383 .cindex "name server for enclosing domain"
7384 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7385 records on the given domain, but if none are found, it removes the first
7386 component of the domain name, and tries again. This process continues until NS
7387 records are found or there are no more components left (or there is a DNS
7388 error). In other words, it may return the name servers for a top-level domain,
7389 but it never returns the root name servers. If there are no NS records for the
7390 top-level domain, the lookup fails. Consider these examples:
7391 .code
7392 ${lookup dnsdb{zns=xxx.quercite.com}}
7393 ${lookup dnsdb{zns=xxx.edu}}
7394 .endd
7395 Assuming that in each case there are no NS records for the full domain name,
7396 the first returns the name servers for &%quercite.com%&, and the second returns
7397 the name servers for &%edu%&.
7398
7399 You should be careful about how you use this lookup because, unless the
7400 top-level domain does not exist, the lookup always returns some host names. The
7401 sort of use to which this might be put is for seeing if the name servers for a
7402 given domain are on a blacklist. You can probably assume that the name servers
7403 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7404 such a list.
7405
7406 .cindex "CSA" "in &(dnsdb)& lookup"
7407 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7408 records according to the CSA rules, which are described in section
7409 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7410 not sufficient because of the extra parent domain search behaviour of CSA. The
7411 result of a successful lookup such as:
7412 .code
7413 ${lookup dnsdb {csa=$sender_helo_name}}
7414 .endd
7415 has two space-separated fields: an authorization code and a target host name.
7416 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7417 authorization required but absent, or &"?"& for unknown.
7418
7419 .cindex "A+" "in &(dnsdb)& lookup"
7420 The pseudo-type A+ performs an AAAA
7421 and then an A lookup.  All results are returned; defer processing
7422 (see below) is handled separately for each lookup.  Example:
7423 .code
7424 ${lookup dnsdb {>; a+=$sender_helo_name}}
7425 .endd
7426
7427
7428 .section "Multiple dnsdb lookups" "SECID67"
7429 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7430 However, you can specify a list of domains or IP addresses in a single
7431 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7432 the default separator, but with the ability to change this. For example:
7433 .code
7434 ${lookup dnsdb{one.domain.com:two.domain.com}}
7435 ${lookup dnsdb{a=one.host.com:two.host.com}}
7436 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7437 .endd
7438 In order to retain backwards compatibility, there is one special case: if
7439 the lookup type is PTR and no change of separator is specified, Exim looks
7440 to see if the rest of the string is precisely one IPv6 address. In this
7441 case, it does not treat it as a list.
7442
7443 The data from each lookup is concatenated, with newline separators by default,
7444 in the same way that multiple DNS records for a single item are handled. A
7445 different separator can be specified, as described above.
7446
7447
7448
7449
7450 .section "More about LDAP" "SECTldap"
7451 .cindex "LDAP" "lookup, more about"
7452 .cindex "lookup" "LDAP"
7453 .cindex "Solaris" "LDAP"
7454 The original LDAP implementation came from the University of Michigan; this has
7455 become &"Open LDAP"&, and there are now two different releases. Another
7456 implementation comes from Netscape, and Solaris 7 and subsequent releases
7457 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7458 the lookup function level, their error handling is different. For this reason
7459 it is necessary to set a compile-time variable when building Exim with LDAP, to
7460 indicate which LDAP library is in use. One of the following should appear in
7461 your &_Local/Makefile_&:
7462 .code
7463 LDAP_LIB_TYPE=UMICHIGAN
7464 LDAP_LIB_TYPE=OPENLDAP1
7465 LDAP_LIB_TYPE=OPENLDAP2
7466 LDAP_LIB_TYPE=NETSCAPE
7467 LDAP_LIB_TYPE=SOLARIS
7468 .endd
7469 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7470 same interface as the University of Michigan version.
7471
7472 There are three LDAP lookup types in Exim. These behave slightly differently in
7473 the way they handle the results of a query:
7474
7475 .ilist
7476 &(ldap)& requires the result to contain just one entry; if there are more, it
7477 gives an error.
7478 .next
7479 &(ldapdn)& also requires the result to contain just one entry, but it is the
7480 Distinguished Name that is returned rather than any attribute values.
7481 .next
7482 &(ldapm)& permits the result to contain more than one entry; the attributes
7483 from all of them are returned.
7484 .endlist
7485
7486
7487 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7488 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7489 the data returned by a successful lookup is described in the next section.
7490 First we explain how LDAP queries are coded.
7491
7492
7493 .section "Format of LDAP queries" "SECTforldaque"
7494 .cindex "LDAP" "query format"
7495 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7496 the configuration of a &(redirect)& router one might have this setting:
7497 .code
7498 data = ${lookup ldap \
7499   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7500   c=UK?mailbox?base?}}
7501 .endd
7502 .cindex "LDAP" "with TLS"
7503 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7504 secure (encrypted) LDAP connections. The second of these ensures that an
7505 encrypted TLS connection is used.
7506
7507 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7508 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7509 See the &%ldap_start_tls%& option.
7510
7511 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7512 controlled. Every part of the TLS configuration can be configured by settings in
7513 &_exim.conf_&. Depending on the version of the client libraries installed on
7514 your system, some of the initialization may have required setting options in
7515 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7516 certificates. This revealed a nuance where the current UID that exim was
7517 running as could affect which config files it read. With Exim 4.83, these
7518 methods become optional, only taking effect if not specifically set in
7519 &_exim.conf_&.
7520
7521
7522 .section "LDAP quoting" "SECID68"
7523 .cindex "LDAP" "quoting"
7524 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7525 and the second because the LDAP query is represented as a URL. Furthermore,
7526 within an LDAP query, two different kinds of quoting are required. For this
7527 reason, there are two different LDAP-specific quoting operators.
7528
7529 The &%quote_ldap%& operator is designed for use on strings that are part of
7530 filter specifications. Conceptually, it first does the following conversions on
7531 the string:
7532 .code
7533 *   =>   \2A
7534 (   =>   \28
7535 )   =>   \29
7536 \   =>   \5C
7537 .endd
7538 in accordance with RFC 2254. The resulting string is then quoted according
7539 to the rules for URLs, that is, all non-alphanumeric characters except
7540 .code
7541 ! $ ' - . _ ( ) * +
7542 .endd
7543 are converted to their hex values, preceded by a percent sign. For example:
7544 .code
7545 ${quote_ldap: a(bc)*, a<yz>; }
7546 .endd
7547 yields
7548 .code
7549 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7550 .endd
7551 Removing the URL quoting, this is (with a leading and a trailing space):
7552 .code
7553 a\28bc\29\2A, a<yz>;
7554 .endd
7555 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7556 base DN specifications in queries. Conceptually, it first converts the string
7557 by inserting a backslash in front of any of the following characters:
7558 .code
7559 , + " \ < > ;
7560 .endd
7561 It also inserts a backslash before any leading spaces or # characters, and
7562 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7563 is then quoted according to the rules for URLs. For example:
7564 .code
7565 ${quote_ldap_dn: a(bc)*, a<yz>; }
7566 .endd
7567 yields
7568 .code
7569 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7570 .endd
7571 Removing the URL quoting, this is (with a trailing space):
7572 .code
7573 \ a(bc)*\, a\<yz\>\;\
7574 .endd
7575 There are some further comments about quoting in the section on LDAP
7576 authentication below.
7577
7578
7579 .section "LDAP connections" "SECID69"
7580 .cindex "LDAP" "connections"
7581 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7582 is in use, via a Unix domain socket. The example given above does not specify
7583 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7584 by starting it with
7585 .code
7586 ldap://<hostname>:<port>/...
7587 .endd
7588 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7589 used. When no server is specified in a query, a list of default servers is
7590 taken from the &%ldap_default_servers%& configuration option. This supplies a
7591 colon-separated list of servers which are tried in turn until one successfully
7592 handles a query, or there is a serious error. Successful handling either
7593 returns the requested data, or indicates that it does not exist. Serious errors
7594 are syntactical, or multiple values when only a single value is expected.
7595 Errors which cause the next server to be tried are connection failures, bind
7596 failures, and timeouts.
7597
7598 For each server name in the list, a port number can be given. The standard way
7599 of specifying a host and port is to use a colon separator (RFC 1738). Because
7600 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7601 doubled. For example
7602 .code
7603 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7604 .endd
7605 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7606 to the LDAP library with no server name, and the library's default (normally
7607 the local host) is used.
7608
7609 If you are using the OpenLDAP library, you can connect to an LDAP server using
7610 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7611 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7612 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7613 not available.
7614
7615 For this type of connection, instead of a host name for the server, a pathname
7616 for the socket is required, and the port number is not relevant. The pathname
7617 can be specified either as an item in &%ldap_default_servers%&, or inline in
7618 the query. In the former case, you can have settings such as
7619 .code
7620 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7621 .endd
7622 When the pathname is given in the query, you have to escape the slashes as
7623 &`%2F`& to fit in with the LDAP URL syntax. For example:
7624 .code
7625 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7626 .endd
7627 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7628 a pathname, it uses the Unix domain socket code, even if the query actually
7629 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7630 socket connection. This behaviour means that you can use a setting of
7631 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7632 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7633 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7634 backup host.
7635
7636 If an explicit &`ldapi`& type is given in a query when a host name is
7637 specified, an error is diagnosed. However, if there are more items in
7638 &%ldap_default_servers%&, they are tried. In other words:
7639
7640 .ilist
7641 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7642 interface.
7643 .next
7644 Using &`ldapi`& with a host name causes an error.
7645 .endlist
7646
7647
7648 Using &`ldapi`& with no host or path in the query, and no setting of
7649 &%ldap_default_servers%&, does whatever the library does by default.
7650
7651
7652
7653 .section "LDAP authentication and control information" "SECID70"
7654 .cindex "LDAP" "authentication"
7655 The LDAP URL syntax provides no way of passing authentication and other control
7656 information to the server. To make this possible, the URL in an LDAP query may
7657 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7658 spaces. If a value contains spaces it must be enclosed in double quotes, and
7659 when double quotes are used, backslash is interpreted in the usual way inside
7660 them. The following names are recognized:
7661 .display
7662 &`DEREFERENCE`&  set the dereferencing parameter
7663 &`NETTIME    `&  set a timeout for a network operation
7664 &`USER       `&  set the DN, for authenticating the LDAP bind
7665 &`PASS       `&  set the password, likewise
7666 &`REFERRALS  `&  set the referrals parameter
7667 &`SERVERS    `&  set alternate server list for this query only
7668 &`SIZE       `&  set the limit for the number of entries returned
7669 &`TIME       `&  set the maximum waiting time for a query
7670 .endd
7671 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7672 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7673 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7674 library from trying to follow referrals issued by the LDAP server.
7675
7676 .cindex LDAP timeout
7677 .cindex timeout "LDAP lookup"
7678 The name CONNECT is an obsolete name for NETTIME, retained for
7679 backwards compatibility. This timeout (specified as a number of seconds) is
7680 enforced from the client end for operations that can be carried out over a
7681 network. Specifically, it applies to network connections and calls to the
7682 &'ldap_result()'& function. If the value is greater than zero, it is used if
7683 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7684 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7685 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7686 Netscape SDK; for OpenLDAP no action is taken.
7687
7688 The TIME parameter (also a number of seconds) is passed to the server to
7689 set a server-side limit on the time taken to complete a search.
7690
7691 The SERVERS parameter allows you to specify an alternate list of ldap servers
7692 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7693 default list of ldap servers, and a single lookup can specify a single ldap
7694 server to use.  But when you need to do a lookup with a list of servers that is
7695 different than the default list (maybe different order, maybe a completely
7696 different set of servers), the SERVERS parameter allows you to specify this
7697 alternate list (colon-separated).
7698
7699 Here is an example of an LDAP query in an Exim lookup that uses some of these
7700 values. This is a single line, folded to fit on the page:
7701 .code
7702 ${lookup ldap
7703   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7704   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7705   {$value}fail}
7706 .endd
7707 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7708 any of the auxiliary data. Exim configuration settings that include lookups
7709 which contain password information should be preceded by &"hide"& to prevent
7710 non-admin users from using the &%-bP%& option to see their values.
7711
7712 The auxiliary data items may be given in any order. The default is no
7713 connection timeout (the system timeout is used), no user or password, no limit
7714 on the number of entries returned, and no time limit on queries.
7715
7716 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7717 removes any URL quoting that it may contain before passing it LDAP. Apparently
7718 some libraries do this for themselves, but some do not. Removing the URL
7719 quoting has two advantages:
7720
7721 .ilist
7722 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7723 DNs as with DNs inside actual queries.
7724 .next
7725 It permits spaces inside USER= DNs.
7726 .endlist
7727
7728 For example, a setting such as
7729 .code
7730 USER=cn=${quote_ldap_dn:$1}
7731 .endd
7732 should work even if &$1$& contains spaces.
7733
7734 Expanded data for the PASS= value should be quoted using the &%quote%&
7735 expansion operator, rather than the LDAP quote operators. The only reason this
7736 field needs quoting is to ensure that it conforms to the Exim syntax, which
7737 does not allow unquoted spaces. For example:
7738 .code
7739 PASS=${quote:$3}
7740 .endd
7741 The LDAP authentication mechanism can be used to check passwords as part of
7742 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7743 &<<CHAPexpand>>&.
7744
7745
7746
7747 .section "Format of data returned by LDAP" "SECID71"
7748 .cindex "LDAP" "returned data formats"
7749 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7750 as a sequence of values, for example
7751 .code
7752 cn=manager,o=University of Cambridge,c=UK
7753 .endd
7754 The &(ldap)& lookup type generates an error if more than one entry matches the
7755 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7756 the result between the data from different entries. It is possible for multiple
7757 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7758 you know that whatever values are returned all came from a single entry in the
7759 directory.
7760
7761 In the common case where you specify a single attribute in your LDAP query, the
7762 result is not quoted, and does not contain the attribute name. If the attribute
7763 has multiple values, they are separated by commas. Any comma that is
7764 part of an attribute's value is doubled.
7765
7766 If you specify multiple attributes, the result contains space-separated, quoted
7767 strings, each preceded by the attribute name and an equals sign. Within the
7768 quotes, the quote character, backslash, and newline are escaped with
7769 backslashes, and commas are used to separate multiple values for the attribute.
7770 Any commas in attribute values are doubled
7771 (permitting treatment of the values as a comma-separated list).
7772 Apart from the escaping, the string within quotes takes the same form as the
7773 output when a single attribute is requested. Specifying no attributes is the
7774 same as specifying all of an entry's attributes.
7775
7776 Here are some examples of the output format. The first line of each pair is an
7777 LDAP query, and the second is the data that is returned. The attribute called
7778 &%attr1%& has two values, one of them with an embedded comma, whereas
7779 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7780 (they have SUP &%attr%& in their schema definitions).
7781
7782 .code
7783 ldap:///o=base?attr1?sub?(uid=fred)
7784 value1.1,value1,,2
7785
7786 ldap:///o=base?attr2?sub?(uid=fred)
7787 value two
7788
7789 ldap:///o=base?attr?sub?(uid=fred)
7790 value1.1,value1,,2,value two
7791
7792 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7793 attr1="value1.1,value1,,2" attr2="value two"
7794
7795 ldap:///o=base??sub?(uid=fred)
7796 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7797 .endd
7798 You can
7799 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7800 results of LDAP lookups.
7801 The &%extract%& operator in string expansions can be used to pick out
7802 individual fields from data that consists of &'key'&=&'value'& pairs.
7803 The &%listextract%& operator should be used to pick out individual values
7804 of attributes, even when only a single value is expected.
7805 The doubling of embedded commas allows you to use the returned data as a
7806 comma separated list (using the "<," syntax for changing the input list separator).
7807
7808
7809
7810
7811 .section "More about NIS+" "SECTnisplus"
7812 .cindex "NIS+ lookup type"
7813 .cindex "lookup" "NIS+"
7814 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7815 and field name. If this is given, the result of a successful query is the
7816 contents of the named field; otherwise the result consists of a concatenation
7817 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7818 values containing spaces are quoted. For example, the query
7819 .code
7820 [name=mg1456],passwd.org_dir
7821 .endd
7822 might return the string
7823 .code
7824 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7825 home=/home/mg1456 shell=/bin/bash shadow=""
7826 .endd
7827 (split over two lines here to fit on the page), whereas
7828 .code
7829 [name=mg1456],passwd.org_dir:gcos
7830 .endd
7831 would just return
7832 .code
7833 Martin Guerre
7834 .endd
7835 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7836 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7837 operator is to double any quote characters within the text.
7838
7839
7840
7841 .section "SQL lookups" "SECTsql"
7842 .cindex "SQL lookup types"
7843 .cindex "MySQL" "lookup type"
7844 .cindex "PostgreSQL lookup type"
7845 .cindex "lookup" "MySQL"
7846 .cindex "lookup" "PostgreSQL"
7847 .cindex "Oracle" "lookup type"
7848 .cindex "lookup" "Oracle"
7849 .cindex "InterBase lookup type"
7850 .cindex "lookup" "InterBase"
7851 .cindex "Redis lookup type"
7852 .cindex lookup Redis
7853 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7854 and SQLite
7855 databases. Queries for these databases contain SQL statements, so an example
7856 might be
7857 .code
7858 ${lookup mysql{select mailbox from users where id='userx'}\
7859   {$value}fail}
7860 .endd
7861 If the result of the query contains more than one field, the data for each
7862 field in the row is returned, preceded by its name, so the result of
7863 .code
7864 ${lookup pgsql{select home,name from users where id='userx'}\
7865   {$value}}
7866 .endd
7867 might be
7868 .code
7869 home=/home/userx name="Mister X"
7870 .endd
7871 Empty values and values containing spaces are double quoted, with embedded
7872 quotes escaped by a backslash. If the result of the query contains just one
7873 field, the value is passed back verbatim, without a field name, for example:
7874 .code
7875 Mister X
7876 .endd
7877 If the result of the query yields more than one row, it is all concatenated,
7878 with a newline between the data for each row.
7879
7880
7881 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7882 .cindex "MySQL" "lookup type"
7883 .cindex "PostgreSQL lookup type"
7884 .cindex "lookup" "MySQL"
7885 .cindex "lookup" "PostgreSQL"
7886 .cindex "Oracle" "lookup type"
7887 .cindex "lookup" "Oracle"
7888 .cindex "InterBase lookup type"
7889 .cindex "lookup" "InterBase"
7890 .cindex "Redis lookup type"
7891 .cindex lookup Redis
7892 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7893 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7894 or &%redis_servers%&
7895 option (as appropriate) must be set to a colon-separated list of server
7896 information.
7897 (For MySQL and PostgreSQL, the global option need not be set if all
7898 queries contain their own server information &-- see section
7899 &<<SECTspeserque>>&.)
7900 For all but Redis
7901 each item in the list is a slash-separated list of four
7902 items: host name, database name, user name, and password. In the case of
7903 Oracle, the host name field is used for the &"service name"&, and the database
7904 name field is not used and should be empty. For example:
7905 .code
7906 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7907 .endd
7908 Because password data is sensitive, you should always precede the setting with
7909 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7910 option. Here is an example where two MySQL servers are listed:
7911 .code
7912 hide mysql_servers = localhost/users/root/secret:\
7913                      otherhost/users/root/othersecret
7914 .endd
7915 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7916 because this is a colon-separated list, the colon has to be doubled. For each
7917 query, these parameter groups are tried in order until a connection is made and
7918 a query is successfully processed. The result of a query may be that no data is
7919 found, but that is still a successful query. In other words, the list of
7920 servers provides a backup facility, not a list of different places to look.
7921
7922 For Redis the global option need not be specified if all queries contain their
7923 own server information &-- see section &<<SECTspeserque>>&.
7924 If specified, the option must be set to a colon-separated list of server
7925 information.
7926 Each item in the list is a slash-separated list of three items:
7927 host, database number, and password.
7928 .olist
7929 The host is required and may be either an IPv4 address and optional
7930 port number (separated by a colon, which needs doubling due to the
7931 higher-level list), or a Unix socket pathname enclosed in parentheses
7932 .next
7933 The database number is optional; if present that number is selected in the backend
7934 .next
7935 The password is optional; if present it is used to authenticate to the backend
7936 .endlist
7937
7938 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7939 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7940 respectively, and the characters single-quote, double-quote, and backslash
7941 itself are escaped with backslashes.
7942
7943 The &%quote_redis%& expansion operator
7944 escapes whitespace and backslash characters with a backslash.
7945
7946 .section "Specifying the server in the query" "SECTspeserque"
7947 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7948 it is possible to specify a list of servers with an individual query. This is
7949 done by starting the query with
7950 .display
7951 &`servers=`&&'server1:server2:server3:...'&&`;`&
7952 .endd
7953 Each item in the list may take one of two forms:
7954 .olist
7955 If it contains no slashes it is assumed to be just a host name. The appropriate
7956 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7957 of the same name, and the remaining parameters (database, user, password) are
7958 taken from there.
7959 .next
7960 If it contains any slashes, it is taken as a complete parameter set.
7961 .endlist
7962 The list of servers is used in exactly the same way as the global list.
7963 Once a connection to a server has happened and a query has been
7964 successfully executed, processing of the lookup ceases.
7965
7966 This feature is intended for use in master/slave situations where updates
7967 are occurring and you want to update the master rather than a slave. If the
7968 master is in the list as a backup for reading, you might have a global setting
7969 like this:
7970 .code
7971 mysql_servers = slave1/db/name/pw:\
7972                 slave2/db/name/pw:\
7973                 master/db/name/pw
7974 .endd
7975 In an updating lookup, you could then write:
7976 .code
7977 ${lookup mysql{servers=master; UPDATE ...} }
7978 .endd
7979 That query would then be sent only to the master server. If, on the other hand,
7980 the master is not to be used for reading, and so is not present in the global
7981 option, you can still update it by a query of this form:
7982 .code
7983 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7984 .endd
7985
7986
7987 .section "Special MySQL features" "SECID73"
7988 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7989 causes a connection to the server on the local host by means of a Unix domain
7990 socket. An alternate socket can be specified in parentheses.
7991 An option group name for MySQL option files can be specified in square brackets;
7992 the default value is &"exim"&.
7993 The full syntax of each item in &%mysql_servers%& is:
7994 .display
7995 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7996   <&'database'&>/<&'user'&>/<&'password'&>
7997 .endd
7998 Any of the four sub-parts of the first field can be omitted. For normal use on
7999 the local host it can be left blank or set to just &"localhost"&.
8000
8001 No database need be supplied &-- but if it is absent here, it must be given in
8002 the queries.
8003
8004 If a MySQL query is issued that does not request any data (an insert, update,
8005 or delete command), the result of the lookup is the number of rows affected.
8006
8007 &*Warning*&: This can be misleading. If an update does not actually change
8008 anything (for example, setting a field to the value it already has), the result
8009 is zero because no rows are affected.
8010
8011
8012 .section "Special PostgreSQL features" "SECID74"
8013 PostgreSQL lookups can also use Unix domain socket connections to the database.
8014 This is usually faster and costs less CPU time than a TCP/IP connection.
8015 However it can be used only if the mail server runs on the same machine as the
8016 database server. A configuration line for PostgreSQL via Unix domain sockets
8017 looks like this:
8018 .code
8019 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8020 .endd
8021 In other words, instead of supplying a host name, a path to the socket is
8022 given. The path name is enclosed in parentheses so that its slashes aren't
8023 visually confused with the delimiters for the other server parameters.
8024
8025 If a PostgreSQL query is issued that does not request any data (an insert,
8026 update, or delete command), the result of the lookup is the number of rows
8027 affected.
8028
8029 .section "More about SQLite" "SECTsqlite"
8030 .cindex "lookup" "SQLite"
8031 .cindex "sqlite lookup type"
8032 SQLite is different to the other SQL lookups because a filename is required in
8033 addition to the SQL query. An SQLite database is a single file, and there is no
8034 daemon as in the other SQL databases. The interface to Exim requires the name
8035 of the file, as an absolute path, to be given at the start of the query. It is
8036 separated from the query by white space. This means that the path name cannot
8037 contain white space. Here is a lookup expansion example:
8038 .code
8039 ${lookup sqlite {/some/thing/sqlitedb \
8040   select name from aliases where id='userx';}}
8041 .endd
8042 In a list, the syntax is similar. For example:
8043 .code
8044 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8045    select * from relays where ip='$sender_host_address';
8046 .endd
8047 The only character affected by the &%quote_sqlite%& operator is a single
8048 quote, which it doubles.
8049
8050 .cindex timeout SQLite
8051 .cindex sqlite "lookup timeout"
8052 The SQLite library handles multiple simultaneous accesses to the database
8053 internally. Multiple readers are permitted, but only one process can
8054 update at once. Attempts to access the database while it is being updated
8055 are rejected after a timeout period, during which the SQLite library
8056 waits for the lock to be released. In Exim, the default timeout is set
8057 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8058 option.
8059
8060 .section "More about Redis" "SECTredis"
8061 .cindex "lookup" "Redis"
8062 .cindex "redis lookup type"
8063 Redis is a non-SQL database. Commands are simple get and set.
8064 Examples:
8065 .code
8066 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8067 ${lookup redis{get keyname}}
8068 .endd
8069
8070 As of release 4.91, "lightweight" support for Redis Cluster is available.
8071 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8072 of which must be reachable from the running exim instance. If the cluster has
8073 master/slave replication, the list must contain all the master and slave
8074 servers.
8075
8076 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8077 immediately follow the redirection but treats the response as a DEFER, moving on
8078 to the next server in the &%redis_servers%& list until the correct server is
8079 reached.
8080
8081 .ecindex IIDfidalo1
8082 .ecindex IIDfidalo2
8083
8084
8085 . ////////////////////////////////////////////////////////////////////////////
8086 . ////////////////////////////////////////////////////////////////////////////
8087
8088 .chapter "Domain, host, address, and local part lists" &&&
8089          "CHAPdomhosaddlists" &&&
8090          "Domain, host, and address lists"
8091 .scindex IIDdohoadli "lists of domains; hosts; etc."
8092 A number of Exim configuration options contain lists of domains, hosts,
8093 email addresses, or local parts. For example, the &%hold_domains%& option
8094 contains a list of domains whose delivery is currently suspended. These lists
8095 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8096 arguments to expansion conditions such as &%match_domain%&.
8097
8098 Each item in one of these lists is a pattern to be matched against a domain,
8099 host, email address, or local part, respectively. In the sections below, the
8100 different types of pattern for each case are described, but first we cover some
8101 general facilities that apply to all four kinds of list.
8102
8103 Note that other parts of Exim use a &'string list'& which does not
8104 support all the complexity available in
8105 domain, host, address and local part lists.
8106
8107
8108
8109 .section "Expansion of lists" "SECTlistexpand"
8110 .cindex "expansion" "of lists"
8111 Each list is expanded as a single string before it is used.
8112
8113 &'Exception: the router headers_remove option, where list-item
8114 splitting is done before string-expansion.'&
8115
8116 The result of
8117 expansion must be a list, possibly containing empty items, which is split up
8118 into separate items for matching. By default, colon is the separator character,
8119 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8120 &<<SECTempitelis>>& for details of the list syntax; the second of these
8121 discusses the way to specify empty list items.
8122
8123
8124 If the string expansion is forced to fail, Exim behaves as if the item it is
8125 testing (domain, host, address, or local part) is not in the list. Other
8126 expansion failures cause temporary errors.
8127
8128 If an item in a list is a regular expression, backslashes, dollars and possibly
8129 other special characters in the expression must be protected against
8130 misinterpretation by the string expander. The easiest way to do this is to use
8131 the &`\N`& expansion feature to indicate that the contents of the regular
8132 expression should not be expanded. For example, in an ACL you might have:
8133 .code
8134 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8135                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8136 .endd
8137 The first item is a regular expression that is protected from expansion by
8138 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8139 senders based on the receiving domain.
8140
8141
8142
8143
8144 .section "Negated items in lists" "SECID76"
8145 .cindex "list" "negation"
8146 .cindex "negation" "in lists"
8147 Items in a list may be positive or negative. Negative items are indicated by a
8148 leading exclamation mark, which may be followed by optional white space. A list
8149 defines a set of items (domains, etc). When Exim processes one of these lists,
8150 it is trying to find out whether a domain, host, address, or local part
8151 (respectively) is in the set that is defined by the list. It works like this:
8152
8153 The list is scanned from left to right. If a positive item is matched, the
8154 subject that is being checked is in the set; if a negative item is matched, the
8155 subject is not in the set. If the end of the list is reached without the
8156 subject having matched any of the patterns, it is in the set if the last item
8157 was a negative one, but not if it was a positive one. For example, the list in
8158 .code
8159 domainlist relay_to_domains = !a.b.c : *.b.c
8160 .endd
8161 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8162 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8163 list is positive. However, if the setting were
8164 .code
8165 domainlist relay_to_domains = !a.b.c
8166 .endd
8167 then all domains other than &'a.b.c'& would match because the last item in the
8168 list is negative. In other words, a list that ends with a negative item behaves
8169 as if it had an extra item &`:*`& on the end.
8170
8171 Another way of thinking about positive and negative items in lists is to read
8172 the connector as &"or"& after a positive item and as &"and"& after a negative
8173 item.
8174
8175
8176
8177 .section "File names in lists" "SECTfilnamlis"
8178 .cindex "list" "filename in"
8179 If an item in a domain, host, address, or local part list is an absolute
8180 filename (beginning with a slash character), each line of the file is read and
8181 processed as if it were an independent item in the list, except that further
8182 filenames are not allowed,
8183 and no expansion of the data from the file takes place.
8184 Empty lines in the file are ignored, and the file may also contain comment
8185 lines:
8186
8187 .ilist
8188 For domain and host lists, if a # character appears anywhere in a line of the
8189 file, it and all following characters are ignored.
8190 .next
8191 Because local parts may legitimately contain # characters, a comment in an
8192 address list or local part list file is recognized only if # is preceded by
8193 white space or the start of the line. For example:
8194 .code
8195 not#comment@x.y.z   # but this is a comment
8196 .endd
8197 .endlist
8198
8199 Putting a filename in a list has the same effect as inserting each line of the
8200 file as an item in the list (blank lines and comments excepted). However, there
8201 is one important difference: the file is read each time the list is processed,
8202 so if its contents vary over time, Exim's behaviour changes.
8203
8204 If a filename is preceded by an exclamation mark, the sense of any match
8205 within the file is inverted. For example, if
8206 .code
8207 hold_domains = !/etc/nohold-domains
8208 .endd
8209 and the file contains the lines
8210 .code
8211 !a.b.c
8212 *.b.c
8213 .endd
8214 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8215 any domain matching &`*.b.c`& is not.
8216
8217
8218
8219 .section "An lsearch file is not an out-of-line list" "SECID77"
8220 As will be described in the sections that follow, lookups can be used in lists
8221 to provide indexed methods of checking list membership. There has been some
8222 confusion about the way &(lsearch)& lookups work in lists. Because
8223 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8224 sometimes thought that it is allowed to contain wild cards and other kinds of
8225 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8226 always fixed strings, just as for any other single-key lookup type.
8227
8228 If you want to use a file to contain wild-card patterns that form part of a
8229 list, just give the filename on its own, without a search type, as described
8230 in the previous section. You could also use the &(wildlsearch)& or
8231 &(nwildlsearch)&, but there is no advantage in doing this.
8232
8233
8234
8235
8236 .section "Named lists" "SECTnamedlists"
8237 .cindex "named lists"
8238 .cindex "list" "named"
8239 A list of domains, hosts, email addresses, or local parts can be given a name
8240 which is then used to refer to the list elsewhere in the configuration. This is
8241 particularly convenient if the same list is required in several different
8242 places. It also allows lists to be given meaningful names, which can improve
8243 the readability of the configuration. For example, it is conventional to define
8244 a domain list called &'local_domains'& for all the domains that are handled
8245 locally on a host, using a configuration line such as
8246 .code
8247 domainlist local_domains = localhost:my.dom.example
8248 .endd
8249 Named lists are referenced by giving their name preceded by a plus sign, so,
8250 for example, a router that is intended to handle local domains would be
8251 configured with the line
8252 .code
8253 domains = +local_domains
8254 .endd
8255 The first router in a configuration is often one that handles all domains
8256 except the local ones, using a configuration with a negated item like this:
8257 .code
8258 dnslookup:
8259   driver = dnslookup
8260   domains = ! +local_domains
8261   transport = remote_smtp
8262   no_more
8263 .endd
8264 The four kinds of named list are created by configuration lines starting with
8265 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8266 respectively. Then there follows the name that you are defining, followed by an
8267 equals sign and the list itself. For example:
8268 .code
8269 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8270 addresslist bad_senders = cdb;/etc/badsenders
8271 .endd
8272 A named list may refer to other named lists:
8273 .code
8274 domainlist  dom1 = first.example : second.example
8275 domainlist  dom2 = +dom1 : third.example
8276 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8277 .endd
8278 &*Warning*&: If the last item in a referenced list is a negative one, the
8279 effect may not be what you intended, because the negation does not propagate
8280 out to the higher level. For example, consider:
8281 .code
8282 domainlist  dom1 = !a.b
8283 domainlist  dom2 = +dom1 : *.b
8284 .endd
8285 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8286 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8287 means it matches the second list as well. The effect is not the same as
8288 .code
8289 domainlist  dom2 = !a.b : *.b
8290 .endd
8291 where &'x.y'& does not match. It's best to avoid negation altogether in
8292 referenced lists if you can.
8293
8294 Named lists may have a performance advantage. When Exim is routing an
8295 address or checking an incoming message, it caches the result of tests on named
8296 lists. So, if you have a setting such as
8297 .code
8298 domains = +local_domains
8299 .endd
8300 on several of your routers
8301 or in several ACL statements,
8302 the actual test is done only for the first one. However, the caching works only
8303 if there are no expansions within the list itself or any sublists that it
8304 references. In other words, caching happens only for lists that are known to be
8305 the same each time they are referenced.
8306
8307 By default, there may be up to 16 named lists of each type. This limit can be
8308 extended by changing a compile-time variable. The use of domain and host lists
8309 is recommended for concepts such as local domains, relay domains, and relay
8310 hosts. The default configuration is set up like this.
8311
8312
8313
8314 .section "Named lists compared with macros" "SECID78"
8315 .cindex "list" "named compared with macro"
8316 .cindex "macro" "compared with named list"
8317 At first sight, named lists might seem to be no different from macros in the
8318 configuration file. However, macros are just textual substitutions. If you
8319 write
8320 .code
8321 ALIST = host1 : host2
8322 auth_advertise_hosts = !ALIST
8323 .endd
8324 it probably won't do what you want, because that is exactly the same as
8325 .code
8326 auth_advertise_hosts = !host1 : host2
8327 .endd
8328 Notice that the second host name is not negated. However, if you use a host
8329 list, and write
8330 .code
8331 hostlist alist = host1 : host2
8332 auth_advertise_hosts = ! +alist
8333 .endd
8334 the negation applies to the whole list, and so that is equivalent to
8335 .code
8336 auth_advertise_hosts = !host1 : !host2
8337 .endd
8338
8339
8340 .section "Named list caching" "SECID79"
8341 .cindex "list" "caching of named"
8342 .cindex "caching" "named lists"
8343 While processing a message, Exim caches the result of checking a named list if
8344 it is sure that the list is the same each time. In practice, this means that
8345 the cache operates only if the list contains no $ characters, which guarantees
8346 that it will not change when it is expanded. Sometimes, however, you may have
8347 an expanded list that you know will be the same each time within a given
8348 message. For example:
8349 .code
8350 domainlist special_domains = \
8351            ${lookup{$sender_host_address}cdb{/some/file}}
8352 .endd
8353 This provides a list of domains that depends only on the sending host's IP
8354 address. If this domain list is referenced a number of times (for example,
8355 in several ACL lines, or in several routers) the result of the check is not
8356 cached by default, because Exim does not know that it is going to be the
8357 same list each time.
8358
8359 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8360 cache the result anyway. For example:
8361 .code
8362 domainlist_cache special_domains = ${lookup{...
8363 .endd
8364 If you do this, you should be absolutely sure that caching is going to do
8365 the right thing in all cases. When in doubt, leave it out.
8366
8367
8368
8369 .section "Domain lists" "SECTdomainlist"
8370 .cindex "domain list" "patterns for"
8371 .cindex "list" "domain list"
8372 Domain lists contain patterns that are to be matched against a mail domain.
8373 The following types of item may appear in domain lists:
8374
8375 .ilist
8376 .cindex "primary host name"
8377 .cindex "host name" "matched in domain list"
8378 .oindex "&%primary_hostname%&"
8379 .cindex "domain list" "matching primary host name"
8380 .cindex "@ in a domain list"
8381 If a pattern consists of a single @ character, it matches the local host name,
8382 as set by the &%primary_hostname%& option (or defaulted). This makes it
8383 possible to use the same configuration file on several different hosts that
8384 differ only in their names.
8385 .next
8386 .cindex "@[] in a domain list"
8387 .cindex "domain list" "matching local IP interfaces"
8388 .cindex "domain literal"
8389 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8390 in square brackets (as in an email address that contains a domain literal), but
8391 only if that IP address is recognized as local for email routing purposes. The
8392 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8393 control which of a host's several IP addresses are treated as local.
8394 In today's Internet, the use of domain literals is controversial.
8395 .next
8396 .cindex "@mx_any"
8397 .cindex "@mx_primary"
8398 .cindex "@mx_secondary"
8399 .cindex "domain list" "matching MX pointers to local host"
8400 If a pattern consists of the string &`@mx_any`& it matches any domain that
8401 has an MX record pointing to the local host or to any host that is listed in
8402 .oindex "&%hosts_treat_as_local%&"
8403 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8404 are similar, except that the first matches only when a primary MX target is the
8405 local host, and the second only when no primary MX target is the local host,
8406 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8407 preference value &-- there may of course be more than one of them.
8408
8409 The MX lookup that takes place when matching a pattern of this type is
8410 performed with the resolver options for widening names turned off. Thus, for
8411 example, a single-component domain will &'not'& be expanded by adding the
8412 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8413 options of the &(dnslookup)& router for a discussion of domain widening.
8414
8415 Sometimes you may want to ignore certain IP addresses when using one of these
8416 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8417 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8418 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8419 on a router). For example:
8420 .code
8421 domains = @mx_any/ignore=127.0.0.1
8422 .endd
8423 This example matches any domain that has an MX record pointing to one of
8424 the local host's IP addresses other than 127.0.0.1.
8425
8426 The list of IP addresses is in fact processed by the same code that processes
8427 host lists, so it may contain CIDR-coded network specifications and it may also
8428 contain negative items.
8429
8430 Because the list of IP addresses is a sublist within a domain list, you have to
8431 be careful about delimiters if there is more than one address. Like any other
8432 list, the default delimiter can be changed. Thus, you might have:
8433 .code
8434 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8435           an.other.domain : ...
8436 .endd
8437 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8438 involved, it is easiest to change the delimiter for the main list as well:
8439 .code
8440 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8441           an.other.domain ? ...
8442 .endd
8443 .next
8444 .cindex "asterisk" "in domain list"
8445 .cindex "domain list" "asterisk in"
8446 .cindex "domain list" "matching &""ends with""&"
8447 If a pattern starts with an asterisk, the remaining characters of the pattern
8448 are compared with the terminating characters of the domain. The use of &"*"& in
8449 domain lists differs from its use in partial matching lookups. In a domain
8450 list, the character following the asterisk need not be a dot, whereas partial
8451 matching works only in terms of dot-separated components. For example, a domain
8452 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8453 &'cipher.key.ex'&.
8454
8455 .next
8456 .cindex "regular expressions" "in domain list"
8457 .cindex "domain list" "matching regular expression"
8458 If a pattern starts with a circumflex character, it is treated as a regular
8459 expression, and matched against the domain using a regular expression matching
8460 function. The circumflex is treated as part of the regular expression.
8461 Email domains are case-independent, so this regular expression match is by
8462 default case-independent, but you can make it case-dependent by starting it
8463 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8464 are given in chapter &<<CHAPregexp>>&.
8465
8466 &*Warning*&: Because domain lists are expanded before being processed, you
8467 must escape any backslash and dollar characters in the regular expression, or
8468 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8469 it is not to be expanded (unless you really do want to build a regular
8470 expression by expansion, of course).
8471 .next
8472 .cindex "lookup" "in domain list"
8473 .cindex "domain list" "matching by lookup"
8474 If a pattern starts with the name of a single-key lookup type followed by a
8475 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8476 must be a filename in a suitable format for the lookup type. For example, for
8477 &"cdb;"& it must be an absolute path:
8478 .code
8479 domains = cdb;/etc/mail/local_domains.cdb
8480 .endd
8481 The appropriate type of lookup is done on the file using the domain name as the
8482 key. In most cases, the data that is looked up is not used; Exim is interested
8483 only in whether or not the key is present in the file. However, when a lookup
8484 is used for the &%domains%& option on a router
8485 or a &%domains%& condition in an ACL statement, the data is preserved in the
8486 &$domain_data$& variable and can be referred to in other router options or
8487 other statements in the same ACL.
8488
8489 .next
8490 Any of the single-key lookup type names may be preceded by
8491 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8492 .code
8493 domains = partial-dbm;/partial/domains
8494 .endd
8495 This causes partial matching logic to be invoked; a description of how this
8496 works is given in section &<<SECTpartiallookup>>&.
8497
8498 .next
8499 .cindex "asterisk" "in lookup type"
8500 Any of the single-key lookup types may be followed by an asterisk. This causes
8501 a default lookup for a key consisting of a single asterisk to be done if the
8502 original lookup fails. This is not a useful feature when using a domain list to
8503 select particular domains (because any domain would match), but it might have
8504 value if the result of the lookup is being used via the &$domain_data$&
8505 expansion variable.
8506 .next
8507 If the pattern starts with the name of a query-style lookup type followed by a
8508 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8509 pattern must be an appropriate query for the lookup type, as described in
8510 chapter &<<CHAPfdlookup>>&. For example:
8511 .code
8512 hold_domains = mysql;select domain from holdlist \
8513   where domain = '${quote_mysql:$domain}';
8514 .endd
8515 In most cases, the data that is looked up is not used (so for an SQL query, for
8516 example, it doesn't matter what field you select). Exim is interested only in
8517 whether or not the query succeeds. However, when a lookup is used for the
8518 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8519 variable and can be referred to in other options.
8520 .next
8521 .cindex "domain list" "matching literal domain name"
8522 If none of the above cases apply, a caseless textual comparison is made
8523 between the pattern and the domain.
8524 .endlist
8525
8526 Here is an example that uses several different kinds of pattern:
8527 .code
8528 domainlist funny_domains = \
8529   @ : \
8530   lib.unseen.edu : \
8531   *.foundation.fict.example : \
8532   \N^[1-2]\d{3}\.fict\.example$\N : \
8533   partial-dbm;/opt/data/penguin/book : \
8534   nis;domains.byname : \
8535   nisplus;[name=$domain,status=local],domains.org_dir
8536 .endd
8537 There are obvious processing trade-offs among the various matching modes. Using
8538 an asterisk is faster than a regular expression, and listing a few names
8539 explicitly probably is too. The use of a file or database lookup is expensive,
8540 but may be the only option if hundreds of names are required. Because the
8541 patterns are tested in order, it makes sense to put the most commonly matched
8542 patterns earlier.
8543
8544
8545
8546 .section "Host lists" "SECThostlist"
8547 .cindex "host list" "patterns in"
8548 .cindex "list" "host list"
8549 Host lists are used to control what remote hosts are allowed to do. For
8550 example, some hosts may be allowed to use the local host as a relay, and some
8551 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8552 two different ways, by name or by IP address. In a host list, some types of
8553 pattern are matched to a host name, and some are matched to an IP address.
8554 You need to be particularly careful with this when single-key lookups are
8555 involved, to ensure that the right value is being used as the key.
8556
8557
8558 .section "Special host list patterns" "SECID80"
8559 .cindex "empty item in hosts list"
8560 .cindex "host list" "empty string in"
8561 If a host list item is the empty string, it matches only when no remote host is
8562 involved. This is the case when a message is being received from a local
8563 process using SMTP on the standard input, that is, when a TCP/IP connection is
8564 not used.
8565
8566 .cindex "asterisk" "in host list"
8567 The special pattern &"*"& in a host list matches any host or no host. Neither
8568 the IP address nor the name is actually inspected.
8569
8570
8571
8572 .section "Host list patterns that match by IP address" "SECThoslispatip"
8573 .cindex "host list" "matching IP addresses"
8574 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8575 the incoming address actually appears in the IPv6 host as
8576 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8577 list, it is converted into a traditional IPv4 address first. (Not all operating
8578 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8579 concerns.)
8580
8581 The following types of pattern in a host list check the remote host by
8582 inspecting its IP address:
8583
8584 .ilist
8585 If the pattern is a plain domain name (not a regular expression, not starting
8586 with *, not a lookup of any kind), Exim calls the operating system function
8587 to find the associated IP address(es). Exim uses the newer
8588 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8589 This typically causes a forward DNS lookup of the name. The result is compared
8590 with the IP address of the subject host.
8591
8592 If there is a temporary problem (such as a DNS timeout) with the host name
8593 lookup, a temporary error occurs. For example, if the list is being used in an
8594 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8595 temporary SMTP error code. If no IP address can be found for the host name,
8596 what happens is described in section &<<SECTbehipnot>>& below.
8597
8598 .next
8599 .cindex "@ in a host list"
8600 If the pattern is &"@"&, the primary host name is substituted and used as a
8601 domain name, as just described.
8602
8603 .next
8604 If the pattern is an IP address, it is matched against the IP address of the
8605 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8606 IPv6 addresses can be given in colon-separated format, but the colons have to
8607 be doubled so as not to be taken as item separators when the default list
8608 separator is used. IPv6 addresses are recognized even when Exim is compiled
8609 without IPv6 support. This means that if they appear in a host list on an
8610 IPv4-only host, Exim will not treat them as host names. They are just addresses
8611 that can never match a client host.
8612
8613 .next
8614 .cindex "@[] in a host list"
8615 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8616 the local host. For example, if the local host is an IPv4 host with one
8617 interface address 10.45.23.56, these two ACL statements have the same effect:
8618 .code
8619 accept hosts = 127.0.0.1 : 10.45.23.56
8620 accept hosts = @[]
8621 .endd
8622 .next
8623 .cindex "CIDR notation"
8624 If the pattern is an IP address followed by a slash and a mask length (for
8625 example 10.11.42.0/24), it is matched against the IP address of the subject
8626 host under the given mask. This allows, an entire network of hosts to be
8627 included (or excluded) by a single item. The mask uses CIDR notation; it
8628 specifies the number of address bits that must match, starting from the most
8629 significant end of the address.
8630
8631 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8632 of a range of addresses. It is the number of bits in the network portion of the
8633 address. The above example specifies a 24-bit netmask, so it matches all 256
8634 addresses in the 10.11.42.0 network. An item such as
8635 .code
8636 192.168.23.236/31
8637 .endd
8638 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8639 32 for an IPv4 address is the same as no mask at all; just a single address
8640 matches.
8641
8642 Here is another example which shows an IPv4 and an IPv6 network:
8643 .code
8644 recipient_unqualified_hosts = 192.168.0.0/16: \
8645                               3ffe::ffff::836f::::/48
8646 .endd
8647 The doubling of list separator characters applies only when these items
8648 appear inline in a host list. It is not required when indirecting via a file.
8649 For example:
8650 .code
8651 recipient_unqualified_hosts = /opt/exim/unqualnets
8652 .endd
8653 could make use of a file containing
8654 .code
8655 172.16.0.0/12
8656 3ffe:ffff:836f::/48
8657 .endd
8658 to have exactly the same effect as the previous example. When listing IPv6
8659 addresses inline, it is usually more convenient to use the facility for
8660 changing separator characters. This list contains the same two networks:
8661 .code
8662 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8663                                  3ffe:ffff:836f::/48
8664 .endd
8665 The separator is changed to semicolon by the leading &"<;"& at the start of the
8666 list.
8667 .endlist
8668
8669
8670
8671 .section "Host list patterns for single-key lookups by host address" &&&
8672          "SECThoslispatsikey"
8673 .cindex "host list" "lookup of IP address"
8674 When a host is to be identified by a single-key lookup of its complete IP
8675 address, the pattern takes this form:
8676 .display
8677 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8678 .endd
8679 For example:
8680 .code
8681 hosts_lookup = net-cdb;/hosts-by-ip.db
8682 .endd
8683 The text form of the IP address of the subject host is used as the lookup key.
8684 IPv6 addresses are converted to an unabbreviated form, using lower case
8685 letters, with dots as separators because colon is the key terminator in
8686 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8687 quoting the keys, but this is a facility that was added later.] The data
8688 returned by the lookup is not used.
8689
8690 .cindex "IP address" "masking"
8691 .cindex "host list" "masked IP address"
8692 Single-key lookups can also be performed using masked IP addresses, using
8693 patterns of this form:
8694 .display
8695 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8696 .endd
8697 For example:
8698 .code
8699 net24-dbm;/networks.db
8700 .endd
8701 The IP address of the subject host is masked using <&'number'&> as the mask
8702 length. A textual string is constructed from the masked value, followed by the
8703 mask, and this is used as the lookup key. For example, if the host's IP address
8704 is 192.168.34.6, the key that is looked up for the above example is
8705 &"192.168.34.0/24"&.
8706
8707 When an IPv6 address is converted to a string, dots are normally used instead
8708 of colons, so that keys in &(lsearch)& files need not contain colons (which
8709 terminate &(lsearch)& keys). This was implemented some time before the ability
8710 to quote keys was made available in &(lsearch)& files. However, the more
8711 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8712 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8713 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8714 converted using colons and not dots.
8715 .new
8716 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8717 addresses are always used.
8718 The latter are converted to IPv4 addresses, in dotted-quad form.
8719 .wen
8720
8721 Ideally, it would be nice to tidy up this anomalous situation by changing to
8722 colons in all cases, given that quoting is now available for &(lsearch)&.
8723 However, this would be an incompatible change that might break some existing
8724 configurations.
8725
8726 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8727 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8728 the former case the key strings include the mask value, whereas in the latter
8729 case the IP address is used on its own.
8730
8731
8732
8733 .section "Host list patterns that match by host name" "SECThoslispatnam"
8734 .cindex "host" "lookup failures"
8735 .cindex "unknown host name"
8736 .cindex "host list" "matching host name"
8737 There are several types of pattern that require Exim to know the name of the
8738 remote host. These are either wildcard patterns or lookups by name. (If a
8739 complete hostname is given without any wildcarding, it is used to find an IP
8740 address to match against, as described in section &<<SECThoslispatip>>&
8741 above.)
8742
8743 If the remote host name is not already known when Exim encounters one of these
8744 patterns, it has to be found from the IP address.
8745 Although many sites on the Internet are conscientious about maintaining reverse
8746 DNS data for their hosts, there are also many that do not do this.
8747 Consequently, a name cannot always be found, and this may lead to unwanted
8748 effects. Take care when configuring host lists with wildcarded name patterns.
8749 Consider what will happen if a name cannot be found.
8750
8751 Because of the problems of determining host names from IP addresses, matching
8752 against host names is not as common as matching against IP addresses.
8753
8754 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8755 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8756 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8757 are done can be changed by setting the &%host_lookup_order%& option. For
8758 security, once Exim has found one or more names, it looks up the IP addresses
8759 for these names and compares them with the IP address that it started with.
8760 Only those names whose IP addresses match are accepted. Any other names are
8761 discarded. If no names are left, Exim behaves as if the host name cannot be
8762 found. In the most common case there is only one name and one IP address.
8763
8764 There are some options that control what happens if a host name cannot be
8765 found. These are described in section &<<SECTbehipnot>>& below.
8766
8767 .cindex "host" "alias for"
8768 .cindex "alias for host"
8769 As a result of aliasing, hosts may have more than one name. When processing any
8770 of the following types of pattern, all the host's names are checked:
8771
8772 .ilist
8773 .cindex "asterisk" "in host list"
8774 If a pattern starts with &"*"& the remainder of the item must match the end of
8775 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8776 &'.b.c'&. This special simple form is provided because this is a very common
8777 requirement. Other kinds of wildcarding require the use of a regular
8778 expression.
8779 .next
8780 .cindex "regular expressions" "in host list"
8781 .cindex "host list" "regular expression in"
8782 If the item starts with &"^"& it is taken to be a regular expression which is
8783 matched against the host name. Host names are case-independent, so this regular
8784 expression match is by default case-independent, but you can make it
8785 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8786 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8787 example,
8788 .code
8789 ^(a|b)\.c\.d$
8790 .endd
8791 is a regular expression that matches either of the two hosts &'a.c.d'& or
8792 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8793 that backslash and dollar characters are not misinterpreted as part of the
8794 string expansion. The simplest way to do this is to use &`\N`& to mark that
8795 part of the string as non-expandable. For example:
8796 .code
8797 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8798 .endd
8799 &*Warning*&: If you want to match a complete host name, you must include the
8800 &`$`& terminating metacharacter in the regular expression, as in the above
8801 example. Without it, a match at the start of the host name is all that is
8802 required.
8803 .endlist
8804
8805
8806
8807
8808 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8809 .cindex "host" "lookup failures, permanent"
8810 While processing a host list, Exim may need to look up an IP address from a
8811 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8812 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8813 behaviour when it fails to find the information it is seeking is the same.
8814
8815 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8816 apply to temporary DNS errors, whose handling is described in the next section.
8817
8818 .cindex "&`+include_unknown`&"
8819 .cindex "&`+ignore_unknown`&"
8820 Exim parses a host list from left to right. If it encounters a permanent
8821 lookup failure in any item in the host list before it has found a match,
8822 Exim treats it as a failure and the default behavior is as if the host
8823 does not match the list. This may not always be what you want to happen.
8824 To change Exim's behaviour, the special items &`+include_unknown`& or
8825 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8826 not recognized in an indirected file).
8827
8828 .ilist
8829 If any item that follows &`+include_unknown`& requires information that
8830 cannot found, Exim behaves as if the host does match the list. For example,
8831 .code
8832 host_reject_connection = +include_unknown:*.enemy.ex
8833 .endd
8834 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8835 any hosts whose name it cannot find.
8836
8837 .next
8838 If any item that follows &`+ignore_unknown`& requires information that cannot
8839 be found, Exim ignores that item and proceeds to the rest of the list. For
8840 example:
8841 .code
8842 accept hosts = +ignore_unknown : friend.example : \
8843                192.168.4.5
8844 .endd
8845 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8846 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8847 name can be found for 192.168.4.5, it is rejected.
8848 .endlist
8849
8850 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8851 list. The effect of each one lasts until the next, or until the end of the
8852 list.
8853
8854 .section "Mixing wildcarded host names and addresses in host lists" &&&
8855          "SECTmixwilhos"
8856 .cindex "host list" "mixing names and addresses in"
8857
8858 This section explains the host/ip processing logic with the same concepts
8859 as the previous section, but specifically addresses what happens when a
8860 wildcarded hostname is one of the items in the hostlist.
8861
8862 .ilist
8863 If you have name lookups or wildcarded host names and
8864 IP addresses in the same host list, you should normally put the IP
8865 addresses first. For example, in an ACL you could have:
8866 .code
8867 accept hosts = 10.9.8.7 : *.friend.example
8868 .endd
8869 The reason you normally would order it this way lies in the
8870 left-to-right way that Exim processes lists.  It can test IP addresses
8871 without doing any DNS lookups, but when it reaches an item that requires
8872 a host name, it fails if it cannot find a host name to compare with the
8873 pattern. If the above list is given in the opposite order, the
8874 &%accept%& statement fails for a host whose name cannot be found, even
8875 if its IP address is 10.9.8.7.
8876
8877 .next
8878 If you really do want to do the name check first, and still recognize the IP
8879 address, you can rewrite the ACL like this:
8880 .code
8881 accept hosts = *.friend.example
8882 accept hosts = 10.9.8.7
8883 .endd
8884 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8885 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8886 &`+ignore_unknown`&, which was discussed in depth in the first example in
8887 this section.
8888 .endlist
8889
8890
8891 .section "Temporary DNS errors when looking up host information" &&&
8892          "SECTtemdnserr"
8893 .cindex "host" "lookup failures, temporary"
8894 .cindex "&`+include_defer`&"
8895 .cindex "&`+ignore_defer`&"
8896 A temporary DNS lookup failure normally causes a defer action (except when
8897 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8898 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8899 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8900 section. These options should be used with care, probably only in non-critical
8901 host lists such as whitelists.
8902
8903
8904
8905 .section "Host list patterns for single-key lookups by host name" &&&
8906          "SECThoslispatnamsk"
8907 .cindex "unknown host name"
8908 .cindex "host list" "matching host name"
8909 If a pattern is of the form
8910 .display
8911 <&'single-key-search-type'&>;<&'search-data'&>
8912 .endd
8913 for example
8914 .code
8915 dbm;/host/accept/list
8916 .endd
8917 a single-key lookup is performed, using the host name as its key. If the
8918 lookup succeeds, the host matches the item. The actual data that is looked up
8919 is not used.
8920
8921 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8922 keys in the file, not IP addresses. If you want to do lookups based on IP
8923 addresses, you must precede the search type with &"net-"& (see section
8924 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8925 two items in the same list, one doing an address lookup and one doing a name
8926 lookup, both using the same file.
8927
8928
8929
8930 .section "Host list patterns for query-style lookups" "SECID81"
8931 If a pattern is of the form
8932 .display
8933 <&'query-style-search-type'&>;<&'query'&>
8934 .endd
8935 the query is obeyed, and if it succeeds, the host matches the item. The actual
8936 data that is looked up is not used. The variables &$sender_host_address$& and
8937 &$sender_host_name$& can be used in the query. For example:
8938 .code
8939 hosts_lookup = pgsql;\
8940   select ip from hostlist where ip='$sender_host_address'
8941 .endd
8942 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8943 can use the &%sg%& expansion item to change this if you need to. If you want to
8944 use masked IP addresses in database queries, you can use the &%mask%& expansion
8945 operator.
8946
8947 If the query contains a reference to &$sender_host_name$&, Exim automatically
8948 looks up the host name if it has not already done so. (See section
8949 &<<SECThoslispatnam>>& for comments on finding host names.)
8950
8951 Historical note: prior to release 4.30, Exim would always attempt to find a
8952 host name before running the query, unless the search type was preceded by
8953 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8954 still recognized for query-style lookups, but its presence or absence has no
8955 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8956 See section &<<SECThoslispatsikey>>&.)
8957
8958
8959
8960
8961
8962 .section "Address lists" "SECTaddresslist"
8963 .cindex "list" "address list"
8964 .cindex "address list" "empty item"
8965 .cindex "address list" "patterns"
8966 Address lists contain patterns that are matched against mail addresses. There
8967 is one special case to be considered: the sender address of a bounce message is
8968 always empty. You can test for this by providing an empty item in an address
8969 list. For example, you can set up a router to process bounce messages by
8970 using this option setting:
8971 .code
8972 senders = :
8973 .endd
8974 The presence of the colon creates an empty item. If you do not provide any
8975 data, the list is empty and matches nothing. The empty sender can also be
8976 detected by a regular expression that matches an empty string,
8977 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8978
8979 Non-empty items in an address list can be straightforward email addresses. For
8980 example:
8981 .code
8982 senders = jbc@askone.example : hs@anacreon.example
8983 .endd
8984 A certain amount of wildcarding is permitted. If a pattern contains an @
8985 character, but is not a regular expression and does not begin with a
8986 semicolon-terminated lookup type (described below), the local part of the
8987 subject address is compared with the local part of the pattern, which may start
8988 with an asterisk. If the local parts match, the domain is checked in exactly
8989 the same way as for a pattern in a domain list. For example, the domain can be
8990 wildcarded, refer to a named list, or be a lookup:
8991 .code
8992 deny senders = *@*.spamming.site:\
8993                *@+hostile_domains:\
8994                bozo@partial-lsearch;/list/of/dodgy/sites:\
8995                *@dbm;/bad/domains.db
8996 .endd
8997 .cindex "local part" "starting with !"
8998 .cindex "address list" "local part starting with !"
8999 If a local part that begins with an exclamation mark is required, it has to be
9000 specified using a regular expression, because otherwise the exclamation mark is
9001 treated as a sign of negation, as is standard in lists.
9002
9003 If a non-empty pattern that is not a regular expression or a lookup does not
9004 contain an @ character, it is matched against the domain part of the subject
9005 address. The only two formats that are recognized this way are a literal
9006 domain, or a domain pattern that starts with *. In both these cases, the effect
9007 is the same as if &`*@`& preceded the pattern. For example:
9008 .code
9009 deny senders = enemy.domain : *.enemy.domain
9010 .endd
9011
9012 The following kinds of more complicated address list pattern can match any
9013 address, including the empty address that is characteristic of bounce message
9014 senders:
9015
9016 .ilist
9017 .cindex "regular expressions" "in address list"
9018 .cindex "address list" "regular expression in"
9019 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9020 done against the complete address, with the pattern as the regular expression.
9021 You must take care that backslash and dollar characters are not misinterpreted
9022 as part of the string expansion. The simplest way to do this is to use &`\N`&
9023 to mark that part of the string as non-expandable. For example:
9024 .code
9025 deny senders = \N^.*this.*@example\.com$\N : \
9026                \N^\d{8}.+@spamhaus.example$\N : ...
9027 .endd
9028 The &`\N`& sequences are removed by the expansion, so these items do indeed
9029 start with &"^"& by the time they are being interpreted as address patterns.
9030
9031 .next
9032 .cindex "address list" "lookup for complete address"
9033 Complete addresses can be looked up by using a pattern that starts with a
9034 lookup type terminated by a semicolon, followed by the data for the lookup. For
9035 example:
9036 .code
9037 deny senders = cdb;/etc/blocked.senders : \
9038   mysql;select address from blocked where \
9039   address='${quote_mysql:$sender_address}'
9040 .endd
9041 Both query-style and single-key lookup types can be used. For a single-key
9042 lookup type, Exim uses the complete address as the key. However, empty keys are
9043 not supported for single-key lookups, so a match against the empty address
9044 always fails. This restriction does not apply to query-style lookups.
9045
9046 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9047 cannot be used, and is ignored if specified, with an entry being written to the
9048 panic log.
9049 .cindex "*@ with single-key lookup"
9050 However, you can configure lookup defaults, as described in section
9051 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9052 default. For example, with this lookup:
9053 .code
9054 accept senders = lsearch*@;/some/file
9055 .endd
9056 the file could contains lines like this:
9057 .code
9058 user1@domain1.example
9059 *@domain2.example
9060 .endd
9061 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9062 that are tried is:
9063 .code
9064 nimrod@jaeger.example
9065 *@jaeger.example
9066 *
9067 .endd
9068 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9069 would mean that every address matches, thus rendering the test useless.
9070
9071 &*Warning 2*&: Do not confuse these two kinds of item:
9072 .code
9073 deny recipients = dbm*@;/some/file
9074 deny recipients = *@dbm;/some/file
9075 .endd
9076 The first does a whole address lookup, with defaulting, as just described,
9077 because it starts with a lookup type. The second matches the local part and
9078 domain independently, as described in a bullet point below.
9079 .endlist
9080
9081
9082 The following kinds of address list pattern can match only non-empty addresses.
9083 If the subject address is empty, a match against any of these pattern types
9084 always fails.
9085
9086
9087 .ilist
9088 .cindex "@@ with single-key lookup"
9089 .cindex "address list" "@@ lookup type"
9090 .cindex "address list" "split local part and domain"
9091 If a pattern starts with &"@@"& followed by a single-key lookup item
9092 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9093 split into a local part and a domain. The domain is looked up in the file. If
9094 it is not found, there is no match. If it is found, the data that is looked up
9095 from the file is treated as a colon-separated list of local part patterns, each
9096 of which is matched against the subject local part in turn.
9097
9098 .cindex "asterisk" "in address list"
9099 The lookup may be a partial one, and/or one involving a search for a default
9100 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9101 patterns that are looked up can be regular expressions or begin with &"*"&, or
9102 even be further lookups. They may also be independently negated. For example,
9103 with
9104 .code
9105 deny senders = @@dbm;/etc/reject-by-domain
9106 .endd
9107 the data from which the DBM file is built could contain lines like
9108 .code
9109 baddomain.com:  !postmaster : *
9110 .endd
9111 to reject all senders except &%postmaster%& from that domain.
9112
9113 .cindex "local part" "starting with !"
9114 If a local part that actually begins with an exclamation mark is required, it
9115 has to be specified using a regular expression. In &(lsearch)& files, an entry
9116 may be split over several lines by indenting the second and subsequent lines,
9117 but the separating colon must still be included at line breaks. White space
9118 surrounding the colons is ignored. For example:
9119 .code
9120 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9121   spammer3 : spammer4
9122 .endd
9123 As in all colon-separated lists in Exim, a colon can be included in an item by
9124 doubling.
9125
9126 If the last item in the list starts with a right angle-bracket, the remainder
9127 of the item is taken as a new key to look up in order to obtain a continuation
9128 list of local parts. The new key can be any sequence of characters. Thus one
9129 might have entries like
9130 .code
9131 aol.com: spammer1 : spammer 2 : >*
9132 xyz.com: spammer3 : >*
9133 *:       ^\d{8}$
9134 .endd
9135 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9136 local parts for all domains, in addition to the specific local parts listed for
9137 each domain. Of course, using this feature costs another lookup each time a
9138 chain is followed, but the effort needed to maintain the data is reduced.
9139
9140 .cindex "loop" "in lookups"
9141 It is possible to construct loops using this facility, and in order to catch
9142 them, the chains may be no more than fifty items long.
9143
9144 .next
9145 The @@<&'lookup'&> style of item can also be used with a query-style
9146 lookup, but in this case, the chaining facility is not available. The lookup
9147 can only return a single list of local parts.
9148 .endlist
9149
9150 &*Warning*&: There is an important difference between the address list items
9151 in these two examples:
9152 .code
9153 senders = +my_list
9154 senders = *@+my_list
9155 .endd
9156 In the first one, &`my_list`& is a named address list, whereas in the second
9157 example it is a named domain list.
9158
9159
9160
9161
9162 .section "Case of letters in address lists" "SECTcasletadd"
9163 .cindex "case of local parts"
9164 .cindex "address list" "case forcing"
9165 .cindex "case forcing in address lists"
9166 Domains in email addresses are always handled caselessly, but for local parts
9167 case may be significant on some systems (see &%caseful_local_part%& for how
9168 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9169 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9170 blocking lists should be done in a case-independent manner. Since most address
9171 lists in Exim are used for this kind of control, Exim attempts to do this by
9172 default.
9173
9174 The domain portion of an address is always lowercased before matching it to an
9175 address list. The local part is lowercased by default, and any string
9176 comparisons that take place are done caselessly. This means that the data in
9177 the address list itself, in files included as plain filenames, and in any file
9178 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9179 keys in files that are looked up by a search type other than &(lsearch)& (which
9180 works caselessly) must be in lower case, because these lookups are not
9181 case-independent.
9182
9183 .cindex "&`+caseful`&"
9184 To allow for the possibility of caseful address list matching, if an item in
9185 an address list is the string &"+caseful"&, the original case of the local
9186 part is restored for any comparisons that follow, and string comparisons are no
9187 longer case-independent. This does not affect the domain, which remains in
9188 lower case. However, although independent matches on the domain alone are still
9189 performed caselessly, regular expressions that match against an entire address
9190 become case-sensitive after &"+caseful"& has been seen.
9191
9192
9193
9194 .section "Local part lists" "SECTlocparlis"
9195 .cindex "list" "local part list"
9196 .cindex "local part" "list"
9197 Case-sensitivity in local part lists is handled in the same way as for address
9198 lists, as just described. The &"+caseful"& item can be used if required. In a
9199 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9200 set false, the subject is lowercased and the matching is initially
9201 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9202 matching in the local part list, but not elsewhere in the router. If
9203 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9204 option is case-sensitive from the start.
9205
9206 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9207 comments are handled in the same way as address lists &-- they are recognized
9208 only if the # is preceded by white space or the start of the line.
9209 Otherwise, local part lists are matched in the same way as domain lists, except
9210 that the special items that refer to the local host (&`@`&, &`@[]`&,
9211 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9212 Refer to section &<<SECTdomainlist>>& for details of the other available item
9213 types.
9214 .ecindex IIDdohoadli
9215
9216
9217
9218
9219 . ////////////////////////////////////////////////////////////////////////////
9220 . ////////////////////////////////////////////////////////////////////////////
9221
9222 .chapter "String expansions" "CHAPexpand"
9223 .scindex IIDstrexp "expansion" "of strings"
9224 Many strings in Exim's runtime configuration are expanded before use. Some of
9225 them are expanded every time they are used; others are expanded only once.
9226
9227 When a string is being expanded it is copied verbatim from left to right except
9228 .cindex expansion "string concatenation"
9229 when a dollar or backslash character is encountered. A dollar specifies the
9230 start of a portion of the string that is interpreted and replaced as described
9231 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9232 escape character, as described in the following section.
9233
9234 Whether a string is expanded depends upon the context.  Usually this is solely
9235 dependent upon the option for which a value is sought; in this documentation,
9236 options for which string expansion is performed are marked with &dagger; after
9237 the data type.  ACL rules always expand strings.  A couple of expansion
9238 conditions do not expand some of the brace-delimited branches, for security
9239 reasons,
9240 .new
9241 .cindex "tainted data" expansion
9242 .cindex expansion "tainted data"
9243 and expansion of data deriving from the sender (&"tainted data"&)
9244 is not permitted.
9245 .wen
9246
9247
9248
9249 .section "Literal text in expanded strings" "SECTlittext"
9250 .cindex "expansion" "including literal text"
9251 An uninterpreted dollar can be included in an expanded string by putting a
9252 backslash in front of it. A backslash can be used to prevent any special
9253 character being treated specially in an expansion, including backslash itself.
9254 If the string appears in quotes in the configuration file, two backslashes are
9255 required because the quotes themselves cause interpretation of backslashes when
9256 the string is read in (see section &<<SECTstrings>>&).
9257
9258 .cindex "expansion" "non-expandable substrings"
9259 A portion of the string can specified as non-expandable by placing it between
9260 two occurrences of &`\N`&. This is particularly useful for protecting regular
9261 expressions, which often contain backslashes and dollar signs. For example:
9262 .code
9263 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9264 .endd
9265 On encountering the first &`\N`&, the expander copies subsequent characters
9266 without interpretation until it reaches the next &`\N`& or the end of the
9267 string.
9268
9269
9270
9271 .section "Character escape sequences in expanded strings" "SECID82"
9272 .cindex "expansion" "escape sequences"
9273 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9274 expanded string is recognized as an escape sequence for the character newline,
9275 carriage return, or tab, respectively. A backslash followed by up to three
9276 octal digits is recognized as an octal encoding for a single character, and a
9277 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9278 encoding.
9279
9280 These escape sequences are also recognized in quoted strings when they are read
9281 in. Their interpretation in expansions as well is useful for unquoted strings,
9282 and for other cases such as looked-up strings that are then expanded.
9283
9284
9285 .section "Testing string expansions" "SECID83"
9286 .cindex "expansion" "testing"
9287 .cindex "testing" "string expansion"
9288 .oindex "&%-be%&"
9289 Many expansions can be tested by calling Exim with the &%-be%& option. This
9290 takes the command arguments, or lines from the standard input if there are no
9291 arguments, runs them through the string expansion code, and writes the results
9292 to the standard output. Variables based on configuration values are set up, but
9293 since no message is being processed, variables such as &$local_part$& have no
9294 value. Nevertheless the &%-be%& option can be useful for checking out file and
9295 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9296 and &%nhash%&.
9297
9298 Exim gives up its root privilege when it is called with the &%-be%& option, and
9299 instead runs under the uid and gid it was called with, to prevent users from
9300 using &%-be%& for reading files to which they do not have access.
9301
9302 .oindex "&%-bem%&"
9303 If you want to test expansions that include variables whose values are taken
9304 from a message, there are two other options that can be used. The &%-bem%&
9305 option is like &%-be%& except that it is followed by a filename. The file is
9306 read as a message before doing the test expansions. For example:
9307 .code
9308 exim -bem /tmp/test.message '$h_subject:'
9309 .endd
9310 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9311 Exim message identifier. For example:
9312 .code
9313 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9314 .endd
9315 This loads the message from Exim's spool before doing the test expansions, and
9316 is therefore restricted to admin users.
9317
9318
9319 .section "Forced expansion failure" "SECTforexpfai"
9320 .cindex "expansion" "forced failure"
9321 A number of expansions that are described in the following section have
9322 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9323 (which are sometimes called &"curly brackets"&). Which of the two strings is
9324 used depends on some condition that is evaluated as part of the expansion. If,
9325 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9326 the entire string expansion fails in a way that can be detected by the code
9327 that requested the expansion. This is called &"forced expansion failure"&, and
9328 its consequences depend on the circumstances. In some cases it is no different
9329 from any other expansion failure, but in others a different action may be
9330 taken. Such variations are mentioned in the documentation of the option that is
9331 being expanded.
9332
9333
9334
9335
9336 .section "Expansion items" "SECTexpansionitems"
9337 The following items are recognized in expanded strings. White space may be used
9338 between sub-items that are keywords or substrings enclosed in braces inside an
9339 outer set of braces, to improve readability. &*Warning*&: Within braces,
9340 white space is significant.
9341
9342 .vlist
9343 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9344 .cindex "expansion" "variables"
9345 Substitute the contents of the named variable, for example:
9346 .code
9347 $local_part
9348 ${domain}
9349 .endd
9350 The second form can be used to separate the name from subsequent alphanumeric
9351 characters. This form (using braces) is available only for variables; it does
9352 &'not'& apply to message headers. The names of the variables are given in
9353 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9354 given, the expansion fails.
9355
9356 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9357 .cindex "expansion" "operators"
9358 The string is first itself expanded, and then the operation specified by
9359 <&'op'&> is applied to it. For example:
9360 .code
9361 ${lc:$local_part}
9362 .endd
9363 The string starts with the first character after the colon, which may be
9364 leading white space. A list of operators is given in section &<<SECTexpop>>&
9365 below. The operator notation is used for simple expansion items that have just
9366 one argument, because it reduces the number of braces and therefore makes the
9367 string easier to understand.
9368
9369 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9370 This item inserts &"basic"& header lines. It is described with the &%header%&
9371 expansion item below.
9372
9373
9374 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9375 .cindex "expansion" "calling an acl"
9376 .cindex "&%acl%&" "call from expansion"
9377 The name and zero to nine argument strings are first expanded separately.  The expanded
9378 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9379 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9380 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9381 and may use the variables; if another acl expansion is used the values
9382 are restored after it returns.  If the ACL sets
9383 a value using a "message =" modifier and returns accept or deny, the value becomes
9384 the result of the expansion.
9385 If no message is set and the ACL returns accept or deny
9386 the expansion result is an empty string.
9387 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9388
9389
9390 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9391 .cindex authentication "results header"
9392 .cindex headers "authentication-results:"
9393 .cindex authentication "expansion item"
9394 This item returns a string suitable for insertion as an
9395 &'Authentication-Results:'&
9396 header line.
9397 The given <&'authserv-id'&> is included in the result; typically this
9398 will be a domain name identifying the system performing the authentications.
9399 Methods that might be present in the result include:
9400 .code
9401 none
9402 iprev
9403 auth
9404 spf
9405 dkim
9406 .endd
9407
9408 Example use (as an ACL modifier):
9409 .code
9410       add_header = :at_start:${authresults {$primary_hostname}}
9411 .endd
9412 This is safe even if no authentication results are available.
9413
9414
9415 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9416        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9417 .cindex "expansion" "extracting certificate fields"
9418 .cindex "&%certextract%&" "certificate fields"
9419 .cindex "certificate" "extracting fields"
9420 The <&'certificate'&> must be a variable of type certificate.
9421 The field name is expanded and used to retrieve the relevant field from
9422 the certificate.  Supported fields are:
9423 .display
9424 &`version        `&
9425 &`serial_number  `&
9426 &`subject        `& RFC4514 DN
9427 &`issuer         `& RFC4514 DN
9428 &`notbefore      `& time
9429 &`notafter       `& time
9430 &`sig_algorithm  `&
9431 &`signature      `&
9432 &`subj_altname   `& tagged list
9433 &`ocsp_uri       `& list
9434 &`crl_uri        `& list
9435 .endd
9436 If the field is found,
9437 <&'string2'&> is expanded, and replaces the whole item;
9438 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9439 variable &$value$& contains the value that has been extracted. Afterwards, it
9440 is restored to any previous value it might have had.
9441
9442 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9443 key is not found. If {<&'string2'&>} is also omitted, the value that was
9444 extracted is used.
9445
9446 Some field names take optional modifiers, appended and separated by commas.
9447
9448 The field selectors marked as "RFC4514" above
9449 output a Distinguished Name string which is
9450 not quite
9451 parseable by Exim as a comma-separated tagged list
9452 (the exceptions being elements containing commas).
9453 RDN elements of a single type may be selected by
9454 a modifier of the type label; if so the expansion
9455 result is a list (newline-separated by default).
9456 The separator may be changed by another modifier of
9457 a right angle-bracket followed immediately by the new separator.
9458 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9459
9460 The field selectors marked as "time" above
9461 take an optional modifier of "int"
9462 for which the result is the number of seconds since epoch.
9463 Otherwise the result is a human-readable string
9464 in the timezone selected by the main "timezone" option.
9465
9466 The field selectors marked as "list" above return a list,
9467 newline-separated by default,
9468 (embedded separator characters in elements are doubled).
9469 The separator may be changed by a modifier of
9470 a right angle-bracket followed immediately by the new separator.
9471
9472 The field selectors marked as "tagged" above
9473 prefix each list element with a type string and an equals sign.
9474 Elements of only one type may be selected by a modifier
9475 which is one of "dns", "uri" or "mail";
9476 if so the element tags are omitted.
9477
9478 If not otherwise noted field values are presented in human-readable form.
9479
9480 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9481        {*&<&'arg'&>&*}...}*&"
9482 .cindex &%dlfunc%&
9483 This expansion dynamically loads and then calls a locally-written C function.
9484 This functionality is available only if Exim is compiled with
9485 .code
9486 EXPAND_DLFUNC=yes
9487 .endd
9488 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9489 object so that it doesn't reload the same object file in the same Exim process
9490 (but of course Exim does start new processes frequently).
9491
9492 There may be from zero to eight arguments to the function.
9493
9494 .new
9495 When compiling
9496 a local function that is to be called in this way,
9497 first &_DLFUNC_IMPL_& should be defined,
9498 and second &_local_scan.h_& should be included.
9499 .wen
9500 The Exim variables and functions that are defined by that API
9501 are also available for dynamically loaded functions. The function itself
9502 must have the following type:
9503 .code
9504 int dlfunction(uschar **yield, int argc, uschar *argv[])
9505 .endd
9506 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9507 function should return one of the following values:
9508
9509 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9510 into the expanded string that is being built.
9511
9512 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9513 from &'yield'&, if it is set.
9514
9515 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9516 taken from &'yield'& if it is set.
9517
9518 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9519
9520 When compiling a function that is to be used in this way with gcc,
9521 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9522 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9523
9524
9525 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9526 .cindex "expansion" "extracting value from environment"
9527 .cindex "environment" "values from"
9528 The key is first expanded separately, and leading and trailing white space
9529 removed.
9530 This is then searched for as a name in the environment.
9531 If a variable is found then its value is placed in &$value$&
9532 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9533
9534 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9535 appear, for example:
9536 .code
9537 ${env{USER}{$value} fail }
9538 .endd
9539 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9540 {<&'string1'&>} must be present for &"fail"& to be recognized.
9541
9542 If {<&'string2'&>} is omitted an empty string is substituted on
9543 search failure.
9544 If {<&'string1'&>} is omitted the search result is substituted on
9545 search success.
9546
9547 The environment is adjusted by the &%keep_environment%& and
9548 &%add_environment%& main section options.
9549
9550
9551 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9552        {*&<&'string3'&>&*}}*&"
9553 .cindex "expansion" "extracting substrings by key"
9554 .cindex "&%extract%&" "substrings by key"
9555 The key and <&'string1'&> are first expanded separately. Leading and trailing
9556 white space is removed from the key (but not from any of the strings). The key
9557 must not be empty and must not consist entirely of digits.
9558 The expanded <&'string1'&> must be of the form:
9559 .display
9560 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9561 .endd
9562 .vindex "&$value$&"
9563 where the equals signs and spaces (but not both) are optional. If any of the
9564 values contain white space, they must be enclosed in double quotes, and any
9565 values that are enclosed in double quotes are subject to escape processing as
9566 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9567 for the value that corresponds to the key. The search is case-insensitive. If
9568 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9569 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9570 variable &$value$& contains the value that has been extracted. Afterwards, it
9571 is restored to any previous value it might have had.
9572
9573 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9574 key is not found. If {<&'string2'&>} is also omitted, the value that was
9575 extracted is used. Thus, for example, these two expansions are identical, and
9576 yield &"2001"&:
9577 .code
9578 ${extract{gid}{uid=1984 gid=2001}}
9579 ${extract{gid}{uid=1984 gid=2001}{$value}}
9580 .endd
9581 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9582 appear, for example:
9583 .code
9584 ${extract{Z}{A=... B=...}{$value} fail }
9585 .endd
9586 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9587 {<&'string2'&>} must be present for &"fail"& to be recognized.
9588
9589 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9590        {*&<&'string3'&>&*}}*&" &&&
9591        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9592        {*&<&'string3'&>&*}}*&"
9593 .cindex "expansion" "extracting from JSON object"
9594 .cindex JSON expansions
9595 The key and <&'string1'&> are first expanded separately. Leading and trailing
9596 white space is removed from the key (but not from any of the strings). The key
9597 must not be empty and must not consist entirely of digits.
9598 The expanded <&'string1'&> must be of the form:
9599 .display
9600 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9601 .endd
9602 .vindex "&$value$&"
9603 The braces, commas and colons, and the quoting of the member name are required;
9604 the spaces are optional.
9605 Matching of the key against the member names is done case-sensitively.
9606 For the &"json"& variant,
9607 if a returned value is a JSON string, it retains its leading and
9608 trailing quotes.
9609 .new
9610 For the &"jsons"& variant, which is intended for use with JSON strings, the
9611 leading and trailing quotes are removed from the returned value.
9612 .wen
9613 . XXX should be a UTF-8 compare
9614
9615 The results of matching are handled as above.
9616
9617
9618 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9619         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9620 .cindex "expansion" "extracting substrings by number"
9621 .cindex "&%extract%&" "substrings by number"
9622 The <&'number'&> argument must consist entirely of decimal digits,
9623 apart from leading and trailing white space, which is ignored.
9624 This is what distinguishes this form of &%extract%& from the previous kind. It
9625 behaves in the same way, except that, instead of extracting a named field, it
9626 extracts from <&'string1'&> the field whose number is given as the first
9627 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9628 <&'string3'&> as before.
9629
9630 The fields in the string are separated by any one of the characters in the
9631 separator string. These may include space or tab characters.
9632 The first field is numbered one. If the number is negative, the fields are
9633 counted from the end of the string, with the rightmost one numbered -1. If the
9634 number given is zero, the entire string is returned. If the modulus of the
9635 number is greater than the number of fields in the string, the result is the
9636 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9637 provided. For example:
9638 .code
9639 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9640 .endd
9641 yields &"42"&, and
9642 .code
9643 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9644 .endd
9645 yields &"99"&. Two successive separators mean that the field between them is
9646 empty (for example, the fifth field above).
9647
9648
9649 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9650         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9651        "&*${extract jsons{*&<&'number'&>&*}}&&&
9652         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9653 .cindex "expansion" "extracting from JSON array"
9654 .cindex JSON expansions
9655 The <&'number'&> argument must consist entirely of decimal digits,
9656 apart from leading and trailing white space, which is ignored.
9657
9658 Field selection and result handling is as above;
9659 there is no choice of field separator.
9660 For the &"json"& variant,
9661 if a returned value is a JSON string, it retains its leading and
9662 trailing quotes.
9663 .new
9664 For the &"jsons"& variant, which is intended for use with JSON strings, the
9665 leading and trailing quotes are removed from the returned value.
9666 .wen
9667
9668
9669 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9670 .cindex "list" "selecting by condition"
9671 .cindex "expansion" "selecting from list by condition"
9672 .vindex "&$item$&"
9673 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9674 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9675 For each item
9676 in this list, its value is place in &$item$&, and then the condition is
9677 evaluated. If the condition is true, &$item$& is added to the output as an
9678 item in a new list; if the condition is false, the item is discarded. The
9679 separator used for the output list is the same as the one used for the
9680 input, but a separator setting is not included in the output. For example:
9681 .code
9682 ${filter{a:b:c}{!eq{$item}{b}}}
9683 .endd
9684 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9685 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9686
9687
9688 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9689 .cindex "hash function" "textual"
9690 .cindex "expansion" "textual hash"
9691 This is a textual hashing function, and was the first to be implemented in
9692 early versions of Exim. In current releases, there are other hashing functions
9693 (numeric, MD5, and SHA-1), which are described below.
9694
9695 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9696 <&'n'&>. If you are using fixed values for these numbers, that is, if
9697 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9698 use the simpler operator notation that avoids some of the braces:
9699 .code
9700 ${hash_<n>_<m>:<string>}
9701 .endd
9702 The second number is optional (in both notations). If <&'n'&> is greater than
9703 or equal to the length of the string, the expansion item returns the string.
9704 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9705 function to the string. The new string consists of characters taken from the
9706 first <&'m'&> characters of the string
9707 .code
9708 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9709 .endd
9710 If <&'m'&> is not present the value 26 is used, so that only lower case
9711 letters appear. For example:
9712 .display
9713 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9714 &`$hash{5}{monty}}           `&   yields  &`monty`&
9715 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9716 .endd
9717
9718 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9719         &*$h_*&<&'header&~name'&>&*:*&" &&&
9720        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9721         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9722        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9723         &*$lh_*&<&'header&~name'&>&*:*&"
9724        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9725         &*$rh_*&<&'header&~name'&>&*:*&"
9726 .cindex "expansion" "header insertion"
9727 .vindex "&$header_$&"
9728 .vindex "&$bheader_$&"
9729 .vindex "&$lheader_$&"
9730 .vindex "&$rheader_$&"
9731 .cindex "header lines" "in expansion strings"
9732 .cindex "header lines" "character sets"
9733 .cindex "header lines" "decoding"
9734 Substitute the contents of the named message header line, for example
9735 .code
9736 $header_reply-to:
9737 .endd
9738 The newline that terminates a header line is not included in the expansion, but
9739 internal newlines (caused by splitting the header line over several physical
9740 lines) may be present.
9741
9742 The difference between the four pairs of expansions is in the way
9743 the data in the header line is interpreted.
9744
9745 .ilist
9746 .cindex "white space" "in header lines"
9747 &%rheader%& gives the original &"raw"& content of the header line, with no
9748 processing at all, and without the removal of leading and trailing white space.
9749
9750 .next
9751 .cindex "list" "of header lines"
9752 &%lheader%& gives a colon-separated list, one element per header when there
9753 are multiple headers with a given name.
9754 Any embedded colon characters within an element are doubled, so normal Exim
9755 list-processing facilities can be used.
9756 The terminating newline of each element is removed; in other respects
9757 the content is &"raw"&.
9758
9759 .next
9760 .cindex "base64 encoding" "in header lines"
9761 &%bheader%& removes leading and trailing white space, and then decodes base64
9762 or quoted-printable MIME &"words"& within the header text, but does no
9763 character set translation. If decoding of what looks superficially like a MIME
9764 &"word"& fails, the raw string is returned. If decoding
9765 .cindex "binary zero" "in header line"
9766 produces a binary zero character, it is replaced by a question mark &-- this is
9767 what Exim does for binary zeros that are actually received in header lines.
9768
9769 .next
9770 &%header%& tries to translate the string as decoded by &%bheader%& to a
9771 standard character set. This is an attempt to produce the same string as would
9772 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9773 returned. Translation is attempted only on operating systems that support the
9774 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9775 a system Makefile or in &_Local/Makefile_&.
9776 .endlist ilist
9777
9778 In a filter file, the target character set for &%header%& can be specified by a
9779 command of the following form:
9780 .code
9781 headers charset "UTF-8"
9782 .endd
9783 This command affects all references to &$h_$& (or &$header_$&) expansions in
9784 subsequently obeyed filter commands. In the absence of this command, the target
9785 character set in a filter is taken from the setting of the &%headers_charset%&
9786 option in the runtime configuration. The value of this option defaults to the
9787 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9788 ISO-8859-1.
9789
9790 Header names follow the syntax of RFC 2822, which states that they may contain
9791 any printing characters except space and colon. Consequently, curly brackets
9792 &'do not'& terminate header names, and should not be used to enclose them as
9793 if they were variables. Attempting to do so causes a syntax error.
9794
9795 Only header lines that are common to all copies of a message are visible to
9796 this mechanism. These are the original header lines that are received with the
9797 message, and any that are added by an ACL statement or by a system
9798 filter. Header lines that are added to a particular copy of a message by a
9799 router or transport are not accessible.
9800
9801 For incoming SMTP messages, no header lines are visible in
9802 ACLs that are obeyed before the data phase completes,
9803 because the header structure is not set up until the message is received.
9804 They are visible in DKIM, PRDR and DATA ACLs.
9805 Header lines that are added in a RCPT ACL (for example)
9806 are saved until the message's incoming header lines are available, at which
9807 point they are added.
9808 When any of the above ACLs ar
9809 running, however, header lines added by earlier ACLs are visible.
9810
9811 Upper case and lower case letters are synonymous in header names. If the
9812 following character is white space, the terminating colon may be omitted, but
9813 this is not recommended, because you may then forget it when it is needed. When
9814 white space terminates the header name, this white space is included in the
9815 expanded string.  If the message does not contain the given header, the
9816 expansion item is replaced by an empty string. (See the &%def%& condition in
9817 section &<<SECTexpcond>>& for a means of testing for the existence of a
9818 header.)
9819
9820 If there is more than one header with the same name, they are all concatenated
9821 to form the substitution string, up to a maximum length of 64K. Unless
9822 &%rheader%& is being used, leading and trailing white space is removed from
9823 each header before concatenation, and a completely empty header is ignored. A
9824 newline character is then inserted between non-empty headers, but there is no
9825 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9826 those headers that contain lists of addresses, a comma is also inserted at the
9827 junctions between headers. This does not happen for the &%rheader%& expansion.
9828
9829
9830 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9831 .cindex "expansion" "hmac hashing"
9832 .cindex &%hmac%&
9833 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9834 shared secret and some text into a message authentication code, as specified in
9835 RFC 2104. This differs from &`${md5:secret_text...}`& or
9836 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9837 cryptographic hash, allowing for authentication that is not possible with MD5
9838 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9839 present. For example:
9840 .code
9841 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9842 .endd
9843 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9844 produces:
9845 .code
9846 dd97e3ba5d1a61b5006108f8c8252953
9847 .endd
9848 As an example of how this might be used, you might put in the main part of
9849 an Exim configuration:
9850 .code
9851 SPAMSCAN_SECRET=cohgheeLei2thahw
9852 .endd
9853 In a router or a transport you could then have:
9854 .code
9855 headers_add = \
9856   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9857   ${hmac{md5}{SPAMSCAN_SECRET}\
9858   {${primary_hostname},${message_exim_id},$h_message-id:}}
9859 .endd
9860 Then given a message, you can check where it was scanned by looking at the
9861 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9862 this header line is authentic by recomputing the authentication code from the
9863 host name, message ID and the &'Message-id:'& header line. This can be done
9864 using Exim's &%-be%& option, or by other means, for example, by using the
9865 &'hmac_md5_hex()'& function in Perl.
9866
9867
9868 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9869 .cindex "expansion" "conditional"
9870 .cindex "&%if%&, expansion item"
9871 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9872 item; otherwise <&'string2'&> is used. The available conditions are described
9873 in section &<<SECTexpcond>>& below. For example:
9874 .code
9875 ${if eq {$local_part}{postmaster} {yes}{no} }
9876 .endd
9877 The second string need not be present; if it is not and the condition is not
9878 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9879 be present instead of the second string (without any curly brackets). In this
9880 case, the expansion is forced to fail if the condition is not true (see section
9881 &<<SECTforexpfai>>&).
9882
9883 If both strings are omitted, the result is the string &`true`& if the condition
9884 is true, and the empty string if the condition is false. This makes it less
9885 cumbersome to write custom ACL and router conditions. For example, instead of
9886 .code
9887 condition = ${if >{$acl_m4}{3}{true}{false}}
9888 .endd
9889 you can use
9890 .code
9891 condition = ${if >{$acl_m4}{3}}
9892 .endd
9893
9894
9895
9896 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9897 .cindex expansion "imap folder"
9898 .cindex "&%imapfolder%& expansion item"
9899 This item converts a (possibly multilevel, or with non-ASCII characters)
9900 folder specification to a Maildir name for filesystem use.
9901 For information on internationalisation support see &<<SECTi18nMDA>>&.
9902
9903
9904
9905 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9906 .cindex "expansion" "string truncation"
9907 .cindex "&%length%& expansion item"
9908 The &%length%& item is used to extract the initial portion of a string. Both
9909 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9910 you are using a fixed value for the number, that is, if <&'string1'&> does not
9911 change when expanded, you can use the simpler operator notation that avoids
9912 some of the braces:
9913 .code
9914 ${length_<n>:<string>}
9915 .endd
9916 The result of this item is either the first <&'n'&> bytes or the whole
9917 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9918 &%strlen%&, which gives the length of a string.
9919 All measurement is done in bytes and is not UTF-8 aware.
9920
9921
9922 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9923         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9924 .cindex "expansion" "extracting list elements by number"
9925 .cindex "&%listextract%&" "extract list elements by number"
9926 .cindex "list" "extracting elements by number"
9927 The <&'number'&> argument must consist entirely of decimal digits,
9928 apart from an optional leading minus,
9929 and leading and trailing white space (which is ignored).
9930
9931 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9932 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9933
9934 The first field of the list is numbered one.
9935 If the number is negative, the fields are
9936 counted from the end of the list, with the rightmost one numbered -1.
9937 The numbered element of the list is extracted and placed in &$value$&,
9938 then <&'string2'&> is expanded as the result.
9939
9940 If the modulus of the
9941 number is zero or greater than the number of fields in the string,
9942 the result is the expansion of <&'string3'&>.
9943
9944 For example:
9945 .code
9946 ${listextract{2}{x:42:99}}
9947 .endd
9948 yields &"42"&, and
9949 .code
9950 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9951 .endd
9952 yields &"result: 42"&.
9953
9954 If {<&'string3'&>} is omitted, an empty string is used for string3.
9955 If {<&'string2'&>} is also omitted, the value that was
9956 extracted is used.
9957 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9958
9959
9960 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9961         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9962 This is the first of one of two different types of lookup item, which are both
9963 described in the next item.
9964
9965 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9966         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9967 .cindex "expansion" "lookup in"
9968 .cindex "file" "lookups"
9969 .cindex "lookup" "in expanded string"
9970 The two forms of lookup item specify data lookups in files and databases, as
9971 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9972 lookups, and the second is used for query-style lookups. The <&'key'&>,
9973 <&'file'&>, and <&'query'&> strings are expanded before use.
9974
9975 If there is any white space in a lookup item which is part of a filter command,
9976 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9977 other place where white space is significant, the lookup item must be enclosed
9978 in double quotes. The use of data lookups in users' filter files may be locked
9979 out by the system administrator.
9980
9981 .vindex "&$value$&"
9982 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9983 During its expansion, the variable &$value$& contains the data returned by the
9984 lookup. Afterwards it reverts to the value it had previously (at the outer
9985 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9986 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9987 string on failure. If <&'string2'&> is provided, it can itself be a nested
9988 lookup, thus providing a mechanism for looking up a default value when the
9989 original lookup fails.
9990
9991 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9992 data for the outer lookup while the parameters of the second lookup are
9993 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9994 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9995 appear, and in this case, if the lookup fails, the entire expansion is forced
9996 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9997 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9998 successful lookup, and nothing in the case of failure.
9999
10000 For single-key lookups, the string &"partial"& is permitted to precede the
10001 search type in order to do partial matching, and * or *@ may follow a search
10002 type to request default lookups if the key does not match (see sections
10003 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10004
10005 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10006 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10007 and non-wild parts of the key during the expansion of the replacement text.
10008 They return to their previous values at the end of the lookup item.
10009
10010 This example looks up the postmaster alias in the conventional alias file:
10011 .code
10012 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10013 .endd
10014 This example uses NIS+ to look up the full name of the user corresponding to
10015 the local part of an address, forcing the expansion to fail if it is not found:
10016 .code
10017 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10018   {$value}fail}
10019 .endd
10020
10021
10022 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10023 .cindex "expansion" "list creation"
10024 .vindex "&$item$&"
10025 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10026 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10027 For each item
10028 in this list, its value is place in &$item$&, and then <&'string2'&> is
10029 expanded and added to the output as an item in a new list. The separator used
10030 for the output list is the same as the one used for the input, but a separator
10031 setting is not included in the output. For example:
10032 .code
10033 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10034 .endd
10035 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10036 value of &$item$& is restored to what it was before. See also the &%filter%&
10037 and &%reduce%& expansion items.
10038
10039 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10040 .cindex "expansion" "numeric hash"
10041 .cindex "hash function" "numeric"
10042 The three strings are expanded; the first two must yield numbers. Call them
10043 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10044 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10045 can use the simpler operator notation that avoids some of the braces:
10046 .code
10047 ${nhash_<n>_<m>:<string>}
10048 .endd
10049 The second number is optional (in both notations). If there is only one number,
10050 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10051 processed by a div/mod hash function that returns two numbers, separated by a
10052 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10053 example,
10054 .code
10055 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10056 .endd
10057 returns the string &"6/33"&.
10058
10059
10060
10061 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10062 .cindex "Perl" "use in expanded string"
10063 .cindex "expansion" "calling Perl from"
10064 This item is available only if Exim has been built to include an embedded Perl
10065 interpreter. The subroutine name and the arguments are first separately
10066 expanded, and then the Perl subroutine is called with those arguments. No
10067 additional arguments need be given; the maximum number permitted, including the
10068 name of the subroutine, is nine.
10069
10070 The return value of the subroutine is inserted into the expanded string, unless
10071 the return value is &%undef%&. In that case, the expansion fails in the same
10072 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10073 Whatever you return is evaluated in a scalar context. For example, if you
10074 return the name of a Perl vector, the return value is the size of the vector,
10075 not its contents.
10076
10077 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10078 with the error message that was passed to &%die%&. More details of the embedded
10079 Perl facility are given in chapter &<<CHAPperl>>&.
10080
10081 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10082 out the use of this expansion item in filter files.
10083
10084
10085 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10086 .cindex "&%prvs%& expansion item"
10087 The first argument is a complete email address and the second is secret
10088 keystring. The third argument, specifying a key number, is optional. If absent,
10089 it defaults to 0. The result of the expansion is a prvs-signed email address,
10090 to be typically used with the &%return_path%& option on an &(smtp)& transport
10091 as part of a bounce address tag validation (BATV) scheme. For more discussion
10092 and an example, see section &<<SECTverifyPRVS>>&.
10093
10094 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10095         {*&<&'string'&>&*}}*&"
10096 .cindex "&%prvscheck%& expansion item"
10097 This expansion item is the complement of the &%prvs%& item. It is used for
10098 checking prvs-signed addresses. If the expansion of the first argument does not
10099 yield a syntactically valid prvs-signed address, the whole item expands to the
10100 empty string. When the first argument does expand to a syntactically valid
10101 prvs-signed address, the second argument is expanded, with the prvs-decoded
10102 version of the address and the key number extracted from the address in the
10103 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10104
10105 These two variables can be used in the expansion of the second argument to
10106 retrieve the secret. The validity of the prvs-signed address is then checked
10107 against the secret. The result is stored in the variable &$prvscheck_result$&,
10108 which is empty for failure or &"1"& for success.
10109
10110 The third argument is optional; if it is missing, it defaults to an empty
10111 string. This argument is now expanded. If the result is an empty string, the
10112 result of the expansion is the decoded version of the address. This is the case
10113 whether or not the signature was valid. Otherwise, the result of the expansion
10114 is the expansion of the third argument.
10115
10116 All three variables can be used in the expansion of the third argument.
10117 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10118 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10119
10120 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10121 .cindex "expansion" "inserting an entire file"
10122 .cindex "file" "inserting into expansion"
10123 .cindex "&%readfile%& expansion item"
10124 The filename and end-of-line string are first expanded separately. The file is
10125 then read, and its contents replace the entire item. All newline characters in
10126 the file are replaced by the end-of-line string if it is present. Otherwise,
10127 newlines are left in the string.
10128 String expansion is not applied to the contents of the file. If you want this,
10129 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10130 the string expansion fails.
10131
10132 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10133 locks out the use of this expansion item in filter files.
10134
10135
10136
10137 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10138         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10139 .cindex "expansion" "inserting from a socket"
10140 .cindex "socket, use of in expansion"
10141 .cindex "&%readsocket%& expansion item"
10142 This item inserts data from a Unix domain or TCP socket into the expanded
10143 string. The minimal way of using it uses just two arguments, as in these
10144 examples:
10145 .code
10146 ${readsocket{/socket/name}{request string}}
10147 ${readsocket{inet:some.host:1234}{request string}}
10148 .endd
10149 For a Unix domain socket, the first substring must be the path to the socket.
10150 For an Internet socket, the first substring must contain &`inet:`& followed by
10151 a host name or IP address, followed by a colon and a port, which can be a
10152 number or the name of a TCP port in &_/etc/services_&. An IP address may
10153 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10154 example:
10155 .code
10156 ${readsocket{inet:[::1]:1234}{request string}}
10157 .endd
10158 Only a single host name may be given, but if looking it up yields more than
10159 one IP address, they are each tried in turn until a connection is made. For
10160 both kinds of socket, Exim makes a connection, writes the request string
10161 unless it is an empty string; and no terminating NUL is ever sent)
10162 and reads from the socket until an end-of-file
10163 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10164 extend what can be done. Firstly, you can vary the timeout. For example:
10165 .code
10166 ${readsocket{/socket/name}{request string}{3s}}
10167 .endd
10168
10169 The third argument is a list of options, of which the first element is the timeout
10170 and must be present if the argument is given.
10171 Further elements are options of form &'name=value'&.
10172 Two option types is currently recognised: shutdown and tls.
10173 The first defines whether (the default)
10174 or not a shutdown is done on the connection after sending the request.
10175 Example, to not do so (preferred, eg. by some webservers):
10176 .code
10177 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10178 .endd
10179 The second, tls, controls the use of TLS on the connection.  Example:
10180 .code
10181 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10182 .endd
10183 The default is to not use TLS.
10184 If it is enabled, a shutdown as descripbed above is never done.
10185
10186 A fourth argument allows you to change any newlines that are in the data
10187 that is read, in the same way as for &%readfile%& (see above). This example
10188 turns them into spaces:
10189 .code
10190 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10191 .endd
10192 As with all expansions, the substrings are expanded before the processing
10193 happens. Errors in these sub-expansions cause the expansion to fail. In
10194 addition, the following errors can occur:
10195
10196 .ilist
10197 Failure to create a socket file descriptor;
10198 .next
10199 Failure to connect the socket;
10200 .next
10201 Failure to write the request string;
10202 .next
10203 Timeout on reading from the socket.
10204 .endlist
10205
10206 By default, any of these errors causes the expansion to fail. However, if
10207 you supply a fifth substring, it is expanded and used when any of the above
10208 errors occurs. For example:
10209 .code
10210 ${readsocket{/socket/name}{request string}{3s}{\n}\
10211   {socket failure}}
10212 .endd
10213 You can test for the existence of a Unix domain socket by wrapping this
10214 expansion in &`${if exists`&, but there is a race condition between that test
10215 and the actual opening of the socket, so it is safer to use the fifth argument
10216 if you want to be absolutely sure of avoiding an expansion error for a
10217 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10218
10219 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10220 locks out the use of this expansion item in filter files.
10221
10222
10223 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10224 .cindex "expansion" "reducing a list to a scalar"
10225 .cindex "list" "reducing to a scalar"
10226 .vindex "&$value$&"
10227 .vindex "&$item$&"
10228 This operation reduces a list to a single, scalar string. After expansion,
10229 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10230 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10231 Then <&'string2'&> is expanded and
10232 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10233 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10234 them. The result of that expansion is assigned to &$value$& before the next
10235 iteration. When the end of the list is reached, the final value of &$value$& is
10236 added to the expansion output. The &%reduce%& expansion item can be used in a
10237 number of ways. For example, to add up a list of numbers:
10238 .code
10239 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10240 .endd
10241 The result of that expansion would be &`6`&. The maximum of a list of numbers
10242 can be found:
10243 .code
10244 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10245 .endd
10246 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10247 restored to what they were before. See also the &%filter%& and &%map%&
10248 expansion items.
10249
10250 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10251 This item inserts &"raw"& header lines. It is described with the &%header%&
10252 expansion item in section &<<SECTexpansionitems>>& above.
10253
10254 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10255         {*&<&'string2'&>&*}}*&"
10256 .cindex "expansion" "running a command"
10257 .cindex "&%run%& expansion item"
10258 The command and its arguments are first expanded as one string. The string is
10259 split apart into individual arguments by spaces, and then the command is run
10260 in a separate process, but under the same uid and gid.  As in other command
10261 executions from Exim, a shell is not used by default. If the command requires
10262 a shell, you must explicitly code it.
10263
10264 Since the arguments are split by spaces, when there is a variable expansion
10265 which has an empty result, it will cause the situation that the argument will
10266 simply be omitted when the program is actually executed by Exim. If the
10267 script/program requires a specific number of arguments and the expanded
10268 variable could possibly result in this empty expansion, the variable must be
10269 quoted. This is more difficult if the expanded variable itself could result
10270 in a string containing quotes, because it would interfere with the quotes
10271 around the command arguments. A possible guard against this is to wrap the
10272 variable in the &%sg%& operator to change any quote marks to some other
10273 character.
10274
10275 The standard input for the command exists, but is empty. The standard output
10276 and standard error are set to the same file descriptor.
10277 .cindex "return code" "from &%run%& expansion"
10278 .vindex "&$value$&"
10279 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10280 and replaces the entire item; during this expansion, the standard output/error
10281 from the command is in the variable &$value$&. If the command fails,
10282 <&'string2'&>, if present, is expanded and used. Once again, during the
10283 expansion, the standard output/error from the command is in the variable
10284 &$value$&.
10285
10286 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10287 can be the word &"fail"& (not in braces) to force expansion failure if the
10288 command does not succeed. If both strings are omitted, the result is contents
10289 of the standard output/error on success, and nothing on failure.
10290
10291 .vindex "&$run_in_acl$&"
10292 The standard output/error of the command is put in the variable &$value$&.
10293 In this ACL example, the output of a command is logged for the admin to
10294 troubleshoot:
10295 .code
10296 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10297       log_message  = Output of id: $value
10298 .endd
10299 If the command requires shell idioms, such as the > redirect operator, the
10300 shell must be invoked directly, such as with:
10301 .code
10302 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10303 .endd
10304
10305 .vindex "&$runrc$&"
10306 The return code from the command is put in the variable &$runrc$&, and this
10307 remains set afterwards, so in a filter file you can do things like this:
10308 .code
10309 if "${run{x y z}{}}$runrc" is 1 then ...
10310   elif $runrc is 2 then ...
10311   ...
10312 endif
10313 .endd
10314 If execution of the command fails (for example, the command does not exist),
10315 the return code is 127 &-- the same code that shells use for non-existent
10316 commands.
10317
10318 &*Warning*&: In a router or transport, you cannot assume the order in which
10319 option values are expanded, except for those preconditions whose order of
10320 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10321 by the expansion of one option, and use it in another.
10322
10323 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10324 out the use of this expansion item in filter files.
10325
10326
10327 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10328 .cindex "expansion" "string substitution"
10329 .cindex "&%sg%& expansion item"
10330 This item works like Perl's substitution operator (s) with the global (/g)
10331 option; hence its name. However, unlike the Perl equivalent, Exim does not
10332 modify the subject string; instead it returns the modified string for insertion
10333 into the overall expansion. The item takes three arguments: the subject string,
10334 a regular expression, and a substitution string. For example:
10335 .code
10336 ${sg{abcdefabcdef}{abc}{xyz}}
10337 .endd
10338 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10339 if any $, } or \ characters are required in the regular expression or in the
10340 substitution string, they have to be escaped. For example:
10341 .code
10342 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10343 .endd
10344 yields &"defabc"&, and
10345 .code
10346 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10347 .endd
10348 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10349 the regular expression from string expansion.
10350
10351 The regular expression is compiled in 8-bit mode, working against bytes
10352 rather than any Unicode-aware character handling.
10353
10354
10355 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10356 .cindex sorting "a list"
10357 .cindex list sorting
10358 .cindex expansion "list sorting"
10359 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10360 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10361 The <&'comparator'&> argument is interpreted as the operator
10362 of a two-argument expansion condition.
10363 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10364 The comparison should return true when applied to two values
10365 if the first value should sort before the second value.
10366 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10367 the element being placed in &$item$&,
10368 to give values for comparison.
10369
10370 The item result is a sorted list,
10371 with the original list separator,
10372 of the list elements (in full) of the original.
10373
10374 Examples:
10375 .code
10376 ${sort{3:2:1:4}{<}{$item}}
10377 .endd
10378 sorts a list of numbers, and
10379 .code
10380 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10381 .endd
10382 will sort an MX lookup into priority order.
10383
10384
10385 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10386 .cindex "&%substr%& expansion item"
10387 .cindex "substring extraction"
10388 .cindex "expansion" "substring extraction"
10389 The three strings are expanded; the first two must yield numbers. Call them
10390 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10391 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10392 can use the simpler operator notation that avoids some of the braces:
10393 .code
10394 ${substr_<n>_<m>:<string>}
10395 .endd
10396 The second number is optional (in both notations).
10397 If it is absent in the simpler format, the preceding underscore must also be
10398 omitted.
10399
10400 The &%substr%& item can be used to extract more general substrings than
10401 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10402 length required. For example
10403 .code
10404 ${substr{3}{2}{$local_part}}
10405 .endd
10406 If the starting offset is greater than the string length the result is the
10407 null string; if the length plus starting offset is greater than the string
10408 length, the result is the right-hand part of the string, starting from the
10409 given offset. The first byte (character) in the string has offset zero.
10410
10411 The &%substr%& expansion item can take negative offset values to count
10412 from the right-hand end of its operand. The last byte (character) is offset -1,
10413 the second-last is offset -2, and so on. Thus, for example,
10414 .code
10415 ${substr{-5}{2}{1234567}}
10416 .endd
10417 yields &"34"&. If the absolute value of a negative offset is greater than the
10418 length of the string, the substring starts at the beginning of the string, and
10419 the length is reduced by the amount of overshoot. Thus, for example,
10420 .code
10421 ${substr{-5}{2}{12}}
10422 .endd
10423 yields an empty string, but
10424 .code
10425 ${substr{-3}{2}{12}}
10426 .endd
10427 yields &"1"&.
10428
10429 When the second number is omitted from &%substr%&, the remainder of the string
10430 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10431 string preceding the offset point are taken. For example, an offset of -1 and
10432 no length, as in these semantically identical examples:
10433 .code
10434 ${substr_-1:abcde}
10435 ${substr{-1}{abcde}}
10436 .endd
10437 yields all but the last character of the string, that is, &"abcd"&.
10438
10439 All measurement is done in bytes and is not UTF-8 aware.
10440
10441
10442
10443 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10444         {*&<&'replacements'&>&*}}*&"
10445 .cindex "expansion" "character translation"
10446 .cindex "&%tr%& expansion item"
10447 This item does single-character (in bytes) translation on its subject string. The second
10448 argument is a list of characters to be translated in the subject string. Each
10449 matching character is replaced by the corresponding character from the
10450 replacement list. For example
10451 .code
10452 ${tr{abcdea}{ac}{13}}
10453 .endd
10454 yields &`1b3de1`&. If there are duplicates in the second character string, the
10455 last occurrence is used. If the third string is shorter than the second, its
10456 last character is replicated. However, if it is empty, no translation takes
10457 place.
10458
10459 All character handling is done in bytes and is not UTF-8 aware.
10460
10461 .endlist
10462
10463
10464
10465 .section "Expansion operators" "SECTexpop"
10466 .cindex "expansion" "operators"
10467 For expansion items that perform transformations on a single argument string,
10468 the &"operator"& notation is used because it is simpler and uses fewer braces.
10469 The substring is first expanded before the operation is applied to it. The
10470 following operations can be performed:
10471
10472 .vlist
10473 .vitem &*${address:*&<&'string'&>&*}*&
10474 .cindex "expansion" "RFC 2822 address handling"
10475 .cindex "&%address%& expansion item"
10476 The string is interpreted as an RFC 2822 address, as it might appear in a
10477 header line, and the effective address is extracted from it. If the string does
10478 not parse successfully, the result is empty.
10479
10480 The parsing correctly handles SMTPUTF8 Unicode in the string.
10481
10482
10483 .vitem &*${addresses:*&<&'string'&>&*}*&
10484 .cindex "expansion" "RFC 2822 address handling"
10485 .cindex "&%addresses%& expansion item"
10486 The string (after expansion) is interpreted as a list of addresses in RFC
10487 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10488 operative address (&'local-part@domain'&) is extracted from each item, and the
10489 result of the expansion is a colon-separated list, with appropriate
10490 doubling of colons should any happen to be present in the email addresses.
10491 Syntactically invalid RFC2822 address items are omitted from the output.
10492
10493 It is possible to specify a character other than colon for the output
10494 separator by starting the string with > followed by the new separator
10495 character. For example:
10496 .code
10497 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10498 .endd
10499 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10500 first, so if the expanded string starts with >, it may change the output
10501 separator unintentionally. This can be avoided by setting the output
10502 separator explicitly:
10503 .code
10504 ${addresses:>:$h_from:}
10505 .endd
10506
10507 Compare the &%address%& (singular)
10508 expansion item, which extracts the working address from a single RFC2822
10509 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10510 processing lists.
10511
10512 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10513 a strict interpretation of header line formatting.  Exim parses the bare,
10514 unquoted portion of an email address and if it finds a comma, treats it as an
10515 email address separator. For the example header line:
10516 .code
10517 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10518 .endd
10519 The first example below demonstrates that Q-encoded email addresses are parsed
10520 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10521 It does not see the comma because it's still encoded as "=2C".  The second
10522 example below is passed the contents of &`$header_from:`&, meaning it gets
10523 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10524 The third example shows that the presence of a comma is skipped when it is
10525 quoted.  The fourth example shows SMTPUTF8 handling.
10526 .code
10527 # exim -be '${addresses:From: \
10528 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10529 user@example.com
10530 # exim -be '${addresses:From: Last, First <user@example.com>}'
10531 Last:user@example.com
10532 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10533 user@example.com
10534 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10535 フィリップ@example.jp
10536 .endd
10537
10538 .vitem &*${base32:*&<&'digits'&>&*}*&
10539 .cindex "&%base32%& expansion item"
10540 .cindex "expansion" "conversion to base 32"
10541 The string must consist entirely of decimal digits. The number is converted to
10542 base 32 and output as a (empty, for zero) string of characters.
10543 Only lowercase letters are used.
10544
10545 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10546 .cindex "&%base32d%& expansion item"
10547 .cindex "expansion" "conversion to base 32"
10548 The string must consist entirely of base-32 digits.
10549 The number is converted to decimal and output as a string.
10550
10551 .vitem &*${base62:*&<&'digits'&>&*}*&
10552 .cindex "&%base62%& expansion item"
10553 .cindex "expansion" "conversion to base 62"
10554 The string must consist entirely of decimal digits. The number is converted to
10555 base 62 and output as a string of six characters, including leading zeros. In
10556 the few operating environments where Exim uses base 36 instead of base 62 for
10557 its message identifiers (because those systems do not have case-sensitive
10558 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10559 to be absolutely clear: this is &'not'& base64 encoding.
10560
10561 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10562 .cindex "&%base62d%& expansion item"
10563 .cindex "expansion" "conversion to base 62"
10564 The string must consist entirely of base-62 digits, or, in operating
10565 environments where Exim uses base 36 instead of base 62 for its message
10566 identifiers, base-36 digits. The number is converted to decimal and output as a
10567 string.
10568
10569 .vitem &*${base64:*&<&'string'&>&*}*&
10570 .cindex "expansion" "base64 encoding"
10571 .cindex "base64 encoding" "in string expansion"
10572 .cindex "&%base64%& expansion item"
10573 .cindex certificate "base64 of DER"
10574 This operator converts a string into one that is base64 encoded.
10575
10576 If the string is a single variable of type certificate,
10577 returns the base64 encoding of the DER form of the certificate.
10578
10579
10580 .vitem &*${base64d:*&<&'string'&>&*}*&
10581 .cindex "expansion" "base64 decoding"
10582 .cindex "base64 decoding" "in string expansion"
10583 .cindex "&%base64d%& expansion item"
10584 This operator converts a base64-encoded string into the un-coded form.
10585
10586
10587 .vitem &*${domain:*&<&'string'&>&*}*&
10588 .cindex "domain" "extraction"
10589 .cindex "expansion" "domain extraction"
10590 The string is interpreted as an RFC 2822 address and the domain is extracted
10591 from it. If the string does not parse successfully, the result is empty.
10592
10593
10594 .vitem &*${escape:*&<&'string'&>&*}*&
10595 .cindex "expansion" "escaping non-printing characters"
10596 .cindex "&%escape%& expansion item"
10597 If the string contains any non-printing characters, they are converted to
10598 escape sequences starting with a backslash. Whether characters with the most
10599 significant bit set (so-called &"8-bit characters"&) count as printing or not
10600 is controlled by the &%print_topbitchars%& option.
10601
10602 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10603 .cindex "expansion" "escaping 8-bit characters"
10604 .cindex "&%escape8bit%& expansion item"
10605 If the string contains and characters with the most significant bit set,
10606 they are converted to escape sequences starting with a backslash.
10607 Backslashes and DEL characters are also converted.
10608
10609
10610 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10611 .cindex "expansion" "expression evaluation"
10612 .cindex "expansion" "arithmetic expression"
10613 .cindex "&%eval%& expansion item"
10614 These items supports simple arithmetic and bitwise logical operations in
10615 expansion strings. The string (after expansion) must be a conventional
10616 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10617 logical operators, and parentheses. All operations are carried out using
10618 integer arithmetic. The operator priorities are as follows (the same as in the
10619 C programming language):
10620 .table2 70pt 300pt
10621 .irow &'highest:'& "not (~), negate (-)"
10622 .irow ""   "multiply (*), divide (/), remainder (%)"
10623 .irow ""   "plus (+), minus (-)"
10624 .irow ""   "shift-left (<<), shift-right (>>)"
10625 .irow ""   "and (&&)"
10626 .irow ""   "xor (^)"
10627 .irow &'lowest:'&  "or (|)"
10628 .endtable
10629 Binary operators with the same priority are evaluated from left to right. White
10630 space is permitted before or after operators.
10631
10632 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10633 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10634 decimal, even if they start with a leading zero; hexadecimal numbers are not
10635 permitted. This can be useful when processing numbers extracted from dates or
10636 times, which often do have leading zeros.
10637
10638 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10639 or 1024*1024*1024,
10640 respectively. Negative numbers are supported. The result of the computation is
10641 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10642
10643 .display
10644 &`${eval:1+1}            `&  yields 2
10645 &`${eval:1+2*3}          `&  yields 7
10646 &`${eval:(1+2)*3}        `&  yields 9
10647 &`${eval:2+42%5}         `&  yields 4
10648 &`${eval:0xc&amp;5}          `&  yields 4
10649 &`${eval:0xc|5}          `&  yields 13
10650 &`${eval:0xc^5}          `&  yields 9
10651 &`${eval:0xc>>1}         `&  yields 6
10652 &`${eval:0xc<<1}         `&  yields 24
10653 &`${eval:~255&amp;0x1234}    `&  yields 4608
10654 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10655 .endd
10656
10657 As a more realistic example, in an ACL you might have
10658 .code
10659 deny   message = Too many bad recipients
10660        condition =                    \
10661          ${if and {                   \
10662            {>{$rcpt_count}{10}}       \
10663            {                          \
10664            <                          \
10665              {$recipients_count}      \
10666              {${eval:$rcpt_count/2}}  \
10667            }                          \
10668          }{yes}{no}}
10669 .endd
10670 The condition is true if there have been more than 10 RCPT commands and
10671 fewer than half of them have resulted in a valid recipient.
10672
10673
10674 .vitem &*${expand:*&<&'string'&>&*}*&
10675 .cindex "expansion" "re-expansion of substring"
10676 The &%expand%& operator causes a string to be expanded for a second time. For
10677 example,
10678 .code
10679 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10680 .endd
10681 first looks up a string in a file while expanding the operand for &%expand%&,
10682 and then re-expands what it has found.
10683
10684
10685 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10686 .cindex "Unicode"
10687 .cindex "UTF-8" "conversion from"
10688 .cindex "expansion" "UTF-8 conversion"
10689 .cindex "&%from_utf8%& expansion item"
10690 The world is slowly moving towards Unicode, although there are no standards for
10691 email yet. However, other applications (including some databases) are starting
10692 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10693 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10694 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10695 the result is an undefined sequence of bytes.
10696
10697 Unicode code points with values less than 256 are compatible with ASCII and
10698 ISO-8859-1 (also known as Latin-1).
10699 For example, character 169 is the copyright symbol in both cases, though the
10700 way it is encoded is different. In UTF-8, more than one byte is needed for
10701 characters with code values greater than 127, whereas ISO-8859-1 is a
10702 single-byte encoding (but thereby limited to 256 characters). This makes
10703 translation from UTF-8 to ISO-8859-1 straightforward.
10704
10705
10706 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10707 .cindex "hash function" "textual"
10708 .cindex "expansion" "textual hash"
10709 The &%hash%& operator is a simpler interface to the hashing function that can
10710 be used when the two parameters are fixed numbers (as opposed to strings that
10711 change when expanded). The effect is the same as
10712 .code
10713 ${hash{<n>}{<m>}{<string>}}
10714 .endd
10715 See the description of the general &%hash%& item above for details. The
10716 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10717
10718
10719
10720 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10721 .cindex "base64 encoding" "conversion from hex"
10722 .cindex "expansion" "hex to base64"
10723 .cindex "&%hex2b64%& expansion item"
10724 This operator converts a hex string into one that is base64 encoded. This can
10725 be useful for processing the output of the various hashing functions.
10726
10727
10728
10729 .vitem &*${hexquote:*&<&'string'&>&*}*&
10730 .cindex "quoting" "hex-encoded unprintable characters"
10731 .cindex "&%hexquote%& expansion item"
10732 This operator converts non-printable characters in a string into a hex
10733 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10734 as is, and other byte values are converted to &`\xNN`&, for example, a
10735 byte value 127 is converted to &`\x7f`&.
10736
10737
10738 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10739 .cindex "&%ipv6denorm%& expansion item"
10740 .cindex "IP address" normalisation
10741 This expands an IPv6 address to a full eight-element colon-separated set
10742 of hex digits including leading zeroes.
10743 A trailing ipv4-style dotted-decimal set is converted to hex.
10744 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10745
10746 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10747 .cindex "&%ipv6norm%& expansion item"
10748 .cindex "IP address" normalisation
10749 .cindex "IP address" "canonical form"
10750 This converts an IPv6 address to canonical form.
10751 Leading zeroes of groups are omitted, and the longest
10752 set of zero-valued groups is replaced with a double colon.
10753 A trailing ipv4-style dotted-decimal set is converted to hex.
10754 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10755
10756
10757 .vitem &*${lc:*&<&'string'&>&*}*&
10758 .cindex "case forcing in strings"
10759 .cindex "string" "case forcing"
10760 .cindex "lower casing"
10761 .cindex "expansion" "case forcing"
10762 .cindex "&%lc%& expansion item"
10763 This forces the letters in the string into lower-case, for example:
10764 .code
10765 ${lc:$local_part}
10766 .endd
10767 Case is defined per the system C locale.
10768
10769 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10770 .cindex "expansion" "string truncation"
10771 .cindex "&%length%& expansion item"
10772 The &%length%& operator is a simpler interface to the &%length%& function that
10773 can be used when the parameter is a fixed number (as opposed to a string that
10774 changes when expanded). The effect is the same as
10775 .code
10776 ${length{<number>}{<string>}}
10777 .endd
10778 See the description of the general &%length%& item above for details. Note that
10779 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10780 when &%length%& is used as an operator.
10781 All measurement is done in bytes and is not UTF-8 aware.
10782
10783
10784 .vitem &*${listcount:*&<&'string'&>&*}*&
10785 .cindex "expansion" "list item count"
10786 .cindex "list" "item count"
10787 .cindex "list" "count of items"
10788 .cindex "&%listcount%& expansion item"
10789 The string is interpreted as a list and the number of items is returned.
10790
10791
10792 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10793 .cindex "expansion" "named list"
10794 .cindex "&%listnamed%& expansion item"
10795 The name is interpreted as a named list and the content of the list is returned,
10796 expanding any referenced lists, re-quoting as needed for colon-separation.
10797 If the optional type is given it must be one of "a", "d", "h" or "l"
10798 and selects address-, domain-, host- or localpart- lists to search among respectively.
10799 Otherwise all types are searched in an undefined order and the first
10800 matching list is returned.
10801
10802
10803 .vitem &*${local_part:*&<&'string'&>&*}*&
10804 .cindex "expansion" "local part extraction"
10805 .cindex "&%local_part%& expansion item"
10806 The string is interpreted as an RFC 2822 address and the local part is
10807 extracted from it. If the string does not parse successfully, the result is
10808 empty.
10809 The parsing correctly handles SMTPUTF8 Unicode in the string.
10810
10811
10812 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10813 .cindex "masked IP address"
10814 .cindex "IP address" "masking"
10815 .cindex "CIDR notation"
10816 .cindex "expansion" "IP address masking"
10817 .cindex "&%mask%& expansion item"
10818 If the form of the string to be operated on is not an IP address followed by a
10819 slash and an integer (that is, a network address in CIDR notation), the
10820 expansion fails. Otherwise, this operator converts the IP address to binary,
10821 masks off the least significant bits according to the bit count, and converts
10822 the result back to text, with mask appended. For example,
10823 .code
10824 ${mask:10.111.131.206/28}
10825 .endd
10826 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10827 be mostly used for looking up masked addresses in files, the result for an IPv6
10828 address uses dots to separate components instead of colons, because colon
10829 terminates a key string in lsearch files. So, for example,
10830 .code
10831 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10832 .endd
10833 returns the string
10834 .code
10835 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10836 .endd
10837 Letters in IPv6 addresses are always output in lower case.
10838
10839
10840 .vitem &*${md5:*&<&'string'&>&*}*&
10841 .cindex "MD5 hash"
10842 .cindex "expansion" "MD5 hash"
10843 .cindex certificate fingerprint
10844 .cindex "&%md5%& expansion item"
10845 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10846 as a 32-digit hexadecimal number, in which any letters are in lower case.
10847
10848 If the string is a single variable of type certificate,
10849 returns the MD5 hash fingerprint of the certificate.
10850
10851
10852 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10853 .cindex "expansion" "numeric hash"
10854 .cindex "hash function" "numeric"
10855 The &%nhash%& operator is a simpler interface to the numeric hashing function
10856 that can be used when the two parameters are fixed numbers (as opposed to
10857 strings that change when expanded). The effect is the same as
10858 .code
10859 ${nhash{<n>}{<m>}{<string>}}
10860 .endd
10861 See the description of the general &%nhash%& item above for details.
10862
10863
10864 .vitem &*${quote:*&<&'string'&>&*}*&
10865 .cindex "quoting" "in string expansions"
10866 .cindex "expansion" "quoting"
10867 .cindex "&%quote%& expansion item"
10868 The &%quote%& operator puts its argument into double quotes if it
10869 is an empty string or
10870 contains anything other than letters, digits, underscores, dots, and hyphens.
10871 Any occurrences of double quotes and backslashes are escaped with a backslash.
10872 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10873 respectively For example,
10874 .code
10875 ${quote:ab"*"cd}
10876 .endd
10877 becomes
10878 .code
10879 "ab\"*\"cd"
10880 .endd
10881 The place where this is useful is when the argument is a substitution from a
10882 variable or a message header.
10883
10884 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10885 .cindex "&%quote_local_part%& expansion item"
10886 This operator is like &%quote%&, except that it quotes the string only if
10887 required to do so by the rules of RFC 2822 for quoting local parts. For
10888 example, a plus sign would not cause quoting (but it would for &%quote%&).
10889 If you are creating a new email address from the contents of &$local_part$&
10890 (or any other unknown data), you should always use this operator.
10891
10892 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10893 will likely use the quoting form.
10894 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10895
10896
10897 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10898 .cindex "quoting" "lookup-specific"
10899 This operator applies lookup-specific quoting rules to the string. Each
10900 query-style lookup type has its own quoting rules which are described with
10901 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10902 .code
10903 ${quote_ldap:two * two}
10904 .endd
10905 returns
10906 .code
10907 two%20%5C2A%20two
10908 .endd
10909 For single-key lookup types, no quoting is ever necessary and this operator
10910 yields an unchanged string.
10911
10912
10913 .vitem &*${randint:*&<&'n'&>&*}*&
10914 .cindex "random number"
10915 This operator returns a somewhat random number which is less than the
10916 supplied number and is at least 0.  The quality of this randomness depends
10917 on how Exim was built; the values are not suitable for keying material.
10918 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10919 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10920 for versions of GnuTLS with that function.
10921 Otherwise, the implementation may be arc4random(), random() seeded by
10922 srandomdev() or srandom(), or a custom implementation even weaker than
10923 random().
10924
10925
10926 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10927 .cindex "expansion" "IP address"
10928 This operator reverses an IP address; for IPv4 addresses, the result is in
10929 dotted-quad decimal form, while for IPv6 addresses the result is in
10930 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10931 for DNS.  For example,
10932 .code
10933 ${reverse_ip:192.0.2.4}
10934 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10935 .endd
10936 returns
10937 .code
10938 4.2.0.192
10939 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
10940 .endd
10941
10942
10943 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10944 .cindex "expansion" "RFC 2047"
10945 .cindex "RFC 2047" "expansion operator"
10946 .cindex "&%rfc2047%& expansion item"
10947 This operator encodes text according to the rules of RFC 2047. This is an
10948 encoding that is used in header lines to encode non-ASCII characters. It is
10949 assumed that the input string is in the encoding specified by the
10950 &%headers_charset%& option, which gets its default at build time. If the string
10951 contains only characters in the range 33&--126, and no instances of the
10952 characters
10953 .code
10954 ? = ( ) < > @ , ; : \ " . [ ] _
10955 .endd
10956 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10957 string, using as many &"encoded words"& as necessary to encode all the
10958 characters.
10959
10960
10961 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10962 .cindex "expansion" "RFC 2047"
10963 .cindex "RFC 2047" "decoding"
10964 .cindex "&%rfc2047d%& expansion item"
10965 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10966 bytes are replaced by question marks. Characters are converted into the
10967 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10968 not recognized unless &%check_rfc2047_length%& is set false.
10969
10970 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10971 access a header line, RFC 2047 decoding is done automatically. You do not need
10972 to use this operator as well.
10973
10974
10975
10976 .vitem &*${rxquote:*&<&'string'&>&*}*&
10977 .cindex "quoting" "in regular expressions"
10978 .cindex "regular expressions" "quoting"
10979 .cindex "&%rxquote%& expansion item"
10980 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10981 characters in its argument. This is useful when substituting the values of
10982 variables or headers inside regular expressions.
10983
10984
10985 .vitem &*${sha1:*&<&'string'&>&*}*&
10986 .cindex "SHA-1 hash"
10987 .cindex "expansion" "SHA-1 hashing"
10988 .cindex certificate fingerprint
10989 .cindex "&%sha1%& expansion item"
10990 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10991 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10992
10993 If the string is a single variable of type certificate,
10994 returns the SHA-1 hash fingerprint of the certificate.
10995
10996
10997 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
10998        &*${sha2:*&<&'string'&>&*}*& &&&
10999        &*${sha2_<n>:*&<&'string'&>&*}*&
11000 .cindex "SHA-256 hash"
11001 .cindex "SHA-2 hash"
11002 .cindex certificate fingerprint
11003 .cindex "expansion" "SHA-256 hashing"
11004 .cindex "&%sha256%& expansion item"
11005 .cindex "&%sha2%& expansion item"
11006 The &%sha256%& operator computes the SHA-256 hash value of the string
11007 and returns
11008 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11009
11010 If the string is a single variable of type certificate,
11011 returns the SHA-256 hash fingerprint of the certificate.
11012
11013 .new
11014 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11015 (except for certificates, which are not supported).
11016 Finally, if an underbar
11017 and a number is appended it specifies the output length, selecting a
11018 member of the SHA-2 family of hash functions.
11019 Values of 256, 384 and 512 are accepted, with 256 being the default.
11020 .wen
11021
11022
11023 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11024        &*${sha3_<n>:*&<&'string'&>&*}*&
11025 .cindex "SHA3 hash"
11026 .cindex "expansion" "SHA3 hashing"
11027 .cindex "&%sha3%& expansion item"
11028 The &%sha3%& operator computes the SHA3-256 hash value of the string
11029 and returns
11030 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11031
11032 If a number is appended, separated by an underbar, it specifies
11033 the output length.  Values of 224, 256, 384 and 512 are accepted;
11034 with 256 being the default.
11035
11036 The &%sha3%& expansion item is only supported if Exim has been
11037 compiled with GnuTLS 3.5.0 or later,
11038 or OpenSSL 1.1.1 or later.
11039 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11040
11041
11042 .vitem &*${stat:*&<&'string'&>&*}*&
11043 .cindex "expansion" "statting a file"
11044 .cindex "file" "extracting characteristics"
11045 .cindex "&%stat%& expansion item"
11046 The string, after expansion, must be a file path. A call to the &[stat()]&
11047 function is made for this path. If &[stat()]& fails, an error occurs and the
11048 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11049 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11050 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11051 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11052 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11053 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11054 can extract individual fields using the &%extract%& expansion item.
11055
11056 The use of the &%stat%& expansion in users' filter files can be locked out by
11057 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11058 systems for files larger than 2GB.
11059
11060 .vitem &*${str2b64:*&<&'string'&>&*}*&
11061 .cindex "&%str2b64%& expansion item"
11062 Now deprecated, a synonym for the &%base64%& expansion operator.
11063
11064
11065
11066 .vitem &*${strlen:*&<&'string'&>&*}*&
11067 .cindex "expansion" "string length"
11068 .cindex "string" "length in expansion"
11069 .cindex "&%strlen%& expansion item"
11070 The item is replace by the length of the expanded string, expressed as a
11071 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11072 All measurement is done in bytes and is not UTF-8 aware.
11073
11074
11075 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11076 .cindex "&%substr%& expansion item"
11077 .cindex "substring extraction"
11078 .cindex "expansion" "substring expansion"
11079 The &%substr%& operator is a simpler interface to the &%substr%& function that
11080 can be used when the two parameters are fixed numbers (as opposed to strings
11081 that change when expanded). The effect is the same as
11082 .code
11083 ${substr{<start>}{<length>}{<string>}}
11084 .endd
11085 See the description of the general &%substr%& item above for details. The
11086 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11087 All measurement is done in bytes and is not UTF-8 aware.
11088
11089 .vitem &*${time_eval:*&<&'string'&>&*}*&
11090 .cindex "&%time_eval%& expansion item"
11091 .cindex "time interval" "decoding"
11092 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11093 seconds.
11094
11095 .vitem &*${time_interval:*&<&'string'&>&*}*&
11096 .cindex "&%time_interval%& expansion item"
11097 .cindex "time interval" "formatting"
11098 The argument (after sub-expansion) must be a sequence of decimal digits that
11099 represents an interval of time as a number of seconds. It is converted into a
11100 number of larger units and output in Exim's normal time format, for example,
11101 &`1w3d4h2m6s`&.
11102
11103 .vitem &*${uc:*&<&'string'&>&*}*&
11104 .cindex "case forcing in strings"
11105 .cindex "string" "case forcing"
11106 .cindex "upper casing"
11107 .cindex "expansion" "case forcing"
11108 .cindex "&%uc%& expansion item"
11109 This forces the letters in the string into upper-case.
11110 Case is defined per the system C locale.
11111
11112 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11113 .cindex "correction of invalid utf-8 sequences in strings"
11114 .cindex "utf-8" "utf-8 sequences"
11115 .cindex "incorrect utf-8"
11116 .cindex "expansion" "utf-8 forcing"
11117 .cindex "&%utf8clean%& expansion item"
11118 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11119 In versions of Exim before 4.92, this did not correctly do so for a truncated
11120 final codepoint's encoding, and the character would be silently dropped.
11121 If you must handle detection of this scenario across both sets of Exim behavior,
11122 the complexity will depend upon the task.
11123 For instance, to detect if the first character is multibyte and a 1-byte
11124 extraction can be successfully used as a path component (as is common for
11125 dividing up delivery folders), you might use:
11126 .code
11127 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11128 .endd
11129 (which will false-positive if the first character of the local part is a
11130 literal question mark).
11131
11132 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11133        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11134        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11135        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11136 .cindex expansion UTF-8
11137 .cindex UTF-8 expansion
11138 .cindex EAI
11139 .cindex internationalisation
11140 .cindex "&%utf8_domain_to_alabel%& expansion item"
11141 .cindex "&%utf8_domain_from_alabel%& expansion item"
11142 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11143 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11144 These convert EAI mail name components between UTF-8 and a-label forms.
11145 For information on internationalisation support see &<<SECTi18nMTA>>&.
11146 .endlist
11147
11148
11149
11150
11151
11152
11153 .section "Expansion conditions" "SECTexpcond"
11154 .scindex IIDexpcond "expansion" "conditions"
11155 The following conditions are available for testing by the &%${if%& construct
11156 while expanding strings:
11157
11158 .vlist
11159 .vitem &*!*&<&'condition'&>
11160 .cindex "expansion" "negating a condition"
11161 .cindex "negation" "in expansion condition"
11162 Preceding any condition with an exclamation mark negates the result of the
11163 condition.
11164
11165 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11166 .cindex "numeric comparison"
11167 .cindex "expansion" "numeric comparison"
11168 There are a number of symbolic operators for doing numeric comparisons. They
11169 are:
11170 .display
11171 &`=   `&   equal
11172 &`==  `&   equal
11173 &`>   `&   greater
11174 &`>=  `&   greater or equal
11175 &`<   `&   less
11176 &`<=  `&   less or equal
11177 .endd
11178 For example:
11179 .code
11180 ${if >{$message_size}{10M} ...
11181 .endd
11182 Note that the general negation operator provides for inequality testing. The
11183 two strings must take the form of optionally signed decimal integers,
11184 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11185 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11186 As a special case, the numerical value of an empty string is taken as
11187 zero.
11188
11189 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11190 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11191 10M, not if 10M is larger than &$message_size$&.
11192
11193
11194 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11195         {*&<&'arg2'&>&*}...}*&
11196 .cindex "expansion" "calling an acl"
11197 .cindex "&%acl%&" "expansion condition"
11198 The name and zero to nine argument strings are first expanded separately.  The expanded
11199 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11200 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11201 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11202 and may use the variables; if another acl expansion is used the values
11203 are restored after it returns.  If the ACL sets
11204 a value using a "message =" modifier the variable $value becomes
11205 the result of the expansion, otherwise it is empty.
11206 If the ACL returns accept the condition is true; if deny, false.
11207 If the ACL returns defer the result is a forced-fail.
11208
11209 .vitem &*bool&~{*&<&'string'&>&*}*&
11210 .cindex "expansion" "boolean parsing"
11211 .cindex "&%bool%& expansion condition"
11212 This condition turns a string holding a true or false representation into
11213 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11214 (case-insensitively); also integer numbers map to true if non-zero,
11215 false if zero.
11216 An empty string is treated as false.
11217 Leading and trailing whitespace is ignored;
11218 thus a string consisting only of whitespace is false.
11219 All other string values will result in expansion failure.
11220
11221 When combined with ACL variables, this expansion condition will let you
11222 make decisions in one place and act on those decisions in another place.
11223 For example:
11224 .code
11225 ${if bool{$acl_m_privileged_sender} ...
11226 .endd
11227
11228
11229 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11230 .cindex "expansion" "boolean parsing"
11231 .cindex "&%bool_lax%& expansion condition"
11232 Like &%bool%&, this condition turns a string into a boolean state.  But
11233 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11234 loose definition that the Router &%condition%& option uses.  The empty string
11235 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11236 true.  Leading and trailing whitespace is ignored.
11237
11238 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11239
11240 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11241 .cindex "expansion" "encrypted comparison"
11242 .cindex "encrypted strings, comparing"
11243 .cindex "&%crypteq%& expansion condition"
11244 This condition is included in the Exim binary if it is built to support any
11245 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11246 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11247 included in the binary.
11248
11249 The &%crypteq%& condition has two arguments. The first is encrypted and
11250 compared against the second, which is already encrypted. The second string may
11251 be in the LDAP form for storing encrypted strings, which starts with the
11252 encryption type in curly brackets, followed by the data. If the second string
11253 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11254 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11255 Typically this will be a field from a password file. An example of an encrypted
11256 string in LDAP form is:
11257 .code
11258 {md5}CY9rzUYh03PK3k6DJie09g==
11259 .endd
11260 If such a string appears directly in an expansion, the curly brackets have to
11261 be quoted, because they are part of the expansion syntax. For example:
11262 .code
11263 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11264 .endd
11265 The following encryption types (whose names are matched case-independently) are
11266 supported:
11267
11268 .ilist
11269 .cindex "MD5 hash"
11270 .cindex "base64 encoding" "in encrypted password"
11271 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11272 printable characters to compare with the remainder of the second string. If the
11273 length of the comparison string is 24, Exim assumes that it is base64 encoded
11274 (as in the above example). If the length is 32, Exim assumes that it is a
11275 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11276 comparison fails.
11277
11278 .next
11279 .cindex "SHA-1 hash"
11280 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11281 printable characters to compare with the remainder of the second string. If the
11282 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11283 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11284 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11285
11286 .next
11287 .cindex "&[crypt()]&"
11288 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11289 only the first eight characters of the password. However, in modern operating
11290 systems this is no longer true, and in many cases the entire password is used,
11291 whatever its length.
11292
11293 .next
11294 .cindex "&[crypt16()]&"
11295 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11296 use up to 16 characters of the password in some operating systems. Again, in
11297 modern operating systems, more characters may be used.
11298 .endlist
11299 Exim has its own version of &[crypt16()]&, which is just a double call to
11300 &[crypt()]&. For operating systems that have their own version, setting
11301 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11302 operating system version instead of its own. This option is set by default in
11303 the OS-dependent &_Makefile_& for those operating systems that are known to
11304 support &[crypt16()]&.
11305
11306 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11307 it was not using the same algorithm as some operating systems' versions. It
11308 turns out that as well as &[crypt16()]& there is a function called
11309 &[bigcrypt()]& in some operating systems. This may or may not use the same
11310 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11311
11312 However, since there is now a move away from the traditional &[crypt()]&
11313 functions towards using SHA1 and other algorithms, tidying up this area of
11314 Exim is seen as very low priority.
11315
11316 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11317 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11318 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11319 default is &`{crypt}`&. Whatever the default, you can always use either
11320 function by specifying it explicitly in curly brackets.
11321
11322 .vitem &*def:*&<&'variable&~name'&>
11323 .cindex "expansion" "checking for empty variable"
11324 .cindex "&%def%& expansion condition"
11325 The &%def%& condition must be followed by the name of one of the expansion
11326 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11327 variable does not contain the empty string. For example:
11328 .code
11329 ${if def:sender_ident {from $sender_ident}}
11330 .endd
11331 Note that the variable name is given without a leading &%$%& character. If the
11332 variable does not exist, the expansion fails.
11333
11334 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11335         &~&*def:h_*&<&'header&~name'&>&*:*&"
11336 .cindex "expansion" "checking header line existence"
11337 This condition is true if a message is being processed and the named header
11338 exists in the message. For example,
11339 .code
11340 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11341 .endd
11342 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11343 the header name must be terminated by a colon if white space does not follow.
11344
11345 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11346        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11347 .cindex "string" "comparison"
11348 .cindex "expansion" "string comparison"
11349 .cindex "&%eq%& expansion condition"
11350 .cindex "&%eqi%& expansion condition"
11351 The two substrings are first expanded. The condition is true if the two
11352 resulting strings are identical. For &%eq%& the comparison includes the case of
11353 letters, whereas for &%eqi%& the comparison is case-independent, where
11354 case is defined per the system C locale.
11355
11356 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11357 .cindex "expansion" "file existence test"
11358 .cindex "file" "existence test"
11359 .cindex "&%exists%&, expansion condition"
11360 The substring is first expanded and then interpreted as an absolute path. The
11361 condition is true if the named file (or directory) exists. The existence test
11362 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11363 users' filter files may be locked out by the system administrator.
11364
11365 .vitem &*first_delivery*&
11366 .cindex "delivery" "first"
11367 .cindex "first delivery"
11368 .cindex "expansion" "first delivery test"
11369 .cindex "&%first_delivery%& expansion condition"
11370 This condition, which has no data, is true during a message's first delivery
11371 attempt. It is false during any subsequent delivery attempts.
11372
11373
11374 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11375        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11376 .cindex "list" "iterative conditions"
11377 .cindex "expansion" "&*forall*& condition"
11378 .cindex "expansion" "&*forany*& condition"
11379 .vindex "&$item$&"
11380 These conditions iterate over a list. The first argument is expanded to form
11381 the list. By default, the list separator is a colon, but it can be changed by
11382 the normal method (&<<SECTlistsepchange>>&).
11383 The second argument is interpreted as a condition that is to
11384 be applied to each item in the list in turn. During the interpretation of the
11385 condition, the current list item is placed in a variable called &$item$&.
11386 .ilist
11387 For &*forany*&, interpretation stops if the condition is true for any item, and
11388 the result of the whole condition is true. If the condition is false for all
11389 items in the list, the overall condition is false.
11390 .next
11391 For &*forall*&, interpretation stops if the condition is false for any item,
11392 and the result of the whole condition is false. If the condition is true for
11393 all items in the list, the overall condition is true.
11394 .endlist
11395 Note that negation of &*forany*& means that the condition must be false for all
11396 items for the overall condition to succeed, and negation of &*forall*& means
11397 that the condition must be false for at least one item. In this example, the
11398 list separator is changed to a comma:
11399 .code
11400 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11401 .endd
11402 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11403 being processed, to enable these expansion items to be nested.
11404
11405 To scan a named list, expand it with the &*listnamed*& operator.
11406
11407 .new
11408 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11409        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11410        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11411        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11412 .cindex JSON "iterative conditions"
11413 .cindex JSON expansions
11414 .cindex expansion "&*forall_json*& condition"
11415 .cindex expansion "&*forany_json*& condition"
11416 .cindex expansion "&*forall_jsons*& condition"
11417 .cindex expansion "&*forany_jsons*& condition"
11418 As for the above, except that the first argument must, after expansion,
11419 be a JSON array.
11420 The array separator is not changeable.
11421 For the &"jsons"& variants the elements are expected to be JSON strings
11422 and have their quotes removed before the evaluation of the condition.
11423 .wen
11424
11425
11426
11427 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11428        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11429 .cindex "string" "comparison"
11430 .cindex "expansion" "string comparison"
11431 .cindex "&%ge%& expansion condition"
11432 .cindex "&%gei%& expansion condition"
11433 The two substrings are first expanded. The condition is true if the first
11434 string is lexically greater than or equal to the second string. For &%ge%& the
11435 comparison includes the case of letters, whereas for &%gei%& the comparison is
11436 case-independent.
11437 Case and collation order are defined per the system C locale.
11438
11439 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11440        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11441 .cindex "string" "comparison"
11442 .cindex "expansion" "string comparison"
11443 .cindex "&%gt%& expansion condition"
11444 .cindex "&%gti%& expansion condition"
11445 The two substrings are first expanded. The condition is true if the first
11446 string is lexically greater than the second string. For &%gt%& the comparison
11447 includes the case of letters, whereas for &%gti%& the comparison is
11448 case-independent.
11449 Case and collation order are defined per the system C locale.
11450
11451 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11452        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11453 .cindex "string" "comparison"
11454 .cindex "list" "iterative conditions"
11455 Both strings are expanded; the second string is treated as a list of simple
11456 strings; if the first string is a member of the second, then the condition
11457 is true.
11458 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11459
11460 These are simpler to use versions of the more powerful &*forany*& condition.
11461 Examples, and the &*forany*& equivalents:
11462 .code
11463 ${if inlist{needle}{foo:needle:bar}}
11464   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11465 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11466   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11467 .endd
11468
11469 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11470        &*isip4&~{*&<&'string'&>&*}*& &&&
11471        &*isip6&~{*&<&'string'&>&*}*&
11472 .cindex "IP address" "testing string format"
11473 .cindex "string" "testing for IP address"
11474 .cindex "&%isip%& expansion condition"
11475 .cindex "&%isip4%& expansion condition"
11476 .cindex "&%isip6%& expansion condition"
11477 The substring is first expanded, and then tested to see if it has the form of
11478 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11479 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11480
11481 For an IPv4 address, the test is for four dot-separated components, each of
11482 which consists of from one to three digits. For an IPv6 address, up to eight
11483 colon-separated components are permitted, each containing from one to four
11484 hexadecimal digits. There may be fewer than eight components if an empty
11485 component (adjacent colons) is present. Only one empty component is permitted.
11486
11487 &*Note*&: The checks used to be just on the form of the address; actual numerical
11488 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11489 check.
11490 This is no longer the case.
11491
11492 The main use of these tests is to distinguish between IP addresses and
11493 host names, or between IPv4 and IPv6 addresses. For example, you could use
11494 .code
11495 ${if isip4{$sender_host_address}...
11496 .endd
11497 to test which IP version an incoming SMTP connection is using.
11498
11499 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11500 .cindex "LDAP" "use for authentication"
11501 .cindex "expansion" "LDAP authentication test"
11502 .cindex "&%ldapauth%& expansion condition"
11503 This condition supports user authentication using LDAP. See section
11504 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11505 queries. For this use, the query must contain a user name and password. The
11506 query itself is not used, and can be empty. The condition is true if the
11507 password is not empty, and the user name and password are accepted by the LDAP
11508 server. An empty password is rejected without calling LDAP because LDAP binds
11509 with an empty password are considered anonymous regardless of the username, and
11510 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11511 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11512 this can be used.
11513
11514
11515 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11516        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11517 .cindex "string" "comparison"
11518 .cindex "expansion" "string comparison"
11519 .cindex "&%le%& expansion condition"
11520 .cindex "&%lei%& expansion condition"
11521 The two substrings are first expanded. The condition is true if the first
11522 string is lexically less than or equal to the second string. For &%le%& the
11523 comparison includes the case of letters, whereas for &%lei%& the comparison is
11524 case-independent.
11525 Case and collation order are defined per the system C locale.
11526
11527 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11528        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11529 .cindex "string" "comparison"
11530 .cindex "expansion" "string comparison"
11531 .cindex "&%lt%& expansion condition"
11532 .cindex "&%lti%& expansion condition"
11533 The two substrings are first expanded. The condition is true if the first
11534 string is lexically less than the second string. For &%lt%& the comparison
11535 includes the case of letters, whereas for &%lti%& the comparison is
11536 case-independent.
11537 Case and collation order are defined per the system C locale.
11538
11539
11540 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11541 .cindex "expansion" "regular expression comparison"
11542 .cindex "regular expressions" "match in expanded string"
11543 .cindex "&%match%& expansion condition"
11544 The two substrings are first expanded. The second is then treated as a regular
11545 expression and applied to the first. Because of the pre-expansion, if the
11546 regular expression contains dollar, or backslash characters, they must be
11547 escaped. Care must also be taken if the regular expression contains braces
11548 (curly brackets). A closing brace must be escaped so that it is not taken as a
11549 premature termination of <&'string2'&>. The easiest approach is to use the
11550 &`\N`& feature to disable expansion of the regular expression.
11551 For example,
11552 .code
11553 ${if match {$local_part}{\N^\d{3}\N} ...
11554 .endd
11555 If the whole expansion string is in double quotes, further escaping of
11556 backslashes is also required.
11557
11558 The condition is true if the regular expression match succeeds.
11559 The regular expression is not required to begin with a circumflex
11560 metacharacter, but if there is no circumflex, the expression is not anchored,
11561 and it may match anywhere in the subject, not just at the start. If you want
11562 the pattern to match at the end of the subject, you must include the &`$`&
11563 metacharacter at an appropriate point.
11564 All character handling is done in bytes and is not UTF-8 aware,
11565 but we might change this in a future Exim release.
11566
11567 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11568 At the start of an &%if%& expansion the values of the numeric variable
11569 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11570 succeeds causes them to be reset to the substrings of that condition and they
11571 will have these values during the expansion of the success string. At the end
11572 of the &%if%& expansion, the previous values are restored. After testing a
11573 combination of conditions using &%or%&, the subsequent values of the numeric
11574 variables are those of the condition that succeeded.
11575
11576 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11577 .cindex "&%match_address%& expansion condition"
11578 See &*match_local_part*&.
11579
11580 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11581 .cindex "&%match_domain%& expansion condition"
11582 See &*match_local_part*&.
11583
11584 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11585 .cindex "&%match_ip%& expansion condition"
11586 This condition matches an IP address to a list of IP address patterns. It must
11587 be followed by two argument strings. The first (after expansion) must be an IP
11588 address or an empty string. The second (not expanded) is a restricted host
11589 list that can match only an IP address, not a host name. For example:
11590 .code
11591 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11592 .endd
11593 The specific types of host list item that are permitted in the list are:
11594
11595 .ilist
11596 An IP address, optionally with a CIDR mask.
11597 .next
11598 A single asterisk, which matches any IP address.
11599 .next
11600 An empty item, which matches only if the IP address is empty. This could be
11601 useful for testing for a locally submitted message or one from specific hosts
11602 in a single test such as
11603 . ==== As this is a nested list, any displays it contains must be indented
11604 . ==== as otherwise they are too far to the left. This comment applies to
11605 . ==== the use of xmlto plus fop. There's no problem when formatting with
11606 . ==== sdop, with or without the extra indent.
11607 .code
11608   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11609 .endd
11610 where the first item in the list is the empty string.
11611 .next
11612 The item @[] matches any of the local host's interface addresses.
11613 .next
11614 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11615 even if &`net-`& is not specified. There is never any attempt to turn the IP
11616 address into a host name. The most common type of linear search for
11617 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11618 masks. For example:
11619 .code
11620   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11621 .endd
11622 It is of course possible to use other kinds of lookup, and in such a case, you
11623 do need to specify the &`net-`& prefix if you want to specify a specific
11624 address mask, for example:
11625 .code
11626   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11627 .endd
11628 However, unless you are combining a &%match_ip%& condition with others, it is
11629 just as easy to use the fact that a lookup is itself a condition, and write:
11630 .code
11631   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11632 .endd
11633 .endlist ilist
11634
11635 Note that <&'string2'&> is not itself subject to string expansion, unless
11636 Exim was built with the EXPAND_LISTMATCH_RHS option.
11637
11638 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11639
11640 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11641 .cindex "domain list" "in expansion condition"
11642 .cindex "address list" "in expansion condition"
11643 .cindex "local part" "list, in expansion condition"
11644 .cindex "&%match_local_part%& expansion condition"
11645 This condition, together with &%match_address%& and &%match_domain%&, make it
11646 possible to test domain, address, and local part lists within expansions. Each
11647 condition requires two arguments: an item and a list to match. A trivial
11648 example is:
11649 .code
11650 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11651 .endd
11652 In each case, the second argument may contain any of the allowable items for a
11653 list of the appropriate type. Also, because the second argument
11654 is a standard form of list, it is possible to refer to a named list.
11655 Thus, you can use conditions like this:
11656 .code
11657 ${if match_domain{$domain}{+local_domains}{...
11658 .endd
11659 .cindex "&`+caseful`&"
11660 For address lists, the matching starts off caselessly, but the &`+caseful`&
11661 item can be used, as in all address lists, to cause subsequent items to
11662 have their local parts matched casefully. Domains are always matched
11663 caselessly.
11664
11665 Note that <&'string2'&> is not itself subject to string expansion, unless
11666 Exim was built with the EXPAND_LISTMATCH_RHS option.
11667
11668 &*Note*&: Host lists are &'not'& supported in this way. This is because
11669 hosts have two identities: a name and an IP address, and it is not clear
11670 how to specify cleanly how such a test would work. However, IP addresses can be
11671 matched using &%match_ip%&.
11672
11673 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11674 .cindex "PAM authentication"
11675 .cindex "AUTH" "with PAM"
11676 .cindex "Solaris" "PAM support"
11677 .cindex "expansion" "PAM authentication test"
11678 .cindex "&%pam%& expansion condition"
11679 &'Pluggable Authentication Modules'&
11680 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11681 available in the latest releases of Solaris and in some GNU/Linux
11682 distributions. The Exim support, which is intended for use in conjunction with
11683 the SMTP AUTH command, is available only if Exim is compiled with
11684 .code
11685 SUPPORT_PAM=yes
11686 .endd
11687 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11688 in some releases of GNU/Linux &%-ldl%& is also needed.
11689
11690 The argument string is first expanded, and the result must be a
11691 colon-separated list of strings. Leading and trailing white space is ignored.
11692 The PAM module is initialized with the service name &"exim"& and the user name
11693 taken from the first item in the colon-separated data string (<&'string1'&>).
11694 The remaining items in the data string are passed over in response to requests
11695 from the authentication function. In the simple case there will only be one
11696 request, for a password, so the data consists of just two strings.
11697
11698 There can be problems if any of the strings are permitted to contain colon
11699 characters. In the usual way, these have to be doubled to avoid being taken as
11700 separators. If the data is being inserted from a variable, the &%sg%& expansion
11701 item can be used to double any existing colons. For example, the configuration
11702 of a LOGIN authenticator might contain this setting:
11703 .code
11704 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11705 .endd
11706 For a PLAIN authenticator you could use:
11707 .code
11708 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11709 .endd
11710 In some operating systems, PAM authentication can be done only from a process
11711 running as root. Since Exim is running as the Exim user when receiving
11712 messages, this means that PAM cannot be used directly in those systems.
11713 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11714
11715
11716 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11717 .cindex "&'pwcheck'& daemon"
11718 .cindex "Cyrus"
11719 .cindex "expansion" "&'pwcheck'& authentication test"
11720 .cindex "&%pwcheck%& expansion condition"
11721 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11722 This is one way of making it possible for passwords to be checked by a process
11723 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11724 deprecated. Its replacement is &'saslauthd'& (see below).
11725
11726 The pwcheck support is not included in Exim by default. You need to specify
11727 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11728 building Exim. For example:
11729 .code
11730 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11731 .endd
11732 You do not need to install the full Cyrus software suite in order to use
11733 the pwcheck daemon. You can compile and install just the daemon alone
11734 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11735 access to the &_/var/pwcheck_& directory.
11736
11737 The &%pwcheck%& condition takes one argument, which must be the user name and
11738 password, separated by a colon. For example, in a LOGIN authenticator
11739 configuration, you might have this:
11740 .code
11741 server_condition = ${if pwcheck{$auth1:$auth2}}
11742 .endd
11743 Again, for a PLAIN authenticator configuration, this would be:
11744 .code
11745 server_condition = ${if pwcheck{$auth2:$auth3}}
11746 .endd
11747 .vitem &*queue_running*&
11748 .cindex "queue runner" "detecting when delivering from"
11749 .cindex "expansion" "queue runner test"
11750 .cindex "&%queue_running%& expansion condition"
11751 This condition, which has no data, is true during delivery attempts that are
11752 initiated by queue runner processes, and false otherwise.
11753
11754
11755 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11756 .cindex "Radius"
11757 .cindex "expansion" "Radius authentication"
11758 .cindex "&%radius%& expansion condition"
11759 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11760 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11761 the Radius client configuration file in order to build Exim with Radius
11762 support.
11763
11764 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11765 library, using the original API. If you are using release 0.4.0 or later of
11766 this library, you need to set
11767 .code
11768 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11769 .endd
11770 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11771 &%libradius%& library that comes with FreeBSD. To do this, set
11772 .code
11773 RADIUS_LIB_TYPE=RADLIB
11774 .endd
11775 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11776 You may also have to supply a suitable setting in EXTRALIBS so that the
11777 Radius library can be found when Exim is linked.
11778
11779 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11780 Radius client library, which calls the Radius server. The condition is true if
11781 the authentication is successful. For example:
11782 .code
11783 server_condition = ${if radius{<arguments>}}
11784 .endd
11785
11786
11787 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11788         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11789 .cindex "&'saslauthd'& daemon"
11790 .cindex "Cyrus"
11791 .cindex "expansion" "&'saslauthd'& authentication test"
11792 .cindex "&%saslauthd%& expansion condition"
11793 This condition supports user authentication using the Cyrus &'saslauthd'&
11794 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11795 Using this daemon is one way of making it possible for passwords to be checked
11796 by a process that is not running as root.
11797
11798 The saslauthd support is not included in Exim by default. You need to specify
11799 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11800 building Exim. For example:
11801 .code
11802 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11803 .endd
11804 You do not need to install the full Cyrus software suite in order to use
11805 the saslauthd daemon. You can compile and install just the daemon alone
11806 from the Cyrus SASL library.
11807
11808 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11809 two are mandatory. For example:
11810 .code
11811 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11812 .endd
11813 The service and the realm are optional (which is why the arguments are enclosed
11814 in their own set of braces). For details of the meaning of the service and
11815 realm, and how to run the daemon, consult the Cyrus documentation.
11816 .endlist vlist
11817
11818
11819
11820 .section "Combining expansion conditions" "SECID84"
11821 .cindex "expansion" "combining conditions"
11822 Several conditions can be tested at once by combining them using the &%and%&
11823 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11824 conditions on their own, and precede their lists of sub-conditions. Each
11825 sub-condition must be enclosed in braces within the overall braces that contain
11826 the list. No repetition of &%if%& is used.
11827
11828
11829 .vlist
11830 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11831 .cindex "&""or""& expansion condition"
11832 .cindex "expansion" "&""or""& of conditions"
11833 The sub-conditions are evaluated from left to right. The condition is true if
11834 any one of the sub-conditions is true.
11835 For example,
11836 .code
11837 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11838 .endd
11839 When a true sub-condition is found, the following ones are parsed but not
11840 evaluated. If there are several &"match"& sub-conditions the values of the
11841 numeric variables afterwards are taken from the first one that succeeds.
11842
11843 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11844 .cindex "&""and""& expansion condition"
11845 .cindex "expansion" "&""and""& of conditions"
11846 The sub-conditions are evaluated from left to right. The condition is true if
11847 all of the sub-conditions are true. If there are several &"match"&
11848 sub-conditions, the values of the numeric variables afterwards are taken from
11849 the last one. When a false sub-condition is found, the following ones are
11850 parsed but not evaluated.
11851 .endlist
11852 .ecindex IIDexpcond
11853
11854
11855
11856
11857 .section "Expansion variables" "SECTexpvar"
11858 .cindex "expansion" "variables, list of"
11859 This section contains an alphabetical list of all the expansion variables. Some
11860 of them are available only when Exim is compiled with specific options such as
11861 support for TLS or the content scanning extension.
11862
11863 .vlist
11864 .vitem "&$0$&, &$1$&, etc"
11865 .cindex "numerical variables (&$1$& &$2$& etc)"
11866 When a &%match%& expansion condition succeeds, these variables contain the
11867 captured substrings identified by the regular expression during subsequent
11868 processing of the success string of the containing &%if%& expansion item.
11869 In the expansion condition case
11870 they do not retain their values afterwards; in fact, their previous
11871 values are restored at the end of processing an &%if%& item. The numerical
11872 variables may also be set externally by some other matching process which
11873 precedes the expansion of the string. For example, the commands available in
11874 Exim filter files include an &%if%& command with its own regular expression
11875 matching condition.
11876
11877 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11878 Within an acl condition, expansion condition or expansion item
11879 any arguments are copied to these variables,
11880 any unused variables being made empty.
11881
11882 .vitem "&$acl_c...$&"
11883 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11884 can be given any name that starts with &$acl_c$& and is at least six characters
11885 long, but the sixth character must be either a digit or an underscore. For
11886 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11887 variables persist throughout the lifetime of an SMTP connection. They can be
11888 used to pass information between ACLs and between different invocations of the
11889 same ACL. When a message is received, the values of these variables are saved
11890 with the message, and can be accessed by filters, routers, and transports
11891 during subsequent delivery.
11892
11893 .vitem "&$acl_m...$&"
11894 These variables are like the &$acl_c...$& variables, except that their values
11895 are reset after a message has been received. Thus, if several messages are
11896 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11897 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11898 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11899 message is received, the values of these variables are saved with the message,
11900 and can be accessed by filters, routers, and transports during subsequent
11901 delivery.
11902
11903 .vitem &$acl_narg$&
11904 Within an acl condition, expansion condition or expansion item
11905 this variable has the number of arguments.
11906
11907 .vitem &$acl_verify_message$&
11908 .vindex "&$acl_verify_message$&"
11909 After an address verification has failed, this variable contains the failure
11910 message. It retains its value for use in subsequent modifiers. The message can
11911 be preserved by coding like this:
11912 .code
11913 warn !verify = sender
11914      set acl_m0 = $acl_verify_message
11915 .endd
11916 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11917 &%log_message%& modifiers, to include information about the verification
11918 failure.
11919
11920 .vitem &$address_data$&
11921 .vindex "&$address_data$&"
11922 This variable is set by means of the &%address_data%& option in routers. The
11923 value then remains with the address while it is processed by subsequent routers
11924 and eventually a transport. If the transport is handling multiple addresses,
11925 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11926 for more details. &*Note*&: The contents of &$address_data$& are visible in
11927 user filter files.
11928
11929 If &$address_data$& is set when the routers are called from an ACL to verify
11930 a recipient address, the final value is still in the variable for subsequent
11931 conditions and modifiers of the ACL statement. If routing the address caused it
11932 to be redirected to just one address, the child address is also routed as part
11933 of the verification, and in this case the final value of &$address_data$& is
11934 from the child's routing.
11935
11936 If &$address_data$& is set when the routers are called from an ACL to verify a
11937 sender address, the final value is also preserved, but this time in
11938 &$sender_address_data$&, to distinguish it from data from a recipient
11939 address.
11940
11941 In both cases (recipient and sender verification), the value does not persist
11942 after the end of the current ACL statement. If you want to preserve
11943 these values for longer, you can save them in ACL variables.
11944
11945 .vitem &$address_file$&
11946 .vindex "&$address_file$&"
11947 When, as a result of aliasing, forwarding, or filtering, a message is directed
11948 to a specific file, this variable holds the name of the file when the transport
11949 is running. At other times, the variable is empty. For example, using the
11950 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11951 .code
11952 /home/r2d2/savemail
11953 .endd
11954 then when the &(address_file)& transport is running, &$address_file$&
11955 contains the text string &`/home/r2d2/savemail`&.
11956 .cindex "Sieve filter" "value of &$address_file$&"
11957 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11958 then up to the transport configuration to generate an appropriate absolute path
11959 to the relevant file.
11960
11961 .vitem &$address_pipe$&
11962 .vindex "&$address_pipe$&"
11963 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11964 this variable holds the pipe command when the transport is running.
11965
11966 .vitem "&$auth1$& &-- &$auth3$&"
11967 .vindex "&$auth1$&, &$auth2$&, etc"
11968 These variables are used in SMTP authenticators (see chapters
11969 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11970
11971 .vitem &$authenticated_id$&
11972 .cindex "authentication" "id"
11973 .vindex "&$authenticated_id$&"
11974 When a server successfully authenticates a client it may be configured to
11975 preserve some of the authentication information in the variable
11976 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11977 user/password authenticator configuration might preserve the user name for use
11978 in the routers. Note that this is not the same information that is saved in
11979 &$sender_host_authenticated$&.
11980
11981 When a message is submitted locally (that is, not over a TCP connection)
11982 the value of &$authenticated_id$& is normally the login name of the calling
11983 process. However, a trusted user can override this by means of the &%-oMai%&
11984 command line option.
11985 This second case also sets up information used by the
11986 &$authresults$& expansion item.
11987
11988 .vitem &$authenticated_fail_id$&
11989 .cindex "authentication" "fail" "id"
11990 .vindex "&$authenticated_fail_id$&"
11991 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11992 will contain the failed authentication id. If more than one authentication
11993 id is attempted, it will contain only the last one. The variable is
11994 available for processing in the ACL's, generally the quit or notquit ACL.
11995 A message to a local recipient could still be accepted without requiring
11996 authentication, which means this variable could also be visible in all of
11997 the ACL's as well.
11998
11999
12000 .vitem &$authenticated_sender$&
12001 .cindex "sender" "authenticated"
12002 .cindex "authentication" "sender"
12003 .cindex "AUTH" "on MAIL command"
12004 .vindex "&$authenticated_sender$&"
12005 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12006 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12007 described in section &<<SECTauthparamail>>&. Unless the data is the string
12008 &"<>"&, it is set as the authenticated sender of the message, and the value is
12009 available during delivery in the &$authenticated_sender$& variable. If the
12010 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12011
12012 .vindex "&$qualify_domain$&"
12013 When a message is submitted locally (that is, not over a TCP connection), the
12014 value of &$authenticated_sender$& is an address constructed from the login
12015 name of the calling process and &$qualify_domain$&, except that a trusted user
12016 can override this by means of the &%-oMas%& command line option.
12017
12018
12019 .vitem &$authentication_failed$&
12020 .cindex "authentication" "failure"
12021 .vindex "&$authentication_failed$&"
12022 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12023 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12024 possible to distinguish between &"did not try to authenticate"&
12025 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12026 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12027 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12028 negative response to an AUTH command, including (for example) an attempt to use
12029 an undefined mechanism.
12030
12031 .vitem &$av_failed$&
12032 .cindex "content scanning" "AV scanner failure"
12033 This variable is available when Exim is compiled with the content-scanning
12034 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12035 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12036 the ACL malware condition.
12037
12038 .vitem &$body_linecount$&
12039 .cindex "message body" "line count"
12040 .cindex "body of message" "line count"
12041 .vindex "&$body_linecount$&"
12042 When a message is being received or delivered, this variable contains the
12043 number of lines in the message's body. See also &$message_linecount$&.
12044
12045 .vitem &$body_zerocount$&
12046 .cindex "message body" "binary zero count"
12047 .cindex "body of message" "binary zero count"
12048 .cindex "binary zero" "in message body"
12049 .vindex "&$body_zerocount$&"
12050 When a message is being received or delivered, this variable contains the
12051 number of binary zero bytes (ASCII NULs) in the message's body.
12052
12053 .vitem &$bounce_recipient$&
12054 .vindex "&$bounce_recipient$&"
12055 This is set to the recipient address of a bounce message while Exim is creating
12056 it. It is useful if a customized bounce message text file is in use (see
12057 chapter &<<CHAPemsgcust>>&).
12058
12059 .vitem &$bounce_return_size_limit$&
12060 .vindex "&$bounce_return_size_limit$&"
12061 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12062 up to a multiple of 1000. It is useful when a customized error message text
12063 file is in use (see chapter &<<CHAPemsgcust>>&).
12064
12065 .vitem &$caller_gid$&
12066 .cindex "gid (group id)" "caller"
12067 .vindex "&$caller_gid$&"
12068 The real group id under which the process that called Exim was running. This is
12069 not the same as the group id of the originator of a message (see
12070 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12071 incarnation normally contains the Exim gid.
12072
12073 .vitem &$caller_uid$&
12074 .cindex "uid (user id)" "caller"
12075 .vindex "&$caller_uid$&"
12076 The real user id under which the process that called Exim was running. This is
12077 not the same as the user id of the originator of a message (see
12078 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12079 incarnation normally contains the Exim uid.
12080
12081 .vitem &$callout_address$&
12082 .vindex "&$callout_address$&"
12083 After a callout for verification, spamd or malware daemon service, the
12084 address that was connected to.
12085
12086 .vitem &$compile_number$&
12087 .vindex "&$compile_number$&"
12088 The building process for Exim keeps a count of the number
12089 of times it has been compiled. This serves to distinguish different
12090 compilations of the same version of Exim.
12091
12092 .vitem &$config_dir$&
12093 .vindex "&$config_dir$&"
12094 The directory name of the main configuration file. That is, the content of
12095 &$config_file$& with the last component stripped. The value does not
12096 contain the trailing slash. If &$config_file$& does not contain a slash,
12097 &$config_dir$& is ".".
12098
12099 .vitem &$config_file$&
12100 .vindex "&$config_file$&"
12101 The name of the main configuration file Exim is using.
12102
12103 .new
12104 .vitem &$dmarc_domain_policy$& &&&
12105        &$dmarc_status$& &&&
12106        &$dmarc_status_text$& &&&
12107        &$dmarc_used_domains$&
12108 Results of DMARC verification.
12109 For details see section &<<SECDMARC>>&.
12110 .wen
12111
12112 .vitem &$dkim_verify_status$&
12113 Results of DKIM verification.
12114 For details see section &<<SECDKIMVFY>>&.
12115
12116 .vitem &$dkim_cur_signer$& &&&
12117        &$dkim_verify_reason$& &&&
12118        &$dkim_domain$& &&&
12119        &$dkim_identity$& &&&
12120        &$dkim_selector$& &&&
12121        &$dkim_algo$& &&&
12122        &$dkim_canon_body$& &&&
12123        &$dkim_canon_headers$& &&&
12124        &$dkim_copiedheaders$& &&&
12125        &$dkim_bodylength$& &&&
12126        &$dkim_created$& &&&
12127        &$dkim_expires$& &&&
12128        &$dkim_headernames$& &&&
12129        &$dkim_key_testing$& &&&
12130        &$dkim_key_nosubdomains$& &&&
12131        &$dkim_key_srvtype$& &&&
12132        &$dkim_key_granularity$& &&&
12133        &$dkim_key_notes$& &&&
12134        &$dkim_key_length$&
12135 These variables are only available within the DKIM ACL.
12136 For details see section &<<SECDKIMVFY>>&.
12137
12138 .vitem &$dkim_signers$&
12139 .vindex &$dkim_signers$&
12140 When a message has been received this variable contains
12141 a colon-separated list of signer domains and identities for the message.
12142 For details see section &<<SECDKIMVFY>>&.
12143
12144 .vitem &$dnslist_domain$& &&&
12145        &$dnslist_matched$& &&&
12146        &$dnslist_text$& &&&
12147        &$dnslist_value$&
12148 .vindex "&$dnslist_domain$&"
12149 .vindex "&$dnslist_matched$&"
12150 .vindex "&$dnslist_text$&"
12151 .vindex "&$dnslist_value$&"
12152 .cindex "black list (DNS)"
12153 When a DNS (black) list lookup succeeds, these variables are set to contain
12154 the following data from the lookup: the list's domain name, the key that was
12155 looked up, the contents of any associated TXT record, and the value from the
12156 main A record. See section &<<SECID204>>& for more details.
12157
12158 .vitem &$domain$&
12159 .vindex "&$domain$&"
12160 When an address is being routed, or delivered on its own, this variable
12161 contains the domain. Uppercase letters in the domain are converted into lower
12162 case for &$domain$&.
12163
12164 Global address rewriting happens when a message is received, so the value of
12165 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12166 is set during user filtering, but not during system filtering, because a
12167 message may have many recipients and the system filter is called just once.
12168
12169 When more than one address is being delivered at once (for example, several
12170 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12171 have the same domain. Transports can be restricted to handling only one domain
12172 at a time if the value of &$domain$& is required at transport time &-- this is
12173 the default for local transports. For further details of the environment in
12174 which local transports are run, see chapter &<<CHAPenvironment>>&.
12175
12176 .oindex "&%delay_warning_condition%&"
12177 At the end of a delivery, if all deferred addresses have the same domain, it is
12178 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12179
12180 The &$domain$& variable is also used in some other circumstances:
12181
12182 .ilist
12183 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12184 the recipient address. The domain of the &'sender'& address is in
12185 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12186 normally set during the running of the MAIL ACL. However, if the sender address
12187 is verified with a callout during the MAIL ACL, the sender domain is placed in
12188 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12189 the &(smtp)& transport.
12190
12191 .next
12192 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12193 &$domain$& contains the domain portion of the address that is being rewritten;
12194 it can be used in the expansion of the replacement address, for example, to
12195 rewrite domains by file lookup.
12196
12197 .next
12198 With one important exception, whenever a domain list is being scanned,
12199 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12200 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12201 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12202 that, in a RCPT ACL, the sender domain list can be dependent on the
12203 recipient domain (which is what is in &$domain$& at this time).
12204
12205 .next
12206 .cindex "ETRN" "value of &$domain$&"
12207 .oindex "&%smtp_etrn_command%&"
12208 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12209 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12210 .endlist
12211
12212
12213 .vitem &$domain_data$&
12214 .vindex "&$domain_data$&"
12215 When the &%domains%& option on a router matches a domain by
12216 means of a lookup, the data read by the lookup is available during the running
12217 of the router as &$domain_data$&. In addition, if the driver routes the
12218 address to a transport, the value is available in that transport. If the
12219 transport is handling multiple addresses, the value from the first address is
12220 used.
12221
12222 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12223 domain by means of a lookup. The data read by the lookup is available during
12224 the rest of the ACL statement. In all other situations, this variable expands
12225 to nothing.
12226
12227 .vitem &$exim_gid$&
12228 .vindex "&$exim_gid$&"
12229 This variable contains the numerical value of the Exim group id.
12230
12231 .vitem &$exim_path$&
12232 .vindex "&$exim_path$&"
12233 This variable contains the path to the Exim binary.
12234
12235 .vitem &$exim_uid$&
12236 .vindex "&$exim_uid$&"
12237 This variable contains the numerical value of the Exim user id.
12238
12239 .vitem &$exim_version$&
12240 .vindex "&$exim_version$&"
12241 This variable contains the version string of the Exim build.
12242 The first character is a major version number, currently 4.
12243 Then after a dot, the next group of digits is a minor version number.
12244 There may be other characters following the minor version.
12245 This value may be overridden by the &%exim_version%& main config option.
12246
12247 .vitem &$header_$&<&'name'&>
12248 This is not strictly an expansion variable. It is expansion syntax for
12249 inserting the message header line with the given name. Note that the name must
12250 be terminated by colon or white space, because it may contain a wide variety of
12251 characters. Note also that braces must &'not'& be used.
12252 See the full description in section &<<SECTexpansionitems>>& above.
12253
12254 .vitem &$headers_added$&
12255 .vindex "&$headers_added$&"
12256 Within an ACL this variable contains the headers added so far by
12257 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12258 The headers are a newline-separated list.
12259
12260 .vitem &$home$&
12261 .vindex "&$home$&"
12262 When the &%check_local_user%& option is set for a router, the user's home
12263 directory is placed in &$home$& when the check succeeds. In particular, this
12264 means it is set during the running of users' filter files. A router may also
12265 explicitly set a home directory for use by a transport; this can be overridden
12266 by a setting on the transport itself.
12267
12268 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12269 of the environment variable HOME, which is subject to the
12270 &%keep_environment%& and &%add_environment%& main config options.
12271
12272 .vitem &$host$&
12273 .vindex "&$host$&"
12274 If a router assigns an address to a transport (any transport), and passes a
12275 list of hosts with the address, the value of &$host$& when the transport starts
12276 to run is the name of the first host on the list. Note that this applies both
12277 to local and remote transports.
12278
12279 .cindex "transport" "filter"
12280 .cindex "filter" "transport filter"
12281 For the &(smtp)& transport, if there is more than one host, the value of
12282 &$host$& changes as the transport works its way through the list. In
12283 particular, when the &(smtp)& transport is expanding its options for encryption
12284 using TLS, or for specifying a transport filter (see chapter
12285 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12286 is connected.
12287
12288 When used in the client part of an authenticator configuration (see chapter
12289 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12290 client is connected.
12291
12292
12293 .vitem &$host_address$&
12294 .vindex "&$host_address$&"
12295 This variable is set to the remote host's IP address whenever &$host$& is set
12296 for a remote connection. It is also set to the IP address that is being checked
12297 when the &%ignore_target_hosts%& option is being processed.
12298
12299 .vitem &$host_data$&
12300 .vindex "&$host_data$&"
12301 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12302 result of the lookup is made available in the &$host_data$& variable. This
12303 allows you, for example, to do things like this:
12304 .code
12305 deny  hosts = net-lsearch;/some/file
12306 message = $host_data
12307 .endd
12308 .vitem &$host_lookup_deferred$&
12309 .cindex "host name" "lookup, failure of"
12310 .vindex "&$host_lookup_deferred$&"
12311 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12312 message comes from a remote host and there is an attempt to look up the host's
12313 name from its IP address, and the attempt is not successful, one of these
12314 variables is set to &"1"&.
12315
12316 .ilist
12317 If the lookup receives a definite negative response (for example, a DNS lookup
12318 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12319
12320 .next
12321 If there is any kind of problem during the lookup, such that Exim cannot
12322 tell whether or not the host name is defined (for example, a timeout for a DNS
12323 lookup), &$host_lookup_deferred$& is set to &"1"&.
12324 .endlist ilist
12325
12326 Looking up a host's name from its IP address consists of more than just a
12327 single reverse lookup. Exim checks that a forward lookup of at least one of the
12328 names it receives from a reverse lookup yields the original IP address. If this
12329 is not the case, Exim does not accept the looked up name(s), and
12330 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12331 IP address (for example, the existence of a PTR record in the DNS) is not
12332 sufficient on its own for the success of a host name lookup. If the reverse
12333 lookup succeeds, but there is a lookup problem such as a timeout when checking
12334 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12335 &"1"&. See also &$sender_host_name$&.
12336
12337 .cindex authentication "expansion item"
12338 Performing these checks sets up information used by the
12339 &%authresults%& expansion item.
12340
12341
12342 .vitem &$host_lookup_failed$&
12343 .vindex "&$host_lookup_failed$&"
12344 See &$host_lookup_deferred$&.
12345
12346 .vitem &$host_port$&
12347 .vindex "&$host_port$&"
12348 This variable is set to the remote host's TCP port whenever &$host$& is set
12349 for an outbound connection.
12350
12351 .vitem &$initial_cwd$&
12352 .vindex "&$initial_cwd$&
12353 This variable contains the full path name of the initial working
12354 directory of the current Exim process. This may differ from the current
12355 working directory, as Exim changes this to "/" during early startup, and
12356 to &$spool_directory$& later.
12357
12358 .vitem &$inode$&
12359 .vindex "&$inode$&"
12360 The only time this variable is set is while expanding the &%directory_file%&
12361 option in the &(appendfile)& transport. The variable contains the inode number
12362 of the temporary file which is about to be renamed. It can be used to construct
12363 a unique name for the file.
12364
12365 .vitem &$interface_address$&
12366 .vindex "&$interface_address$&"
12367 This is an obsolete name for &$received_ip_address$&.
12368
12369 .vitem &$interface_port$&
12370 .vindex "&$interface_port$&"
12371 This is an obsolete name for &$received_port$&.
12372
12373 .vitem &$item$&
12374 .vindex "&$item$&"
12375 This variable is used during the expansion of &*forall*& and &*forany*&
12376 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12377 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12378 empty.
12379
12380 .vitem &$ldap_dn$&
12381 .vindex "&$ldap_dn$&"
12382 This variable, which is available only when Exim is compiled with LDAP support,
12383 contains the DN from the last entry in the most recently successful LDAP
12384 lookup.
12385
12386 .vitem &$load_average$&
12387 .vindex "&$load_average$&"
12388 This variable contains the system load average, multiplied by 1000 so that it
12389 is an integer. For example, if the load average is 0.21, the value of the
12390 variable is 210. The value is recomputed every time the variable is referenced.
12391
12392 .vitem &$local_part$&
12393 .vindex "&$local_part$&"
12394 When an address is being routed, or delivered on its own, this
12395 variable contains the local part. When a number of addresses are being
12396 delivered together (for example, multiple RCPT commands in an SMTP
12397 session), &$local_part$& is not set.
12398
12399 Global address rewriting happens when a message is received, so the value of
12400 &$local_part$& during routing and delivery is the value after rewriting.
12401 &$local_part$& is set during user filtering, but not during system filtering,
12402 because a message may have many recipients and the system filter is called just
12403 once.
12404
12405 .vindex "&$local_part_prefix$&"
12406 .vindex "&$local_part_suffix$&"
12407 .cindex affix variables
12408 If a local part prefix or suffix has been recognized, it is not included in the
12409 value of &$local_part$& during routing and subsequent delivery. The values of
12410 any prefix or suffix are in &$local_part_prefix$& and
12411 &$local_part_suffix$&, respectively.
12412
12413 When a message is being delivered to a file, pipe, or autoreply transport as a
12414 result of aliasing or forwarding, &$local_part$& is set to the local part of
12415 the parent address, not to the filename or command (see &$address_file$& and
12416 &$address_pipe$&).
12417
12418 When an ACL is running for a RCPT command, &$local_part$& contains the
12419 local part of the recipient address.
12420
12421 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12422 &$local_part$& contains the local part of the address that is being rewritten;
12423 it can be used in the expansion of the replacement address, for example.
12424
12425 In all cases, all quoting is removed from the local part. For example, for both
12426 the addresses
12427 .code
12428 "abc:xyz"@test.example
12429 abc\:xyz@test.example
12430 .endd
12431 the value of &$local_part$& is
12432 .code
12433 abc:xyz
12434 .endd
12435 If you use &$local_part$& to create another address, you should always wrap it
12436 inside a quoting operator. For example, in a &(redirect)& router you could
12437 have:
12438 .code
12439 data = ${quote_local_part:$local_part}@new.domain.example
12440 .endd
12441 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12442 to process local parts in a case-dependent manner in a router, you can set the
12443 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12444
12445 .vitem &$local_part_data$&
12446 .vindex "&$local_part_data$&"
12447 When the &%local_parts%& option on a router matches a local part by means of a
12448 lookup, the data read by the lookup is available during the running of the
12449 router as &$local_part_data$&. In addition, if the driver routes the address
12450 to a transport, the value is available in that transport. If the transport is
12451 handling multiple addresses, the value from the first address is used.
12452
12453 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12454 matches a local part by means of a lookup. The data read by the lookup is
12455 available during the rest of the ACL statement. In all other situations, this
12456 variable expands to nothing.
12457
12458 .vitem &$local_part_prefix$&
12459 .vindex "&$local_part_prefix$&"
12460 .cindex affix variables
12461 When an address is being routed or delivered, and a
12462 specific prefix for the local part was recognized, it is available in this
12463 variable, having been removed from &$local_part$&.
12464
12465 .vitem &$local_part_suffix$&
12466 .vindex "&$local_part_suffix$&"
12467 When an address is being routed or delivered, and a
12468 specific suffix for the local part was recognized, it is available in this
12469 variable, having been removed from &$local_part$&.
12470
12471 .vitem &$local_scan_data$&
12472 .vindex "&$local_scan_data$&"
12473 This variable contains the text returned by the &[local_scan()]& function when
12474 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12475
12476 .vitem &$local_user_gid$&
12477 .vindex "&$local_user_gid$&"
12478 See &$local_user_uid$&.
12479
12480 .vitem &$local_user_uid$&
12481 .vindex "&$local_user_uid$&"
12482 This variable and &$local_user_gid$& are set to the uid and gid after the
12483 &%check_local_user%& router precondition succeeds. This means that their values
12484 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12485 and &%condition%&), for the &%address_data%& expansion, and for any
12486 router-specific expansions. At all other times, the values in these variables
12487 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12488
12489 .vitem &$localhost_number$&
12490 .vindex "&$localhost_number$&"
12491 This contains the expanded value of the
12492 &%localhost_number%& option. The expansion happens after the main options have
12493 been read.
12494
12495 .vitem &$log_inodes$&
12496 .vindex "&$log_inodes$&"
12497 The number of free inodes in the disk partition where Exim's
12498 log files are being written. The value is recalculated whenever the variable is
12499 referenced. If the relevant file system does not have the concept of inodes,
12500 the value of is -1. See also the &%check_log_inodes%& option.
12501
12502 .vitem &$log_space$&
12503 .vindex "&$log_space$&"
12504 The amount of free space (as a number of kilobytes) in the disk
12505 partition where Exim's log files are being written. The value is recalculated
12506 whenever the variable is referenced. If the operating system does not have the
12507 ability to find the amount of free space (only true for experimental systems),
12508 the space value is -1. See also the &%check_log_space%& option.
12509
12510
12511 .vitem &$lookup_dnssec_authenticated$&
12512 .vindex "&$lookup_dnssec_authenticated$&"
12513 This variable is set after a DNS lookup done by
12514 a dnsdb lookup expansion, dnslookup router or smtp transport.
12515 .cindex "DNS" "DNSSEC"
12516 It will be empty if &(DNSSEC)& was not requested,
12517 &"no"& if the result was not labelled as authenticated data
12518 and &"yes"& if it was.
12519 Results that are labelled as authoritative answer that match
12520 the &%dns_trust_aa%& configuration variable count also
12521 as authenticated data.
12522
12523 .vitem &$mailstore_basename$&
12524 .vindex "&$mailstore_basename$&"
12525 This variable is set only when doing deliveries in &"mailstore"& format in the
12526 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12527 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12528 contains the basename of the files that are being written, that is, the name
12529 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12530 variable is empty.
12531
12532 .vitem &$malware_name$&
12533 .vindex "&$malware_name$&"
12534 This variable is available when Exim is compiled with the
12535 content-scanning extension. It is set to the name of the virus that was found
12536 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12537
12538 .vitem &$max_received_linelength$&
12539 .vindex "&$max_received_linelength$&"
12540 .cindex "maximum" "line length"
12541 .cindex "line length" "maximum"
12542 This variable contains the number of bytes in the longest line that was
12543 received as part of the message, not counting the line termination
12544 character(s).
12545 It is not valid if the &%spool_files_wireformat%& option is used.
12546
12547 .vitem &$message_age$&
12548 .cindex "message" "age of"
12549 .vindex "&$message_age$&"
12550 This variable is set at the start of a delivery attempt to contain the number
12551 of seconds since the message was received. It does not change during a single
12552 delivery attempt.
12553
12554 .vitem &$message_body$&
12555 .cindex "body of message" "expansion variable"
12556 .cindex "message body" "in expansion"
12557 .cindex "binary zero" "in message body"
12558 .vindex "&$message_body$&"
12559 .oindex "&%message_body_visible%&"
12560 This variable contains the initial portion of a message's body while it is
12561 being delivered, and is intended mainly for use in filter files. The maximum
12562 number of characters of the body that are put into the variable is set by the
12563 &%message_body_visible%& configuration option; the default is 500.
12564
12565 .oindex "&%message_body_newlines%&"
12566 By default, newlines are converted into spaces in &$message_body$&, to make it
12567 easier to search for phrases that might be split over a line break. However,
12568 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12569 zeros are always converted into spaces.
12570
12571 .vitem &$message_body_end$&
12572 .cindex "body of message" "expansion variable"
12573 .cindex "message body" "in expansion"
12574 .vindex "&$message_body_end$&"
12575 This variable contains the final portion of a message's
12576 body while it is being delivered. The format and maximum size are as for
12577 &$message_body$&.
12578
12579 .vitem &$message_body_size$&
12580 .cindex "body of message" "size"
12581 .cindex "message body" "size"
12582 .vindex "&$message_body_size$&"
12583 When a message is being delivered, this variable contains the size of the body
12584 in bytes. The count starts from the character after the blank line that
12585 separates the body from the header. Newlines are included in the count. See
12586 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12587
12588 If the spool file is wireformat
12589 (see the &%spool_files_wireformat%& main option)
12590 the CRLF line-terminators are included in the count.
12591
12592 .vitem &$message_exim_id$&
12593 .vindex "&$message_exim_id$&"
12594 When a message is being received or delivered, this variable contains the
12595 unique message id that is generated and used by Exim to identify the message.
12596 An id is not created for a message until after its header has been successfully
12597 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12598 line; it is the local id that Exim assigns to the message, for example:
12599 &`1BXTIK-0001yO-VA`&.
12600
12601 .vitem &$message_headers$&
12602 .vindex &$message_headers$&
12603 This variable contains a concatenation of all the header lines when a message
12604 is being processed, except for lines added by routers or transports. The header
12605 lines are separated by newline characters. Their contents are decoded in the
12606 same way as a header line that is inserted by &%bheader%&.
12607
12608 .vitem &$message_headers_raw$&
12609 .vindex &$message_headers_raw$&
12610 This variable is like &$message_headers$& except that no processing of the
12611 contents of header lines is done.
12612
12613 .vitem &$message_id$&
12614 This is an old name for &$message_exim_id$&. It is now deprecated.
12615
12616 .vitem &$message_linecount$&
12617 .vindex "&$message_linecount$&"
12618 This variable contains the total number of lines in the header and body of the
12619 message. Compare &$body_linecount$&, which is the count for the body only.
12620 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12621 number of lines received. Before delivery happens (that is, before filters,
12622 routers, and transports run) the count is increased to include the
12623 &'Received:'& header line that Exim standardly adds, and also any other header
12624 lines that are added by ACLs. The blank line that separates the message header
12625 from the body is not counted.
12626
12627 As with the special case of &$message_size$&, during the expansion of the
12628 appendfile transport's maildir_tag option in maildir format, the value of
12629 &$message_linecount$& is the precise size of the number of newlines in the
12630 file that has been written (minus one for the blank line between the
12631 header and the body).
12632
12633 Here is an example of the use of this variable in a DATA ACL:
12634 .code
12635 deny message   = Too many lines in message header
12636      condition = \
12637       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12638 .endd
12639 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12640 message has not yet been received.
12641
12642 This variable is not valid if the &%spool_files_wireformat%& option is used.
12643
12644 .vitem &$message_size$&
12645 .cindex "size" "of message"
12646 .cindex "message" "size"
12647 .vindex "&$message_size$&"
12648 When a message is being processed, this variable contains its size in bytes. In
12649 most cases, the size includes those headers that were received with the
12650 message, but not those (such as &'Envelope-to:'&) that are added to individual
12651 deliveries as they are written. However, there is one special case: during the
12652 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12653 doing a delivery in maildir format, the value of &$message_size$& is the
12654 precise size of the file that has been written. See also
12655 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12656
12657 .cindex "RCPT" "value of &$message_size$&"
12658 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12659 contains the size supplied on the MAIL command, or -1 if no size was given. The
12660 value may not, of course, be truthful.
12661
12662 .vitem &$mime_$&&'xxx'&
12663 A number of variables whose names start with &$mime$& are
12664 available when Exim is compiled with the content-scanning extension. For
12665 details, see section &<<SECTscanmimepart>>&.
12666
12667 .vitem "&$n0$& &-- &$n9$&"
12668 These variables are counters that can be incremented by means
12669 of the &%add%& command in filter files.
12670
12671 .vitem &$original_domain$&
12672 .vindex "&$domain$&"
12673 .vindex "&$original_domain$&"
12674 When a top-level address is being processed for delivery, this contains the
12675 same value as &$domain$&. However, if a &"child"& address (for example,
12676 generated by an alias, forward, or filter file) is being processed, this
12677 variable contains the domain of the original address (lower cased). This
12678 differs from &$parent_domain$& only when there is more than one level of
12679 aliasing or forwarding. When more than one address is being delivered in a
12680 single transport run, &$original_domain$& is not set.
12681
12682 If a new address is created by means of a &%deliver%& command in a system
12683 filter, it is set up with an artificial &"parent"& address. This has the local
12684 part &'system-filter'& and the default qualify domain.
12685
12686 .vitem &$original_local_part$&
12687 .vindex "&$local_part$&"
12688 .vindex "&$original_local_part$&"
12689 When a top-level address is being processed for delivery, this contains the
12690 same value as &$local_part$&, unless a prefix or suffix was removed from the
12691 local part, because &$original_local_part$& always contains the full local
12692 part. When a &"child"& address (for example, generated by an alias, forward, or
12693 filter file) is being processed, this variable contains the full local part of
12694 the original address.
12695
12696 If the router that did the redirection processed the local part
12697 case-insensitively, the value in &$original_local_part$& is in lower case.
12698 This variable differs from &$parent_local_part$& only when there is more than
12699 one level of aliasing or forwarding. When more than one address is being
12700 delivered in a single transport run, &$original_local_part$& is not set.
12701
12702 If a new address is created by means of a &%deliver%& command in a system
12703 filter, it is set up with an artificial &"parent"& address. This has the local
12704 part &'system-filter'& and the default qualify domain.
12705
12706 .vitem &$originator_gid$&
12707 .cindex "gid (group id)" "of originating user"
12708 .cindex "sender" "gid"
12709 .vindex "&$caller_gid$&"
12710 .vindex "&$originator_gid$&"
12711 This variable contains the value of &$caller_gid$& that was set when the
12712 message was received. For messages received via the command line, this is the
12713 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12714 normally the gid of the Exim user.
12715
12716 .vitem &$originator_uid$&
12717 .cindex "uid (user id)" "of originating user"
12718 .cindex "sender" "uid"
12719 .vindex "&$caller_uid$&"
12720 .vindex "&$originator_uid$&"
12721 The value of &$caller_uid$& that was set when the message was received. For
12722 messages received via the command line, this is the uid of the sending user.
12723 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12724 user.
12725
12726 .vitem &$parent_domain$&
12727 .vindex "&$parent_domain$&"
12728 This variable is similar to &$original_domain$& (see
12729 above), except that it refers to the immediately preceding parent address.
12730
12731 .vitem &$parent_local_part$&
12732 .vindex "&$parent_local_part$&"
12733 This variable is similar to &$original_local_part$&
12734 (see above), except that it refers to the immediately preceding parent address.
12735
12736 .vitem &$pid$&
12737 .cindex "pid (process id)" "of current process"
12738 .vindex "&$pid$&"
12739 This variable contains the current process id.
12740
12741 .vitem &$pipe_addresses$&
12742 .cindex "filter" "transport filter"
12743 .cindex "transport" "filter"
12744 .vindex "&$pipe_addresses$&"
12745 This is not an expansion variable, but is mentioned here because the string
12746 &`$pipe_addresses`& is handled specially in the command specification for the
12747 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12748 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12749 It cannot be used in general expansion strings, and provokes an &"unknown
12750 variable"& error if encountered.
12751
12752 .vitem &$primary_hostname$&
12753 .vindex "&$primary_hostname$&"
12754 This variable contains the value set by &%primary_hostname%& in the
12755 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12756 a single-component name, Exim calls &[gethostbyname()]& (or
12757 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12758 qualified host name. See also &$smtp_active_hostname$&.
12759
12760
12761 .vitem &$proxy_external_address$& &&&
12762        &$proxy_external_port$& &&&
12763        &$proxy_local_address$& &&&
12764        &$proxy_local_port$& &&&
12765        &$proxy_session$&
12766 These variables are only available when built with Proxy Protocol
12767 or SOCKS5 support.
12768 For details see chapter &<<SECTproxyInbound>>&.
12769
12770 .vitem &$prdr_requested$&
12771 .cindex "PRDR" "variable for"
12772 This variable is set to &"yes"& if PRDR was requested by the client for the
12773 current message, otherwise &"no"&.
12774
12775 .vitem &$prvscheck_address$&
12776 This variable is used in conjunction with the &%prvscheck%& expansion item,
12777 which is described in sections &<<SECTexpansionitems>>& and
12778 &<<SECTverifyPRVS>>&.
12779
12780 .vitem &$prvscheck_keynum$&
12781 This variable is used in conjunction with the &%prvscheck%& expansion item,
12782 which is described in sections &<<SECTexpansionitems>>& and
12783 &<<SECTverifyPRVS>>&.
12784
12785 .vitem &$prvscheck_result$&
12786 This variable is used in conjunction with the &%prvscheck%& expansion item,
12787 which is described in sections &<<SECTexpansionitems>>& and
12788 &<<SECTverifyPRVS>>&.
12789
12790 .vitem &$qualify_domain$&
12791 .vindex "&$qualify_domain$&"
12792 The value set for the &%qualify_domain%& option in the configuration file.
12793
12794 .vitem &$qualify_recipient$&
12795 .vindex "&$qualify_recipient$&"
12796 The value set for the &%qualify_recipient%& option in the configuration file,
12797 or if not set, the value of &$qualify_domain$&.
12798
12799 .vitem &$queue_name$&
12800 .vindex &$queue_name$&
12801 .cindex "named queues"
12802 .cindex queues named
12803 The name of the spool queue in use; empty for the default queue.
12804
12805 .new
12806 .vitem &$r_...$&
12807 .vindex &$r_...$&
12808 .cindex router variables
12809 Values can be placed in these variables by the &%set%& option of a router.
12810 They can be given any name that starts with &$r_$&.
12811 The values persist for the address being handled through subsequent routers
12812 and the eventual transport.
12813 .wen
12814
12815 .vitem &$rcpt_count$&
12816 .vindex "&$rcpt_count$&"
12817 When a message is being received by SMTP, this variable contains the number of
12818 RCPT commands received for the current message. If this variable is used in a
12819 RCPT ACL, its value includes the current command.
12820
12821 .vitem &$rcpt_defer_count$&
12822 .vindex "&$rcpt_defer_count$&"
12823 .cindex "4&'xx'& responses" "count of"
12824 When a message is being received by SMTP, this variable contains the number of
12825 RCPT commands in the current message that have previously been rejected with a
12826 temporary (4&'xx'&) response.
12827
12828 .vitem &$rcpt_fail_count$&
12829 .vindex "&$rcpt_fail_count$&"
12830 When a message is being received by SMTP, this variable contains the number of
12831 RCPT commands in the current message that have previously been rejected with a
12832 permanent (5&'xx'&) response.
12833
12834 .vitem &$received_count$&
12835 .vindex "&$received_count$&"
12836 This variable contains the number of &'Received:'& header lines in the message,
12837 including the one added by Exim (so its value is always greater than zero). It
12838 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12839 delivering.
12840
12841 .vitem &$received_for$&
12842 .vindex "&$received_for$&"
12843 If there is only a single recipient address in an incoming message, this
12844 variable contains that address when the &'Received:'& header line is being
12845 built. The value is copied after recipient rewriting has happened, but before
12846 the &[local_scan()]& function is run.
12847
12848 .vitem &$received_ip_address$&
12849 .vindex "&$received_ip_address$&"
12850 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12851 variable is set to the address of the local IP interface, and &$received_port$&
12852 is set to the local port number. (The remote IP address and port are in
12853 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12854 the port value is -1 unless it has been set using the &%-oMi%& command line
12855 option.
12856
12857 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12858 could be used, for example, to make the filename for a TLS certificate depend
12859 on which interface and/or port is being used for the incoming connection. The
12860 values of &$received_ip_address$& and &$received_port$& are saved with any
12861 messages that are received, thus making these variables available at delivery
12862 time.
12863 For outbound connections see &$sending_ip_address$&.
12864
12865 .vitem &$received_port$&
12866 .vindex "&$received_port$&"
12867 See &$received_ip_address$&.
12868
12869 .vitem &$received_protocol$&
12870 .vindex "&$received_protocol$&"
12871 When a message is being processed, this variable contains the name of the
12872 protocol by which it was received. Most of the names used by Exim are defined
12873 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12874 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12875 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12876 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12877 connection and the client was successfully authenticated.
12878
12879 Exim uses the protocol name &"smtps"& for the case when encryption is
12880 automatically set up on connection without the use of STARTTLS (see
12881 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12882 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12883 where the client initially uses EHLO, sets up an encrypted connection using
12884 STARTTLS, and then uses HELO afterwards.
12885
12886 The &%-oMr%& option provides a way of specifying a custom protocol name for
12887 messages that are injected locally by trusted callers. This is commonly used to
12888 identify messages that are being re-injected after some kind of scanning.
12889
12890 .vitem &$received_time$&
12891 .vindex "&$received_time$&"
12892 This variable contains the date and time when the current message was received,
12893 as a number of seconds since the start of the Unix epoch.
12894
12895 .vitem &$recipient_data$&
12896 .vindex "&$recipient_data$&"
12897 This variable is set after an indexing lookup success in an ACL &%recipients%&
12898 condition. It contains the data from the lookup, and the value remains set
12899 until the next &%recipients%& test. Thus, you can do things like this:
12900 .display
12901 &`require recipients  = cdb*@;/some/file`&
12902 &`deny    `&&'some further test involving'& &`$recipient_data`&
12903 .endd
12904 &*Warning*&: This variable is set only when a lookup is used as an indexing
12905 method in the address list, using the semicolon syntax as in the example above.
12906 The variable is not set for a lookup that is used as part of the string
12907 expansion that all such lists undergo before being interpreted.
12908
12909 .vitem &$recipient_verify_failure$&
12910 .vindex "&$recipient_verify_failure$&"
12911 In an ACL, when a recipient verification fails, this variable contains
12912 information about the failure. It is set to one of the following words:
12913
12914 .ilist
12915 &"qualify"&: The address was unqualified (no domain), and the message
12916 was neither local nor came from an exempted host.
12917
12918 .next
12919 &"route"&: Routing failed.
12920
12921 .next
12922 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12923 or before the MAIL command (that is, on initial connection, HELO, or
12924 MAIL).
12925
12926 .next
12927 &"recipient"&: The RCPT command in a callout was rejected.
12928 .next
12929
12930 &"postmaster"&: The postmaster check in a callout was rejected.
12931 .endlist
12932
12933 The main use of this variable is expected to be to distinguish between
12934 rejections of MAIL and rejections of RCPT.
12935
12936 .vitem &$recipients$&
12937 .vindex "&$recipients$&"
12938 This variable contains a list of envelope recipients for a message. A comma and
12939 a space separate the addresses in the replacement text. However, the variable
12940 is not generally available, to prevent exposure of Bcc recipients in
12941 unprivileged users' filter files. You can use &$recipients$& only in these
12942 cases:
12943
12944 .olist
12945 In a system filter file.
12946 .next
12947 In the ACLs associated with the DATA command and with non-SMTP messages, that
12948 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12949 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12950 &%acl_not_smtp_mime%&.
12951 .next
12952 From within a &[local_scan()]& function.
12953 .endlist
12954
12955
12956 .vitem &$recipients_count$&
12957 .vindex "&$recipients_count$&"
12958 When a message is being processed, this variable contains the number of
12959 envelope recipients that came with the message. Duplicates are not excluded
12960 from the count. While a message is being received over SMTP, the number
12961 increases for each accepted recipient. It can be referenced in an ACL.
12962
12963
12964 .vitem &$regex_match_string$&
12965 .vindex "&$regex_match_string$&"
12966 This variable is set to contain the matching regular expression after a
12967 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12968
12969 .vitem "&$regex1$&, &$regex2$&, etc"
12970 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12971 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12972 these variables contain the
12973 captured substrings identified by the regular expression.
12974
12975
12976 .vitem &$reply_address$&
12977 .vindex "&$reply_address$&"
12978 When a message is being processed, this variable contains the contents of the
12979 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12980 contents of the &'From:'& header line. Apart from the removal of leading
12981 white space, the value is not processed in any way. In particular, no RFC 2047
12982 decoding or character code translation takes place.
12983
12984 .vitem &$return_path$&
12985 .vindex "&$return_path$&"
12986 When a message is being delivered, this variable contains the return path &--
12987 the sender field that will be sent as part of the envelope. It is not enclosed
12988 in <> characters. At the start of routing an address, &$return_path$& has the
12989 same value as &$sender_address$&, but if, for example, an incoming message to a
12990 mailing list has been expanded by a router which specifies a different address
12991 for bounce messages, &$return_path$& subsequently contains the new bounce
12992 address, whereas &$sender_address$& always contains the original sender address
12993 that was received with the message. In other words, &$sender_address$& contains
12994 the incoming envelope sender, and &$return_path$& contains the outgoing
12995 envelope sender.
12996
12997 .vitem &$return_size_limit$&
12998 .vindex "&$return_size_limit$&"
12999 This is an obsolete name for &$bounce_return_size_limit$&.
13000
13001 .vitem &$router_name$&
13002 .cindex "router" "name"
13003 .cindex "name" "of router"
13004 .vindex "&$router_name$&"
13005 During the running of a router this variable contains its name.
13006
13007 .vitem &$runrc$&
13008 .cindex "return code" "from &%run%& expansion"
13009 .vindex "&$runrc$&"
13010 This variable contains the return code from a command that is run by the
13011 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13012 assume the order in which option values are expanded, except for those
13013 preconditions whose order of testing is documented. Therefore, you cannot
13014 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13015 another.
13016
13017 .vitem &$self_hostname$&
13018 .oindex "&%self%&" "value of host name"
13019 .vindex "&$self_hostname$&"
13020 When an address is routed to a supposedly remote host that turns out to be the
13021 local host, what happens is controlled by the &%self%& generic router option.
13022 One of its values causes the address to be passed to another router. When this
13023 happens, &$self_hostname$& is set to the name of the local host that the
13024 original router encountered. In other circumstances its contents are null.
13025
13026 .vitem &$sender_address$&
13027 .vindex "&$sender_address$&"
13028 When a message is being processed, this variable contains the sender's address
13029 that was received in the message's envelope. The case of letters in the address
13030 is retained, in both the local part and the domain. For bounce messages, the
13031 value of this variable is the empty string. See also &$return_path$&.
13032
13033 .vitem &$sender_address_data$&
13034 .vindex "&$address_data$&"
13035 .vindex "&$sender_address_data$&"
13036 If &$address_data$& is set when the routers are called from an ACL to verify a
13037 sender address, the final value is preserved in &$sender_address_data$&, to
13038 distinguish it from data from a recipient address. The value does not persist
13039 after the end of the current ACL statement. If you want to preserve it for
13040 longer, you can save it in an ACL variable.
13041
13042 .vitem &$sender_address_domain$&
13043 .vindex "&$sender_address_domain$&"
13044 The domain portion of &$sender_address$&.
13045
13046 .vitem &$sender_address_local_part$&
13047 .vindex "&$sender_address_local_part$&"
13048 The local part portion of &$sender_address$&.
13049
13050 .vitem &$sender_data$&
13051 .vindex "&$sender_data$&"
13052 This variable is set after a lookup success in an ACL &%senders%& condition or
13053 in a router &%senders%& option. It contains the data from the lookup, and the
13054 value remains set until the next &%senders%& test. Thus, you can do things like
13055 this:
13056 .display
13057 &`require senders      = cdb*@;/some/file`&
13058 &`deny    `&&'some further test involving'& &`$sender_data`&
13059 .endd
13060 &*Warning*&: This variable is set only when a lookup is used as an indexing
13061 method in the address list, using the semicolon syntax as in the example above.
13062 The variable is not set for a lookup that is used as part of the string
13063 expansion that all such lists undergo before being interpreted.
13064
13065 .vitem &$sender_fullhost$&
13066 .vindex "&$sender_fullhost$&"
13067 When a message is received from a remote host, this variable contains the host
13068 name and IP address in a single string. It ends with the IP address in square
13069 brackets, followed by a colon and a port number if the logging of ports is
13070 enabled. The format of the rest of the string depends on whether the host
13071 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13072 looking up its IP address. (Looking up the IP address can be forced by the
13073 &%host_lookup%& option, independent of verification.) A plain host name at the
13074 start of the string is a verified host name; if this is not present,
13075 verification either failed or was not requested. A host name in parentheses is
13076 the argument of a HELO or EHLO command. This is omitted if it is identical to
13077 the verified host name or to the host's IP address in square brackets.
13078
13079 .vitem &$sender_helo_dnssec$&
13080 .vindex "&$sender_helo_dnssec$&"
13081 This boolean variable is true if a successful HELO verification was
13082 .cindex "DNS" "DNSSEC"
13083 done using DNS information the resolver library stated was authenticated data.
13084
13085 .vitem &$sender_helo_name$&
13086 .vindex "&$sender_helo_name$&"
13087 When a message is received from a remote host that has issued a HELO or EHLO
13088 command, the argument of that command is placed in this variable. It is also
13089 set if HELO or EHLO is used when a message is received using SMTP locally via
13090 the &%-bs%& or &%-bS%& options.
13091
13092 .vitem &$sender_host_address$&
13093 .vindex "&$sender_host_address$&"
13094 When a message is received from a remote host using SMTP,
13095 this variable contains that
13096 host's IP address. For locally non-SMTP submitted messages, it is empty.
13097
13098 .vitem &$sender_host_authenticated$&
13099 .vindex "&$sender_host_authenticated$&"
13100 This variable contains the name (not the public name) of the authenticator
13101 driver that successfully authenticated the client from which the message was
13102 received. It is empty if there was no successful authentication. See also
13103 &$authenticated_id$&.
13104
13105 .vitem &$sender_host_dnssec$&
13106 .vindex "&$sender_host_dnssec$&"
13107 If an attempt to populate &$sender_host_name$& has been made
13108 (by reference, &%hosts_lookup%& or
13109 otherwise) then this boolean will have been set true if, and only if, the
13110 resolver library states that both
13111 the reverse and forward DNS were authenticated data.  At all
13112 other times, this variable is false.
13113
13114 .cindex "DNS" "DNSSEC"
13115 It is likely that you will need to coerce DNSSEC support on in the resolver
13116 library, by setting:
13117 .code
13118 dns_dnssec_ok = 1
13119 .endd
13120
13121 Exim does not perform DNSSEC validation itself, instead leaving that to a
13122 validating resolver (e.g. unbound, or bind with suitable configuration).
13123
13124 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13125 mechanism in the list, then this variable will be false.
13126
13127 This requires that your system resolver library support EDNS0 (and that
13128 DNSSEC flags exist in the system headers).  If the resolver silently drops
13129 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13130 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13131
13132
13133 .vitem &$sender_host_name$&
13134 .vindex "&$sender_host_name$&"
13135 When a message is received from a remote host, this variable contains the
13136 host's name as obtained by looking up its IP address. For messages received by
13137 other means, this variable is empty.
13138
13139 .vindex "&$host_lookup_failed$&"
13140 If the host name has not previously been looked up, a reference to
13141 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13142 A looked up name is accepted only if it leads back to the original IP address
13143 via a forward lookup. If either the reverse or the forward lookup fails to find
13144 any data, or if the forward lookup does not yield the original IP address,
13145 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13146
13147 .vindex "&$host_lookup_deferred$&"
13148 However, if either of the lookups cannot be completed (for example, there is a
13149 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13150 &$host_lookup_failed$& remains set to &"0"&.
13151
13152 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13153 host name again if there is a subsequent reference to &$sender_host_name$&
13154 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13155 is set to &"1"&.
13156
13157 Exim does not automatically look up every calling host's name. If you want
13158 maximum efficiency, you should arrange your configuration so that it avoids
13159 these lookups altogether. The lookup happens only if one or more of the
13160 following are true:
13161
13162 .ilist
13163 A string containing &$sender_host_name$& is expanded.
13164 .next
13165 The calling host matches the list in &%host_lookup%&. In the default
13166 configuration, this option is set to *, so it must be changed if lookups are
13167 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13168 .next
13169 Exim needs the host name in order to test an item in a host list. The items
13170 that require this are described in sections &<<SECThoslispatnam>>& and
13171 &<<SECThoslispatnamsk>>&.
13172 .next
13173 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13174 In this case, the host name is required to compare with the name quoted in any
13175 EHLO or HELO commands that the client issues.
13176 .next
13177 The remote host issues a EHLO or HELO command that quotes one of the
13178 domains in &%helo_lookup_domains%&. The default value of this option is
13179 . ==== As this is a nested list, any displays it contains must be indented
13180 . ==== as otherwise they are too far to the left.
13181 .code
13182   helo_lookup_domains = @ : @[]
13183 .endd
13184 which causes a lookup if a remote host (incorrectly) gives the server's name or
13185 IP address in an EHLO or HELO command.
13186 .endlist
13187
13188
13189 .vitem &$sender_host_port$&
13190 .vindex "&$sender_host_port$&"
13191 When a message is received from a remote host, this variable contains the port
13192 number that was used on the remote host.
13193
13194 .vitem &$sender_ident$&
13195 .vindex "&$sender_ident$&"
13196 When a message is received from a remote host, this variable contains the
13197 identification received in response to an RFC 1413 request. When a message has
13198 been received locally, this variable contains the login name of the user that
13199 called Exim.
13200
13201 .vitem &$sender_rate_$&&'xxx'&
13202 A number of variables whose names begin &$sender_rate_$& are set as part of the
13203 &%ratelimit%& ACL condition. Details are given in section
13204 &<<SECTratelimiting>>&.
13205
13206 .vitem &$sender_rcvhost$&
13207 .cindex "DNS" "reverse lookup"
13208 .cindex "reverse DNS lookup"
13209 .vindex "&$sender_rcvhost$&"
13210 This is provided specifically for use in &'Received:'& headers. It starts with
13211 either the verified host name (as obtained from a reverse DNS lookup) or, if
13212 there is no verified host name, the IP address in square brackets. After that
13213 there may be text in parentheses. When the first item is a verified host name,
13214 the first thing in the parentheses is the IP address in square brackets,
13215 followed by a colon and a port number if port logging is enabled. When the
13216 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13217 the parentheses.
13218
13219 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13220 was used and its argument was not identical to the real host name or IP
13221 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13222 all three items are present in the parentheses, a newline and tab are inserted
13223 into the string, to improve the formatting of the &'Received:'& header.
13224
13225 .vitem &$sender_verify_failure$&
13226 .vindex "&$sender_verify_failure$&"
13227 In an ACL, when a sender verification fails, this variable contains information
13228 about the failure. The details are the same as for
13229 &$recipient_verify_failure$&.
13230
13231 .vitem &$sending_ip_address$&
13232 .vindex "&$sending_ip_address$&"
13233 This variable is set whenever an outgoing SMTP connection to another host has
13234 been set up. It contains the IP address of the local interface that is being
13235 used. This is useful if a host that has more than one IP address wants to take
13236 on different personalities depending on which one is being used. For incoming
13237 connections, see &$received_ip_address$&.
13238
13239 .vitem &$sending_port$&
13240 .vindex "&$sending_port$&"
13241 This variable is set whenever an outgoing SMTP connection to another host has
13242 been set up. It contains the local port that is being used. For incoming
13243 connections, see &$received_port$&.
13244
13245 .vitem &$smtp_active_hostname$&
13246 .vindex "&$smtp_active_hostname$&"
13247 During an incoming SMTP session, this variable contains the value of the active
13248 host name, as specified by the &%smtp_active_hostname%& option. The value of
13249 &$smtp_active_hostname$& is saved with any message that is received, so its
13250 value can be consulted during routing and delivery.
13251
13252 .vitem &$smtp_command$&
13253 .vindex "&$smtp_command$&"
13254 During the processing of an incoming SMTP command, this variable contains the
13255 entire command. This makes it possible to distinguish between HELO and EHLO in
13256 the HELO ACL, and also to distinguish between commands such as these:
13257 .code
13258 MAIL FROM:<>
13259 MAIL FROM: <>
13260 .endd
13261 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13262 command, the address in &$smtp_command$& is the original address before any
13263 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13264 the address after SMTP-time rewriting.
13265
13266 .vitem &$smtp_command_argument$&
13267 .cindex "SMTP" "command, argument for"
13268 .vindex "&$smtp_command_argument$&"
13269 While an ACL is running to check an SMTP command, this variable contains the
13270 argument, that is, the text that follows the command name, with leading white
13271 space removed. Following the introduction of &$smtp_command$&, this variable is
13272 somewhat redundant, but is retained for backwards compatibility.
13273
13274 .vitem &$smtp_command_history$&
13275 .cindex SMTP "command history"
13276 .vindex "&$smtp_command_history$&"
13277 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13278 received, in time-order left to right.  Only a limited number of commands
13279 are remembered.
13280
13281 .vitem &$smtp_count_at_connection_start$&
13282 .vindex "&$smtp_count_at_connection_start$&"
13283 This variable is set greater than zero only in processes spawned by the Exim
13284 daemon for handling incoming SMTP connections. The name is deliberately long,
13285 in order to emphasize what the contents are. When the daemon accepts a new
13286 connection, it increments this variable. A copy of the variable is passed to
13287 the child process that handles the connection, but its value is fixed, and
13288 never changes. It is only an approximation of how many incoming connections
13289 there actually are, because many other connections may come and go while a
13290 single connection is being processed. When a child process terminates, the
13291 daemon decrements its copy of the variable.
13292
13293 .vitem "&$sn0$& &-- &$sn9$&"
13294 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13295 that were current at the end of the system filter file. This allows a system
13296 filter file to set values that can be tested in users' filter files. For
13297 example, a system filter could set a value indicating how likely it is that a
13298 message is junk mail.
13299
13300 .vitem &$spam_$&&'xxx'&
13301 A number of variables whose names start with &$spam$& are available when Exim
13302 is compiled with the content-scanning extension. For details, see section
13303 &<<SECTscanspamass>>&.
13304
13305 .vitem &$spf_header_comment$& &&&
13306        &$spf_received$& &&&
13307        &$spf_result$& &&&
13308        &$spf_result_guessed$& &&&
13309        &$spf_smtp_comment$&
13310 These variables are only available if Exim is built with SPF support.
13311 For details see section &<<SECSPF>>&.
13312
13313 .vitem &$spool_directory$&
13314 .vindex "&$spool_directory$&"
13315 The name of Exim's spool directory.
13316
13317 .vitem &$spool_inodes$&
13318 .vindex "&$spool_inodes$&"
13319 The number of free inodes in the disk partition where Exim's spool files are
13320 being written. The value is recalculated whenever the variable is referenced.
13321 If the relevant file system does not have the concept of inodes, the value of
13322 is -1. See also the &%check_spool_inodes%& option.
13323
13324 .vitem &$spool_space$&
13325 .vindex "&$spool_space$&"
13326 The amount of free space (as a number of kilobytes) in the disk partition where
13327 Exim's spool files are being written. The value is recalculated whenever the
13328 variable is referenced. If the operating system does not have the ability to
13329 find the amount of free space (only true for experimental systems), the space
13330 value is -1. For example, to check in an ACL that there is at least 50
13331 megabytes free on the spool, you could write:
13332 .code
13333 condition = ${if > {$spool_space}{50000}}
13334 .endd
13335 See also the &%check_spool_space%& option.
13336
13337
13338 .vitem &$thisaddress$&
13339 .vindex "&$thisaddress$&"
13340 This variable is set only during the processing of the &%foranyaddress%&
13341 command in a filter file. Its use is explained in the description of that
13342 command, which can be found in the separate document entitled &'Exim's
13343 interfaces to mail filtering'&.
13344
13345 .vitem &$tls_in_bits$&
13346 .vindex "&$tls_in_bits$&"
13347 Contains an approximation of the TLS cipher's bit-strength
13348 on the inbound connection; the meaning of
13349 this depends upon the TLS implementation used.
13350 If TLS has not been negotiated, the value will be 0.
13351 The value of this is automatically fed into the Cyrus SASL authenticator
13352 when acting as a server, to specify the "external SSF" (a SASL term).
13353
13354 The deprecated &$tls_bits$& variable refers to the inbound side
13355 except when used in the context of an outbound SMTP delivery, when it refers to
13356 the outbound.
13357
13358 .vitem &$tls_out_bits$&
13359 .vindex "&$tls_out_bits$&"
13360 Contains an approximation of the TLS cipher's bit-strength
13361 on an outbound SMTP connection; the meaning of
13362 this depends upon the TLS implementation used.
13363 If TLS has not been negotiated, the value will be 0.
13364
13365 .vitem &$tls_in_ourcert$&
13366 .vindex "&$tls_in_ourcert$&"
13367 .cindex certificate variables
13368 This variable refers to the certificate presented to the peer of an
13369 inbound connection when the message was received.
13370 It is only useful as the argument of a
13371 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13372 or a &%def%& condition.
13373
13374 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13375 when a list of more than one
13376 file is used for &%tls_certificate%&, this variable is not reliable.
13377 .new
13378 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13379 .wen
13380
13381 .vitem &$tls_in_peercert$&
13382 .vindex "&$tls_in_peercert$&"
13383 This variable refers to the certificate presented by the peer of an
13384 inbound connection when the message was received.
13385 It is only useful as the argument of a
13386 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13387 or a &%def%& condition.
13388 If certificate verification fails it may refer to a failing chain element
13389 which is not the leaf.
13390
13391 .vitem &$tls_out_ourcert$&
13392 .vindex "&$tls_out_ourcert$&"
13393 This variable refers to the certificate presented to the peer of an
13394 outbound connection.  It is only useful as the argument of a
13395 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13396 or a &%def%& condition.
13397
13398 .vitem &$tls_out_peercert$&
13399 .vindex "&$tls_out_peercert$&"
13400 This variable refers to the certificate presented by the peer of an
13401 outbound connection.  It is only useful as the argument of a
13402 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13403 or a &%def%& condition.
13404 If certificate verification fails it may refer to a failing chain element
13405 which is not the leaf.
13406
13407 .vitem &$tls_in_certificate_verified$&
13408 .vindex "&$tls_in_certificate_verified$&"
13409 This variable is set to &"1"& if a TLS certificate was verified when the
13410 message was received, and &"0"& otherwise.
13411
13412 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13413 except when used in the context of an outbound SMTP delivery, when it refers to
13414 the outbound.
13415
13416 .vitem &$tls_out_certificate_verified$&
13417 .vindex "&$tls_out_certificate_verified$&"
13418 This variable is set to &"1"& if a TLS certificate was verified when an
13419 outbound SMTP connection was made,
13420 and &"0"& otherwise.
13421
13422 .vitem &$tls_in_cipher$&
13423 .vindex "&$tls_in_cipher$&"
13424 .vindex "&$tls_cipher$&"
13425 When a message is received from a remote host over an encrypted SMTP
13426 connection, this variable is set to the cipher suite that was negotiated, for
13427 example DES-CBC3-SHA. In other circumstances, in particular, for message
13428 received over unencrypted connections, the variable is empty. Testing
13429 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13430 non-encrypted connections during ACL processing.
13431
13432 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13433 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13434 becomes the same as &$tls_out_cipher$&.
13435
13436 .new
13437 .vitem &$tls_in_cipher_std$&
13438 .vindex "&$tls_in_cipher_std$&"
13439 As above, but returning the RFC standard name for the cipher suite.
13440 .wen
13441
13442 .vitem &$tls_out_cipher$&
13443 .vindex "&$tls_out_cipher$&"
13444 This variable is
13445 cleared before any outgoing SMTP connection is made,
13446 and then set to the outgoing cipher suite if one is negotiated. See chapter
13447 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13448 details of the &(smtp)& transport.
13449
13450 .new
13451 .vitem &$tls_out_cipher_std$&
13452 .vindex "&$tls_out_cipher_std$&"
13453 As above, but returning the RFC standard name for the cipher suite.
13454 .wen
13455
13456 .vitem &$tls_out_dane$&
13457 .vindex &$tls_out_dane$&
13458 DANE active status.  See section &<<SECDANE>>&.
13459
13460 .vitem &$tls_in_ocsp$&
13461 .vindex "&$tls_in_ocsp$&"
13462 When a message is received from a remote client connection
13463 the result of any OCSP request from the client is encoded in this variable:
13464 .code
13465 0 OCSP proof was not requested (default value)
13466 1 No response to request
13467 2 Response not verified
13468 3 Verification failed
13469 4 Verification succeeded
13470 .endd
13471
13472 .vitem &$tls_out_ocsp$&
13473 .vindex "&$tls_out_ocsp$&"
13474 When a message is sent to a remote host connection
13475 the result of any OCSP request made is encoded in this variable.
13476 See &$tls_in_ocsp$& for values.
13477
13478 .vitem &$tls_in_peerdn$&
13479 .vindex "&$tls_in_peerdn$&"
13480 .vindex "&$tls_peerdn$&"
13481 .cindex certificate "extracting fields"
13482 When a message is received from a remote host over an encrypted SMTP
13483 connection, and Exim is configured to request a certificate from the client,
13484 the value of the Distinguished Name of the certificate is made available in the
13485 &$tls_in_peerdn$& during subsequent processing.
13486 If certificate verification fails it may refer to a failing chain element
13487 which is not the leaf.
13488
13489 The deprecated &$tls_peerdn$& variable refers to the inbound side
13490 except when used in the context of an outbound SMTP delivery, when it refers to
13491 the outbound.
13492
13493 .vitem &$tls_out_peerdn$&
13494 .vindex "&$tls_out_peerdn$&"
13495 When a message is being delivered to a remote host over an encrypted SMTP
13496 connection, and Exim is configured to request a certificate from the server,
13497 the value of the Distinguished Name of the certificate is made available in the
13498 &$tls_out_peerdn$& during subsequent processing.
13499 If certificate verification fails it may refer to a failing chain element
13500 which is not the leaf.
13501
13502 .vitem &$tls_in_sni$&
13503 .vindex "&$tls_in_sni$&"
13504 .vindex "&$tls_sni$&"
13505 .cindex "TLS" "Server Name Indication"
13506 When a TLS session is being established, if the client sends the Server
13507 Name Indication extension, the value will be placed in this variable.
13508 If the variable appears in &%tls_certificate%& then this option and
13509 some others, described in &<<SECTtlssni>>&,
13510 will be re-expanded early in the TLS session, to permit
13511 a different certificate to be presented (and optionally a different key to be
13512 used) to the client, based upon the value of the SNI extension.
13513
13514 The deprecated &$tls_sni$& variable refers to the inbound side
13515 except when used in the context of an outbound SMTP delivery, when it refers to
13516 the outbound.
13517
13518 .vitem &$tls_out_sni$&
13519 .vindex "&$tls_out_sni$&"
13520 .cindex "TLS" "Server Name Indication"
13521 During outbound
13522 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13523 the transport.
13524
13525 .vitem &$tls_out_tlsa_usage$&
13526 .vindex &$tls_out_tlsa_usage$&
13527 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13528
13529 .new
13530 .vitem &$tls_in_ver$&
13531 .vindex "&$tls_in_ver$&"
13532 When a message is received from a remote host over an encrypted SMTP connection
13533 this variable is set to the protocol version, eg &'TLS1.2'&.
13534
13535 .vitem &$tls_out_ver$&
13536 .vindex "&$tls_out_ver$&"
13537 When a message is being delivered to a remote host over an encrypted SMTP connection
13538 this variable is set to the protocol version.
13539 .wen
13540
13541
13542 .vitem &$tod_bsdinbox$&
13543 .vindex "&$tod_bsdinbox$&"
13544 The time of day and the date, in the format required for BSD-style mailbox
13545 files, for example: Thu Oct 17 17:14:09 1995.
13546
13547 .vitem &$tod_epoch$&
13548 .vindex "&$tod_epoch$&"
13549 The time and date as a number of seconds since the start of the Unix epoch.
13550
13551 .vitem &$tod_epoch_l$&
13552 .vindex "&$tod_epoch_l$&"
13553 The time and date as a number of microseconds since the start of the Unix epoch.
13554
13555 .vitem &$tod_full$&
13556 .vindex "&$tod_full$&"
13557 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13558 +0100. The timezone is always given as a numerical offset from UTC, with
13559 positive values used for timezones that are ahead (east) of UTC, and negative
13560 values for those that are behind (west).
13561
13562 .vitem &$tod_log$&
13563 .vindex "&$tod_log$&"
13564 The time and date in the format used for writing Exim's log files, for example:
13565 1995-10-12 15:32:29, but without a timezone.
13566
13567 .vitem &$tod_logfile$&
13568 .vindex "&$tod_logfile$&"
13569 This variable contains the date in the format yyyymmdd. This is the format that
13570 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13571 flag.
13572
13573 .vitem &$tod_zone$&
13574 .vindex "&$tod_zone$&"
13575 This variable contains the numerical value of the local timezone, for example:
13576 -0500.
13577
13578 .vitem &$tod_zulu$&
13579 .vindex "&$tod_zulu$&"
13580 This variable contains the UTC date and time in &"Zulu"& format, as specified
13581 by ISO 8601, for example: 20030221154023Z.
13582
13583 .vitem &$transport_name$&
13584 .cindex "transport" "name"
13585 .cindex "name" "of transport"
13586 .vindex "&$transport_name$&"
13587 During the running of a transport, this variable contains its name.
13588
13589 .vitem &$value$&
13590 .vindex "&$value$&"
13591 This variable contains the result of an expansion lookup, extraction operation,
13592 or external command, as described above. It is also used during a
13593 &*reduce*& expansion.
13594
13595 .vitem &$verify_mode$&
13596 .vindex "&$verify_mode$&"
13597 While a router or transport is being run in verify mode or for cutthrough delivery,
13598 contains "S" for sender-verification or "R" for recipient-verification.
13599 Otherwise, empty.
13600
13601 .vitem &$version_number$&
13602 .vindex "&$version_number$&"
13603 The version number of Exim. Same as &$exim_version$&, may be overridden
13604 by the &%exim_version%& main config option.
13605
13606 .vitem &$warn_message_delay$&
13607 .vindex "&$warn_message_delay$&"
13608 This variable is set only during the creation of a message warning about a
13609 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13610
13611 .vitem &$warn_message_recipients$&
13612 .vindex "&$warn_message_recipients$&"
13613 This variable is set only during the creation of a message warning about a
13614 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13615 .endlist
13616 .ecindex IIDstrexp
13617
13618
13619
13620 . ////////////////////////////////////////////////////////////////////////////
13621 . ////////////////////////////////////////////////////////////////////////////
13622
13623 .chapter "Embedded Perl" "CHAPperl"
13624 .scindex IIDperl "Perl" "calling from Exim"
13625 Exim can be built to include an embedded Perl interpreter. When this is done,
13626 Perl subroutines can be called as part of the string expansion process. To make
13627 use of the Perl support, you need version 5.004 or later of Perl installed on
13628 your system. To include the embedded interpreter in the Exim binary, include
13629 the line
13630 .code
13631 EXIM_PERL = perl.o
13632 .endd
13633 in your &_Local/Makefile_& and then build Exim in the normal way.
13634
13635
13636 .section "Setting up so Perl can be used" "SECID85"
13637 .oindex "&%perl_startup%&"
13638 Access to Perl subroutines is via a global configuration option called
13639 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13640 no &%perl_startup%& option in the Exim configuration file then no Perl
13641 interpreter is started and there is almost no overhead for Exim (since none of
13642 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13643 option then the associated value is taken to be Perl code which is executed in
13644 a newly created Perl interpreter.
13645
13646 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13647 need backslashes before any characters to escape special meanings. The option
13648 should usually be something like
13649 .code
13650 perl_startup = do '/etc/exim.pl'
13651 .endd
13652 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13653 use from Exim. Exim can be configured either to start up a Perl interpreter as
13654 soon as it is entered, or to wait until the first time it is needed. Starting
13655 the interpreter at the beginning ensures that it is done while Exim still has
13656 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13657 fact used in a particular run. Also, note that this does not mean that Exim is
13658 necessarily running as root when Perl is called at a later time. By default,
13659 the interpreter is started only when it is needed, but this can be changed in
13660 two ways:
13661
13662 .ilist
13663 .oindex "&%perl_at_start%&"
13664 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13665 a startup when Exim is entered.
13666 .next
13667 The command line option &%-ps%& also requests a startup when Exim is entered,
13668 overriding the setting of &%perl_at_start%&.
13669 .endlist
13670
13671 There is also a command line option &%-pd%& (for delay) which suppresses the
13672 initial startup, even if &%perl_at_start%& is set.
13673
13674 .ilist
13675 .oindex "&%perl_taintmode%&"
13676 .cindex "Perl" "taintmode"
13677 To provide more security executing Perl code via the embedded Perl
13678 interpreter, the &%perl_taintmode%& option can be set. This enables the
13679 taint mode of the Perl interpreter. You are encouraged to set this
13680 option to a true value. To avoid breaking existing installations, it
13681 defaults to false.
13682
13683
13684 .section "Calling Perl subroutines" "SECID86"
13685 When the configuration file includes a &%perl_startup%& option you can make use
13686 of the string expansion item to call the Perl subroutines that are defined
13687 by the &%perl_startup%& code. The operator is used in any of the following
13688 forms:
13689 .code
13690 ${perl{foo}}
13691 ${perl{foo}{argument}}
13692 ${perl{foo}{argument1}{argument2} ... }
13693 .endd
13694 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13695 arguments may be passed. Passing more than this results in an expansion failure
13696 with an error message of the form
13697 .code
13698 Too many arguments passed to Perl subroutine "foo" (max is 8)
13699 .endd
13700 The return value of the Perl subroutine is evaluated in a scalar context before
13701 it is passed back to Exim to be inserted into the expanded string. If the
13702 return value is &'undef'&, the expansion is forced to fail in the same way as
13703 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13704 by obeying Perl's &%die%& function, the expansion fails with the error message
13705 that was passed to &%die%&.
13706
13707
13708 .section "Calling Exim functions from Perl" "SECID87"
13709 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13710 is available to call back into Exim's string expansion function. For example,
13711 the Perl code
13712 .code
13713 my $lp = Exim::expand_string('$local_part');
13714 .endd
13715 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13716 Note those are single quotes and not double quotes to protect against
13717 &$local_part$& being interpolated as a Perl variable.
13718
13719 If the string expansion is forced to fail by a &"fail"& item, the result of
13720 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13721 expansion string, the Perl call from the original expansion string fails with
13722 an appropriate error message, in the same way as if &%die%& were used.
13723
13724 .cindex "debugging" "from embedded Perl"
13725 .cindex "log" "writing from embedded Perl"
13726 Two other Exim functions are available for use from within Perl code.
13727 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13728 debugging is enabled. If you want a newline at the end, you must supply it.
13729 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13730 timestamp. In this case, you should not supply a terminating newline.
13731
13732
13733 .section "Use of standard output and error by Perl" "SECID88"
13734 .cindex "Perl" "standard output and error"
13735 You should not write to the standard error or output streams from within your
13736 Perl code, as it is not defined how these are set up. In versions of Exim
13737 before 4.50, it is possible for the standard output or error to refer to the
13738 SMTP connection during message reception via the daemon. Writing to this stream
13739 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13740 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13741 avoided, but the output is lost.
13742
13743 .cindex "Perl" "use of &%warn%&"
13744 The Perl &%warn%& statement writes to the standard error stream by default.
13745 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13746 you have no control. When Exim starts up the Perl interpreter, it arranges for
13747 output from the &%warn%& statement to be written to the Exim main log. You can
13748 change this by including appropriate Perl magic somewhere in your Perl code.
13749 For example, to discard &%warn%& output completely, you need this:
13750 .code
13751 $SIG{__WARN__} = sub { };
13752 .endd
13753 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13754 example, the code for the subroutine is empty, so it does nothing, but you can
13755 include any Perl code that you like. The text of the &%warn%& message is passed
13756 as the first subroutine argument.
13757 .ecindex IIDperl
13758
13759
13760 . ////////////////////////////////////////////////////////////////////////////
13761 . ////////////////////////////////////////////////////////////////////////////
13762
13763 .chapter "Starting the daemon and the use of network interfaces" &&&
13764          "CHAPinterfaces" &&&
13765          "Starting the daemon"
13766 .cindex "daemon" "starting"
13767 .cindex "interface" "listening"
13768 .cindex "network interface"
13769 .cindex "interface" "network"
13770 .cindex "IP address" "for listening"
13771 .cindex "daemon" "listening IP addresses"
13772 .cindex "TCP/IP" "setting listening interfaces"
13773 .cindex "TCP/IP" "setting listening ports"
13774 A host that is connected to a TCP/IP network may have one or more physical
13775 hardware network interfaces. Each of these interfaces may be configured as one
13776 or more &"logical"& interfaces, which are the entities that a program actually
13777 works with. Each of these logical interfaces is associated with an IP address.
13778 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13779 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13780 knowledge about the host's interfaces for use in three different circumstances:
13781
13782 .olist
13783 When a listening daemon is started, Exim needs to know which interfaces
13784 and ports to listen on.
13785 .next
13786 When Exim is routing an address, it needs to know which IP addresses
13787 are associated with local interfaces. This is required for the correct
13788 processing of MX lists by removing the local host and others with the
13789 same or higher priority values. Also, Exim needs to detect cases
13790 when an address is routed to an IP address that in fact belongs to the
13791 local host. Unless the &%self%& router option or the &%allow_localhost%&
13792 option of the smtp transport is set (as appropriate), this is treated
13793 as an error situation.
13794 .next
13795 When Exim connects to a remote host, it may need to know which interface to use
13796 for the outgoing connection.
13797 .endlist
13798
13799
13800 Exim's default behaviour is likely to be appropriate in the vast majority
13801 of cases. If your host has only one interface, and you want all its IP
13802 addresses to be treated in the same way, and you are using only the
13803 standard SMTP port, you should not need to take any special action. The
13804 rest of this chapter does not apply to you.
13805
13806 In a more complicated situation you may want to listen only on certain
13807 interfaces, or on different ports, and for this reason there are a number of
13808 options that can be used to influence Exim's behaviour. The rest of this
13809 chapter describes how they operate.
13810
13811 When a message is received over TCP/IP, the interface and port that were
13812 actually used are set in &$received_ip_address$& and &$received_port$&.
13813
13814
13815
13816 .section "Starting a listening daemon" "SECID89"
13817 When a listening daemon is started (by means of the &%-bd%& command line
13818 option), the interfaces and ports on which it listens are controlled by the
13819 following options:
13820
13821 .ilist
13822 &%daemon_smtp_ports%& contains a list of default ports
13823 or service names.
13824 (For backward compatibility, this option can also be specified in the singular.)
13825 .next
13826 &%local_interfaces%& contains list of interface IP addresses on which to
13827 listen. Each item may optionally also specify a port.
13828 .endlist
13829
13830 The default list separator in both cases is a colon, but this can be changed as
13831 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13832 it is usually best to change the separator to avoid having to double all the
13833 colons. For example:
13834 .code
13835 local_interfaces = <; 127.0.0.1 ; \
13836                       192.168.23.65 ; \
13837                       ::1 ; \
13838                       3ffe:ffff:836f::fe86:a061
13839 .endd
13840 There are two different formats for specifying a port along with an IP address
13841 in &%local_interfaces%&:
13842
13843 .olist
13844 The port is added onto the address with a dot separator. For example, to listen
13845 on port 1234 on two different IP addresses:
13846 .code
13847 local_interfaces = <; 192.168.23.65.1234 ; \
13848                       3ffe:ffff:836f::fe86:a061.1234
13849 .endd
13850 .next
13851 The IP address is enclosed in square brackets, and the port is added
13852 with a colon separator, for example:
13853 .code
13854 local_interfaces = <; [192.168.23.65]:1234 ; \
13855                       [3ffe:ffff:836f::fe86:a061]:1234
13856 .endd
13857 .endlist
13858
13859 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13860 default setting contains just one port:
13861 .code
13862 daemon_smtp_ports = smtp
13863 .endd
13864 If more than one port is listed, each interface that does not have its own port
13865 specified listens on all of them. Ports that are listed in
13866 &%daemon_smtp_ports%& can be identified either by name (defined in
13867 &_/etc/services_&) or by number. However, when ports are given with individual
13868 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13869
13870
13871
13872 .section "Special IP listening addresses" "SECID90"
13873 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13874 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13875 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13876 instead of setting up separate listening sockets for each interface. The
13877 default value of &%local_interfaces%& is
13878 .code
13879 local_interfaces = 0.0.0.0
13880 .endd
13881 when Exim is built without IPv6 support; otherwise it is:
13882 .code
13883 local_interfaces = <; ::0 ; 0.0.0.0
13884 .endd
13885 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13886
13887
13888
13889 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13890 The &%-oX%& command line option can be used to override the values of
13891 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13892 instance. Another way of doing this would be to use macros and the &%-D%&
13893 option. However, &%-oX%& can be used by any admin user, whereas modification of
13894 the runtime configuration by &%-D%& is allowed only when the caller is root or
13895 exim.
13896
13897 The value of &%-oX%& is a list of items. The default colon separator can be
13898 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13899 If there are any items that do not
13900 contain dots or colons (that is, are not IP addresses), the value of
13901 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13902 items that do contain dots or colons, the value of &%local_interfaces%& is
13903 replaced by those items. Thus, for example,
13904 .code
13905 -oX 1225
13906 .endd
13907 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13908 whereas
13909 .code
13910 -oX 192.168.34.5.1125
13911 .endd
13912 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13913 (However, since &%local_interfaces%& now contains no items without ports, the
13914 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13915
13916
13917
13918 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13919 .cindex "submissions protocol"
13920 .cindex "ssmtp protocol"
13921 .cindex "smtps protocol"
13922 .cindex "SMTP" "ssmtp protocol"
13923 .cindex "SMTP" "smtps protocol"
13924 Exim supports the use of TLS-on-connect, used by mail clients in the
13925 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13926 For some years, IETF Standards Track documents only blessed the
13927 STARTTLS-based Submission service (port 587) while common practice was to support
13928 the same feature set on port 465, but using TLS-on-connect.
13929 If your installation needs to provide service to mail clients
13930 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13931 the 465 TCP ports.
13932
13933 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13934 service names, connections to those ports must first establish TLS, before
13935 proceeding to the application layer use of the SMTP protocol.
13936
13937 The common use of this option is expected to be
13938 .code
13939 tls_on_connect_ports = 465
13940 .endd
13941 per RFC 8314.
13942 There is also a command line option &%-tls-on-connect%&, which forces all ports
13943 to behave in this way when a daemon is started.
13944
13945 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13946 daemon to listen on those ports. You must still specify them in
13947 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13948 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13949 connections via the daemon.)
13950
13951
13952
13953
13954 .section "IPv6 address scopes" "SECID92"
13955 .cindex "IPv6" "address scopes"
13956 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13957 can, in principle, have the same link-local IPv6 address on different
13958 interfaces. Thus, additional information is needed, over and above the IP
13959 address, to distinguish individual interfaces. A convention of using a
13960 percent sign followed by something (often the interface name) has been
13961 adopted in some cases, leading to addresses like this:
13962 .code
13963 fe80::202:b3ff:fe03:45c1%eth0
13964 .endd
13965 To accommodate this usage, a percent sign followed by an arbitrary string is
13966 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13967 to convert a textual IPv6 address for actual use. This function recognizes the
13968 percent convention in operating systems that support it, and it processes the
13969 address appropriately. Unfortunately, some older libraries have problems with
13970 &[getaddrinfo()]&. If
13971 .code
13972 IPV6_USE_INET_PTON=yes
13973 .endd
13974 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13975 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13976 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13977 function.) Of course, this means that the additional functionality of
13978 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13979
13980 .section "Disabling IPv6" "SECID93"
13981 .cindex "IPv6" "disabling"
13982 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13983 run on a host whose kernel does not support IPv6. The binary will fall back to
13984 using IPv4, but it may waste resources looking up AAAA records, and trying to
13985 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13986 .oindex "&%disable_ipv6%&"
13987 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13988 activities take place. AAAA records are never looked up, and any IPv6 addresses
13989 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13990 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13991 to handle IPv6 literal addresses.
13992
13993 On the other hand, when IPv6 is in use, there may be times when you want to
13994 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13995 option to globally suppress the lookup of AAAA records for specified domains,
13996 and you can use the &%ignore_target_hosts%& generic router option to ignore
13997 IPv6 addresses in an individual router.
13998
13999
14000
14001 .section "Examples of starting a listening daemon" "SECID94"
14002 The default case in an IPv6 environment is
14003 .code
14004 daemon_smtp_ports = smtp
14005 local_interfaces = <; ::0 ; 0.0.0.0
14006 .endd
14007 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14008 Either one or two sockets may be used, depending on the characteristics of
14009 the TCP/IP stack. (This is complicated and messy; for more information,
14010 read the comments in the &_daemon.c_& source file.)
14011
14012 To specify listening on ports 25 and 26 on all interfaces:
14013 .code
14014 daemon_smtp_ports = 25 : 26
14015 .endd
14016 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14017 .code
14018 local_interfaces = <; ::0.25     ; ::0.26 \
14019                       0.0.0.0.25 ; 0.0.0.0.26
14020 .endd
14021 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14022 IPv4 loopback address only:
14023 .code
14024 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14025 .endd
14026 To specify listening on the default port on specific interfaces only:
14027 .code
14028 local_interfaces = 10.0.0.67 : 192.168.34.67
14029 .endd
14030 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14031
14032
14033
14034 .section "Recognizing the local host" "SECTreclocipadd"
14035 The &%local_interfaces%& option is also used when Exim needs to determine
14036 whether or not an IP address refers to the local host. That is, the IP
14037 addresses of all the interfaces on which a daemon is listening are always
14038 treated as local.
14039
14040 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14041 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14042 available interfaces from the operating system, and extracts the relevant
14043 (that is, IPv4 or IPv6) addresses to use for checking.
14044
14045 Some systems set up large numbers of virtual interfaces in order to provide
14046 many virtual web servers. In this situation, you may want to listen for
14047 email on only a few of the available interfaces, but nevertheless treat all
14048 interfaces as local when routing. You can do this by setting
14049 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14050 &"all"& wildcard values. These addresses are recognized as local, but are not
14051 used for listening. Consider this example:
14052 .code
14053 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14054                       192.168.53.235 ; \
14055                       3ffe:2101:12:1:a00:20ff:fe86:a061
14056
14057 extra_local_interfaces = <; ::0 ; 0.0.0.0
14058 .endd
14059 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14060 address, but all available interface addresses are treated as local when
14061 Exim is routing.
14062
14063 In some environments the local host name may be in an MX list, but with an IP
14064 address that is not assigned to any local interface. In other cases it may be
14065 desirable to treat other host names as if they referred to the local host. Both
14066 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14067 This contains host names rather than IP addresses. When a host is referenced
14068 during routing, either via an MX record or directly, it is treated as the local
14069 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14070 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14071
14072
14073
14074 .section "Delivering to a remote host" "SECID95"
14075 Delivery to a remote host is handled by the smtp transport. By default, it
14076 allows the system's TCP/IP functions to choose which interface to use (if
14077 there is more than one) when connecting to a remote host. However, the
14078 &%interface%& option can be set to specify which interface is used. See the
14079 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14080 details.
14081
14082
14083
14084
14085 . ////////////////////////////////////////////////////////////////////////////
14086 . ////////////////////////////////////////////////////////////////////////////
14087
14088 .chapter "Main configuration" "CHAPmainconfig"
14089 .scindex IIDconfima "configuration file" "main section"
14090 .scindex IIDmaiconf "main configuration"
14091 The first part of the runtime configuration file contains three types of item:
14092
14093 .ilist
14094 Macro definitions: These lines start with an upper case letter. See section
14095 &<<SECTmacrodefs>>& for details of macro processing.
14096 .next
14097 Named list definitions: These lines start with one of the words &"domainlist"&,
14098 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14099 section &<<SECTnamedlists>>&.
14100 .next
14101 Main configuration settings: Each setting occupies one line of the file
14102 (with possible continuations). If any setting is preceded by the word
14103 &"hide"&, the &%-bP%& command line option displays its value to admin users
14104 only. See section &<<SECTcos>>& for a description of the syntax of these option
14105 settings.
14106 .endlist
14107
14108 This chapter specifies all the main configuration options, along with their
14109 types and default values. For ease of finding a particular option, they appear
14110 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14111 are now so many options, they are first listed briefly in functional groups, as
14112 an aid to finding the name of the option you are looking for. Some options are
14113 listed in more than one group.
14114
14115 .section "Miscellaneous" "SECID96"
14116 .table2
14117 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14118 .row &%debug_store%&                 "do extra internal checks"
14119 .row &%disable_ipv6%&                "do no IPv6 processing"
14120 .row &%keep_malformed%&              "for broken files &-- should not happen"
14121 .row &%localhost_number%&            "for unique message ids in clusters"
14122 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14123 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14124 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14125 .row &%print_topbitchars%&           "top-bit characters are printing"
14126 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14127 .row &%timezone%&                    "force time zone"
14128 .endtable
14129
14130
14131 .section "Exim parameters" "SECID97"
14132 .table2
14133 .row &%exim_group%&                  "override compiled-in value"
14134 .row &%exim_path%&                   "override compiled-in value"
14135 .row &%exim_user%&                   "override compiled-in value"
14136 .row &%primary_hostname%&            "default from &[uname()]&"
14137 .row &%split_spool_directory%&       "use multiple directories"
14138 .row &%spool_directory%&             "override compiled-in value"
14139 .endtable
14140
14141
14142
14143 .section "Privilege controls" "SECID98"
14144 .table2
14145 .row &%admin_groups%&                "groups that are Exim admin users"
14146 .row &%commandline_checks_require_admin%& "require admin for various checks"
14147 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14148 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14149 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14150 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14151 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14152 .row &%never_users%&                 "do not run deliveries as these"
14153 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14154 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14155 .row &%trusted_groups%&              "groups that are trusted"
14156 .row &%trusted_users%&               "users that are trusted"
14157 .endtable
14158
14159
14160
14161 .section "Logging" "SECID99"
14162 .table2
14163 .row &%event_action%&                "custom logging"
14164 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14165 .row &%log_file_path%&               "override compiled-in value"
14166 .row &%log_selector%&                "set/unset optional logging"
14167 .row &%log_timezone%&                "add timezone to log lines"
14168 .row &%message_logs%&                "create per-message logs"
14169 .row &%preserve_message_logs%&       "after message completion"
14170 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14171 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14172 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14173 .row &%syslog_facility%&             "set syslog &""facility""& field"
14174 .row &%syslog_pid%&                  "pid in syslog lines"
14175 .row &%syslog_processname%&          "set syslog &""ident""& field"
14176 .row &%syslog_timestamp%&            "timestamp syslog lines"
14177 .row &%write_rejectlog%&             "control use of message log"
14178 .endtable
14179
14180
14181
14182 .section "Frozen messages" "SECID100"
14183 .table2
14184 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14185 .row &%freeze_tell%&                 "send message when freezing"
14186 .row &%move_frozen_messages%&        "to another directory"
14187 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14188 .endtable
14189
14190
14191
14192 .section "Data lookups" "SECID101"
14193 .table2
14194 .row &%ibase_servers%&               "InterBase servers"
14195 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14196 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14197 .row &%ldap_cert_file%&              "client cert file for LDAP"
14198 .row &%ldap_cert_key%&               "client key file for LDAP"
14199 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14200 .row &%ldap_default_servers%&        "used if no server in query"
14201 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14202 .row &%ldap_start_tls%&              "require TLS within LDAP"
14203 .row &%ldap_version%&                "set protocol version"
14204 .row &%lookup_open_max%&             "lookup files held open"
14205 .row &%mysql_servers%&               "default MySQL servers"
14206 .row &%oracle_servers%&              "Oracle servers"
14207 .row &%pgsql_servers%&               "default PostgreSQL servers"
14208 .row &%sqlite_lock_timeout%&         "as it says"
14209 .endtable
14210
14211
14212
14213 .section "Message ids" "SECID102"
14214 .table2
14215 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14216 .row &%message_id_header_text%&      "ditto"
14217 .endtable
14218
14219
14220
14221 .section "Embedded Perl Startup" "SECID103"
14222 .table2
14223 .row &%perl_at_start%&               "always start the interpreter"
14224 .row &%perl_startup%&                "code to obey when starting Perl"
14225 .row &%perl_taintmode%&              "enable taint mode in Perl"
14226 .endtable
14227
14228
14229
14230 .section "Daemon" "SECID104"
14231 .table2
14232 .row &%daemon_smtp_ports%&           "default ports"
14233 .row &%daemon_startup_retries%&      "number of times to retry"
14234 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14235 .row &%extra_local_interfaces%&      "not necessarily listened on"
14236 .row &%local_interfaces%&            "on which to listen, with optional ports"
14237 .row &%pid_file_path%&               "override compiled-in value"
14238 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14239 .endtable
14240
14241
14242
14243 .section "Resource control" "SECID105"
14244 .table2
14245 .row &%check_log_inodes%&            "before accepting a message"
14246 .row &%check_log_space%&             "before accepting a message"
14247 .row &%check_spool_inodes%&          "before accepting a message"
14248 .row &%check_spool_space%&           "before accepting a message"
14249 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14250 .row &%queue_only_load%&             "queue incoming if load high"
14251 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14252 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14253 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14254 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14255 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14256 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14257 .row &%smtp_accept_max_per_connection%& "messages per connection"
14258 .row &%smtp_accept_max_per_host%&    "connections from one host"
14259 .row &%smtp_accept_queue%&           "queue mail if more connections"
14260 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14261                                            connection"
14262 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14263 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14264 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14265 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14266 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14267 .endtable
14268
14269
14270
14271 .section "Policy controls" "SECID106"
14272 .table2
14273 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14274 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14275 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14276 .row &%acl_smtp_auth%&               "ACL for AUTH"
14277 .row &%acl_smtp_connect%&            "ACL for connection"
14278 .row &%acl_smtp_data%&               "ACL for DATA"
14279 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14280 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14281 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14282 .row &%acl_smtp_expn%&               "ACL for EXPN"
14283 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14284 .row &%acl_smtp_mail%&               "ACL for MAIL"
14285 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14286 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14287 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14288 .row &%acl_smtp_predata%&            "ACL for start of data"
14289 .row &%acl_smtp_quit%&               "ACL for QUIT"
14290 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14291 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14292 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14293 .row &%av_scanner%&                  "specify virus scanner"
14294 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14295                                       words""&"
14296 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14297 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14298 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14299 .row &%header_maxsize%&              "total size of message header"
14300 .row &%header_line_maxsize%&         "individual header line limit"
14301 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14302 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14303 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14304 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14305 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14306 .row &%host_lookup%&                 "host name looked up for these hosts"
14307 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14308 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14309 .row &%host_reject_connection%&      "reject connection from these hosts"
14310 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14311 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14312 .row &%message_size_limit%&          "for all messages"
14313 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14314 .row &%spamd_address%&               "set interface to SpamAssassin"
14315 .row &%strict_acl_vars%&             "object to unset ACL variables"
14316 .endtable
14317
14318
14319
14320 .section "Callout cache" "SECID107"
14321 .table2
14322 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14323                                          item"
14324 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14325                                          item"
14326 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14327 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14328 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14329 .endtable
14330
14331
14332
14333 .section "TLS" "SECID108"
14334 .table2
14335 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14336 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14337 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14338 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14339 .row &%tls_certificate%&             "location of server certificate"
14340 .row &%tls_crl%&                     "certificate revocation list"
14341 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14342 .row &%tls_dhparam%&                 "DH parameters for server"
14343 .row &%tls_eccurve%&                 "EC curve selection for server"
14344 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14345 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14346 .row &%tls_privatekey%&              "location of server private key"
14347 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14348 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14349 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14350 .row &%tls_verify_certificates%&     "expected client certificates"
14351 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14352 .endtable
14353
14354
14355
14356 .section "Local user handling" "SECID109"
14357 .table2
14358 .row &%finduser_retries%&            "useful in NIS environments"
14359 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14360 .row &%gecos_pattern%&               "ditto"
14361 .row &%max_username_length%&         "for systems that truncate"
14362 .row &%unknown_login%&               "used when no login name found"
14363 .row &%unknown_username%&            "ditto"
14364 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14365 .row &%uucp_from_sender%&            "ditto"
14366 .endtable
14367
14368
14369
14370 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14371 .table2
14372 .row &%header_maxsize%&              "total size of message header"
14373 .row &%header_line_maxsize%&         "individual header line limit"
14374 .row &%message_size_limit%&          "applies to all messages"
14375 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14376 .row &%received_header_text%&        "expanded to make &'Received:'&"
14377 .row &%received_headers_max%&        "for mail loop detection"
14378 .row &%recipients_max%&              "limit per message"
14379 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14380 .endtable
14381
14382
14383
14384
14385 .section "Non-SMTP incoming messages" "SECID111"
14386 .table2
14387 .row &%receive_timeout%&             "for non-SMTP messages"
14388 .endtable
14389
14390
14391
14392
14393
14394 .section "Incoming SMTP messages" "SECID112"
14395 See also the &'Policy controls'& section above.
14396
14397 .table2
14398 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14399 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14400 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14401 .row &%host_lookup%&                 "host name looked up for these hosts"
14402 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14403 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14404 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14405 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14406 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14407 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14408 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14409 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14410 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14411 .row &%smtp_accept_max_per_connection%& "messages per connection"
14412 .row &%smtp_accept_max_per_host%&    "connections from one host"
14413 .row &%smtp_accept_queue%&           "queue mail if more connections"
14414 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14415                                            connection"
14416 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14417 .row &%smtp_active_hostname%&        "host name to use in messages"
14418 .row &%smtp_banner%&                 "text for welcome banner"
14419 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14420 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14421 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14422 .row &%smtp_etrn_command%&           "what to run for ETRN"
14423 .row &%smtp_etrn_serialize%&         "only one at once"
14424 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14425 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14426 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14427 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14428 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14429 .row &%smtp_receive_timeout%&        "per command or data line"
14430 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14431 .row &%smtp_return_error_details%&   "give detail on rejections"
14432 .endtable
14433
14434
14435
14436 .section "SMTP extensions" "SECID113"
14437 .table2
14438 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14439 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14440 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14441 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14442 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14443 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14444 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14445 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14446 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14447 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14448 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14449 .endtable
14450
14451
14452
14453 .section "Processing messages" "SECID114"
14454 .table2
14455 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14456 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14457 .row &%allow_utf8_domains%&          "in addresses"
14458 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14459                                       words""&"
14460 .row &%delivery_date_remove%&        "from incoming messages"
14461 .row &%envelope_to_remove%&          "from incoming messages"
14462 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14463 .row &%headers_charset%&             "default for translations"
14464 .row &%qualify_domain%&              "default for senders"
14465 .row &%qualify_recipient%&           "default for recipients"
14466 .row &%return_path_remove%&          "from incoming messages"
14467 .row &%strip_excess_angle_brackets%& "in addresses"
14468 .row &%strip_trailing_dot%&          "at end of addresses"
14469 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14470 .endtable
14471
14472
14473
14474 .section "System filter" "SECID115"
14475 .table2
14476 .row &%system_filter%&               "locate system filter"
14477 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14478                                             directory"
14479 .row &%system_filter_file_transport%& "transport for delivery to a file"
14480 .row &%system_filter_group%&         "group for filter running"
14481 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14482 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14483 .row &%system_filter_user%&          "user for filter running"
14484 .endtable
14485
14486
14487
14488 .section "Routing and delivery" "SECID116"
14489 .table2
14490 .row &%disable_ipv6%&                "do no IPv6 processing"
14491 .row &%dns_again_means_nonexist%&    "for broken domains"
14492 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14493 .row &%dns_dnssec_ok%&               "parameter for resolver"
14494 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14495 .row &%dns_retrans%&                 "parameter for resolver"
14496 .row &%dns_retry%&                   "parameter for resolver"
14497 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14498 .row &%dns_use_edns0%&               "parameter for resolver"
14499 .row &%hold_domains%&                "hold delivery for these domains"
14500 .row &%local_interfaces%&            "for routing checks"
14501 .row &%queue_domains%&               "no immediate delivery for these"
14502 .row &%queue_only%&                  "no immediate delivery at all"
14503 .row &%queue_only_file%&             "no immediate delivery if file exists"
14504 .row &%queue_only_load%&             "no immediate delivery if load is high"
14505 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14506 .row &%queue_only_override%&         "allow command line to override"
14507 .row &%queue_run_in_order%&          "order of arrival"
14508 .row &%queue_run_max%&               "of simultaneous queue runners"
14509 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14510 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14511 .row &%remote_sort_domains%&         "order of remote deliveries"
14512 .row &%retry_data_expire%&           "timeout for retry data"
14513 .row &%retry_interval_max%&          "safety net for retry rules"
14514 .endtable
14515
14516
14517
14518 .section "Bounce and warning messages" "SECID117"
14519 .table2
14520 .row &%bounce_message_file%&         "content of bounce"
14521 .row &%bounce_message_text%&         "content of bounce"
14522 .row &%bounce_return_body%&          "include body if returning message"
14523 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14524 .row &%bounce_return_message%&       "include original message in bounce"
14525 .row &%bounce_return_size_limit%&    "limit on returned message"
14526 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14527 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14528 .row &%errors_copy%&                 "copy bounce messages"
14529 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14530 .row &%delay_warning%&               "time schedule"
14531 .row &%delay_warning_condition%&     "condition for warning messages"
14532 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14533 .row &%smtp_return_error_details%&   "give detail on rejections"
14534 .row &%warn_message_file%&           "content of warning message"
14535 .endtable
14536
14537
14538
14539 .section "Alphabetical list of main options" "SECTalomo"
14540 Those options that undergo string expansion before use are marked with
14541 &dagger;.
14542
14543 .option accept_8bitmime main boolean true
14544 .cindex "8BITMIME"
14545 .cindex "8-bit characters"
14546 .cindex "log" "selectors"
14547 .cindex "log" "8BITMIME"
14548 This option causes Exim to send 8BITMIME in its response to an SMTP
14549 EHLO command, and to accept the BODY= parameter on MAIL commands.
14550 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14551 takes no steps to do anything special with messages received by this route.
14552
14553 Historically Exim kept this option off by default, but the maintainers
14554 feel that in today's Internet, this causes more problems than it solves.
14555 It now defaults to true.
14556 A more detailed analysis of the issues is provided by Dan Bernstein:
14557 .display
14558 &url(https://cr.yp.to/smtp/8bitmime.html)
14559 .endd
14560
14561 To log received 8BITMIME status use
14562 .code
14563 log_selector = +8bitmime
14564 .endd
14565
14566 .option acl_not_smtp main string&!! unset
14567 .cindex "&ACL;" "for non-SMTP messages"
14568 .cindex "non-SMTP messages" "ACLs for"
14569 This option defines the ACL that is run when a non-SMTP message has been
14570 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14571 further details.
14572
14573 .option acl_not_smtp_mime main string&!! unset
14574 This option defines the ACL that is run for individual MIME parts of non-SMTP
14575 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14576 SMTP messages.
14577
14578 .option acl_not_smtp_start main string&!! unset
14579 .cindex "&ACL;" "at start of non-SMTP message"
14580 .cindex "non-SMTP messages" "ACLs for"
14581 This option defines the ACL that is run before Exim starts reading a
14582 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14583
14584 .option acl_smtp_auth main string&!! unset
14585 .cindex "&ACL;" "setting up for SMTP commands"
14586 .cindex "AUTH" "ACL for"
14587 This option defines the ACL that is run when an SMTP AUTH command is
14588 received. See chapter &<<CHAPACL>>& for further details.
14589
14590 .option acl_smtp_connect main string&!! unset
14591 .cindex "&ACL;" "on SMTP connection"
14592 This option defines the ACL that is run when an SMTP connection is received.
14593 See chapter &<<CHAPACL>>& for further details.
14594
14595 .option acl_smtp_data main string&!! unset
14596 .cindex "DATA" "ACL for"
14597 This option defines the ACL that is run after an SMTP DATA command has been
14598 processed and the message itself has been received, but before the final
14599 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14600
14601 .option acl_smtp_data_prdr main string&!! accept
14602 .cindex "PRDR" "ACL for"
14603 .cindex "DATA" "PRDR ACL for"
14604 .cindex "&ACL;" "PRDR-related"
14605 .cindex "&ACL;" "per-user data processing"
14606 This option defines the ACL that,
14607 if the PRDR feature has been negotiated,
14608 is run for each recipient after an SMTP DATA command has been
14609 processed and the message itself has been received, but before the
14610 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14611
14612 .option acl_smtp_dkim main string&!! unset
14613 .cindex DKIM "ACL for"
14614 This option defines the ACL that is run for each DKIM signature
14615 (by default, or as specified in the dkim_verify_signers option)
14616 of a received message.
14617 See section &<<SECDKIMVFY>>& for further details.
14618
14619 .option acl_smtp_etrn main string&!! unset
14620 .cindex "ETRN" "ACL for"
14621 This option defines the ACL that is run when an SMTP ETRN command is
14622 received. See chapter &<<CHAPACL>>& for further details.
14623
14624 .option acl_smtp_expn main string&!! unset
14625 .cindex "EXPN" "ACL for"
14626 This option defines the ACL that is run when an SMTP EXPN command is
14627 received. See chapter &<<CHAPACL>>& for further details.
14628
14629 .option acl_smtp_helo main string&!! unset
14630 .cindex "EHLO" "ACL for"
14631 .cindex "HELO" "ACL for"
14632 This option defines the ACL that is run when an SMTP EHLO or HELO
14633 command is received. See chapter &<<CHAPACL>>& for further details.
14634
14635
14636 .option acl_smtp_mail main string&!! unset
14637 .cindex "MAIL" "ACL for"
14638 This option defines the ACL that is run when an SMTP MAIL command is
14639 received. See chapter &<<CHAPACL>>& for further details.
14640
14641 .option acl_smtp_mailauth main string&!! unset
14642 .cindex "AUTH" "on MAIL command"
14643 This option defines the ACL that is run when there is an AUTH parameter on
14644 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14645 &<<CHAPSMTPAUTH>>& for details of authentication.
14646
14647 .option acl_smtp_mime main string&!! unset
14648 .cindex "MIME content scanning" "ACL for"
14649 This option is available when Exim is built with the content-scanning
14650 extension. It defines the ACL that is run for each MIME part in a message. See
14651 section &<<SECTscanmimepart>>& for details.
14652
14653 .option acl_smtp_notquit main string&!! unset
14654 .cindex "not-QUIT, ACL for"
14655 This option defines the ACL that is run when an SMTP session
14656 ends without a QUIT command being received.
14657 See chapter &<<CHAPACL>>& for further details.
14658
14659 .option acl_smtp_predata main string&!! unset
14660 This option defines the ACL that is run when an SMTP DATA command is
14661 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14662 further details.
14663
14664 .option acl_smtp_quit main string&!! unset
14665 .cindex "QUIT, ACL for"
14666 This option defines the ACL that is run when an SMTP QUIT command is
14667 received. See chapter &<<CHAPACL>>& for further details.
14668
14669 .option acl_smtp_rcpt main string&!! unset
14670 .cindex "RCPT" "ACL for"
14671 This option defines the ACL that is run when an SMTP RCPT command is
14672 received. See chapter &<<CHAPACL>>& for further details.
14673
14674 .option acl_smtp_starttls main string&!! unset
14675 .cindex "STARTTLS, ACL for"
14676 This option defines the ACL that is run when an SMTP STARTTLS command is
14677 received. See chapter &<<CHAPACL>>& for further details.
14678
14679 .option acl_smtp_vrfy main string&!! unset
14680 .cindex "VRFY" "ACL for"
14681 This option defines the ACL that is run when an SMTP VRFY command is
14682 received. See chapter &<<CHAPACL>>& for further details.
14683
14684 .option add_environment main "string list" empty
14685 .cindex "environment" "set values"
14686 This option adds individual environment variables that the
14687 currently linked libraries and programs in child processes may use.
14688 Each list element should be of the form &"name=value"&.
14689
14690 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14691
14692 .option admin_groups main "string list&!!" unset
14693 .cindex "admin user"
14694 This option is expanded just once, at the start of Exim's processing. If the
14695 current group or any of the supplementary groups of an Exim caller is in this
14696 colon-separated list, the caller has admin privileges. If all your system
14697 programmers are in a specific group, for example, you can give them all Exim
14698 admin privileges by putting that group in &%admin_groups%&. However, this does
14699 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14700 To permit this, you have to add individuals to the Exim group.
14701
14702 .option allow_domain_literals main boolean false
14703 .cindex "domain literal"
14704 If this option is set, the RFC 2822 domain literal format is permitted in
14705 email addresses. The option is not set by default, because the domain literal
14706 format is not normally required these days, and few people know about it. It
14707 has, however, been exploited by mail abusers.
14708
14709 Unfortunately, it seems that some DNS black list maintainers are using this
14710 format to report black listing to postmasters. If you want to accept messages
14711 addressed to your hosts by IP address, you need to set
14712 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14713 domains (defined in the named domain list &%local_domains%& in the default
14714 configuration). This &"magic string"& matches the domain literal form of all
14715 the local host's IP addresses.
14716
14717
14718 .option allow_mx_to_ip main boolean false
14719 .cindex "MX record" "pointing to IP address"
14720 It appears that more and more DNS zone administrators are breaking the rules
14721 and putting domain names that look like IP addresses on the right hand side of
14722 MX records. Exim follows the rules and rejects this, giving an error message
14723 that explains the misconfiguration. However, some other MTAs support this
14724 practice, so to avoid &"Why can't Exim do this?"& complaints,
14725 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14726 recommended, except when you have no other choice.
14727
14728 .option allow_utf8_domains main boolean false
14729 .cindex "domain" "UTF-8 characters in"
14730 .cindex "UTF-8" "in domain name"
14731 Lots of discussion is going on about internationalized domain names. One
14732 camp is strongly in favour of just using UTF-8 characters, and it seems
14733 that at least two other MTAs permit this.
14734 This option allows Exim users to experiment if they wish.
14735
14736 If it is set true, Exim's domain parsing function allows valid
14737 UTF-8 multicharacters to appear in domain name components, in addition to
14738 letters, digits, and hyphens.
14739
14740 .new
14741 If Exim is built with internationalization support
14742 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14743 this option can be left as default.
14744 .wen
14745 Without that,
14746 if you want to look up such domain names in the DNS, you must also
14747 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14748 suitable setting is:
14749 .code
14750 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14751   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14752 .endd
14753 Alternatively, you can just disable this feature by setting
14754 .code
14755 dns_check_names_pattern =
14756 .endd
14757 That is, set the option to an empty string so that no check is done.
14758
14759
14760 .option auth_advertise_hosts main "host list&!!" *
14761 .cindex "authentication" "advertising"
14762 .cindex "AUTH" "advertising"
14763 If any server authentication mechanisms are configured, Exim advertises them in
14764 response to an EHLO command only if the calling host matches this list.
14765 Otherwise, Exim does not advertise AUTH.
14766 Exim does not accept AUTH commands from clients to which it has not
14767 advertised the availability of AUTH. The advertising of individual
14768 authentication mechanisms can be controlled by the use of the
14769 &%server_advertise_condition%& generic authenticator option on the individual
14770 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14771
14772 Certain mail clients (for example, Netscape) require the user to provide a name
14773 and password for authentication if AUTH is advertised, even though it may
14774 not be needed (the host may accept messages from hosts on its local LAN without
14775 authentication, for example). The &%auth_advertise_hosts%& option can be used
14776 to make these clients more friendly by excluding them from the set of hosts to
14777 which Exim advertises AUTH.
14778
14779 .cindex "AUTH" "advertising when encrypted"
14780 If you want to advertise the availability of AUTH only when the connection
14781 is encrypted using TLS, you can make use of the fact that the value of this
14782 option is expanded, with a setting like this:
14783 .code
14784 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14785 .endd
14786 .vindex "&$tls_in_cipher$&"
14787 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14788 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14789 expansion is *, which matches all hosts.
14790
14791
14792 .option auto_thaw main time 0s
14793 .cindex "thawing messages"
14794 .cindex "unfreezing messages"
14795 If this option is set to a time greater than zero, a queue runner will try a
14796 new delivery attempt on any frozen message, other than a bounce message, if
14797 this much time has passed since it was frozen. This may result in the message
14798 being re-frozen if nothing has changed since the last attempt. It is a way of
14799 saying &"keep on trying, even though there are big problems"&.
14800
14801 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14802 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14803 thought to be very useful any more, and its use should probably be avoided.
14804
14805
14806 .option av_scanner main string "see below"
14807 This option is available if Exim is built with the content-scanning extension.
14808 It specifies which anti-virus scanner to use. The default value is:
14809 .code
14810 sophie:/var/run/sophie
14811 .endd
14812 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14813 before use. See section &<<SECTscanvirus>>& for further details.
14814
14815
14816 .option bi_command main string unset
14817 .oindex "&%-bi%&"
14818 This option supplies the name of a command that is run when Exim is called with
14819 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14820 just the command name, it is not a complete command line. If an argument is
14821 required, it must come from the &%-oA%& command line option.
14822
14823
14824 .option bounce_message_file main string unset
14825 .cindex "bounce message" "customizing"
14826 .cindex "customizing" "bounce message"
14827 This option defines a template file containing paragraphs of text to be used
14828 for constructing bounce messages.  Details of the file's contents are given in
14829 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14830
14831
14832 .option bounce_message_text main string unset
14833 When this option is set, its contents are included in the default bounce
14834 message immediately after &"This message was created automatically by mail
14835 delivery software."& It is not used if &%bounce_message_file%& is set.
14836
14837 .option bounce_return_body main boolean true
14838 .cindex "bounce message" "including body"
14839 This option controls whether the body of an incoming message is included in a
14840 bounce message when &%bounce_return_message%& is true. The default setting
14841 causes the entire message, both header and body, to be returned (subject to the
14842 value of &%bounce_return_size_limit%&). If this option is false, only the
14843 message header is included. In the case of a non-SMTP message containing an
14844 error that is detected during reception, only those header lines preceding the
14845 point at which the error was detected are returned.
14846 .cindex "bounce message" "including original"
14847
14848 .option bounce_return_linesize_limit main integer 998
14849 .cindex "size" "of bounce lines, limit"
14850 .cindex "bounce message" "line length limit"
14851 .cindex "limit" "bounce message line length"
14852 This option sets a limit in bytes on the line length of messages
14853 that are returned to senders due to delivery problems,
14854 when &%bounce_return_message%& is true.
14855 The default value corresponds to RFC limits.
14856 If the message being returned has lines longer than this value it is
14857 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14858
14859 The option also applies to bounces returned when an error is detected
14860 during reception of a message.
14861 In this case lines from the original are truncated.
14862
14863 The option does not apply to messages generated by an &(autoreply)& transport.
14864
14865
14866 .option bounce_return_message main boolean true
14867 If this option is set false, none of the original message is included in
14868 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14869 &%bounce_return_body%&.
14870
14871
14872 .option bounce_return_size_limit main integer 100K
14873 .cindex "size" "of bounce, limit"
14874 .cindex "bounce message" "size limit"
14875 .cindex "limit" "bounce message size"
14876 This option sets a limit in bytes on the size of messages that are returned to
14877 senders as part of bounce messages when &%bounce_return_message%& is true. The
14878 limit should be less than the value of the global &%message_size_limit%& and of
14879 any &%message_size_limit%& settings on transports, to allow for the bounce text
14880 that Exim generates. If this option is set to zero there is no limit.
14881
14882 When the body of any message that is to be included in a bounce message is
14883 greater than the limit, it is truncated, and a comment pointing this out is
14884 added at the top. The actual cutoff may be greater than the value given, owing
14885 to the use of buffering for transferring the message in chunks (typically 8K in
14886 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14887 messages.
14888
14889 .option bounce_sender_authentication main string unset
14890 .cindex "bounce message" "sender authentication"
14891 .cindex "authentication" "bounce message"
14892 .cindex "AUTH" "on bounce message"
14893 This option provides an authenticated sender address that is sent with any
14894 bounce messages generated by Exim that are sent over an authenticated SMTP
14895 connection. A typical setting might be:
14896 .code
14897 bounce_sender_authentication = mailer-daemon@my.domain.example
14898 .endd
14899 which would cause bounce messages to be sent using the SMTP command:
14900 .code
14901 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14902 .endd
14903 The value of &%bounce_sender_authentication%& must always be a complete email
14904 address.
14905
14906 .option callout_domain_negative_expire main time 3h
14907 .cindex "caching" "callout timeouts"
14908 .cindex "callout" "caching timeouts"
14909 This option specifies the expiry time for negative callout cache data for a
14910 domain. See section &<<SECTcallver>>& for details of callout verification, and
14911 section &<<SECTcallvercache>>& for details of the caching.
14912
14913
14914 .option callout_domain_positive_expire main time 7d
14915 This option specifies the expiry time for positive callout cache data for a
14916 domain. See section &<<SECTcallver>>& for details of callout verification, and
14917 section &<<SECTcallvercache>>& for details of the caching.
14918
14919
14920 .option callout_negative_expire main time 2h
14921 This option specifies the expiry time for negative callout cache data for an
14922 address. See section &<<SECTcallver>>& for details of callout verification, and
14923 section &<<SECTcallvercache>>& for details of the caching.
14924
14925
14926 .option callout_positive_expire main time 24h
14927 This option specifies the expiry time for positive callout cache data for an
14928 address. See section &<<SECTcallver>>& for details of callout verification, and
14929 section &<<SECTcallvercache>>& for details of the caching.
14930
14931
14932 .option callout_random_local_part main string&!! "see below"
14933 This option defines the &"random"& local part that can be used as part of
14934 callout verification. The default value is
14935 .code
14936 $primary_hostname-$tod_epoch-testing
14937 .endd
14938 See section &<<CALLaddparcall>>& for details of how this value is used.
14939
14940
14941 .option check_log_inodes main integer 100
14942 See &%check_spool_space%& below.
14943
14944
14945 .option check_log_space main integer 10M
14946 See &%check_spool_space%& below.
14947
14948 .oindex "&%check_rfc2047_length%&"
14949 .cindex "RFC 2047" "disabling length check"
14950 .option check_rfc2047_length main boolean true
14951 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14952 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14953 word; strings to be encoded that exceed this length are supposed to use
14954 multiple encoded words. By default, Exim does not recognize encoded words that
14955 exceed the maximum length. However, it seems that some software, in violation
14956 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14957 set false, Exim recognizes encoded words of any length.
14958
14959
14960 .option check_spool_inodes main integer 100
14961 See &%check_spool_space%& below.
14962
14963
14964 .option check_spool_space main integer 10M
14965 .cindex "checking disk space"
14966 .cindex "disk space, checking"
14967 .cindex "spool directory" "checking space"
14968 The four &%check_...%& options allow for checking of disk resources before a
14969 message is accepted.
14970
14971 .vindex "&$log_inodes$&"
14972 .vindex "&$log_space$&"
14973 .vindex "&$spool_inodes$&"
14974 .vindex "&$spool_space$&"
14975 When any of these options are nonzero, they apply to all incoming messages. If you
14976 want to apply different checks to different kinds of message, you can do so by
14977 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14978 &$spool_space$& in an ACL with appropriate additional conditions.
14979
14980
14981 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14982 either value is greater than zero, for example:
14983 .code
14984 check_spool_space = 100M
14985 check_spool_inodes = 100
14986 .endd
14987 The spool partition is the one that contains the directory defined by
14988 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14989 transit.
14990
14991 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14992 files are written if either is greater than zero. These should be set only if
14993 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14994
14995 If there is less space or fewer inodes than requested, Exim refuses to accept
14996 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14997 error response to the MAIL command. If ESMTP is in use and there was a
14998 SIZE parameter on the MAIL command, its value is added to the
14999 &%check_spool_space%& value, and the check is performed even if
15000 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15001
15002 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15003 number of kilobytes (though specified in bytes).
15004 If a non-multiple of 1024 is specified, it is rounded up.
15005
15006 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15007 failure a message is written to stderr and Exim exits with a non-zero code, as
15008 it obviously cannot send an error message of any kind.
15009
15010 There is a slight performance penalty for these checks.
15011 Versions of Exim preceding 4.88 had these disabled by default;
15012 high-rate installations confident they will never run out of resources
15013 may wish to deliberately disable them.
15014
15015 .option chunking_advertise_hosts main "host list&!!" *
15016 .cindex CHUNKING advertisement
15017 .cindex "RFC 3030" "CHUNKING"
15018 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15019 these hosts.
15020 Hosts may use the BDAT command as an alternate to DATA.
15021
15022 .option commandline_checks_require_admin main boolean &`false`&
15023 .cindex "restricting access to features"
15024 This option restricts various basic checking features to require an
15025 administrative user.
15026 This affects most of the &%-b*%& options, such as &%-be%&.
15027
15028 .option debug_store main boolean &`false`&
15029 .cindex debugging "memory corruption"
15030 .cindex memory debugging
15031 This option, when true, enables extra checking in Exim's internal memory
15032 management.  For use when a memory corruption issue is being investigated,
15033 it should normally be left as default.
15034
15035 .option daemon_smtp_ports main string &`smtp`&
15036 .cindex "port" "for daemon"
15037 .cindex "TCP/IP" "setting listening ports"
15038 This option specifies one or more default SMTP ports on which the Exim daemon
15039 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15040 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15041
15042 .option daemon_startup_retries main integer 9
15043 .cindex "daemon startup, retrying"
15044 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15045 the daemon at startup when it cannot immediately bind a listening socket
15046 (typically because the socket is already in use): &%daemon_startup_retries%&
15047 defines the number of retries after the first failure, and
15048 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15049
15050 .option daemon_startup_sleep main time 30s
15051 See &%daemon_startup_retries%&.
15052
15053 .option delay_warning main "time list" 24h
15054 .cindex "warning of delay"
15055 .cindex "delay warning, specifying"
15056 .cindex "queue" "delay warning"
15057 When a message is delayed, Exim sends a warning message to the sender at
15058 intervals specified by this option. The data is a colon-separated list of times
15059 after which to send warning messages. If the value of the option is an empty
15060 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15061 message has been in the queue for longer than the last time, the last interval
15062 between the times is used to compute subsequent warning times. For example,
15063 with
15064 .code
15065 delay_warning = 4h:8h:24h
15066 .endd
15067 the first message is sent after 4 hours, the second after 8 hours, and
15068 the third one after 24 hours. After that, messages are sent every 16 hours,
15069 because that is the interval between the last two times on the list. If you set
15070 just one time, it specifies the repeat interval. For example, with:
15071 .code
15072 delay_warning = 6h
15073 .endd
15074 messages are repeated every six hours. To stop warnings after a given time, set
15075 a very large time at the end of the list. For example:
15076 .code
15077 delay_warning = 2h:12h:99d
15078 .endd
15079 Note that the option is only evaluated at the time a delivery attempt fails,
15080 which depends on retry and queue-runner configuration.
15081 Typically retries will be configured more frequently than warning messages.
15082
15083 .option delay_warning_condition main string&!! "see below"
15084 .vindex "&$domain$&"
15085 The string is expanded at the time a warning message might be sent. If all the
15086 deferred addresses have the same domain, it is set in &$domain$& during the
15087 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15088 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15089 &"false"& (the comparison being done caselessly) then the warning message is
15090 not sent. The default is:
15091 .code
15092 delay_warning_condition = ${if or {\
15093   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15094   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15095   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15096   } {no}{yes}}
15097 .endd
15098 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15099 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15100 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15101 &"auto-replied"& in an &'Auto-Submitted:'& header.
15102
15103 .option deliver_drop_privilege main boolean false
15104 .cindex "unprivileged delivery"
15105 .cindex "delivery" "unprivileged"
15106 If this option is set true, Exim drops its root privilege at the start of a
15107 delivery process, and runs as the Exim user throughout. This severely restricts
15108 the kinds of local delivery that are possible, but is viable in certain types
15109 of configuration. There is a discussion about the use of root privilege in
15110 chapter &<<CHAPsecurity>>&.
15111
15112 .option deliver_queue_load_max main fixed-point unset
15113 .cindex "load average"
15114 .cindex "queue runner" "abandoning"
15115 When this option is set, a queue run is abandoned if the system load average
15116 becomes greater than the value of the option. The option has no effect on
15117 ancient operating systems on which Exim cannot determine the load average.
15118 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15119
15120
15121 .option delivery_date_remove main boolean true
15122 .cindex "&'Delivery-date:'& header line"
15123 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15124 message when it is delivered, in exactly the same way as &'Return-path:'& is
15125 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15126 should not be present in incoming messages, and this option causes them to be
15127 removed at the time the message is received, to avoid any problems that might
15128 occur when a delivered message is subsequently sent on to some other recipient.
15129
15130 .option disable_fsync main boolean false
15131 .cindex "&[fsync()]&, disabling"
15132 This option is available only if Exim was built with the compile-time option
15133 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15134 a runtime configuration generates an &"unknown option"& error. You should not
15135 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15136 really, really, really understand what you are doing. &'No pre-compiled
15137 distributions of Exim should ever make this option available.'&
15138
15139 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15140 updated files' data to be written to disc before continuing. Unexpected events
15141 such as crashes and power outages may cause data to be lost or scrambled.
15142 Here be Dragons. &*Beware.*&
15143
15144
15145 .option disable_ipv6 main boolean false
15146 .cindex "IPv6" "disabling"
15147 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15148 activities take place. AAAA records are never looked up, and any IPv6 addresses
15149 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15150 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15151 to handle IPv6 literal addresses.
15152
15153
15154 .new
15155 .option dkim_verify_hashes main "string list" "sha256 : sha512 : sha1"
15156 .cindex DKIM "selecting signature algorithms"
15157 This option gives a list of hash types which are acceptable in signatures,
15158 and an order of processing.
15159 Signatures with algorithms not in the list will be ignored.
15160
15161 Note that the presence of sha1 violates RFC 8301.
15162 Signatures using the rsa-sha1 are however (as of writing) still common.
15163 The default inclusion of sha1 may be dropped in a future release.
15164
15165 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15166 This option gives a list of key types which are acceptable in signatures,
15167 and an order of processing.
15168 Signatures with algorithms not in the list will be ignored.
15169
15170 .option dkim_verify_minimal main boolean false
15171 If set to true, verification of signatures will terminate after the
15172 first success.
15173 .wen
15174
15175 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15176 .cindex DKIM "controlling calls to the ACL"
15177 This option gives a list of DKIM domains for which the DKIM ACL is run.
15178 It is expanded after the message is received; by default it runs
15179 the ACL once for each signature in the message.
15180 See section &<<SECDKIMVFY>>&.
15181
15182
15183 .option dns_again_means_nonexist main "domain list&!!" unset
15184 .cindex "DNS" "&""try again""& response; overriding"
15185 DNS lookups give a &"try again"& response for the DNS errors
15186 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15187 keep trying to deliver a message, or to give repeated temporary errors to
15188 incoming mail. Sometimes the effect is caused by a badly set up name server and
15189 may persist for a long time. If a domain which exhibits this problem matches
15190 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15191 This option should be used with care. You can make it apply to reverse lookups
15192 by a setting such as this:
15193 .code
15194 dns_again_means_nonexist = *.in-addr.arpa
15195 .endd
15196 This option applies to all DNS lookups that Exim does. It also applies when the
15197 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15198 since these are most likely to be caused by DNS lookup problems. The
15199 &(dnslookup)& router has some options of its own for controlling what happens
15200 when lookups for MX or SRV records give temporary errors. These more specific
15201 options are applied after this global option.
15202
15203 .option dns_check_names_pattern main string "see below"
15204 .cindex "DNS" "pre-check of name syntax"
15205 When this option is set to a non-empty string, it causes Exim to check domain
15206 names for characters that are not allowed in host names before handing them to
15207 the DNS resolver, because some resolvers give temporary errors for names that
15208 contain unusual characters. If a domain name contains any unwanted characters,
15209 a &"not found"& result is forced, and the resolver is not called. The check is
15210 done by matching the domain name against a regular expression, which is the
15211 value of this option. The default pattern is
15212 .code
15213 dns_check_names_pattern = \
15214   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15215 .endd
15216 which permits only letters, digits, slashes, and hyphens in components, but
15217 they must start and end with a letter or digit. Slashes are not, in fact,
15218 permitted in host names, but they are found in certain NS records (which can be
15219 accessed in Exim by using a &%dnsdb%& lookup). If you set
15220 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15221 empty string.
15222
15223 .option dns_csa_search_limit main integer 5
15224 This option controls the depth of parental searching for CSA SRV records in the
15225 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15226
15227 .option dns_csa_use_reverse main boolean true
15228 This option controls whether or not an IP address, given as a CSA domain, is
15229 reversed and looked up in the reverse DNS, as described in more detail in
15230 section &<<SECTverifyCSA>>&.
15231
15232 .option dns_cname_loops main integer 1
15233 .cindex DNS "CNAME following"
15234 This option controls the following of CNAME chains, needed if the resolver does
15235 not do it internally.
15236 As of 2018 most should, and the default can be left.
15237 If you have an ancient one, a value of 10 is likely needed.
15238
15239 The default value of one CNAME-follow is needed
15240 thanks to the observed return for an MX request,
15241 given no MX presence but a CNAME to an A, of the CNAME.
15242
15243
15244 .option dns_dnssec_ok main integer -1
15245 .cindex "DNS" "resolver options"
15246 .cindex "DNS" "DNSSEC"
15247 If this option is set to a non-negative number then Exim will initialise the
15248 DNS resolver library to either use or not use DNSSEC, overriding the system
15249 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15250
15251 If the resolver library does not support DNSSEC then this option has no effect.
15252
15253
15254 .option dns_ipv4_lookup main "domain list&!!" unset
15255 .cindex "IPv6" "DNS lookup for AAAA records"
15256 .cindex "DNS" "IPv6 lookup for AAAA records"
15257 .cindex DNS "IPv6 disabling"
15258 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15259 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15260 (A records) when trying to find IP addresses for hosts, unless the host's
15261 domain matches this list.
15262
15263 This is a fudge to help with name servers that give big delays or otherwise do
15264 not work for the AAAA record type. In due course, when the world's name
15265 servers have all been upgraded, there should be no need for this option.
15266 .new
15267 Note that all lookups, including those done for verification, are affected;
15268 this will result in verify failure for IPv6 connections or ones using names
15269 only valid for IPv6 addresses.
15270 .wen
15271
15272
15273 .option dns_retrans main time 0s
15274 .cindex "DNS" "resolver options"
15275 .cindex timeout "dns lookup"
15276 .cindex "DNS" timeout
15277 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15278 retransmission and retry parameters for DNS lookups. Values of zero (the
15279 defaults) leave the system default settings unchanged. The first value is the
15280 time between retries, and the second is the number of retries. It isn't
15281 totally clear exactly how these settings affect the total time a DNS lookup may
15282 take. I haven't found any documentation about timeouts on DNS lookups; these
15283 parameter values are available in the external resolver interface structure,
15284 but nowhere does it seem to describe how they are used or what you might want
15285 to set in them.
15286 See also the &%slow_lookup_log%& option.
15287
15288
15289 .option dns_retry main integer 0
15290 See &%dns_retrans%& above.
15291
15292
15293 .option dns_trust_aa main "domain list&!!" unset
15294 .cindex "DNS" "resolver options"
15295 .cindex "DNS" "DNSSEC"
15296 If this option is set then lookup results marked with the AA bit
15297 (Authoritative Answer) are trusted the same way as if they were
15298 DNSSEC-verified. The authority section's name of the answer must
15299 match with this expanded domain list.
15300
15301 Use this option only if you talk directly to a resolver that is
15302 authoritative for some zones and does not set the AD (Authentic Data)
15303 bit in the answer. Some DNS servers may have an configuration option to
15304 mark the answers from their own zones as verified (they set the AD bit).
15305 Others do not have this option. It is considered as poor practice using
15306 a resolver that is an authoritative server for some zones.
15307
15308 Use this option only if you really have to (e.g. if you want
15309 to use DANE for remote delivery to a server that is listed in the DNS
15310 zones that your resolver is authoritative for).
15311
15312 If the DNS answer packet has the AA bit set and contains resource record
15313 in the answer section, the name of the first NS record appearing in the
15314 authority section is compared against the list. If the answer packet is
15315 authoritative but the answer section is empty, the name of the first SOA
15316 record in the authoritative section is used instead.
15317
15318 .cindex "DNS" "resolver options"
15319 .option dns_use_edns0 main integer -1
15320 .cindex "DNS" "resolver options"
15321 .cindex "DNS" "EDNS0"
15322 .cindex "DNS" "OpenBSD
15323 If this option is set to a non-negative number then Exim will initialise the
15324 DNS resolver library to either use or not use EDNS0 extensions, overriding
15325 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15326 on.
15327
15328 If the resolver library does not support EDNS0 then this option has no effect.
15329
15330 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15331 means that DNSSEC will not work with Exim on that platform either, unless Exim
15332 is linked against an alternative DNS client library.
15333
15334
15335 .option drop_cr main boolean false
15336 This is an obsolete option that is now a no-op. It used to affect the way Exim
15337 handled CR and LF characters in incoming messages. What happens now is
15338 described in section &<<SECTlineendings>>&.
15339
15340 .option dsn_advertise_hosts main "host list&!!" unset
15341 .cindex "bounce messages" "success"
15342 .cindex "DSN" "success"
15343 .cindex "Delivery Status Notification" "success"
15344 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15345 and accepted from, these hosts.
15346 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15347 and RET and ORCPT options on MAIL FROM commands.
15348 A NOTIFY=SUCCESS option requests success-DSN messages.
15349 A NOTIFY= option with no argument requests that no delay or failure DSNs
15350 are sent.
15351
15352 .option dsn_from main "string&!!" "see below"
15353 .cindex "&'From:'& header line" "in bounces"
15354 .cindex "bounce messages" "&'From:'& line, specifying"
15355 This option can be used to vary the contents of &'From:'& header lines in
15356 bounces and other automatically generated messages (&"Delivery Status
15357 Notifications"& &-- hence the name of the option). The default setting is:
15358 .code
15359 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15360 .endd
15361 The value is expanded every time it is needed. If the expansion fails, a
15362 panic is logged, and the default value is used.
15363
15364 .option envelope_to_remove main boolean true
15365 .cindex "&'Envelope-to:'& header line"
15366 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15367 message when it is delivered, in exactly the same way as &'Return-path:'& is
15368 handled. &'Envelope-to:'& records the original recipient address from the
15369 message's envelope that caused the delivery to happen. Such headers should not
15370 be present in incoming messages, and this option causes them to be removed at
15371 the time the message is received, to avoid any problems that might occur when a
15372 delivered message is subsequently sent on to some other recipient.
15373
15374
15375 .option errors_copy main "string list&!!" unset
15376 .cindex "bounce message" "copy to other address"
15377 .cindex "copy of bounce message"
15378 Setting this option causes Exim to send bcc copies of bounce messages that it
15379 generates to other addresses. &*Note*&: This does not apply to bounce messages
15380 coming from elsewhere. The value of the option is a colon-separated list of
15381 items. Each item consists of a pattern, terminated by white space, followed by
15382 a comma-separated list of email addresses. If a pattern contains spaces, it
15383 must be enclosed in double quotes.
15384
15385 Each pattern is processed in the same way as a single item in an address list
15386 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15387 the bounce message, the message is copied to the addresses on the list. The
15388 items are scanned in order, and once a matching one is found, no further items
15389 are examined. For example:
15390 .code
15391 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15392               rqps@mydomain   hostmaster@mydomain.example,\
15393                               postmaster@mydomain.example
15394 .endd
15395 .vindex "&$domain$&"
15396 .vindex "&$local_part$&"
15397 The address list is expanded before use. The expansion variables &$local_part$&
15398 and &$domain$& are set from the original recipient of the error message, and if
15399 there was any wildcard matching in the pattern, the expansion
15400 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15401 variables &$0$&, &$1$&, etc. are set in the normal way.
15402
15403
15404 .option errors_reply_to main string unset
15405 .cindex "bounce message" "&'Reply-to:'& in"
15406 By default, Exim's bounce and delivery warning messages contain the header line
15407 .display
15408 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15409 .endd
15410 .oindex &%quota_warn_message%&
15411 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15412 A warning message that is generated by the &%quota_warn_message%& option in an
15413 &(appendfile)& transport may contain its own &'From:'& header line that
15414 overrides the default.
15415
15416 Experience shows that people reply to bounce messages. If the
15417 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15418 and warning messages. For example:
15419 .code
15420 errors_reply_to = postmaster@my.domain.example
15421 .endd
15422 The value of the option is not expanded. It must specify a valid RFC 2822
15423 address. However, if a warning message that is generated by the
15424 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15425 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15426 not used.
15427
15428
15429 .option event_action main string&!! unset
15430 .cindex events
15431 This option declares a string to be expanded for Exim's events mechanism.
15432 For details see chapter &<<CHAPevents>>&.
15433
15434
15435 .option exim_group main string "compile-time configured"
15436 .cindex "gid (group id)" "Exim's own"
15437 .cindex "Exim group"
15438 This option changes the gid under which Exim runs when it gives up root
15439 privilege. The default value is compiled into the binary. The value of this
15440 option is used only when &%exim_user%& is also set. Unless it consists entirely
15441 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15442 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15443 security issues.
15444
15445
15446 .option exim_path main string "see below"
15447 .cindex "Exim binary, path name"
15448 This option specifies the path name of the Exim binary, which is used when Exim
15449 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15450 the directory configured at compile time by the BIN_DIRECTORY setting. It
15451 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15452 other place.
15453 &*Warning*&: Do not use a macro to define the value of this option, because
15454 you will break those Exim utilities that scan the configuration file to find
15455 where the binary is. (They then use the &%-bP%& option to extract option
15456 settings such as the value of &%spool_directory%&.)
15457
15458
15459 .option exim_user main string "compile-time configured"
15460 .cindex "uid (user id)" "Exim's own"
15461 .cindex "Exim user"
15462 This option changes the uid under which Exim runs when it gives up root
15463 privilege. The default value is compiled into the binary. Ownership of the run
15464 time configuration file and the use of the &%-C%& and &%-D%& command line
15465 options is checked against the values in the binary, not what is set here.
15466
15467 Unless it consists entirely of digits, the string is looked up using
15468 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15469 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15470 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15471
15472
15473 .new
15474 .option exim_version main string "current version"
15475 .cindex "Exim version"
15476 .cindex customizing "version number"
15477 .cindex "version number of Exim" override
15478 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15479 various places.  Use with care; this may fool stupid security scanners.
15480 .wen
15481
15482
15483 .option extra_local_interfaces main "string list" unset
15484 This option defines network interfaces that are to be considered local when
15485 routing, but which are not used for listening by the daemon. See section
15486 &<<SECTreclocipadd>>& for details.
15487
15488
15489 . Allow this long option name to split; give it unsplit as a fifth argument
15490 . for the automatic .oindex that is generated by .option.
15491
15492 .option "extract_addresses_remove_arguments" main boolean true &&&
15493          extract_addresses_remove_arguments
15494 .oindex "&%-t%&"
15495 .cindex "command line" "addresses with &%-t%&"
15496 .cindex "Sendmail compatibility" "&%-t%& option"
15497 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15498 are present on the command line when the &%-t%& option is used to build an
15499 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15500 line addresses are removed from the recipients list. This is also how Smail
15501 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15502 command line addresses are added to those obtained from the header lines. When
15503 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15504 argument headers. If it is set false, Exim adds rather than removes argument
15505 addresses.
15506
15507
15508 .option finduser_retries main integer 0
15509 .cindex "NIS, retrying user lookups"
15510 On systems running NIS or other schemes in which user and group information is
15511 distributed from a remote system, there can be times when &[getpwnam()]& and
15512 related functions fail, even when given valid data, because things time out.
15513 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15514 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15515 many extra times to find a user or a group, waiting for one second between
15516 retries.
15517
15518 .cindex "&_/etc/passwd_&" "multiple reading of"
15519 You should not set this option greater than zero if your user information is in
15520 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15521 search the file multiple times for non-existent users, and also cause delay.
15522
15523
15524
15525 .option freeze_tell main "string list, comma separated" unset
15526 .cindex "freezing messages" "sending a message when freezing"
15527 On encountering certain errors, or when configured to do so in a system filter,
15528 ACL, or special router, Exim freezes a message. This means that no further
15529 delivery attempts take place until an administrator thaws the message, or the
15530 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15531 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15532 warning message whenever it freezes something, unless the message it is
15533 freezing is a locally-generated bounce message. (Without this exception there
15534 is the possibility of looping.) The warning message is sent to the addresses
15535 supplied as the comma-separated value of this option. If several of the
15536 message's addresses cause freezing, only a single message is sent. If the
15537 freezing was automatic, the reason(s) for freezing can be found in the message
15538 log. If you configure freezing in a filter or ACL, you must arrange for any
15539 logging that you require.
15540
15541
15542 .option gecos_name main string&!! unset
15543 .cindex "HP-UX"
15544 .cindex "&""gecos""& field, parsing"
15545 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15546 password file to hold other information in addition to users' real names. Exim
15547 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15548 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15549 of the field are used unchanged, except that, if an ampersand is encountered,
15550 it is replaced by the user's login name with the first character forced to
15551 upper case, since this is a convention that is observed on many systems.
15552
15553 When these options are set, &%gecos_pattern%& is treated as a regular
15554 expression that is to be applied to the field (again with && replaced by the
15555 login name), and if it matches, &%gecos_name%& is expanded and used as the
15556 user's name.
15557
15558 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15559 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15560 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15561 name terminates at the first comma, the following can be used:
15562 .code
15563 gecos_pattern = ([^,]*)
15564 gecos_name = $1
15565 .endd
15566
15567 .option gecos_pattern main string unset
15568 See &%gecos_name%& above.
15569
15570
15571 .option gnutls_compat_mode main boolean unset
15572 This option controls whether GnuTLS is used in compatibility mode in an Exim
15573 server. This reduces security slightly, but improves interworking with older
15574 implementations of TLS.
15575
15576
15577 .option gnutls_allow_auto_pkcs11 main boolean unset
15578 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15579 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15580
15581 See
15582 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15583 for documentation.
15584
15585
15586
15587 .option headers_charset main string "see below"
15588 This option sets a default character set for translating from encoded MIME
15589 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15590 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15591 ultimate default is ISO-8859-1. For more details see the description of header
15592 insertions in section &<<SECTexpansionitems>>&.
15593
15594
15595
15596 .option header_maxsize main integer "see below"
15597 .cindex "header section" "maximum size of"
15598 .cindex "limit" "size of message header section"
15599 This option controls the overall maximum size of a message's header
15600 section. The default is the value of HEADER_MAXSIZE in
15601 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15602 sections are rejected.
15603
15604
15605 .option header_line_maxsize main integer 0
15606 .cindex "header lines" "maximum size of"
15607 .cindex "limit" "size of one header line"
15608 This option limits the length of any individual header line in a message, after
15609 all the continuations have been joined together. Messages with individual
15610 header lines that are longer than the limit are rejected. The default value of
15611 zero means &"no limit"&.
15612
15613
15614
15615
15616 .option helo_accept_junk_hosts main "host list&!!" unset
15617 .cindex "HELO" "accepting junk data"
15618 .cindex "EHLO" "accepting junk data"
15619 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15620 mail, and gives an error response for invalid data. Unfortunately, there are
15621 some SMTP clients that send syntactic junk. They can be accommodated by setting
15622 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15623 if you want to do semantic checking.
15624 See also &%helo_allow_chars%& for a way of extending the permitted character
15625 set.
15626
15627
15628 .option helo_allow_chars main string unset
15629 .cindex "HELO" "underscores in"
15630 .cindex "EHLO" "underscores in"
15631 .cindex "underscore in EHLO/HELO"
15632 This option can be set to a string of rogue characters that are permitted in
15633 all EHLO and HELO names in addition to the standard letters, digits,
15634 hyphens, and dots. If you really must allow underscores, you can set
15635 .code
15636 helo_allow_chars = _
15637 .endd
15638 Note that the value is one string, not a list.
15639
15640
15641 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15642 .cindex "HELO" "forcing reverse lookup"
15643 .cindex "EHLO" "forcing reverse lookup"
15644 If the domain given by a client in a HELO or EHLO command matches this
15645 list, a reverse lookup is done in order to establish the host's true name. The
15646 default forces a lookup if the client host gives the server's name or any of
15647 its IP addresses (in brackets), something that broken clients have been seen to
15648 do.
15649
15650
15651 .option helo_try_verify_hosts main "host list&!!" unset
15652 .cindex "HELO verifying" "optional"
15653 .cindex "EHLO" "verifying, optional"
15654 By default, Exim just checks the syntax of HELO and EHLO commands (see
15655 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15656 to do more extensive checking of the data supplied by these commands. The ACL
15657 condition &`verify = helo`& is provided to make this possible.
15658 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15659 to force the check to occur. From release 4.53 onwards, this is no longer
15660 necessary. If the check has not been done before &`verify = helo`& is
15661 encountered, it is done at that time. Consequently, this option is obsolete.
15662 Its specification is retained here for backwards compatibility.
15663
15664 When an EHLO or HELO command is received, if the calling host matches
15665 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15666 EHLO command either:
15667
15668 .ilist
15669 is an IP literal matching the calling address of the host, or
15670 .next
15671 .cindex "DNS" "reverse lookup"
15672 .cindex "reverse DNS lookup"
15673 matches the host name that Exim obtains by doing a reverse lookup of the
15674 calling host address, or
15675 .next
15676 when looked up in DNS yields the calling host address.
15677 .endlist
15678
15679 However, the EHLO or HELO command is not rejected if any of the checks
15680 fail. Processing continues, but the result of the check is remembered, and can
15681 be detected later in an ACL by the &`verify = helo`& condition.
15682
15683 If DNS was used for successful verification, the variable
15684 .cindex "DNS" "DNSSEC"
15685 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15686
15687 .option helo_verify_hosts main "host list&!!" unset
15688 .cindex "HELO verifying" "mandatory"
15689 .cindex "EHLO" "verifying, mandatory"
15690 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15691 backwards compatibility. For hosts that match this option, Exim checks the host
15692 name given in the HELO or EHLO in the same way as for
15693 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15694 rejected with a 550 error, and entries are written to the main and reject logs.
15695 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15696 error.
15697
15698 .option hold_domains main "domain list&!!" unset
15699 .cindex "domain" "delaying delivery"
15700 .cindex "delivery" "delaying certain domains"
15701 This option allows mail for particular domains to be held in the queue
15702 manually. The option is overridden if a message delivery is forced with the
15703 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15704 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15705 item in &%hold_domains%&, no routing or delivery for that address is done, and
15706 it is deferred every time the message is looked at.
15707
15708 This option is intended as a temporary operational measure for delaying the
15709 delivery of mail while some problem is being sorted out, or some new
15710 configuration tested. If you just want to delay the processing of some
15711 domains until a queue run occurs, you should use &%queue_domains%& or
15712 &%queue_smtp_domains%&, not &%hold_domains%&.
15713
15714 A setting of &%hold_domains%& does not override Exim's code for removing
15715 messages from the queue if they have been there longer than the longest retry
15716 time in any retry rule. If you want to hold messages for longer than the normal
15717 retry times, insert a dummy retry rule with a long retry time.
15718
15719
15720 .option host_lookup main "host list&!!" unset
15721 .cindex "host name" "lookup, forcing"
15722 Exim does not look up the name of a calling host from its IP address unless it
15723 is required to compare against some host list, or the host matches
15724 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15725 option (which normally contains IP addresses rather than host names). The
15726 default configuration file contains
15727 .code
15728 host_lookup = *
15729 .endd
15730 which causes a lookup to happen for all hosts. If the expense of these lookups
15731 is felt to be too great, the setting can be changed or removed.
15732
15733 After a successful reverse lookup, Exim does a forward lookup on the name it
15734 has obtained, to verify that it yields the IP address that it started with. If
15735 this check fails, Exim behaves as if the name lookup failed.
15736
15737 .vindex "&$host_lookup_failed$&"
15738 .vindex "&$sender_host_name$&"
15739 After any kind of failure, the host name (in &$sender_host_name$&) remains
15740 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15741 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15742 &`verify = reverse_host_lookup`& in ACLs.
15743
15744
15745 .option host_lookup_order main "string list" &`bydns:byaddr`&
15746 This option specifies the order of different lookup methods when Exim is trying
15747 to find a host name from an IP address. The default is to do a DNS lookup
15748 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15749 if that fails. You can change the order of these lookups, or omit one entirely,
15750 if you want.
15751
15752 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15753 multiple PTR records in the DNS and the IP address is not listed in
15754 &_/etc/hosts_&. Different operating systems give different results in this
15755 case. That is why the default tries a DNS lookup first.
15756
15757
15758
15759 .option host_reject_connection main "host list&!!" unset
15760 .cindex "host" "rejecting connections from"
15761 If this option is set, incoming SMTP calls from the hosts listed are rejected
15762 as soon as the connection is made.
15763 This option is obsolete, and retained only for backward compatibility, because
15764 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15765 connections immediately.
15766
15767 The ability to give an immediate rejection (either by this option or using an
15768 ACL) is provided for use in unusual cases. Many hosts will just try again,
15769 sometimes without much delay. Normally, it is better to use an ACL to reject
15770 incoming messages at a later stage, such as after RCPT commands. See
15771 chapter &<<CHAPACL>>&.
15772
15773
15774 .option hosts_connection_nolog main "host list&!!" unset
15775 .cindex "host" "not logging connections from"
15776 This option defines a list of hosts for which connection logging does not
15777 happen, even though the &%smtp_connection%& log selector is set. For example,
15778 you might want not to log SMTP connections from local processes, or from
15779 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15780 the daemon; you should therefore strive to restrict its value to a short inline
15781 list of IP addresses and networks. To disable logging SMTP connections from
15782 local processes, you must create a host list with an empty item. For example:
15783 .code
15784 hosts_connection_nolog = :
15785 .endd
15786 If the &%smtp_connection%& log selector is not set, this option has no effect.
15787
15788
15789
15790 .option hosts_proxy main "host list&!!" unset
15791 .cindex proxy "proxy protocol"
15792 This option enables use of Proxy Protocol proxies for incoming
15793 connections.  For details see section &<<SECTproxyInbound>>&.
15794
15795
15796 .option hosts_treat_as_local main "domain list&!!" unset
15797 .cindex "local host" "domains treated as"
15798 .cindex "host" "treated as local"
15799 If this option is set, any host names that match the domain list are treated as
15800 if they were the local host when Exim is scanning host lists obtained from MX
15801 records
15802 or other sources. Note that the value of this option is a domain list, not a
15803 host list, because it is always used to check host names, not IP addresses.
15804
15805 This option also applies when Exim is matching the special items
15806 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15807 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15808 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15809 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15810 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15811 interfaces and recognizing the local host.
15812
15813
15814 .option ibase_servers main "string list" unset
15815 .cindex "InterBase" "server list"
15816 This option provides a list of InterBase servers and associated connection data,
15817 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15818 The option is available only if Exim has been built with InterBase support.
15819
15820
15821
15822 .option ignore_bounce_errors_after main time 10w
15823 .cindex "bounce message" "discarding"
15824 .cindex "discarding bounce message"
15825 This option affects the processing of bounce messages that cannot be delivered,
15826 that is, those that suffer a permanent delivery failure. (Bounce messages that
15827 suffer temporary delivery failures are of course retried in the usual way.)
15828
15829 After a permanent delivery failure, bounce messages are frozen,
15830 because there is no sender to whom they can be returned. When a frozen bounce
15831 message has been in the queue for more than the given time, it is unfrozen at
15832 the next queue run, and a further delivery is attempted. If delivery fails
15833 again, the bounce message is discarded. This makes it possible to keep failed
15834 bounce messages around for a shorter time than the normal maximum retry time
15835 for frozen messages. For example,
15836 .code
15837 ignore_bounce_errors_after = 12h
15838 .endd
15839 retries failed bounce message deliveries after 12 hours, discarding any further
15840 failures. If the value of this option is set to a zero time period, bounce
15841 failures are discarded immediately. Setting a very long time (as in the default
15842 value) has the effect of disabling this option. For ways of automatically
15843 dealing with other kinds of frozen message, see &%auto_thaw%& and
15844 &%timeout_frozen_after%&.
15845
15846
15847 .option ignore_fromline_hosts main "host list&!!" unset
15848 .cindex "&""From""& line"
15849 .cindex "UUCP" "&""From""& line"
15850 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15851 the headers of a message. By default this is treated as the start of the
15852 message's body, which means that any following headers are not recognized as
15853 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15854 match those hosts that insist on sending it. If the sender is actually a local
15855 process rather than a remote host, and is using &%-bs%& to inject the messages,
15856 &%ignore_fromline_local%& must be set to achieve this effect.
15857
15858
15859 .option ignore_fromline_local main boolean false
15860 See &%ignore_fromline_hosts%& above.
15861
15862 .option keep_environment main "string list" unset
15863 .cindex "environment" "values from"
15864 This option contains a string list of environment variables to keep.
15865 You have to trust these variables or you have to be sure that
15866 these variables do not impose any security risk. Keep in mind that
15867 during the startup phase Exim is running with an effective UID 0 in most
15868 installations. As the default value is an empty list, the default
15869 environment for using libraries, running embedded Perl code, or running
15870 external binaries is empty, and does not not even contain PATH or HOME.
15871
15872 Actually the list is interpreted as a list of patterns
15873 (&<<SECTlistexpand>>&), except that it is not expanded first.
15874
15875 WARNING: Macro substitution is still done first, so having a macro
15876 FOO and having FOO_HOME in your &%keep_environment%& option may have
15877 unexpected results. You may work around this using a regular expression
15878 that does not match the macro name: ^[F]OO_HOME$.
15879
15880 Current versions of Exim issue a warning during startup if you do not mention
15881 &%keep_environment%& in your runtime configuration file and if your
15882 current environment is not empty. Future versions may not issue that warning
15883 anymore.
15884
15885 See the &%add_environment%& main config option for a way to set
15886 environment variables to a fixed value.  The environment for &(pipe)&
15887 transports is handled separately, see section &<<SECTpipeenv>>& for
15888 details.
15889
15890
15891 .option keep_malformed main time 4d
15892 This option specifies the length of time to keep messages whose spool files
15893 have been corrupted in some way. This should, of course, never happen. At the
15894 next attempt to deliver such a message, it gets removed. The incident is
15895 logged.
15896
15897
15898 .option ldap_ca_cert_dir main string unset
15899 .cindex "LDAP", "TLS CA certificate directory"
15900 .cindex certificate "directory for LDAP"
15901 This option indicates which directory contains CA certificates for verifying
15902 a TLS certificate presented by an LDAP server.
15903 While Exim does not provide a default value, your SSL library may.
15904 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15905 and constrained to be a directory.
15906
15907
15908 .option ldap_ca_cert_file main string unset
15909 .cindex "LDAP", "TLS CA certificate file"
15910 .cindex certificate "file for LDAP"
15911 This option indicates which file contains CA certificates for verifying
15912 a TLS certificate presented by an LDAP server.
15913 While Exim does not provide a default value, your SSL library may.
15914 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15915 and constrained to be a file.
15916
15917
15918 .option ldap_cert_file main string unset
15919 .cindex "LDAP" "TLS client certificate file"
15920 .cindex certificate "file for LDAP"
15921 This option indicates which file contains an TLS client certificate which
15922 Exim should present to the LDAP server during TLS negotiation.
15923 Should be used together with &%ldap_cert_key%&.
15924
15925
15926 .option ldap_cert_key main string unset
15927 .cindex "LDAP" "TLS client key file"
15928 .cindex certificate "key for LDAP"
15929 This option indicates which file contains the secret/private key to use
15930 to prove identity to the LDAP server during TLS negotiation.
15931 Should be used together with &%ldap_cert_file%&, which contains the
15932 identity to be proven.
15933
15934
15935 .option ldap_cipher_suite main string unset
15936 .cindex "LDAP" "TLS cipher suite"
15937 This controls the TLS cipher-suite negotiation during TLS negotiation with
15938 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15939 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15940
15941
15942 .option ldap_default_servers main "string list" unset
15943 .cindex "LDAP" "default servers"
15944 This option provides a list of LDAP servers which are tried in turn when an
15945 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15946 details of LDAP queries. This option is available only when Exim has been built
15947 with LDAP support.
15948
15949
15950 .option ldap_require_cert main string unset.
15951 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15952 This should be one of the values "hard", "demand", "allow", "try" or "never".
15953 A value other than one of these is interpreted as "never".
15954 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15955 Although Exim does not set a default, the LDAP library probably defaults
15956 to hard/demand.
15957
15958
15959 .option ldap_start_tls main boolean false
15960 .cindex "LDAP" "whether or not to negotiate TLS"
15961 If set, Exim will attempt to negotiate TLS with the LDAP server when
15962 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15963 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15964 of SSL-on-connect.
15965 In the event of failure to negotiate TLS, the action taken is controlled
15966 by &%ldap_require_cert%&.
15967 This option is ignored for &`ldapi`& connections.
15968
15969
15970 .option ldap_version main integer unset
15971 .cindex "LDAP" "protocol version, forcing"
15972 This option can be used to force Exim to set a specific protocol version for
15973 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15974 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15975 the LDAP headers; otherwise it is 2. This option is available only when Exim
15976 has been built with LDAP support.
15977
15978
15979
15980 .option local_from_check main boolean true
15981 .cindex "&'Sender:'& header line" "disabling addition of"
15982 .cindex "&'From:'& header line" "disabling checking of"
15983 When a message is submitted locally (that is, not over a TCP/IP connection) by
15984 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15985 checks that the &'From:'& header line matches the login of the calling user and
15986 the domain specified by &%qualify_domain%&.
15987
15988 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15989 locally submitted message is automatically qualified by Exim, unless the
15990 &%-bnq%& command line option is used.
15991
15992 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15993 on the local part. If the &'From:'& header line does not match, Exim adds a
15994 &'Sender:'& header with an address constructed from the calling user's login
15995 and the default qualify domain.
15996
15997 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15998 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15999 &'Sender:'& header lines supplied by untrusted users, you must also set
16000 &%local_sender_retain%& to be true.
16001
16002 .cindex "envelope from"
16003 .cindex "envelope sender"
16004 These options affect only the header lines in the message. The envelope sender
16005 is still forced to be the login id at the qualify domain unless
16006 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16007
16008 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16009 request similar header line checking. See section &<<SECTthesenhea>>&, which
16010 has more details about &'Sender:'& processing.
16011
16012
16013
16014
16015 .option local_from_prefix main string unset
16016 When Exim checks the &'From:'& header line of locally submitted messages for
16017 matching the login id (see &%local_from_check%& above), it can be configured to
16018 ignore certain prefixes and suffixes in the local part of the address. This is
16019 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16020 appropriate lists, in the same form as the &%local_part_prefix%& and
16021 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16022 example, if
16023 .code
16024 local_from_prefix = *-
16025 .endd
16026 is set, a &'From:'& line containing
16027 .code
16028 From: anything-user@your.domain.example
16029 .endd
16030 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16031 matches the actual sender address that is constructed from the login name and
16032 qualify domain.
16033
16034
16035 .option local_from_suffix main string unset
16036 See &%local_from_prefix%& above.
16037
16038
16039 .option local_interfaces main "string list" "see below"
16040 This option controls which network interfaces are used by the daemon for
16041 listening; they are also used to identify the local host when routing. Chapter
16042 &<<CHAPinterfaces>>& contains a full description of this option and the related
16043 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16044 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16045 &%local_interfaces%& is
16046 .code
16047 local_interfaces = 0.0.0.0
16048 .endd
16049 when Exim is built without IPv6 support; otherwise it is
16050 .code
16051 local_interfaces = <; ::0 ; 0.0.0.0
16052 .endd
16053
16054 .option local_scan_timeout main time 5m
16055 .cindex "timeout" "for &[local_scan()]& function"
16056 .cindex "&[local_scan()]& function" "timeout"
16057 This timeout applies to the &[local_scan()]& function (see chapter
16058 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16059 the incoming message is rejected with a temporary error if it is an SMTP
16060 message. For a non-SMTP message, the message is dropped and Exim ends with a
16061 non-zero code. The incident is logged on the main and reject logs.
16062
16063
16064
16065 .option local_sender_retain main boolean false
16066 .cindex "&'Sender:'& header line" "retaining from local submission"
16067 When a message is submitted locally (that is, not over a TCP/IP connection) by
16068 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16069 do not want this to happen, you must set &%local_sender_retain%&, and you must
16070 also set &%local_from_check%& to be false (Exim will complain if you do not).
16071 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16072 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16073
16074
16075
16076
16077 .option localhost_number main string&!! unset
16078 .cindex "host" "locally unique number for"
16079 .cindex "message ids" "with multiple hosts"
16080 .vindex "&$localhost_number$&"
16081 Exim's message ids are normally unique only within the local host. If
16082 uniqueness among a set of hosts is required, each host must set a different
16083 value for the &%localhost_number%& option. The string is expanded immediately
16084 after reading the configuration file (so that a number can be computed from the
16085 host name, for example) and the result of the expansion must be a number in the
16086 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16087 systems). This is available in subsequent string expansions via the variable
16088 &$localhost_number$&. When &%localhost_number is set%&, the final two
16089 characters of the message id, instead of just being a fractional part of the
16090 time, are computed from the time and the local host number as described in
16091 section &<<SECTmessiden>>&.
16092
16093
16094
16095 .option log_file_path main "string list&!!" "set at compile time"
16096 .cindex "log" "file path for"
16097 This option sets the path which is used to determine the names of Exim's log
16098 files, or indicates that logging is to be to syslog, or both. It is expanded
16099 when Exim is entered, so it can, for example, contain a reference to the host
16100 name. If no specific path is set for the log files at compile or runtime,
16101 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16102 they are written in a sub-directory called &_log_& in Exim's spool directory.
16103 .new
16104 A path must start with a slash.
16105 To send to syslog, use the word &"syslog"&.
16106 .wen
16107 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16108 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16109 used. If this string is fixed at your installation (contains no expansion
16110 variables) it is recommended that you do not set this option in the
16111 configuration file, but instead supply the path using LOG_FILE_PATH in
16112 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16113 early on &-- in particular, failure to read the configuration file.
16114
16115
16116 .option log_selector main string unset
16117 .cindex "log" "selectors"
16118 This option can be used to reduce or increase the number of things that Exim
16119 writes to its log files. Its argument is made up of names preceded by plus or
16120 minus characters. For example:
16121 .code
16122 log_selector = +arguments -retry_defer
16123 .endd
16124 A list of possible names and what they control is given in the chapter on
16125 logging, in section &<<SECTlogselector>>&.
16126
16127
16128 .option log_timezone main boolean false
16129 .cindex "log" "timezone for entries"
16130 .vindex "&$tod_log$&"
16131 .vindex "&$tod_zone$&"
16132 By default, the timestamps on log lines are in local time without the
16133 timezone. This means that if your timezone changes twice a year, the timestamps
16134 in log lines are ambiguous for an hour when the clocks go back. One way of
16135 avoiding this problem is to set the timezone to UTC. An alternative is to set
16136 &%log_timezone%& true. This turns on the addition of the timezone offset to
16137 timestamps in log lines. Turning on this option can add quite a lot to the size
16138 of log files because each line is extended by 6 characters. Note that the
16139 &$tod_log$& variable contains the log timestamp without the zone, but there is
16140 another variable called &$tod_zone$& that contains just the timezone offset.
16141
16142
16143 .option lookup_open_max main integer 25
16144 .cindex "too many open files"
16145 .cindex "open files, too many"
16146 .cindex "file" "too many open"
16147 .cindex "lookup" "maximum open files"
16148 .cindex "limit" "open files for lookups"
16149 This option limits the number of simultaneously open files for single-key
16150 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16151 Exim normally keeps these files open during routing, because often the same
16152 file is required several times. If the limit is reached, Exim closes the least
16153 recently used file. Note that if you are using the &'ndbm'& library, it
16154 actually opens two files for each logical DBM database, though it still counts
16155 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16156 open files"& errors with NDBM, you need to reduce the value of
16157 &%lookup_open_max%&.
16158
16159
16160 .option max_username_length main integer 0
16161 .cindex "length of login name"
16162 .cindex "user name" "maximum length"
16163 .cindex "limit" "user name length"
16164 Some operating systems are broken in that they truncate long arguments to
16165 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16166 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16167 an argument that is longer behaves as if &[getpwnam()]& failed.
16168
16169
16170 .option message_body_newlines main bool false
16171 .cindex "message body" "newlines in variables"
16172 .cindex "newline" "in message body variables"
16173 .vindex "&$message_body$&"
16174 .vindex "&$message_body_end$&"
16175 By default, newlines in the message body are replaced by spaces when setting
16176 the &$message_body$& and &$message_body_end$& expansion variables. If this
16177 option is set true, this no longer happens.
16178
16179
16180 .option message_body_visible main integer 500
16181 .cindex "body of message" "visible size"
16182 .cindex "message body" "visible size"
16183 .vindex "&$message_body$&"
16184 .vindex "&$message_body_end$&"
16185 This option specifies how much of a message's body is to be included in the
16186 &$message_body$& and &$message_body_end$& expansion variables.
16187
16188
16189 .option message_id_header_domain main string&!! unset
16190 .cindex "&'Message-ID:'& header line"
16191 If this option is set, the string is expanded and used as the right hand side
16192 (domain) of the &'Message-ID:'& header that Exim creates if a
16193 locally-originated incoming message does not have one. &"Locally-originated"&
16194 means &"not received over TCP/IP."&
16195 Otherwise, the primary host name is used.
16196 Only letters, digits, dot and hyphen are accepted; any other characters are
16197 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16198 empty string, the option is ignored.
16199
16200
16201 .option message_id_header_text main string&!! unset
16202 If this variable is set, the string is expanded and used to augment the text of
16203 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16204 message does not have one. The text of this header is required by RFC 2822 to
16205 take the form of an address. By default, Exim uses its internal message id as
16206 the local part, and the primary host name as the domain. If this option is set,
16207 it is expanded, and provided the expansion is not forced to fail, and does not
16208 yield an empty string, the result is inserted into the header immediately
16209 before the @, separated from the internal message id by a dot. Any characters
16210 that are illegal in an address are automatically converted into hyphens. This
16211 means that variables such as &$tod_log$& can be used, because the spaces and
16212 colons will become hyphens.
16213
16214
16215 .option message_logs main boolean true
16216 .cindex "message logs" "disabling"
16217 .cindex "log" "message log; disabling"
16218 If this option is turned off, per-message log files are not created in the
16219 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16220 Exim, by reducing the number of files involved in handling a message from a
16221 minimum of four (header spool file, body spool file, delivery journal, and
16222 per-message log) to three. The other major I/O activity is Exim's main log,
16223 which is not affected by this option.
16224
16225
16226 .option message_size_limit main string&!! 50M
16227 .cindex "message" "size limit"
16228 .cindex "limit" "message size"
16229 .cindex "size" "of message, limit"
16230 This option limits the maximum size of message that Exim will process. The
16231 value is expanded for each incoming connection so, for example, it can be made
16232 to depend on the IP address of the remote host for messages arriving via
16233 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16234 optionally followed by K or M.
16235
16236 &*Note*&: This limit cannot be made to depend on a message's sender or any
16237 other properties of an individual message, because it has to be advertised in
16238 the server's response to EHLO. String expansion failure causes a temporary
16239 error. A value of zero means no limit, but its use is not recommended. See also
16240 &%bounce_return_size_limit%&.
16241
16242 Incoming SMTP messages are failed with a 552 error if the limit is
16243 exceeded; locally-generated messages either get a stderr message or a delivery
16244 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16245 an oversized message is logged in both the main and the reject logs. See also
16246 the generic transport option &%message_size_limit%&, which limits the size of
16247 message that an individual transport can process.
16248
16249 If you use a virus-scanner and set this option to to a value larger than the
16250 maximum size that your virus-scanner is configured to support, you may get
16251 failures triggered by large mails.  The right size to configure for the
16252 virus-scanner depends upon what data is passed and the options in use but it's
16253 probably safest to just set it to a little larger than this value.  E.g., with a
16254 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16255 some problems may result.
16256
16257 A value of 0 will disable size limit checking; Exim will still advertise the
16258 SIZE extension in an EHLO response, but without a limit, so as to permit
16259 SMTP clients to still indicate the message size along with the MAIL verb.
16260
16261
16262 .option move_frozen_messages main boolean false
16263 .cindex "frozen messages" "moving"
16264 This option, which is available only if Exim has been built with the setting
16265 .code
16266 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16267 .endd
16268 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16269 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16270 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16271 standard utilities for handling such moved messages, and they do not show up in
16272 lists generated by &%-bp%& or by the Exim monitor.
16273
16274
16275 .option mua_wrapper main boolean false
16276 Setting this option true causes Exim to run in a very restrictive mode in which
16277 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16278 contains a full description of this facility.
16279
16280
16281
16282 .option mysql_servers main "string list" unset
16283 .cindex "MySQL" "server list"
16284 This option provides a list of MySQL servers and associated connection data, to
16285 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16286 option is available only if Exim has been built with MySQL support.
16287
16288
16289 .option never_users main "string list&!!" unset
16290 This option is expanded just once, at the start of Exim's processing. Local
16291 message deliveries are normally run in processes that are setuid to the
16292 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16293 It is usually desirable to prevent any deliveries from running as root, as a
16294 safety precaution.
16295
16296 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16297 list of users that must not be used for local deliveries. This list is fixed in
16298 the binary and cannot be overridden by the configuration file. By default, it
16299 contains just the single user name &"root"&. The &%never_users%& runtime option
16300 can be used to add more users to the fixed list.
16301
16302 If a message is to be delivered as one of the users on the fixed list or the
16303 &%never_users%& list, an error occurs, and delivery is deferred. A common
16304 example is
16305 .code
16306 never_users = root:daemon:bin
16307 .endd
16308 Including root is redundant if it is also on the fixed list, but it does no
16309 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16310 transport driver.
16311
16312
16313 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16314 .cindex "OpenSSL "compatibility options"
16315 This option allows an administrator to adjust the SSL options applied
16316 by OpenSSL to connections.  It is given as a space-separated list of items,
16317 each one to be +added or -subtracted from the current value.
16318
16319 This option is only available if Exim is built against OpenSSL.  The values
16320 available for this option vary according to the age of your OpenSSL install.
16321 The &"all"& value controls a subset of flags which are available, typically
16322 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16323 list the values known on your system and Exim should support all the
16324 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16325 names lose the leading &"SSL_OP_"& and are lower-cased.
16326
16327 Note that adjusting the options can have severe impact upon the security of
16328 SSL as used by Exim.  It is possible to disable safety checks and shoot
16329 yourself in the foot in various unpleasant ways.  This option should not be
16330 adjusted lightly.  An unrecognised item will be detected at startup, by
16331 invoking Exim with the &%-bV%& flag.
16332
16333 The option affects Exim operating both as a server and as a client.
16334
16335 Historical note: prior to release 4.80, Exim defaulted this value to
16336 "+dont_insert_empty_fragments", which may still be needed for compatibility
16337 with some clients, but which lowers security by increasing exposure to
16338 some now infamous attacks.
16339
16340 Examples:
16341 .code
16342 # Make both old MS and old Eudora happy:
16343 openssl_options = -all +microsoft_big_sslv3_buffer \
16344                        +dont_insert_empty_fragments
16345
16346 # Disable older protocol versions:
16347 openssl_options = +no_sslv2 +no_sslv3
16348 .endd
16349
16350 Possible options may include:
16351 .ilist
16352 &`all`&
16353 .next
16354 &`allow_unsafe_legacy_renegotiation`&
16355 .next
16356 &`cipher_server_preference`&
16357 .next
16358 &`dont_insert_empty_fragments`&
16359 .next
16360 &`ephemeral_rsa`&
16361 .next
16362 &`legacy_server_connect`&
16363 .next
16364 &`microsoft_big_sslv3_buffer`&
16365 .next
16366 &`microsoft_sess_id_bug`&
16367 .next
16368 &`msie_sslv2_rsa_padding`&
16369 .next
16370 &`netscape_challenge_bug`&
16371 .next
16372 &`netscape_reuse_cipher_change_bug`&
16373 .next
16374 &`no_compression`&
16375 .next
16376 &`no_session_resumption_on_renegotiation`&
16377 .next
16378 &`no_sslv2`&
16379 .next
16380 &`no_sslv3`&
16381 .next
16382 &`no_ticket`&
16383 .next
16384 &`no_tlsv1`&
16385 .next
16386 &`no_tlsv1_1`&
16387 .next
16388 &`no_tlsv1_2`&
16389 .next
16390 &`safari_ecdhe_ecdsa_bug`&
16391 .next
16392 &`single_dh_use`&
16393 .next
16394 &`single_ecdh_use`&
16395 .next
16396 &`ssleay_080_client_dh_bug`&
16397 .next
16398 &`sslref2_reuse_cert_type_bug`&
16399 .next
16400 &`tls_block_padding_bug`&
16401 .next
16402 &`tls_d5_bug`&
16403 .next
16404 &`tls_rollback_bug`&
16405 .endlist
16406
16407 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16408 all clients connecting using the MacOS SecureTransport TLS facility prior
16409 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16410 to negotiate TLS then this option value might help, provided that your OpenSSL
16411 release is new enough to contain this work-around.  This may be a situation
16412 where you have to upgrade OpenSSL to get buggy clients working.
16413
16414
16415 .option oracle_servers main "string list" unset
16416 .cindex "Oracle" "server list"
16417 This option provides a list of Oracle servers and associated connection data,
16418 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16419 The option is available only if Exim has been built with Oracle support.
16420
16421
16422 .option percent_hack_domains main "domain list&!!" unset
16423 .cindex "&""percent hack""&"
16424 .cindex "source routing" "in email address"
16425 .cindex "address" "source-routed"
16426 The &"percent hack"& is the convention whereby a local part containing a
16427 percent sign is re-interpreted as a new email address, with the percent
16428 replaced by @. This is sometimes called &"source routing"&, though that term is
16429 also applied to RFC 2822 addresses that begin with an @ character. If this
16430 option is set, Exim implements the percent facility for those domains listed,
16431 but no others. This happens before an incoming SMTP address is tested against
16432 an ACL.
16433
16434 &*Warning*&: The &"percent hack"& has often been abused by people who are
16435 trying to get round relaying restrictions. For this reason, it is best avoided
16436 if at all possible. Unfortunately, a number of less security-conscious MTAs
16437 implement it unconditionally. If you are running Exim on a gateway host, and
16438 routing mail through to internal MTAs without processing the local parts, it is
16439 a good idea to reject recipient addresses with percent characters in their
16440 local parts. Exim's default configuration does this.
16441
16442
16443 .option perl_at_start main boolean false
16444 .cindex "Perl"
16445 This option is available only when Exim is built with an embedded Perl
16446 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16447
16448
16449 .option perl_startup main string unset
16450 .cindex "Perl"
16451 This option is available only when Exim is built with an embedded Perl
16452 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16453
16454 .option perl_startup main boolean false
16455 .cindex "Perl"
16456 This Option enables the taint mode of the embedded Perl interpreter.
16457
16458
16459 .option pgsql_servers main "string list" unset
16460 .cindex "PostgreSQL lookup type" "server list"
16461 This option provides a list of PostgreSQL servers and associated connection
16462 data, to be used in conjunction with &(pgsql)& lookups (see section
16463 &<<SECID72>>&). The option is available only if Exim has been built with
16464 PostgreSQL support.
16465
16466
16467 .option pid_file_path main string&!! "set at compile time"
16468 .cindex "daemon" "pid file path"
16469 .cindex "pid file, path for"
16470 This option sets the name of the file to which the Exim daemon writes its
16471 process id. The string is expanded, so it can contain, for example, references
16472 to the host name:
16473 .code
16474 pid_file_path = /var/log/$primary_hostname/exim.pid
16475 .endd
16476 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16477 spool directory.
16478 The value set by the option can be overridden by the &%-oP%& command line
16479 option. A pid file is not written if a &"non-standard"& daemon is run by means
16480 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16481
16482
16483 .option pipelining_advertise_hosts main "host list&!!" *
16484 .cindex "PIPELINING" "suppressing advertising"
16485 This option can be used to suppress the advertisement of the SMTP
16486 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16487 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16488 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16489 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16490 that clients will use it; &"out of order"& commands that are &"expected"& do
16491 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16492
16493 .new
16494 .option pipelining_connect_advertise_hosts main "host list&!!" *
16495 .cindex "pipelining" "early connection"
16496 .cindex "pipelining" PIPE_CONNECT
16497 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16498 this option controls which hosts the facility is advertised to
16499 and from which pipeline early-connection (before MAIL) SMTP
16500 commands are acceptable.
16501 When used, the pipelining saves on roundtrip times.
16502
16503 See also the &%hosts_pipe_connect%& smtp transport option.
16504
16505 Currently the option name &"X_PIPE_CONNECT"& is used.
16506 .wen
16507
16508
16509 .option prdr_enable main boolean false
16510 .cindex "PRDR" "enabling on server"
16511 This option can be used to enable the Per-Recipient Data Response extension
16512 to SMTP, defined by Eric Hall.
16513 If the option is set, PRDR is advertised by Exim when operating as a server.
16514 If the client requests PRDR, and more than one recipient, for a message
16515 an additional ACL is called for each recipient after the message content
16516 is received.  See section &<<SECTPRDRACL>>&.
16517
16518 .option preserve_message_logs main boolean false
16519 .cindex "message logs" "preserving"
16520 If this option is set, message log files are not deleted when messages are
16521 completed. Instead, they are moved to a sub-directory of the spool directory
16522 called &_msglog.OLD_&, where they remain available for statistical or debugging
16523 purposes. This is a dangerous option to set on systems with any appreciable
16524 volume of mail. Use with care!
16525
16526
16527 .option primary_hostname main string "see below"
16528 .cindex "name" "of local host"
16529 .cindex "host" "name of local"
16530 .cindex "local host" "name of"
16531 .vindex "&$primary_hostname$&"
16532 This specifies the name of the current host. It is used in the default EHLO or
16533 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16534 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16535 The value is also used by default in some SMTP response messages from an Exim
16536 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16537
16538 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16539 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16540 contains only one component, Exim passes it to &[gethostbyname()]& (or
16541 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16542 version. The variable &$primary_hostname$& contains the host name, whether set
16543 explicitly by this option, or defaulted.
16544
16545
16546 .option print_topbitchars main boolean false
16547 .cindex "printing characters"
16548 .cindex "8-bit characters"
16549 By default, Exim considers only those characters whose codes lie in the range
16550 32&--126 to be printing characters. In a number of circumstances (for example,
16551 when writing log entries) non-printing characters are converted into escape
16552 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16553 is set, code values of 128 and above are also considered to be printing
16554 characters.
16555
16556 This option also affects the header syntax checks performed by the
16557 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16558 the user's full name when constructing From: and Sender: addresses (as
16559 described in section &<<SECTconstr>>&). Setting this option can cause
16560 Exim to generate eight bit message headers that do not conform to the
16561 standards.
16562
16563
16564 .option process_log_path main string unset
16565 .cindex "process log path"
16566 .cindex "log" "process log"
16567 .cindex "&'exiwhat'&"
16568 This option sets the name of the file to which an Exim process writes its
16569 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16570 utility script. If this option is unset, the file called &_exim-process.info_&
16571 in Exim's spool directory is used. The ability to specify the name explicitly
16572 can be useful in environments where two different Exims are running, using
16573 different spool directories.
16574
16575
16576 .option prod_requires_admin main boolean true
16577 .cindex "restricting access to features"
16578 .oindex "&%-M%&"
16579 .oindex "&%-R%&"
16580 .oindex "&%-q%&"
16581 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16582 admin user unless &%prod_requires_admin%& is set false. See also
16583 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16584
16585
16586 .option qualify_domain main string "see below"
16587 .cindex "domain" "for qualifying addresses"
16588 .cindex "address" "qualification"
16589 This option specifies the domain name that is added to any envelope sender
16590 addresses that do not have a domain qualification. It also applies to
16591 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16592 are accepted by default only for locally-generated messages. Qualification is
16593 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16594 locally-generated messages, unless the &%-bnq%& command line option is used.
16595
16596 Messages from external sources must always contain fully qualified addresses,
16597 unless the sending host matches &%sender_unqualified_hosts%& or
16598 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16599 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16600 necessary. Internally, Exim always works with fully qualified envelope
16601 addresses. If &%qualify_domain%& is not set, it defaults to the
16602 &%primary_hostname%& value.
16603
16604
16605 .option qualify_recipient main string "see below"
16606 This option allows you to specify a different domain for qualifying recipient
16607 addresses to the one that is used for senders. See &%qualify_domain%& above.
16608
16609
16610
16611 .option queue_domains main "domain list&!!" unset
16612 .cindex "domain" "specifying non-immediate delivery"
16613 .cindex "queueing incoming messages"
16614 .cindex "message" "queueing certain domains"
16615 This option lists domains for which immediate delivery is not required.
16616 A delivery process is started whenever a message is received, but only those
16617 domains that do not match are processed. All other deliveries wait until the
16618 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16619
16620
16621 .option queue_list_requires_admin main boolean true
16622 .cindex "restricting access to features"
16623 .oindex "&%-bp%&"
16624 The &%-bp%& command-line option, which lists the messages that are on the
16625 queue, requires the caller to be an admin user unless
16626 &%queue_list_requires_admin%& is set false.
16627 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16628
16629
16630 .option queue_only main boolean false
16631 .cindex "queueing incoming messages"
16632 .cindex "message" "queueing unconditionally"
16633 If &%queue_only%& is set, a delivery process is not automatically started
16634 whenever a message is received. Instead, the message waits in the queue for the
16635 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16636 delivered immediately when certain conditions (such as heavy load) occur.
16637
16638 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16639 and &%-odi%& command line options override &%queue_only%& unless
16640 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16641 &%queue_only_load%&, and &%smtp_accept_queue%&.
16642
16643
16644 .option queue_only_file main string unset
16645 .cindex "queueing incoming messages"
16646 .cindex "message" "queueing by file existence"
16647 This option can be set to a colon-separated list of absolute path names, each
16648 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16649 it tests for the existence of each listed path using a call to &[stat()]&. For
16650 each path that exists, the corresponding queueing option is set.
16651 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16652 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16653 .code
16654 queue_only_file = smtp/some/file
16655 .endd
16656 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16657 &_/some/file_& exists.
16658
16659
16660 .option queue_only_load main fixed-point unset
16661 .cindex "load average"
16662 .cindex "queueing incoming messages"
16663 .cindex "message" "queueing by load"
16664 If the system load average is higher than this value, incoming messages from
16665 all sources are queued, and no automatic deliveries are started. If this
16666 happens during local or remote SMTP input, all subsequent messages received on
16667 the same SMTP connection are queued by default, whatever happens to the load in
16668 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16669 false.
16670
16671 Deliveries will subsequently be performed by queue runner processes. This
16672 option has no effect on ancient operating systems on which Exim cannot
16673 determine the load average. See also &%deliver_queue_load_max%& and
16674 &%smtp_load_reserve%&.
16675
16676
16677 .option queue_only_load_latch main boolean true
16678 .cindex "load average" "re-evaluating per message"
16679 When this option is true (the default), once one message has been queued
16680 because the load average is higher than the value set by &%queue_only_load%&,
16681 all subsequent messages received on the same SMTP connection are also queued.
16682 This is a deliberate choice; even though the load average may fall below the
16683 threshold, it doesn't seem right to deliver later messages on the same
16684 connection when not delivering earlier ones. However, there are special
16685 circumstances such as very long-lived connections from scanning appliances
16686 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16687 should be set false. This causes the value of the load average to be
16688 re-evaluated for each message.
16689
16690
16691 .option queue_only_override main boolean true
16692 .cindex "queueing incoming messages"
16693 When this option is true, the &%-od%&&'x'& command line options override the
16694 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16695 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16696 to override; they are accepted, but ignored.
16697
16698
16699 .option queue_run_in_order main boolean false
16700 .cindex "queue runner" "processing messages in order"
16701 If this option is set, queue runs happen in order of message arrival instead of
16702 in an arbitrary order. For this to happen, a complete list of the entire queue
16703 must be set up before the deliveries start. When the queue is all held in a
16704 single directory (the default), a single list is created for both the ordered
16705 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16706 single list is not created when &%queue_run_in_order%& is false. In this case,
16707 the sub-directories are processed one at a time (in a random order), and this
16708 avoids setting up one huge list for the whole queue. Thus, setting
16709 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16710 when the queue is large, because of the extra work in setting up the single,
16711 large list. In most situations, &%queue_run_in_order%& should not be set.
16712
16713
16714
16715 .option queue_run_max main integer&!! 5
16716 .cindex "queue runner" "maximum number of"
16717 This controls the maximum number of queue runner processes that an Exim daemon
16718 can run simultaneously. This does not mean that it starts them all at once,
16719 but rather that if the maximum number are still running when the time comes to
16720 start another one, it refrains from starting another one. This can happen with
16721 very large queues and/or very sluggish deliveries. This option does not,
16722 however, interlock with other processes, so additional queue runners can be
16723 started by other means, or by killing and restarting the daemon.
16724
16725 Setting this option to zero does not suppress queue runs; rather, it disables
16726 the limit, allowing any number of simultaneous queue runner processes to be
16727 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16728 the daemon's command line.
16729
16730 .cindex queues named
16731 .cindex "named queues"
16732 To set limits for different named queues use
16733 an expansion depending on the &$queue_name$& variable.
16734
16735 .option queue_smtp_domains main "domain list&!!" unset
16736 .cindex "queueing incoming messages"
16737 .cindex "message" "queueing remote deliveries"
16738 When this option is set, a delivery process is started whenever a message is
16739 received, routing is performed, and local deliveries take place.
16740 However, if any SMTP deliveries are required for domains that match
16741 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16742 message waits in the queue for the next queue run. Since routing of the message
16743 has taken place, Exim knows to which remote hosts it must be delivered, and so
16744 when the queue run happens, multiple messages for the same host are delivered
16745 over a single SMTP connection. The &%-odqs%& command line option causes all
16746 SMTP deliveries to be queued in this way, and is equivalent to setting
16747 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16748 &%queue_domains%&.
16749
16750
16751 .option receive_timeout main time 0s
16752 .cindex "timeout" "for non-SMTP input"
16753 This option sets the timeout for accepting a non-SMTP message, that is, the
16754 maximum time that Exim waits when reading a message on the standard input. If
16755 the value is zero, it will wait forever. This setting is overridden by the
16756 &%-or%& command line option. The timeout for incoming SMTP messages is
16757 controlled by &%smtp_receive_timeout%&.
16758
16759 .option received_header_text main string&!! "see below"
16760 .cindex "customizing" "&'Received:'& header"
16761 .cindex "&'Received:'& header line" "customizing"
16762 This string defines the contents of the &'Received:'& message header that is
16763 added to each message, except for the timestamp, which is automatically added
16764 on at the end (preceded by a semicolon). The string is expanded each time it is
16765 used. If the expansion yields an empty string, no &'Received:'& header line is
16766 added to the message. Otherwise, the string should start with the text
16767 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16768 header lines.
16769 .new
16770 The default setting is:
16771
16772 .code
16773 received_header_text = Received: \
16774   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16775     {${if def:sender_ident \
16776       {from ${quote_local_part:$sender_ident} }}\
16777         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16778   by $primary_hostname \
16779   ${if def:received_protocol {with $received_protocol }}\
16780   ${if def:tls_ver           { ($tls_ver)}}\
16781   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16782   (Exim $version_number)\n\t\
16783   ${if def:sender_address \
16784   {(envelope-from <$sender_address>)\n\t}}\
16785   id $message_exim_id\
16786   ${if def:received_for {\n\tfor $received_for}}
16787 .endd
16788 .wen
16789
16790 The reference to the TLS cipher is omitted when Exim is built without TLS
16791 support. The use of conditional expansions ensures that this works for both
16792 locally generated messages and messages received from remote hosts, giving
16793 header lines such as the following:
16794 .code
16795 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16796 by marley.carol.example with esmtp (Exim 4.00)
16797 (envelope-from <bob@carol.example>)
16798 id 16IOWa-00019l-00
16799 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16800 Received: by scrooge.carol.example with local (Exim 4.00)
16801 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16802 .endd
16803 Until the body of the message has been received, the timestamp is the time when
16804 the message started to be received. Once the body has arrived, and all policy
16805 checks have taken place, the timestamp is updated to the time at which the
16806 message was accepted.
16807
16808
16809 .option received_headers_max main integer 30
16810 .cindex "loop" "prevention"
16811 .cindex "mail loop prevention"
16812 .cindex "&'Received:'& header line" "counting"
16813 When a message is to be delivered, the number of &'Received:'& headers is
16814 counted, and if it is greater than this parameter, a mail loop is assumed to
16815 have occurred, the delivery is abandoned, and an error message is generated.
16816 This applies to both local and remote deliveries.
16817
16818
16819 .option recipient_unqualified_hosts main "host list&!!" unset
16820 .cindex "unqualified addresses"
16821 .cindex "host" "unqualified addresses from"
16822 This option lists those hosts from which Exim is prepared to accept unqualified
16823 recipient addresses in message envelopes. The addresses are made fully
16824 qualified by the addition of the &%qualify_recipient%& value. This option also
16825 affects message header lines. Exim does not reject unqualified recipient
16826 addresses in headers, but it qualifies them only if the message came from a
16827 host that matches &%recipient_unqualified_hosts%&,
16828 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16829 option was not set.
16830
16831
16832 .option recipients_max main integer 0
16833 .cindex "limit" "number of recipients"
16834 .cindex "recipient" "maximum number"
16835 If this option is set greater than zero, it specifies the maximum number of
16836 original recipients for any message. Additional recipients that are generated
16837 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16838 all recipients over the limit; earlier recipients are delivered as normal.
16839 Non-SMTP messages with too many recipients are failed, and no deliveries are
16840 done.
16841
16842 .cindex "RCPT" "maximum number of incoming"
16843 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16844 RCPT commands in a single message.
16845
16846
16847 .option recipients_max_reject main boolean false
16848 If this option is set true, Exim rejects SMTP messages containing too many
16849 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16850 error to the eventual DATA command. Otherwise (the default) it gives a 452
16851 error to the surplus RCPT commands and accepts the message on behalf of the
16852 initial set of recipients. The remote server should then re-send the message
16853 for the remaining recipients at a later time.
16854
16855
16856 .option remote_max_parallel main integer 2
16857 .cindex "delivery" "parallelism for remote"
16858 This option controls parallel delivery of one message to a number of remote
16859 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16860 does all the remote deliveries for a message one by one. Otherwise, if a single
16861 message has to be delivered to more than one remote host, or if several copies
16862 have to be sent to the same remote host, up to &%remote_max_parallel%&
16863 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16864 deliveries are required, the maximum number of processes are started, and as
16865 each one finishes, another is begun. The order of starting processes is the
16866 same as if sequential delivery were being done, and can be controlled by the
16867 &%remote_sort_domains%& option. If parallel delivery takes place while running
16868 with debugging turned on, the debugging output from each delivery process is
16869 tagged with its process id.
16870
16871 This option controls only the maximum number of parallel deliveries for one
16872 message in one Exim delivery process. Because Exim has no central queue
16873 manager, there is no way of controlling the total number of simultaneous
16874 deliveries if the configuration allows a delivery attempt as soon as a message
16875 is received.
16876
16877 .cindex "number of deliveries"
16878 .cindex "delivery" "maximum number of"
16879 If you want to control the total number of deliveries on the system, you
16880 need to set the &%queue_only%& option. This ensures that all incoming messages
16881 are added to the queue without starting a delivery process. Then set up an Exim
16882 daemon to start queue runner processes at appropriate intervals (probably
16883 fairly often, for example, every minute), and limit the total number of queue
16884 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16885 delivers only one message at a time, the maximum number of deliveries that can
16886 then take place at once is &%queue_run_max%& multiplied by
16887 &%remote_max_parallel%&.
16888
16889 If it is purely remote deliveries you want to control, use
16890 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16891 doing the SMTP routing before queueing, so that several messages for the same
16892 host will eventually get delivered down the same connection.
16893
16894
16895 .option remote_sort_domains main "domain list&!!" unset
16896 .cindex "sorting remote deliveries"
16897 .cindex "delivery" "sorting remote"
16898 When there are a number of remote deliveries for a message, they are sorted by
16899 domain into the order given by this list. For example,
16900 .code
16901 remote_sort_domains = *.cam.ac.uk:*.uk
16902 .endd
16903 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16904 then to those in the &%uk%& domain, then to any others.
16905
16906
16907 .option retry_data_expire main time 7d
16908 .cindex "hints database" "data expiry"
16909 This option sets a &"use before"& time on retry information in Exim's hints
16910 database. Any older retry data is ignored. This means that, for example, once a
16911 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16912 past failures.
16913
16914
16915 .option retry_interval_max main time 24h
16916 .cindex "retry" "limit on interval"
16917 .cindex "limit" "on retry interval"
16918 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16919 intervals between delivery attempts for messages that cannot be delivered
16920 straight away. This option sets an overall limit to the length of time between
16921 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16922 the default value.
16923
16924
16925 .option return_path_remove main boolean true
16926 .cindex "&'Return-path:'& header line" "removing"
16927 RFC 2821, section 4.4, states that an SMTP server must insert a
16928 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16929 The &'Return-path:'& header preserves the sender address as received in the
16930 MAIL command. This description implies that this header should not be present
16931 in an incoming message. If &%return_path_remove%& is true, any existing
16932 &'Return-path:'& headers are removed from messages at the time they are
16933 received. Exim's transports have options for adding &'Return-path:'& headers at
16934 the time of delivery. They are normally used only for final local deliveries.
16935
16936
16937 .option return_size_limit main integer 100K
16938 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16939
16940
16941 .option rfc1413_hosts main "host list&!!" @[]
16942 .cindex "RFC 1413"
16943 .cindex "host" "for RFC 1413 calls"
16944 RFC 1413 identification calls are made to any client host which matches
16945 an item in the list.
16946 The default value specifies just this host, being any local interface
16947 for the system.
16948
16949 .option rfc1413_query_timeout main time 0s
16950 .cindex "RFC 1413" "query timeout"
16951 .cindex "timeout" "for RFC 1413 call"
16952 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16953 no RFC 1413 calls are ever made.
16954
16955
16956 .option sender_unqualified_hosts main "host list&!!" unset
16957 .cindex "unqualified addresses"
16958 .cindex "host" "unqualified addresses from"
16959 This option lists those hosts from which Exim is prepared to accept unqualified
16960 sender addresses. The addresses are made fully qualified by the addition of
16961 &%qualify_domain%&. This option also affects message header lines. Exim does
16962 not reject unqualified addresses in headers that contain sender addresses, but
16963 it qualifies them only if the message came from a host that matches
16964 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16965 using TCP/IP), and the &%-bnq%& option was not set.
16966
16967
16968 .option slow_lookup_log main integer 0
16969 .cindex "logging" "slow lookups"
16970 .cindex "dns" "logging slow lookups"
16971 This option controls logging of slow lookups.
16972 If the value is nonzero it is taken as a number of milliseconds
16973 and lookups taking longer than this are logged.
16974 Currently this applies only to DNS lookups.
16975
16976
16977
16978 .option smtp_accept_keepalive main boolean true
16979 .cindex "keepalive" "on incoming connection"
16980 This option controls the setting of the SO_KEEPALIVE option on incoming
16981 TCP/IP socket connections. When set, it causes the kernel to probe idle
16982 connections periodically, by sending packets with &"old"& sequence numbers. The
16983 other end of the connection should send an acknowledgment if the connection is
16984 still okay or a reset if the connection has been aborted. The reason for doing
16985 this is that it has the beneficial effect of freeing up certain types of
16986 connection that can get stuck when the remote host is disconnected without
16987 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16988 hours to detect unreachable hosts.
16989
16990
16991
16992 .option smtp_accept_max main integer 20
16993 .cindex "limit" "incoming SMTP connections"
16994 .cindex "SMTP" "incoming connection count"
16995 .cindex "inetd"
16996 This option specifies the maximum number of simultaneous incoming SMTP calls
16997 that Exim will accept. It applies only to the listening daemon; there is no
16998 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16999 value is set to zero, no limit is applied. However, it is required to be
17000 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17001 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17002
17003 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17004 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17005 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17006 and &%smtp_load_reserve%& are then checked before accepting the connection.
17007
17008
17009 .option smtp_accept_max_nonmail main integer 10
17010 .cindex "limit" "non-mail SMTP commands"
17011 .cindex "SMTP" "limiting non-mail commands"
17012 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17013 the connection if there are too many. This option defines &"too many"&. The
17014 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17015 client looping sending EHLO, for example. The check is applied only if the
17016 client host matches &%smtp_accept_max_nonmail_hosts%&.
17017
17018 When a new message is expected, one occurrence of RSET is not counted. This
17019 allows a client to send one RSET between messages (this is not necessary,
17020 but some clients do it). Exim also allows one uncounted occurrence of HELO
17021 or EHLO, and one occurrence of STARTTLS between messages. After
17022 starting up a TLS session, another EHLO is expected, and so it too is not
17023 counted. The first occurrence of AUTH in a connection, or immediately
17024 following STARTTLS is not counted. Otherwise, all commands other than
17025 MAIL, RCPT, DATA, and QUIT are counted.
17026
17027
17028 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17029 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17030 check by setting this option. The default value makes it apply to all hosts. By
17031 changing the value, you can exclude any badly-behaved hosts that you have to
17032 live with.
17033
17034
17035 . Allow this long option name to split; give it unsplit as a fifth argument
17036 . for the automatic .oindex that is generated by .option.
17037 . We insert " &~&~" which is both pretty nasty visually and results in
17038 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17039 . zero-width-space, which would be nicer visually and results in (at least)
17040 . html that Firefox will split on when it's forced to reflow (rather than
17041 . inserting a horizontal scrollbar).  However, the text is still not
17042 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17043 . the option name to split.
17044
17045 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17046          smtp_accept_max_per_connection
17047 .cindex "SMTP" "limiting incoming message count"
17048 .cindex "limit" "messages per SMTP connection"
17049 The value of this option limits the number of MAIL commands that Exim is
17050 prepared to accept over a single SMTP connection, whether or not each command
17051 results in the transfer of a message. After the limit is reached, a 421
17052 response is given to subsequent MAIL commands. This limit is a safety
17053 precaution against a client that goes mad (incidents of this type have been
17054 seen).
17055
17056
17057 .option smtp_accept_max_per_host main string&!! unset
17058 .cindex "limit" "SMTP connections from one host"
17059 .cindex "host" "limiting SMTP connections from"
17060 This option restricts the number of simultaneous IP connections from a single
17061 host (strictly, from a single IP address) to the Exim daemon. The option is
17062 expanded, to enable different limits to be applied to different hosts by
17063 reference to &$sender_host_address$&. Once the limit is reached, additional
17064 connection attempts from the same host are rejected with error code 421. This
17065 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17066 of zero imposes no limit. If this option is set greater than zero, it is
17067 required that &%smtp_accept_max%& be non-zero.
17068
17069 &*Warning*&: When setting this option you should not use any expansion
17070 constructions that take an appreciable amount of time. The expansion and test
17071 happen in the main daemon loop, in order to reject additional connections
17072 without forking additional processes (otherwise a denial-of-service attack
17073 could cause a vast number or processes to be created). While the daemon is
17074 doing this processing, it cannot accept any other incoming connections.
17075
17076
17077
17078 .option smtp_accept_queue main integer 0
17079 .cindex "SMTP" "incoming connection count"
17080 .cindex "queueing incoming messages"
17081 .cindex "message" "queueing by SMTP connection count"
17082 If the number of simultaneous incoming SMTP connections being handled via the
17083 listening daemon exceeds this value, messages received by SMTP are just placed
17084 in the queue; no delivery processes are started automatically. The count is
17085 fixed at the start of an SMTP connection. It cannot be updated in the
17086 subprocess that receives messages, and so the queueing or not queueing applies
17087 to all messages received in the same connection.
17088
17089 A value of zero implies no limit, and clearly any non-zero value is useful only
17090 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17091 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17092 various &%-od%&&'x'& command line options.
17093
17094
17095 . See the comment on smtp_accept_max_per_connection
17096
17097 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17098          smtp_accept_queue_per_connection
17099 .cindex "queueing incoming messages"
17100 .cindex "message" "queueing by message count"
17101 This option limits the number of delivery processes that Exim starts
17102 automatically when receiving messages via SMTP, whether via the daemon or by
17103 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17104 and the number of messages received in a single SMTP session exceeds this
17105 number, subsequent messages are placed in the queue, but no delivery processes
17106 are started. This helps to limit the number of Exim processes when a server
17107 restarts after downtime and there is a lot of mail waiting for it on other
17108 systems. On large systems, the default should probably be increased, and on
17109 dial-in client systems it should probably be set to zero (that is, disabled).
17110
17111
17112 .option smtp_accept_reserve main integer 0
17113 .cindex "SMTP" "incoming call count"
17114 .cindex "host" "reserved"
17115 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17116 number of SMTP connections that are reserved for connections from the hosts
17117 that are specified in &%smtp_reserve_hosts%&. The value set in
17118 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17119 restricted to this number of connections; the option specifies a minimum number
17120 of connection slots for them, not a maximum. It is a guarantee that this group
17121 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17122 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17123 individual host.
17124
17125 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17126 set to 5, once there are 45 active connections (from any hosts), new
17127 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17128 provided the other criteria for acceptance are met.
17129
17130
17131 .option smtp_active_hostname main string&!! unset
17132 .cindex "host" "name in SMTP responses"
17133 .cindex "SMTP" "host name in responses"
17134 .vindex "&$primary_hostname$&"
17135 This option is provided for multi-homed servers that want to masquerade as
17136 several different hosts. At the start of an incoming SMTP connection, its value
17137 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17138 responses. For example, it is used as domain name in the response to an
17139 incoming HELO or EHLO command.
17140
17141 .vindex "&$smtp_active_hostname$&"
17142 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17143 is saved with any messages that are received. It is therefore available for use
17144 in routers and transports when the message is later delivered.
17145
17146 If this option is unset, or if its expansion is forced to fail, or if the
17147 expansion results in an empty string, the value of &$primary_hostname$& is
17148 used. Other expansion failures cause a message to be written to the main and
17149 panic logs, and the SMTP command receives a temporary error. Typically, the
17150 value of &%smtp_active_hostname%& depends on the incoming interface address.
17151 For example:
17152 .code
17153 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17154   {cox.mydomain}{box.mydomain}}
17155 .endd
17156
17157 Although &$smtp_active_hostname$& is primarily concerned with incoming
17158 messages, it is also used as the default for HELO commands in callout
17159 verification if there is no remote transport from which to obtain a
17160 &%helo_data%& value.
17161
17162 .option smtp_banner main string&!! "see below"
17163 .cindex "SMTP" "welcome banner"
17164 .cindex "banner for SMTP"
17165 .cindex "welcome banner for SMTP"
17166 .cindex "customizing" "SMTP banner"
17167 This string, which is expanded every time it is used, is output as the initial
17168 positive response to an SMTP connection. The default setting is:
17169 .code
17170 smtp_banner = $smtp_active_hostname ESMTP Exim \
17171   $version_number $tod_full
17172 .endd
17173 Failure to expand the string causes a panic error. If you want to create a
17174 multiline response to the initial SMTP connection, use &"\n"& in the string at
17175 appropriate points, but not at the end. Note that the 220 code is not included
17176 in this string. Exim adds it automatically (several times in the case of a
17177 multiline response).
17178
17179
17180 .option smtp_check_spool_space main boolean true
17181 .cindex "checking disk space"
17182 .cindex "disk space, checking"
17183 .cindex "spool directory" "checking space"
17184 When this option is set, if an incoming SMTP session encounters the SIZE
17185 option on a MAIL command, it checks that there is enough space in the
17186 spool directory's partition to accept a message of that size, while still
17187 leaving free the amount specified by &%check_spool_space%& (even if that value
17188 is zero). If there isn't enough space, a temporary error code is returned.
17189
17190
17191 .option smtp_connect_backlog main integer 20
17192 .cindex "connection backlog"
17193 .cindex "SMTP" "connection backlog"
17194 .cindex "backlog of connections"
17195 This option specifies a maximum number of waiting SMTP connections. Exim passes
17196 this value to the TCP/IP system when it sets up its listener. Once this number
17197 of connections are waiting for the daemon's attention, subsequent connection
17198 attempts are refused at the TCP/IP level. At least, that is what the manuals
17199 say; in some circumstances such connection attempts have been observed to time
17200 out instead. For large systems it is probably a good idea to increase the
17201 value (to 50, say). It also gives some protection against denial-of-service
17202 attacks by SYN flooding.
17203
17204
17205 .option smtp_enforce_sync main boolean true
17206 .cindex "SMTP" "synchronization checking"
17207 .cindex "synchronization checking in SMTP"
17208 The SMTP protocol specification requires the client to wait for a response from
17209 the server at certain points in the dialogue. Without PIPELINING these
17210 synchronization points are after every command; with PIPELINING they are
17211 fewer, but they still exist.
17212
17213 Some spamming sites send out a complete set of SMTP commands without waiting
17214 for any response. Exim protects against this by rejecting a message if the
17215 client has sent further input when it should not have. The error response &"554
17216 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17217 for this error cannot be perfect because of transmission delays (unexpected
17218 input may be on its way but not yet received when Exim checks). However, it
17219 does detect many instances.
17220
17221 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17222 If you want to disable the check selectively (for example, only for certain
17223 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17224 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17225
17226
17227
17228 .option smtp_etrn_command main string&!! unset
17229 .cindex "ETRN" "command to be run"
17230 .vindex "&$domain$&"
17231 If this option is set, the given command is run whenever an SMTP ETRN
17232 command is received from a host that is permitted to issue such commands (see
17233 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17234 are independently expanded. The expansion variable &$domain$& is set to the
17235 argument of the ETRN command, and no syntax checking is done on it. For
17236 example:
17237 .code
17238 smtp_etrn_command = /etc/etrn_command $domain \
17239                     $sender_host_address
17240 .endd
17241 A new process is created to run the command, but Exim does not wait for it to
17242 complete. Consequently, its status cannot be checked. If the command cannot be
17243 run, a line is written to the panic log, but the ETRN caller still receives
17244 a 250 success response. Exim is normally running under its own uid when
17245 receiving SMTP, so it is not possible for it to change the uid before running
17246 the command.
17247
17248
17249 .option smtp_etrn_serialize main boolean true
17250 .cindex "ETRN" "serializing"
17251 When this option is set, it prevents the simultaneous execution of more than
17252 one identical command as a result of ETRN in an SMTP connection. See
17253 section &<<SECTETRN>>& for details.
17254
17255
17256 .option smtp_load_reserve main fixed-point unset
17257 .cindex "load average"
17258 If the system load average ever gets higher than this, incoming SMTP calls are
17259 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17260 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17261 the load is over the limit. The option has no effect on ancient operating
17262 systems on which Exim cannot determine the load average. See also
17263 &%deliver_queue_load_max%& and &%queue_only_load%&.
17264
17265
17266
17267 .option smtp_max_synprot_errors main integer 3
17268 .cindex "SMTP" "limiting syntax and protocol errors"
17269 .cindex "limit" "SMTP syntax and protocol errors"
17270 Exim rejects SMTP commands that contain syntax or protocol errors. In
17271 particular, a syntactically invalid email address, as in this command:
17272 .code
17273 RCPT TO:<abc xyz@a.b.c>
17274 .endd
17275 causes immediate rejection of the command, before any other tests are done.
17276 (The ACL cannot be run if there is no valid address to set up for it.) An
17277 example of a protocol error is receiving RCPT before MAIL. If there are
17278 too many syntax or protocol errors in one SMTP session, the connection is
17279 dropped. The limit is set by this option.
17280
17281 .cindex "PIPELINING" "expected errors"
17282 When the PIPELINING extension to SMTP is in use, some protocol errors are
17283 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17284 Exim assumes that PIPELINING will be used if it advertises it (see
17285 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17286 not count towards the limit.
17287
17288
17289
17290 .option smtp_max_unknown_commands main integer 3
17291 .cindex "SMTP" "limiting unknown commands"
17292 .cindex "limit" "unknown SMTP commands"
17293 If there are too many unrecognized commands in an incoming SMTP session, an
17294 Exim server drops the connection. This is a defence against some kinds of abuse
17295 that subvert web
17296 clients
17297 into making connections to SMTP ports; in these circumstances, a number of
17298 non-SMTP command lines are sent first.
17299
17300
17301
17302 .option smtp_ratelimit_hosts main "host list&!!" unset
17303 .cindex "SMTP" "rate limiting"
17304 .cindex "limit" "rate of message arrival"
17305 .cindex "RCPT" "rate limiting"
17306 Some sites find it helpful to be able to limit the rate at which certain hosts
17307 can send them messages, and the rate at which an individual message can specify
17308 recipients.
17309
17310 Exim has two rate-limiting facilities. This section describes the older
17311 facility, which can limit rates within a single connection. The newer
17312 &%ratelimit%& ACL condition can limit rates across all connections. See section
17313 &<<SECTratelimiting>>& for details of the newer facility.
17314
17315 When a host matches &%smtp_ratelimit_hosts%&, the values of
17316 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17317 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17318 respectively. Each option, if set, must contain a set of four comma-separated
17319 values:
17320
17321 .ilist
17322 A threshold, before which there is no rate limiting.
17323 .next
17324 An initial time delay. Unlike other times in Exim, numbers with decimal
17325 fractional parts are allowed here.
17326 .next
17327 A factor by which to increase the delay each time.
17328 .next
17329 A maximum value for the delay. This should normally be less than 5 minutes,
17330 because after that time, the client is liable to timeout the SMTP command.
17331 .endlist
17332
17333 For example, these settings have been used successfully at the site which
17334 first suggested this feature, for controlling mail from their customers:
17335 .code
17336 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17337 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17338 .endd
17339 The first setting specifies delays that are applied to MAIL commands after
17340 two have been received over a single connection. The initial delay is 0.5
17341 seconds, increasing by a factor of 1.05 each time. The second setting applies
17342 delays to RCPT commands when more than four occur in a single message.
17343
17344
17345 .option smtp_ratelimit_mail main string unset
17346 See &%smtp_ratelimit_hosts%& above.
17347
17348
17349 .option smtp_ratelimit_rcpt main string unset
17350 See &%smtp_ratelimit_hosts%& above.
17351
17352
17353 .option smtp_receive_timeout main time&!! 5m
17354 .cindex "timeout" "for SMTP input"
17355 .cindex "SMTP" "input timeout"
17356 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17357 input, including batch SMTP. If a line of input (either an SMTP command or a
17358 data line) is not received within this time, the SMTP connection is dropped and
17359 the message is abandoned.
17360 A line is written to the log containing one of the following messages:
17361 .code
17362 SMTP command timeout on connection from...
17363 SMTP data timeout on connection from...
17364 .endd
17365 The former means that Exim was expecting to read an SMTP command; the latter
17366 means that it was in the DATA phase, reading the contents of a message.
17367
17368 If the first character of the option is a &"$"& the option is
17369 expanded before use and may depend on
17370 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17371
17372
17373 .oindex "&%-os%&"
17374 The value set by this option can be overridden by the
17375 &%-os%& command-line option. A setting of zero time disables the timeout, but
17376 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17377 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17378 timeout is controlled by &%receive_timeout%& and &%-or%&.
17379
17380
17381 .option smtp_reserve_hosts main "host list&!!" unset
17382 This option defines hosts for which SMTP connections are reserved; see
17383 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17384
17385
17386 .option smtp_return_error_details main boolean false
17387 .cindex "SMTP" "details policy failures"
17388 .cindex "policy control" "rejection, returning details"
17389 In the default state, Exim uses bland messages such as
17390 &"Administrative prohibition"& when it rejects SMTP commands for policy
17391 reasons. Many sysadmins like this because it gives away little information
17392 to spammers. However, some other sysadmins who are applying strict checking
17393 policies want to give out much fuller information about failures. Setting
17394 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17395 example, instead of &"Administrative prohibition"&, it might give:
17396 .code
17397 550-Rejected after DATA: '>' missing at end of address:
17398 550 failing address in "From" header is: <user@dom.ain
17399 .endd
17400
17401
17402 .option smtputf8_advertise_hosts main "host list&!!" *
17403 .cindex "SMTPUTF8" "advertising"
17404 When Exim is built with support for internationalised mail names,
17405 the availability thereof is advertised in
17406 response to EHLO only to those client hosts that match this option. See
17407 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17408
17409
17410 .option spamd_address main string "127.0.0.1 783"
17411 This option is available when Exim is compiled with the content-scanning
17412 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17413 See section &<<SECTscanspamass>>& for more details.
17414
17415
17416
17417 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17418 This option is available when Exim is compiled with SPF support.
17419 See section &<<SECSPF>>& for more details.
17420
17421
17422
17423 .option split_spool_directory main boolean false
17424 .cindex "multiple spool directories"
17425 .cindex "spool directory" "split"
17426 .cindex "directories, multiple"
17427 If this option is set, it causes Exim to split its input directory into 62
17428 subdirectories, each with a single alphanumeric character as its name. The
17429 sixth character of the message id is used to allocate messages to
17430 subdirectories; this is the least significant base-62 digit of the time of
17431 arrival of the message.
17432
17433 Splitting up the spool in this way may provide better performance on systems
17434 where there are long mail queues, by reducing the number of files in any one
17435 directory. The msglog directory is also split up in a similar way to the input
17436 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17437 are still placed in the single directory &_msglog.OLD_&.
17438
17439 It is not necessary to take any special action for existing messages when
17440 changing &%split_spool_directory%&. Exim notices messages that are in the
17441 &"wrong"& place, and continues to process them. If the option is turned off
17442 after a period of being on, the subdirectories will eventually empty and be
17443 automatically deleted.
17444
17445 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17446 changes. Instead of creating a list of all messages in the queue, and then
17447 trying to deliver each one, in turn, it constructs a list of those in one
17448 sub-directory and tries to deliver them, before moving on to the next
17449 sub-directory. The sub-directories are processed in a random order. This
17450 spreads out the scanning of the input directories, and uses less memory. It is
17451 particularly beneficial when there are lots of messages in the queue. However,
17452 if &%queue_run_in_order%& is set, none of this new processing happens. The
17453 entire queue has to be scanned and sorted before any deliveries can start.
17454
17455
17456 .option spool_directory main string&!! "set at compile time"
17457 .cindex "spool directory" "path to"
17458 This defines the directory in which Exim keeps its spool, that is, the messages
17459 it is waiting to deliver. The default value is taken from the compile-time
17460 configuration setting, if there is one. If not, this option must be set. The
17461 string is expanded, so it can contain, for example, a reference to
17462 &$primary_hostname$&.
17463
17464 If the spool directory name is fixed on your installation, it is recommended
17465 that you set it at build time rather than from this option, particularly if the
17466 log files are being written to the spool directory (see &%log_file_path%&).
17467 Otherwise log files cannot be used for errors that are detected early on, such
17468 as failures in the configuration file.
17469
17470 By using this option to override the compiled-in path, it is possible to run
17471 tests of Exim without using the standard spool.
17472
17473 .option spool_wireformat main boolean false
17474 .cindex "spool directory" "file formats"
17475 If this option is set, Exim may for some messages use an alternative format
17476 for data-files in the spool which matches the wire format.
17477 Doing this permits more efficient message reception and transmission.
17478 Currently it is only done for messages received using the ESMTP CHUNKING
17479 option.
17480
17481 The following variables will not have useful values:
17482 .code
17483 $max_received_linelength
17484 $body_linecount
17485 $body_zerocount
17486 .endd
17487
17488 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17489 and any external programs which are passed a reference to a message data file
17490 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17491 will need to be aware of the different formats potentially available.
17492
17493 Using any of the ACL conditions noted will negate the reception benefit
17494 (as a Unix-mbox-format file is constructed for them).
17495 The transmission benefit is maintained.
17496
17497 .option sqlite_lock_timeout main time 5s
17498 .cindex "sqlite lookup type" "lock timeout"
17499 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17500 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17501
17502 .option strict_acl_vars main boolean false
17503 .cindex "&ACL;" "variables, handling unset"
17504 This option controls what happens if a syntactically valid but undefined ACL
17505 variable is referenced. If it is false (the default), an empty string
17506 is substituted; if it is true, an error is generated. See section
17507 &<<SECTaclvariables>>& for details of ACL variables.
17508
17509 .option strip_excess_angle_brackets main boolean false
17510 .cindex "angle brackets, excess"
17511 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17512 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17513 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17514 passed on to another MTA, the excess angle brackets are not passed on. If this
17515 option is not set, multiple pairs of angle brackets cause a syntax error.
17516
17517
17518 .option strip_trailing_dot main boolean false
17519 .cindex "trailing dot on domain"
17520 .cindex "dot" "trailing on domain"
17521 If this option is set, a trailing dot at the end of a domain in an address is
17522 ignored. If this is in the envelope and the message is passed on to another
17523 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17524 domain causes a syntax error.
17525 However, addresses in header lines are checked only when an ACL requests header
17526 syntax checking.
17527
17528
17529 .option syslog_duplication main boolean true
17530 .cindex "syslog" "duplicate log lines; suppressing"
17531 When Exim is logging to syslog, it writes the log lines for its three
17532 separate logs at different syslog priorities so that they can in principle
17533 be separated on the logging hosts. Some installations do not require this
17534 separation, and in those cases, the duplication of certain log lines is a
17535 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17536 particular log line is written to syslog. For lines that normally go to
17537 both the main log and the reject log, the reject log version (possibly
17538 containing message header lines) is written, at LOG_NOTICE priority.
17539 Lines that normally go to both the main and the panic log are written at
17540 the LOG_ALERT priority.
17541
17542
17543 .option syslog_facility main string unset
17544 .cindex "syslog" "facility; setting"
17545 This option sets the syslog &"facility"& name, used when Exim is logging to
17546 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17547 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17548 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17549 details of Exim's logging.
17550
17551
17552 .option syslog_pid main boolean true
17553 .cindex "syslog" "pid"
17554 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17555 omitted when these lines are sent to syslog. (Syslog normally prefixes
17556 the log lines with the PID of the logging process automatically.) You need
17557 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17558 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17559
17560
17561
17562 .option syslog_processname main string &`exim`&
17563 .cindex "syslog" "process name; setting"
17564 This option sets the syslog &"ident"& name, used when Exim is logging to
17565 syslog. The value must be no longer than 32 characters. See chapter
17566 &<<CHAPlog>>& for details of Exim's logging.
17567
17568
17569
17570 .option syslog_timestamp main boolean true
17571 .cindex "syslog" "timestamps"
17572 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17573 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17574 details of Exim's logging.
17575
17576
17577 .option system_filter main string&!! unset
17578 .cindex "filter" "system filter"
17579 .cindex "system filter" "specifying"
17580 .cindex "Sieve filter" "not available for system filter"
17581 This option specifies an Exim filter file that is applied to all messages at
17582 the start of each delivery attempt, before any routing is done. System filters
17583 must be Exim filters; they cannot be Sieve filters. If the system filter
17584 generates any deliveries to files or pipes, or any new mail messages, the
17585 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17586 which transports are to be used. Details of this facility are given in chapter
17587 &<<CHAPsystemfilter>>&.
17588 A forced expansion failure results in no filter operation.
17589
17590
17591 .option system_filter_directory_transport main string&!! unset
17592 .vindex "&$address_file$&"
17593 This sets the name of the transport driver that is to be used when the
17594 &%save%& command in a system message filter specifies a path ending in &"/"&,
17595 implying delivery of each message into a separate file in some directory.
17596 During the delivery, the variable &$address_file$& contains the path name.
17597
17598
17599 .option system_filter_file_transport main string&!! unset
17600 .cindex "file" "transport for system filter"
17601 This sets the name of the transport driver that is to be used when the &%save%&
17602 command in a system message filter specifies a path not ending in &"/"&. During
17603 the delivery, the variable &$address_file$& contains the path name.
17604
17605 .option system_filter_group main string unset
17606 .cindex "gid (group id)" "system filter"
17607 This option is used only when &%system_filter_user%& is also set. It sets the
17608 gid under which the system filter is run, overriding any gid that is associated
17609 with the user. The value may be numerical or symbolic.
17610
17611 .option system_filter_pipe_transport main string&!! unset
17612 .cindex "&(pipe)& transport" "for system filter"
17613 .vindex "&$address_pipe$&"
17614 This specifies the transport driver that is to be used when a &%pipe%& command
17615 is used in a system filter. During the delivery, the variable &$address_pipe$&
17616 contains the pipe command.
17617
17618
17619 .option system_filter_reply_transport main string&!! unset
17620 .cindex "&(autoreply)& transport" "for system filter"
17621 This specifies the transport driver that is to be used when a &%mail%& command
17622 is used in a system filter.
17623
17624
17625 .option system_filter_user main string unset
17626 .cindex "uid (user id)" "system filter"
17627 If this option is set to root, the system filter is run in the main Exim
17628 delivery process, as root.  Otherwise, the system filter runs in a separate
17629 process, as the given user, defaulting to the Exim run-time user.
17630 Unless the string consists entirely of digits, it
17631 is looked up in the password data. Failure to find the named user causes a
17632 configuration error. The gid is either taken from the password data, or
17633 specified by &%system_filter_group%&. When the uid is specified numerically,
17634 &%system_filter_group%& is required to be set.
17635
17636 If the system filter generates any pipe, file, or reply deliveries, the uid
17637 under which the filter is run is used when transporting them, unless a
17638 transport option overrides.
17639
17640
17641 .option tcp_nodelay main boolean true
17642 .cindex "daemon" "TCP_NODELAY on sockets"
17643 .cindex "Nagle algorithm"
17644 .cindex "TCP_NODELAY on listening sockets"
17645 If this option is set false, it stops the Exim daemon setting the
17646 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17647 turns off the &"Nagle algorithm"&, which is a way of improving network
17648 performance in interactive (character-by-character) situations. Turning it off
17649 should improve Exim's performance a bit, so that is what happens by default.
17650 However, it appears that some broken clients cannot cope, and time out. Hence
17651 this option. It affects only those sockets that are set up for listening by the
17652 daemon. Sockets created by the smtp transport for delivering mail always set
17653 TCP_NODELAY.
17654
17655
17656 .option timeout_frozen_after main time 0s
17657 .cindex "frozen messages" "timing out"
17658 .cindex "timeout" "frozen messages"
17659 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17660 message of any kind that has been in the queue for longer than the given time
17661 is automatically cancelled at the next queue run. If the frozen message is a
17662 bounce message, it is just discarded; otherwise, a bounce is sent to the
17663 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17664 If you want to timeout frozen bounce messages earlier than other kinds of
17665 frozen message, see &%ignore_bounce_errors_after%&.
17666
17667 &*Note:*& the default value of zero means no timeouts; with this setting,
17668 frozen messages remain in the queue forever (except for any frozen bounce
17669 messages that are released by &%ignore_bounce_errors_after%&).
17670
17671
17672 .option timezone main string unset
17673 .cindex "timezone, setting"
17674 .cindex "environment" "values from"
17675 The value of &%timezone%& is used to set the environment variable TZ while
17676 running Exim (if it is different on entry). This ensures that all timestamps
17677 created by Exim are in the required timezone. If you want all your timestamps
17678 to be in UTC (aka GMT) you should set
17679 .code
17680 timezone = UTC
17681 .endd
17682 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17683 or, if that is not set, from the value of the TZ environment variable when Exim
17684 is built. If &%timezone%& is set to the empty string, either at build or run
17685 time, any existing TZ variable is removed from the environment when Exim
17686 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17687 unfortunately not all, operating systems.
17688
17689
17690 .option tls_advertise_hosts main "host list&!!" *
17691 .cindex "TLS" "advertising"
17692 .cindex "encryption" "on SMTP connection"
17693 .cindex "SMTP" "encrypted connection"
17694 When Exim is built with support for TLS encrypted connections, the availability
17695 of the STARTTLS command to set up an encrypted session is advertised in
17696 response to EHLO only to those client hosts that match this option. See
17697 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17698 Note that the default value requires that a certificate be supplied
17699 using the &%tls_certificate%& option.  If TLS support for incoming connections
17700 is not required the &%tls_advertise_hosts%& option should be set empty.
17701
17702
17703 .option tls_certificate main string list&!! unset
17704 .cindex "TLS" "server certificate; location of"
17705 .cindex "certificate" "server, location of"
17706 The value of this option is expanded, and must then be a list of absolute paths to
17707 files which contain the server's certificates (in PEM format).
17708 Commonly only one file is needed.
17709 The server's private key is also
17710 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17711 &<<CHAPTLS>>& for further details.
17712
17713 &*Note*&: The certificates defined by this option are used only when Exim is
17714 receiving incoming messages as a server. If you want to supply certificates for
17715 use when sending messages as a client, you must set the &%tls_certificate%&
17716 option in the relevant &(smtp)& transport.
17717
17718 &*Note*&: If you use filenames based on IP addresses, change the list
17719 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17720
17721 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17722 when a list of more than one
17723 file is used, the &$tls_in_ourcert$& variable is unreliable.
17724 .new
17725 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17726 .wen
17727
17728 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17729 if the OpenSSL build supports TLS extensions and the TLS client sends the
17730 Server Name Indication extension, then this option and others documented in
17731 &<<SECTtlssni>>& will be re-expanded.
17732
17733 If this option is unset or empty a fresh self-signed certificate will be
17734 generated for every connection.
17735
17736 .option tls_crl main string&!! unset
17737 .cindex "TLS" "server certificate revocation list"
17738 .cindex "certificate" "revocation list for server"
17739 This option specifies a certificate revocation list. The expanded value must
17740 be the name of a file that contains CRLs in PEM format.
17741
17742 Under OpenSSL the option can specify a directory with CRL files.
17743
17744 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17745 for each signing element of the certificate chain (i.e. all but the leaf).
17746 For the file variant this can be multiple PEM blocks in the one file.
17747
17748 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17749
17750
17751 .option tls_dh_max_bits main integer 2236
17752 .cindex "TLS" "D-H bit count"
17753 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17754 the chosen TLS library.  That value might prove to be too high for
17755 interoperability.  This option provides a maximum clamp on the value
17756 suggested, trading off security for interoperability.
17757
17758 The value must be at least 1024.
17759
17760 The value 2236 was chosen because, at time of adding the option, it was the
17761 hard-coded maximum value supported by the NSS cryptographic library, as used
17762 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17763
17764 If you prefer more security and are willing to break some clients, raise this
17765 number.
17766
17767 Note that the value passed to GnuTLS for *generating* a new prime may be a
17768 little less than this figure, because GnuTLS is inexact and may produce a
17769 larger prime than requested.
17770
17771
17772 .option tls_dhparam main string&!! unset
17773 .cindex "TLS" "D-H parameters for server"
17774 The value of this option is expanded and indicates the source of DH parameters
17775 to be used by Exim.
17776
17777 .new
17778 This option is ignored for GnuTLS version 3.6.0 and later.
17779 The library manages parameter negotiation internally.
17780 .wen
17781
17782 &*Note: The Exim Maintainers strongly recommend,
17783 for other TLS library versions,
17784 using a filename with site-generated
17785 local DH parameters*&, which has been supported across all versions of Exim.  The
17786 other specific constants available are a fallback so that even when
17787 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17788
17789 If &%tls_dhparam%& is a filename starting with a &`/`&,
17790 then it names a file from which DH
17791 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17792 PKCS#3 representation of the DH prime.  If the file does not exist, for
17793 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17794 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17795 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17796 and treated as though the &%tls_dhparam%& were set to "none".
17797
17798 If this option expands to the string "none", then no DH parameters will be
17799 loaded by Exim.
17800
17801 If this option expands to the string "historic" and Exim is using GnuTLS, then
17802 Exim will attempt to load a file from inside the spool directory.  If the file
17803 does not exist, Exim will attempt to create it.
17804 See section &<<SECTgnutlsparam>>& for further details.
17805
17806 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17807 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17808
17809 In older versions of Exim the default was the 2048 bit prime described in section
17810 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17811 in IKE is assigned number 23.
17812
17813 Otherwise, the option must expand to the name used by Exim for any of a number
17814 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17815 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17816 the number used by IKE, or "default" which corresponds to
17817 &`exim.dev.20160529.3`&.
17818
17819 The available standard primes are:
17820 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17821 &`ike1`&, &`ike2`&, &`ike5`&,
17822 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17823 &`ike22`&, &`ike23`& and &`ike24`&.
17824
17825 The available additional primes are:
17826 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17827
17828 Some of these will be too small to be accepted by clients.
17829 Some may be too large to be accepted by clients.
17830 The open cryptographic community has suspicions about the integrity of some
17831 of the later IKE values, which led into RFC7919 providing new fixed constants
17832 (the "ffdhe" identifiers).
17833
17834 At this point, all of the "ike" values should be considered obsolete;
17835 they're still in Exim to avoid breaking unusual configurations, but are
17836 candidates for removal the next time we have backwards-incompatible changes.
17837
17838 The TLS protocol does not negotiate an acceptable size for this; clients tend
17839 to hard-drop connections if what is offered by the server is unacceptable,
17840 whether too large or too small, and there's no provision for the client to
17841 tell the server what these constraints are.  Thus, as a server operator, you
17842 need to make an educated guess as to what is most likely to work for your
17843 userbase.
17844
17845 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17846 is most likely to maximise interoperability.  The upper bound comes from
17847 applications using the Mozilla Network Security Services (NSS) library, which
17848 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17849 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17850 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17851 acceptable bound from 1024 to 2048.
17852
17853
17854 .option tls_eccurve main string&!! &`auto`&
17855 .cindex TLS "EC cryptography"
17856 This option selects a EC curve for use by Exim when used with OpenSSL.
17857 It has no effect when Exim is used with GnuTLS.
17858
17859 After expansion it must contain a valid EC curve parameter, such as
17860 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17861 for valid selections.
17862
17863 For OpenSSL versions before (and not including) 1.0.2, the string
17864 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17865 &`auto`& tells the library to choose.
17866
17867 If the option expands to an empty string, no EC curves will be enabled.
17868
17869
17870 .option tls_ocsp_file main string&!! unset
17871 .cindex TLS "certificate status"
17872 .cindex TLS "OCSP proof file"
17873 This option
17874 must if set expand to the absolute path to a file which contains a current
17875 status proof for the server's certificate, as obtained from the
17876 Certificate Authority.
17877
17878 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17879 .new
17880 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
17881 .wen
17882
17883 .new
17884 For OpenSSL 1.1.0 or later, and
17885 .wen
17886 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17887 of files, to match a list given for the &%tls_certificate%& option.
17888 The ordering of the two lists must match.
17889 .new
17890 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
17891 .wen
17892
17893 .new
17894 The file(s) should be in DER format,
17895 except for GnuTLS 3.6.3 or later
17896 or for OpenSSL,
17897 when an optional filetype prefix can be used.
17898 The prefix must be one of "DER" or "PEM", followed by
17899 a single space.  If one is used it sets the format for subsequent
17900 files in the list; the initial format is DER.
17901 If multiple proofs are wanted, for multiple chain elements
17902 (this only works under TLS1.3)
17903 they must be coded as a combined OCSP response.
17904
17905 Although GnuTLS will accept PEM files with multiple separate
17906 PEM blobs (ie. separate OCSP responses), it sends them in the
17907 TLS Certificate record interleaved with the certificates of the chain;
17908 although a GnuTLS client is happy with that, an OpenSSL client is not.
17909 .wen
17910
17911 .option tls_on_connect_ports main "string list" unset
17912 .cindex SSMTP
17913 .cindex SMTPS
17914 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17915 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17916 set up without waiting for the client to issue a STARTTLS command. For
17917 further details, see section &<<SECTsupobssmt>>&.
17918
17919
17920
17921 .option tls_privatekey main string list&!! unset
17922 .cindex "TLS" "server private key; location of"
17923 The value of this option is expanded, and must then be a list of absolute paths to
17924 files which contains the server's private keys.
17925 If this option is unset, or if
17926 the expansion is forced to fail, or the result is an empty string, the private
17927 key is assumed to be in the same file as the server's certificates. See chapter
17928 &<<CHAPTLS>>& for further details.
17929
17930 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17931
17932
17933 .option tls_remember_esmtp main boolean false
17934 .cindex "TLS" "esmtp state; remembering"
17935 .cindex "TLS" "broken clients"
17936 If this option is set true, Exim violates the RFCs by remembering that it is in
17937 &"esmtp"& state after successfully negotiating a TLS session. This provides
17938 support for broken clients that fail to send a new EHLO after starting a
17939 TLS session.
17940
17941
17942 .option tls_require_ciphers main string&!! unset
17943 .cindex "TLS" "requiring specific ciphers"
17944 .cindex "cipher" "requiring specific"
17945 This option controls which ciphers can be used for incoming TLS connections.
17946 The &(smtp)& transport has an option of the same name for controlling outgoing
17947 connections. This option is expanded for each connection, so can be varied for
17948 different clients if required. The value of this option must be a list of
17949 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17950 in somewhat different ways. If GnuTLS is being used, the client controls the
17951 preference order of the available ciphers. Details are given in sections
17952 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17953
17954
17955 .option tls_try_verify_hosts main "host list&!!" unset
17956 .cindex "TLS" "client certificate verification"
17957 .cindex "certificate" "verification of client"
17958 See &%tls_verify_hosts%& below.
17959
17960
17961 .option tls_verify_certificates main string&!! system
17962 .cindex "TLS" "client certificate verification"
17963 .cindex "certificate" "verification of client"
17964 The value of this option is expanded, and must then be either the
17965 word "system"
17966 or the absolute path to
17967 a file or directory containing permitted certificates for clients that
17968 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17969
17970 The "system" value for the option will use a
17971 system default location compiled into the SSL library.
17972 This is not available for GnuTLS versions preceding 3.0.20,
17973 and will be taken as empty; an explicit location
17974 must be specified.
17975
17976 The use of a directory for the option value is not available for GnuTLS versions
17977 preceding 3.3.6 and a single file must be used.
17978
17979 With OpenSSL the certificates specified
17980 explicitly
17981 either by file or directory
17982 are added to those given by the system default location.
17983
17984 These certificates should be for the certificate authorities trusted, rather
17985 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17986 the value is a file then the certificates are sent by Exim as a server to
17987 connecting clients, defining the list of accepted certificate authorities.
17988 Thus the values defined should be considered public data.  To avoid this,
17989 use the explicit directory version.
17990
17991 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17992
17993 A forced expansion failure or setting to an empty string is equivalent to
17994 being unset.
17995
17996
17997 .option tls_verify_hosts main "host list&!!" unset
17998 .cindex "TLS" "client certificate verification"
17999 .cindex "certificate" "verification of client"
18000 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18001 certificates from clients. The expected certificates are defined by
18002 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18003 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18004 &%tls_verify_certificates%& is not set.
18005
18006 Any client that matches &%tls_verify_hosts%& is constrained by
18007 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18008 present one of the listed certificates. If it does not, the connection is
18009 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18010 the host to use TLS. It can still send SMTP commands through unencrypted
18011 connections. Forcing a client to use TLS has to be done separately using an
18012 ACL to reject inappropriate commands when the connection is not encrypted.
18013
18014 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18015 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18016 certificate and checks it against &%tls_verify_certificates%&, but does not
18017 abort the connection if there is no certificate or if it does not match. This
18018 state can be detected in an ACL, which makes it possible to implement policies
18019 such as &"accept for relay only if a verified certificate has been received,
18020 but accept for local delivery if encrypted, even without a verified
18021 certificate"&.
18022
18023 Client hosts that match neither of these lists are not asked to present
18024 certificates.
18025
18026
18027 .option trusted_groups main "string list&!!" unset
18028 .cindex "trusted groups"
18029 .cindex "groups" "trusted"
18030 This option is expanded just once, at the start of Exim's processing. If this
18031 option is set, any process that is running in one of the listed groups, or
18032 which has one of them as a supplementary group, is trusted. The groups can be
18033 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18034 details of what trusted callers are permitted to do. If neither
18035 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18036 are trusted.
18037
18038 .option trusted_users main "string list&!!" unset
18039 .cindex "trusted users"
18040 .cindex "user" "trusted"
18041 This option is expanded just once, at the start of Exim's processing. If this
18042 option is set, any process that is running as one of the listed users is
18043 trusted. The users can be specified numerically or by name. See section
18044 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18045 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18046 Exim user are trusted.
18047
18048 .option unknown_login main string&!! unset
18049 .cindex "uid (user id)" "unknown caller"
18050 .vindex "&$caller_uid$&"
18051 This is a specialized feature for use in unusual configurations. By default, if
18052 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18053 gives up. The &%unknown_login%& option can be used to set a login name to be
18054 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18055 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18056 is used for the user's real name (gecos field), unless this has been set by the
18057 &%-F%& option.
18058
18059 .option unknown_username main string unset
18060 See &%unknown_login%&.
18061
18062 .option untrusted_set_sender main "address list&!!" unset
18063 .cindex "trusted users"
18064 .cindex "sender" "setting by untrusted user"
18065 .cindex "untrusted user setting sender"
18066 .cindex "user" "untrusted setting sender"
18067 .cindex "envelope from"
18068 .cindex "envelope sender"
18069 When an untrusted user submits a message to Exim using the standard input, Exim
18070 normally creates an envelope sender address from the user's login and the
18071 default qualification domain. Data from the &%-f%& option (for setting envelope
18072 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18073 is used) is ignored.
18074
18075 However, untrusted users are permitted to set an empty envelope sender address,
18076 to declare that a message should never generate any bounces. For example:
18077 .code
18078 exim -f '<>' user@domain.example
18079 .endd
18080 .vindex "&$sender_ident$&"
18081 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18082 other envelope sender addresses in a controlled way. When it is set, untrusted
18083 users are allowed to set envelope sender addresses that match any of the
18084 patterns in the list. Like all address lists, the string is expanded. The
18085 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18086 users to setting senders that start with their login ids
18087 followed by a hyphen
18088 by a setting like this:
18089 .code
18090 untrusted_set_sender = ^$sender_ident-
18091 .endd
18092 If you want to allow untrusted users to set envelope sender addresses without
18093 restriction, you can use
18094 .code
18095 untrusted_set_sender = *
18096 .endd
18097 The &%untrusted_set_sender%& option applies to all forms of local input, but
18098 only to the setting of the envelope sender. It does not permit untrusted users
18099 to use the other options which trusted user can use to override message
18100 parameters. Furthermore, it does not stop Exim from removing an existing
18101 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18102 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18103 overriding these actions. The handling of the &'Sender:'& header is also
18104 described in section &<<SECTthesenhea>>&.
18105
18106 The log line for a message's arrival shows the envelope sender following
18107 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18108 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18109 envelope sender address, the user's login is shown in parentheses after the
18110 sender address.
18111
18112
18113 .option uucp_from_pattern main string "see below"
18114 .cindex "&""From""& line"
18115 .cindex "UUCP" "&""From""& line"
18116 Some applications that pass messages to an MTA via a command line interface use
18117 an initial line starting with &"From&~"& to pass the envelope sender. In
18118 particular, this is used by UUCP software. Exim recognizes such a line by means
18119 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18120 matches, the sender address is constructed by expanding the contents of
18121 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18122 default pattern recognizes lines in the following two forms:
18123 .code
18124 From ph10 Fri Jan  5 12:35 GMT 1996
18125 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18126 .endd
18127 The pattern can be seen by running
18128 .code
18129 exim -bP uucp_from_pattern
18130 .endd
18131 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18132 year in the second case. The first word after &"From&~"& is matched in the
18133 regular expression by a parenthesized subpattern. The default value for
18134 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18135 (&"ph10"& in the example above) as the message's sender. See also
18136 &%ignore_fromline_hosts%&.
18137
18138
18139 .option uucp_from_sender main string&!! &`$1`&
18140 See &%uucp_from_pattern%& above.
18141
18142
18143 .option warn_message_file main string unset
18144 .cindex "warning of delay" "customizing the message"
18145 .cindex "customizing" "warning message"
18146 This option defines a template file containing paragraphs of text to be used
18147 for constructing the warning message which is sent by Exim when a message has
18148 been in the queue for a specified amount of time, as specified by
18149 &%delay_warning%&. Details of the file's contents are given in chapter
18150 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18151
18152
18153 .option write_rejectlog main boolean true
18154 .cindex "reject log" "disabling"
18155 If this option is set false, Exim no longer writes anything to the reject log.
18156 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18157 .ecindex IIDconfima
18158 .ecindex IIDmaiconf
18159
18160
18161
18162
18163 . ////////////////////////////////////////////////////////////////////////////
18164 . ////////////////////////////////////////////////////////////////////////////
18165
18166 .chapter "Generic options for routers" "CHAProutergeneric"
18167 .scindex IIDgenoprou1 "options" "generic; for routers"
18168 .scindex IIDgenoprou2 "generic options" "router"
18169 This chapter describes the generic options that apply to all routers.
18170 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18171
18172 For a general description of how a router operates, see sections
18173 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18174 which the preconditions are tested. The order of expansion of the options that
18175 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18176 &%headers_remove%&, &%transport%&.
18177
18178
18179
18180 .option address_data routers string&!! unset
18181 .cindex "router" "data attached to address"
18182 The string is expanded just before the router is run, that is, after all the
18183 precondition tests have succeeded. If the expansion is forced to fail, the
18184 router declines, the value of &%address_data%& remains unchanged, and the
18185 &%more%& option controls what happens next. Other expansion failures cause
18186 delivery of the address to be deferred.
18187
18188 .vindex "&$address_data$&"
18189 When the expansion succeeds, the value is retained with the address, and can be
18190 accessed using the variable &$address_data$& in the current router, subsequent
18191 routers, and the eventual transport.
18192
18193 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18194 that runs a user's filter file, the contents of &$address_data$& are accessible
18195 in the filter. This is not normally a problem, because such data is usually
18196 either not confidential or it &"belongs"& to the current user, but if you do
18197 put confidential data into &$address_data$& you need to remember this point.
18198
18199 Even if the router declines or passes, the value of &$address_data$& remains
18200 with the address, though it can be changed by another &%address_data%& setting
18201 on a subsequent router. If a router generates child addresses, the value of
18202 &$address_data$& propagates to them. This also applies to the special kind of
18203 &"child"& that is generated by a router with the &%unseen%& option.
18204
18205 The idea of &%address_data%& is that you can use it to look up a lot of data
18206 for the address once, and then pick out parts of the data later. For example,
18207 you could use a single LDAP lookup to return a string of the form
18208 .code
18209 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18210 .endd
18211 In the transport you could pick out the mailbox by a setting such as
18212 .code
18213 file = ${extract{mailbox}{$address_data}}
18214 .endd
18215 This makes the configuration file less messy, and also reduces the number of
18216 lookups (though Exim does cache lookups).
18217
18218 .new
18219 See also the &%set%& option below.
18220 .wen
18221
18222 .vindex "&$sender_address_data$&"
18223 .vindex "&$address_data$&"
18224 The &%address_data%& facility is also useful as a means of passing information
18225 from one router to another, and from a router to a transport. In addition, if
18226 &$address_data$& is set by a router when verifying a recipient address from an
18227 ACL, it remains available for use in the rest of the ACL statement. After
18228 verifying a sender, the value is transferred to &$sender_address_data$&.
18229
18230
18231
18232 .option address_test routers&!? boolean true
18233 .oindex "&%-bt%&"
18234 .cindex "router" "skipping when address testing"
18235 If this option is set false, the router is skipped when routing is being tested
18236 by means of the &%-bt%& command line option. This can be a convenience when
18237 your first router sends messages to an external scanner, because it saves you
18238 having to set the &"already scanned"& indicator when testing real address
18239 routing.
18240
18241
18242
18243 .option cannot_route_message routers string&!! unset
18244 .cindex "router" "customizing &""cannot route""& message"
18245 .cindex "customizing" "&""cannot route""& message"
18246 This option specifies a text message that is used when an address cannot be
18247 routed because Exim has run out of routers. The default message is
18248 &"Unrouteable address"&. This option is useful only on routers that have
18249 &%more%& set false, or on the very last router in a configuration, because the
18250 value that is used is taken from the last router that is considered. This
18251 includes a router that is skipped because its preconditions are not met, as
18252 well as a router that declines. For example, using the default configuration,
18253 you could put:
18254 .code
18255 cannot_route_message = Remote domain not found in DNS
18256 .endd
18257 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18258 and
18259 .code
18260 cannot_route_message = Unknown local user
18261 .endd
18262 on the final router that checks for local users. If string expansion fails for
18263 this option, the default message is used. Unless the expansion failure was
18264 explicitly forced, a message about the failure is written to the main and panic
18265 logs, in addition to the normal message about the routing failure.
18266
18267
18268 .option caseful_local_part routers boolean false
18269 .cindex "case of local parts"
18270 .cindex "router" "case of local parts"
18271 By default, routers handle the local parts of addresses in a case-insensitive
18272 manner, though the actual case is preserved for transmission with the message.
18273 If you want the case of letters to be significant in a router, you must set
18274 this option true. For individual router options that contain address or local
18275 part lists (for example, &%local_parts%&), case-sensitive matching can be
18276 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18277 more details.
18278
18279 .vindex "&$local_part$&"
18280 .vindex "&$original_local_part$&"
18281 .vindex "&$parent_local_part$&"
18282 The value of the &$local_part$& variable is forced to lower case while a
18283 router is running unless &%caseful_local_part%& is set. When a router assigns
18284 an address to a transport, the value of &$local_part$& when the transport runs
18285 is the same as it was in the router. Similarly, when a router generates child
18286 addresses by aliasing or forwarding, the values of &$original_local_part$&
18287 and &$parent_local_part$& are those that were used by the redirecting router.
18288
18289 This option applies to the processing of an address by a router. When a
18290 recipient address is being processed in an ACL, there is a separate &%control%&
18291 modifier that can be used to specify case-sensitive processing within the ACL
18292 (see section &<<SECTcontrols>>&).
18293
18294
18295
18296 .option check_local_user routers&!? boolean false
18297 .cindex "local user, checking in router"
18298 .cindex "router" "checking for local user"
18299 .cindex "&_/etc/passwd_&"
18300 .vindex "&$home$&"
18301 When this option is true, Exim checks that the local part of the recipient
18302 address (with affixes removed if relevant) is the name of an account on the
18303 local system. The check is done by calling the &[getpwnam()]& function rather
18304 than trying to read &_/etc/passwd_& directly. This means that other methods of
18305 holding password data (such as NIS) are supported. If the local part is a local
18306 user, &$home$& is set from the password data, and can be tested in other
18307 preconditions that are evaluated after this one (the order of evaluation is
18308 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18309 overridden by &%router_home_directory%&. If the local part is not a local user,
18310 the router is skipped.
18311
18312 If you want to check that the local part is either the name of a local user
18313 or matches something else, you cannot combine &%check_local_user%& with a
18314 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18315 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18316 setting to achieve this. For example:
18317 .code
18318 local_parts = passwd;$local_part : lsearch;/etc/other/users
18319 .endd
18320 Note, however, that the side effects of &%check_local_user%& (such as setting
18321 up a home directory) do not occur when a &(passwd)& lookup is used in a
18322 &%local_parts%& (or any other) precondition.
18323
18324
18325
18326 .option condition routers&!? string&!! unset
18327 .cindex "router" "customized precondition"
18328 This option specifies a general precondition test that has to succeed for the
18329 router to be called. The &%condition%& option is the last precondition to be
18330 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18331 result is a forced failure, or an empty string, or one of the strings &"0"& or
18332 &"no"& or &"false"& (checked without regard to the case of the letters), the
18333 router is skipped, and the address is offered to the next one.
18334
18335 If the result is any other value, the router is run (as this is the last
18336 precondition to be evaluated, all the other preconditions must be true).
18337
18338 This option is unusual in that multiple &%condition%& options may be present.
18339 All &%condition%& options must succeed.
18340
18341 The &%condition%& option provides a means of applying custom conditions to the
18342 running of routers. Note that in the case of a simple conditional expansion,
18343 the default expansion values are exactly what is wanted. For example:
18344 .code
18345 condition = ${if >{$message_age}{600}}
18346 .endd
18347 Because of the default behaviour of the string expansion, this is equivalent to
18348 .code
18349 condition = ${if >{$message_age}{600}{true}{}}
18350 .endd
18351
18352 A multiple condition example, which succeeds:
18353 .code
18354 condition = ${if >{$message_age}{600}}
18355 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18356 condition = foobar
18357 .endd
18358
18359 If the expansion fails (other than forced failure) delivery is deferred. Some
18360 of the other precondition options are common special cases that could in fact
18361 be specified using &%condition%&.
18362
18363 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18364 are far older, and use one set of semantics.  ACLs are newer and when
18365 they were created, the ACL &%condition%& process was given far stricter
18366 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18367 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18368 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18369 Router rules processing behavior.
18370
18371 This is best illustrated in an example:
18372 .code
18373 # If used in an ACL condition will fail with a syntax error, but
18374 # in a router condition any extra characters are treated as a string
18375
18376 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18377 true {yes} {no}}
18378
18379 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18380  {yes} {no}}
18381 .endd
18382 In each example above, the &%if%& statement actually ends after
18383 &"{google.com}}"&.  Since no true or false braces were defined, the
18384 default &%if%& behavior is to return a boolean true or a null answer
18385 (which evaluates to false). The rest of the line is then treated as a
18386 string. So the first example resulted in the boolean answer &"true"&
18387 with the string &" {yes} {no}}"& appended to it. The second example
18388 resulted in the null output (indicating false) with the string
18389 &" {yes} {no}}"& appended to it.
18390
18391 In fact you can put excess forward braces in too.  In the router
18392 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18393 mean something, like after a &"$"& or when required as part of a
18394 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18395 string characters.
18396
18397 Thus, in a Router, the above expansion strings will both always evaluate
18398 true, as the result of expansion is a non-empty string which doesn't
18399 match an explicit false value.  This can be tricky to debug.  By
18400 contrast, in an ACL either of those strings will always result in an
18401 expansion error because the result doesn't look sufficiently boolean.
18402
18403
18404 .option debug_print routers string&!! unset
18405 .cindex "testing" "variables in drivers"
18406 If this option is set and debugging is enabled (see the &%-d%& command line
18407 option) or in address-testing mode (see the &%-bt%& command line option),
18408 the string is expanded and included in the debugging output.
18409 If expansion of the string fails, the error message is written to the debugging
18410 output, and Exim carries on processing.
18411 This option is provided to help with checking out the values of variables and
18412 so on when debugging router configurations. For example, if a &%condition%&
18413 option appears not to be working, &%debug_print%& can be used to output the
18414 variables it references. The output happens after checks for &%domains%&,
18415 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18416 are tested. A newline is added to the text if it does not end with one.
18417 The variable &$router_name$& contains the name of the router.
18418
18419
18420
18421 .option disable_logging routers boolean false
18422 If this option is set true, nothing is logged for any routing errors
18423 or for any deliveries caused by this router. You should not set this option
18424 unless you really, really know what you are doing. See also the generic
18425 transport option of the same name.
18426
18427 .option dnssec_request_domains routers "domain list&!!" *
18428 .cindex "MX record" "security"
18429 .cindex "DNSSEC" "MX lookup"
18430 .cindex "security" "MX lookup"
18431 .cindex "DNS" "DNSSEC"
18432 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18433 the dnssec request bit set.
18434 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18435
18436 .option dnssec_require_domains routers "domain list&!!" unset
18437 .cindex "MX record" "security"
18438 .cindex "DNSSEC" "MX lookup"
18439 .cindex "security" "MX lookup"
18440 .cindex "DNS" "DNSSEC"
18441 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18442 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18443 (AD bit) set will be ignored and logged as a host-lookup failure.
18444 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18445
18446
18447 .option domains routers&!? "domain list&!!" unset
18448 .cindex "router" "restricting to specific domains"
18449 .vindex "&$domain_data$&"
18450 If this option is set, the router is skipped unless the current domain matches
18451 the list. If the match is achieved by means of a file lookup, the data that the
18452 lookup returned for the domain is placed in &$domain_data$& for use in string
18453 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18454 a list of the order in which preconditions are evaluated.
18455
18456
18457
18458 .option driver routers string unset
18459 This option must always be set. It specifies which of the available routers is
18460 to be used.
18461
18462
18463 .option dsn_lasthop routers boolean false
18464 .cindex "DSN" "success"
18465 .cindex "Delivery Status Notification" "success"
18466 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18467 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18468 instead send a success DSN as if the next hop does not support DSN.
18469 Not effective on redirect routers.
18470
18471
18472
18473 .option errors_to routers string&!! unset
18474 .cindex "envelope from"
18475 .cindex "envelope sender"
18476 .cindex "router" "changing address for errors"
18477 If a router successfully handles an address, it may assign the address to a
18478 transport for delivery or it may generate child addresses. In both cases, if
18479 there is a delivery problem during later processing, the resulting bounce
18480 message is sent to the address that results from expanding this string,
18481 provided that the address verifies successfully. The &%errors_to%& option is
18482 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18483
18484 The &%errors_to%& setting associated with an address can be overridden if it
18485 subsequently passes through other routers that have their own &%errors_to%&
18486 settings, or if the message is delivered by a transport with a &%return_path%&
18487 setting.
18488
18489 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18490 the expansion fails to verify, the errors address associated with the incoming
18491 address is used. At top level, this is the envelope sender. A non-forced
18492 expansion failure causes delivery to be deferred.
18493
18494 If an address for which &%errors_to%& has been set ends up being delivered over
18495 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18496 any bounces that are generated by other MTAs on the delivery route are also
18497 sent there. You can set &%errors_to%& to the empty string by either of these
18498 settings:
18499 .code
18500 errors_to =
18501 errors_to = ""
18502 .endd
18503 An expansion item that yields an empty string has the same effect. If you do
18504 this, a locally detected delivery error for addresses processed by this router
18505 no longer gives rise to a bounce message; the error is discarded. If the
18506 address is delivered to a remote host, the return path is set to &`<>`&, unless
18507 overridden by the &%return_path%& option on the transport.
18508
18509 .vindex "&$address_data$&"
18510 If for some reason you want to discard local errors, but use a non-empty
18511 MAIL command for remote delivery, you can preserve the original return
18512 path in &$address_data$& in the router, and reinstate it in the transport by
18513 setting &%return_path%&.
18514
18515 The most common use of &%errors_to%& is to direct mailing list bounces to the
18516 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18517 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18518
18519
18520
18521 .option expn routers&!? boolean true
18522 .cindex "address" "testing"
18523 .cindex "testing" "addresses"
18524 .cindex "EXPN" "router skipping"
18525 .cindex "router" "skipping for EXPN"
18526 If this option is turned off, the router is skipped when testing an address
18527 as a result of processing an SMTP EXPN command. You might, for example,
18528 want to turn it off on a router for users' &_.forward_& files, while leaving it
18529 on for the system alias file.
18530 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18531 are evaluated.
18532
18533 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18534 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18535 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18536
18537
18538
18539 .option fail_verify routers boolean false
18540 .cindex "router" "forcing verification failure"
18541 Setting this option has the effect of setting both &%fail_verify_sender%& and
18542 &%fail_verify_recipient%& to the same value.
18543
18544
18545
18546 .option fail_verify_recipient routers boolean false
18547 If this option is true and an address is accepted by this router when
18548 verifying a recipient, verification fails.
18549
18550
18551
18552 .option fail_verify_sender routers boolean false
18553 If this option is true and an address is accepted by this router when
18554 verifying a sender, verification fails.
18555
18556
18557
18558 .option fallback_hosts routers "string list" unset
18559 .cindex "router" "fallback hosts"
18560 .cindex "fallback" "hosts specified on router"
18561 String expansion is not applied to this option. The argument must be a
18562 colon-separated list of host names or IP addresses. The list separator can be
18563 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18564 each name or address. In fact, the format of each item is exactly the same as
18565 defined for the list of hosts in a &(manualroute)& router (see section
18566 &<<SECTformatonehostitem>>&).
18567
18568 If a router queues an address for a remote transport, this host list is
18569 associated with the address, and used instead of the transport's fallback host
18570 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18571 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18572 transport for further details.
18573
18574
18575 .option group routers string&!! "see below"
18576 .cindex "gid (group id)" "local delivery"
18577 .cindex "local transports" "uid and gid"
18578 .cindex "transport" "local"
18579 .cindex "router" "setting group"
18580 When a router queues an address for a transport, and the transport does not
18581 specify a group, the group given here is used when running the delivery
18582 process.
18583 The group may be specified numerically or by name. If expansion fails, the
18584 error is logged and delivery is deferred.
18585 The default is unset, unless &%check_local_user%& is set, when the default
18586 is taken from the password information. See also &%initgroups%& and &%user%&
18587 and the discussion in chapter &<<CHAPenvironment>>&.
18588
18589
18590
18591 .option headers_add routers list&!! unset
18592 .cindex "header lines" "adding"
18593 .cindex "router" "adding header lines"
18594 This option specifies a list of text headers,
18595 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18596 that is associated with any addresses that are accepted by the router.
18597 Each item is separately expanded, at routing time.  However, this
18598 option has no effect when an address is just being verified. The way in which
18599 the text is used to add header lines at transport time is described in section
18600 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18601 message is in the process of being transported. This means that references to
18602 header lines in string expansions in the transport's configuration do not
18603 &"see"& the added header lines.
18604
18605 The &%headers_add%& option is expanded after &%errors_to%&, but before
18606 &%headers_remove%& and &%transport%&. If an item is empty, or if
18607 an item expansion is forced to fail, the item has no effect. Other expansion
18608 failures are treated as configuration errors.
18609
18610 Unlike most options, &%headers_add%& can be specified multiple times
18611 for a router; all listed headers are added.
18612
18613 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18614 router that has the &%one_time%& option set.
18615
18616 .cindex "duplicate addresses"
18617 .oindex "&%unseen%&"
18618 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18619 additions are deleted when the address is passed on to subsequent routers.
18620 For a &%redirect%& router, if a generated address is the same as the incoming
18621 address, this can lead to duplicate addresses with different header
18622 modifications. Exim does not do duplicate deliveries (except, in certain
18623 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18624 which of the duplicates is discarded, so this ambiguous situation should be
18625 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18626
18627
18628
18629 .option headers_remove routers list&!! unset
18630 .cindex "header lines" "removing"
18631 .cindex "router" "removing header lines"
18632 This option specifies a list of text headers,
18633 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18634 that is associated with any addresses that are accepted by the router.
18635 Each item is separately expanded, at routing time.  However, this
18636 option has no effect when an address is just being verified. The way in which
18637 the text is used to remove header lines at transport time is described in
18638 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18639 the message is in the process of being transported. This means that references
18640 to header lines in string expansions in the transport's configuration still
18641 &"see"& the original header lines.
18642
18643 The &%headers_remove%& option is expanded after &%errors_to%& and
18644 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18645 the item has no effect. Other expansion failures are treated as configuration
18646 errors.
18647
18648 Unlike most options, &%headers_remove%& can be specified multiple times
18649 for a router; all listed headers are removed.
18650
18651 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18652 router that has the &%one_time%& option set.
18653
18654 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18655 removal requests are deleted when the address is passed on to subsequent
18656 routers, and this can lead to problems with duplicates -- see the similar
18657 warning for &%headers_add%& above.
18658
18659 &*Warning 3*&: Because of the separate expansion of the list items,
18660 items that contain a list separator must have it doubled.
18661 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18662
18663
18664
18665 .option ignore_target_hosts routers "host list&!!" unset
18666 .cindex "IP address" "discarding"
18667 .cindex "router" "discarding IP addresses"
18668 Although this option is a host list, it should normally contain IP address
18669 entries rather than names. If any host that is looked up by the router has an
18670 IP address that matches an item in this list, Exim behaves as if that IP
18671 address did not exist. This option allows you to cope with rogue DNS entries
18672 like
18673 .code
18674 remote.domain.example.  A  127.0.0.1
18675 .endd
18676 by setting
18677 .code
18678 ignore_target_hosts = 127.0.0.1
18679 .endd
18680 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18681 discarded in this way, the router declines. In a conventional configuration, an
18682 attempt to mail to such a domain would normally provoke the &"unrouteable
18683 domain"& error, and an attempt to verify an address in the domain would fail.
18684 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18685 router declines if presented with one of the listed addresses.
18686
18687 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18688 means of the first or the second of the following settings, respectively:
18689 .code
18690 ignore_target_hosts = 0.0.0.0/0
18691 ignore_target_hosts = <; 0::0/0
18692 .endd
18693 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18694 in the second line matches all IPv6 addresses.
18695
18696 This option may also be useful for ignoring link-local and site-local IPv6
18697 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18698 is expanded before use as a list, it is possible to make it dependent on the
18699 domain that is being routed.
18700
18701 .vindex "&$host_address$&"
18702 During its expansion, &$host_address$& is set to the IP address that is being
18703 checked.
18704
18705 .option initgroups routers boolean false
18706 .cindex "additional groups"
18707 .cindex "groups" "additional"
18708 .cindex "local transports" "uid and gid"
18709 .cindex "transport" "local"
18710 If the router queues an address for a transport, and this option is true, and
18711 the uid supplied by the router is not overridden by the transport, the
18712 &[initgroups()]& function is called when running the transport to ensure that
18713 any additional groups associated with the uid are set up. See also &%group%&
18714 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18715
18716
18717
18718 .option local_part_prefix routers&!? "string list" unset
18719 .cindex affix "router precondition"
18720 .cindex "router" "prefix for local part"
18721 .cindex "prefix" "for local part, used in router"
18722 If this option is set, the router is skipped unless the local part starts with
18723 one of the given strings, or &%local_part_prefix_optional%& is true. See
18724 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18725 evaluated.
18726
18727 The list is scanned from left to right, and the first prefix that matches is
18728 used. A limited form of wildcard is available; if the prefix begins with an
18729 asterisk, it matches the longest possible sequence of arbitrary characters at
18730 the start of the local part. An asterisk should therefore always be followed by
18731 some character that does not occur in normal local parts.
18732 .cindex "multiple mailboxes"
18733 .cindex "mailbox" "multiple"
18734 Wildcarding can be used to set up multiple user mailboxes, as described in
18735 section &<<SECTmulbox>>&.
18736
18737 .vindex "&$local_part$&"
18738 .vindex "&$local_part_prefix$&"
18739 During the testing of the &%local_parts%& option, and while the router is
18740 running, the prefix is removed from the local part, and is available in the
18741 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18742 the router accepts the address, this remains true during subsequent delivery by
18743 a transport. In particular, the local part that is transmitted in the RCPT
18744 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18745 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18746 the relevant transport.
18747
18748 When an address is being verified, &%local_part_prefix%& affects only the
18749 behaviour of the router. If the callout feature of verification is in use, this
18750 means that the full address, including the prefix, will be used during the
18751 callout.
18752
18753 The prefix facility is commonly used to handle local parts of the form
18754 &%owner-something%&. Another common use is to support local parts of the form
18755 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18756 to tell a user their forwarding is broken &-- by placing a router like this one
18757 immediately before the router that handles &_.forward_& files:
18758 .code
18759 real_localuser:
18760   driver = accept
18761   local_part_prefix = real-
18762   check_local_user
18763   transport = local_delivery
18764 .endd
18765 For security, it would probably be a good idea to restrict the use of this
18766 router to locally-generated messages, using a condition such as this:
18767 .code
18768   condition = ${if match {$sender_host_address}\
18769                          {\N^(|127\.0\.0\.1)$\N}}
18770 .endd
18771
18772 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18773 both conditions must be met if not optional. Care must be taken if wildcards
18774 are used in both a prefix and a suffix on the same router. Different
18775 separator characters must be used to avoid ambiguity.
18776
18777
18778 .option local_part_prefix_optional routers boolean false
18779 See &%local_part_prefix%& above.
18780
18781
18782
18783 .option local_part_suffix routers&!? "string list" unset
18784 .cindex "router" "suffix for local part"
18785 .cindex "suffix for local part" "used in router"
18786 This option operates in the same way as &%local_part_prefix%&, except that the
18787 local part must end (rather than start) with the given string, the
18788 &%local_part_suffix_optional%& option determines whether the suffix is
18789 mandatory, and the wildcard * character, if present, must be the last
18790 character of the suffix. This option facility is commonly used to handle local
18791 parts of the form &%something-request%& and multiple user mailboxes of the form
18792 &%username-foo%&.
18793
18794
18795 .option local_part_suffix_optional routers boolean false
18796 See &%local_part_suffix%& above.
18797
18798
18799
18800 .option local_parts routers&!? "local part list&!!" unset
18801 .cindex "router" "restricting to specific local parts"
18802 .cindex "local part" "checking in router"
18803 The router is run only if the local part of the address matches the list.
18804 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18805 are evaluated, and
18806 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18807 string is expanded, it is possible to make it depend on the domain, for
18808 example:
18809 .code
18810 local_parts = dbm;/usr/local/specials/$domain
18811 .endd
18812 .vindex "&$local_part_data$&"
18813 If the match is achieved by a lookup, the data that the lookup returned
18814 for the local part is placed in the variable &$local_part_data$& for use in
18815 expansions of the router's private options. You might use this option, for
18816 example, if you have a large number of local virtual domains, and you want to
18817 send all postmaster mail to the same place without having to set up an alias in
18818 each virtual domain:
18819 .code
18820 postmaster:
18821   driver = redirect
18822   local_parts = postmaster
18823   data = postmaster@real.domain.example
18824 .endd
18825
18826
18827 .option log_as_local routers boolean "see below"
18828 .cindex "log" "delivery line"
18829 .cindex "delivery" "log line format"
18830 Exim has two logging styles for delivery, the idea being to make local
18831 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18832 recipient address is given just as the local part, without a domain. The use of
18833 this style is controlled by this option. It defaults to true for the &(accept)&
18834 router, and false for all the others. This option applies only when a
18835 router assigns an address to a transport. It has no effect on routers that
18836 redirect addresses.
18837
18838
18839
18840 .option more routers boolean&!! true
18841 The result of string expansion for this option must be a valid boolean value,
18842 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18843 result causes an error, and delivery is deferred. If the expansion is forced to
18844 fail, the default value for the option (true) is used. Other failures cause
18845 delivery to be deferred.
18846
18847 If this option is set false, and the router declines to handle the address, no
18848 further routers are tried, routing fails, and the address is bounced.
18849 .oindex "&%self%&"
18850 However, if the router explicitly passes an address to the following router by
18851 means of the setting
18852 .code
18853 self = pass
18854 .endd
18855 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18856 does not affect the behaviour if one of the precondition tests fails. In that
18857 case, the address is always passed to the next router.
18858
18859 Note that &%address_data%& is not considered to be a precondition. If its
18860 expansion is forced to fail, the router declines, and the value of &%more%&
18861 controls what happens next.
18862
18863
18864 .option pass_on_timeout routers boolean false
18865 .cindex "timeout" "of router"
18866 .cindex "router" "timeout"
18867 If a router times out during a host lookup, it normally causes deferral of the
18868 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18869 router, overriding &%no_more%&. This may be helpful for systems that are
18870 intermittently connected to the Internet, or those that want to pass to a smart
18871 host any messages that cannot immediately be delivered.
18872
18873 There are occasional other temporary errors that can occur while doing DNS
18874 lookups. They are treated in the same way as a timeout, and this option
18875 applies to all of them.
18876
18877
18878
18879 .option pass_router routers string unset
18880 .cindex "router" "go to after &""pass""&"
18881 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18882 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18883 routing to continue, and overriding a false setting of &%more%&. When one of
18884 these routers returns &"pass"&, the address is normally handed on to the next
18885 router in sequence. This can be changed by setting &%pass_router%& to the name
18886 of another router. However (unlike &%redirect_router%&) the named router must
18887 be below the current router, to avoid loops. Note that this option applies only
18888 to the special case of &"pass"&. It does not apply when a router returns
18889 &"decline"& because it cannot handle an address.
18890
18891
18892
18893 .option redirect_router routers string unset
18894 .cindex "router" "start at after redirection"
18895 Sometimes an administrator knows that it is pointless to reprocess addresses
18896 generated from alias or forward files with the same router again. For
18897 example, if an alias file translates real names into login ids there is no
18898 point searching the alias file a second time, especially if it is a large file.
18899
18900 The &%redirect_router%& option can be set to the name of any router instance.
18901 It causes the routing of any generated addresses to start at the named router
18902 instead of at the first router. This option has no effect if the router in
18903 which it is set does not generate new addresses.
18904
18905
18906
18907 .option require_files routers&!? "string list&!!" unset
18908 .cindex "file" "requiring for router"
18909 .cindex "router" "requiring file existence"
18910 This option provides a general mechanism for predicating the running of a
18911 router on the existence or non-existence of certain files or directories.
18912 Before running a router, as one of its precondition tests, Exim works its way
18913 through the &%require_files%& list, expanding each item separately.
18914
18915 Because the list is split before expansion, any colons in expansion items must
18916 be doubled, or the facility for using a different list separator must be used
18917 (&<<SECTlistsepchange>>&).
18918 If any expansion is forced to fail, the item is ignored. Other expansion
18919 failures cause routing of the address to be deferred.
18920
18921 If any expanded string is empty, it is ignored. Otherwise, except as described
18922 below, each string must be a fully qualified file path, optionally preceded by
18923 &"!"&. The paths are passed to the &[stat()]& function to test for the
18924 existence of the files or directories. The router is skipped if any paths not
18925 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18926
18927 .cindex "NFS"
18928 If &[stat()]& cannot determine whether a file exists or not, delivery of
18929 the message is deferred. This can happen when NFS-mounted filesystems are
18930 unavailable.
18931
18932 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18933 options, so you cannot use it to check for the existence of a file in which to
18934 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18935 full list of the order in which preconditions are evaluated.) However, as
18936 these options are all expanded, you can use the &%exists%& expansion condition
18937 to make such tests. The &%require_files%& option is intended for checking files
18938 that the router may be going to use internally, or which are needed by a
18939 transport (e.g., &_.procmailrc_&).
18940
18941 During delivery, the &[stat()]& function is run as root, but there is a
18942 facility for some checking of the accessibility of a file by another user.
18943 This is not a proper permissions check, but just a &"rough"& check that
18944 operates as follows:
18945
18946 If an item in a &%require_files%& list does not contain any forward slash
18947 characters, it is taken to be the user (and optional group, separated by a
18948 comma) to be checked for subsequent files in the list. If no group is specified
18949 but the user is specified symbolically, the gid associated with the uid is
18950 used. For example:
18951 .code
18952 require_files = mail:/some/file
18953 require_files = $local_part:$home/.procmailrc
18954 .endd
18955 If a user or group name in a &%require_files%& list does not exist, the
18956 &%require_files%& condition fails.
18957
18958 Exim performs the check by scanning along the components of the file path, and
18959 checking the access for the given uid and gid. It checks for &"x"& access on
18960 directories, and &"r"& access on the final file. Note that this means that file
18961 access control lists, if the operating system has them, are ignored.
18962
18963 &*Warning 1*&: When the router is being run to verify addresses for an
18964 incoming SMTP message, Exim is not running as root, but under its own uid. This
18965 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18966 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18967 user is not permitted to read one of the directories on the file's path.
18968
18969 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18970 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18971 without root access. In this case, if a check for access by a particular user
18972 is requested, Exim creates a subprocess that runs as that user, and tries the
18973 check again in that process.
18974
18975 The default action for handling an unresolved EACCES is to consider it to
18976 be caused by a configuration error, and routing is deferred because the
18977 existence or non-existence of the file cannot be determined. However, in some
18978 circumstances it may be desirable to treat this condition as if the file did
18979 not exist. If the filename (or the exclamation mark that precedes the filename
18980 for non-existence) is preceded by a plus sign, the EACCES error is treated
18981 as if the file did not exist. For example:
18982 .code
18983 require_files = +/some/file
18984 .endd
18985 If the router is not an essential part of verification (for example, it
18986 handles users' &_.forward_& files), another solution is to set the &%verify%&
18987 option false so that the router is skipped when verifying.
18988
18989
18990
18991 .option retry_use_local_part routers boolean "see below"
18992 .cindex "hints database" "retry keys"
18993 .cindex "local part" "in retry keys"
18994 When a delivery suffers a temporary routing failure, a retry record is created
18995 in Exim's hints database. For addresses whose routing depends only on the
18996 domain, the key for the retry record should not involve the local part, but for
18997 other addresses, both the domain and the local part should be included.
18998 Usually, remote routing is of the former kind, and local routing is of the
18999 latter kind.
19000
19001 This option controls whether the local part is used to form the key for retry
19002 hints for addresses that suffer temporary errors while being handled by this
19003 .new
19004 router. The default value is true for any router that has any of
19005 &%check_local_user%&,
19006 &%local_parts%&,
19007 &%condition%&,
19008 &%local_part_prefix%&,
19009 &%local_part_suffix%&,
19010 &%senders%& or
19011 &%require_files%&
19012 .wen
19013 set, and false otherwise. Note that this option does not apply to hints keys
19014 for transport delays; they are controlled by a generic transport option of the
19015 same name.
19016
19017 Failing to set this option when it is needed
19018 (because a remote router handles only some of the local-parts for a domain)
19019 can result in incorrect error messages being generated.
19020
19021 The setting of &%retry_use_local_part%& applies only to the router on which it
19022 appears. If the router generates child addresses, they are routed
19023 independently; this setting does not become attached to them.
19024
19025
19026
19027 .option router_home_directory routers string&!! unset
19028 .cindex "router" "home directory for"
19029 .cindex "home directory" "for router"
19030 .vindex "&$home$&"
19031 This option sets a home directory for use while the router is running. (Compare
19032 &%transport_home_directory%&, which sets a home directory for later
19033 transporting.) In particular, if used on a &(redirect)& router, this option
19034 sets a value for &$home$& while a filter is running. The value is expanded;
19035 forced expansion failure causes the option to be ignored &-- other failures
19036 cause the router to defer.
19037
19038 Expansion of &%router_home_directory%& happens immediately after the
19039 &%check_local_user%& test (if configured), before any further expansions take
19040 place.
19041 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19042 are evaluated.)
19043 While the router is running, &%router_home_directory%& overrides the value of
19044 &$home$& that came from &%check_local_user%&.
19045
19046 When a router accepts an address and assigns it to a local transport (including
19047 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19048 delivery), the home directory setting for the transport is taken from the first
19049 of these values that is set:
19050
19051 .ilist
19052 The &%home_directory%& option on the transport;
19053 .next
19054 The &%transport_home_directory%& option on the router;
19055 .next
19056 The password data if &%check_local_user%& is set on the router;
19057 .next
19058 The &%router_home_directory%& option on the router.
19059 .endlist
19060
19061 In other words, &%router_home_directory%& overrides the password data for the
19062 router, but not for the transport.
19063
19064
19065
19066 .option self routers string freeze
19067 .cindex "MX record" "pointing to local host"
19068 .cindex "local host" "MX pointing to"
19069 This option applies to those routers that use a recipient address to find a
19070 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19071 and &(manualroute)& routers.
19072 Certain configurations of the &(queryprogram)& router can also specify a list
19073 of remote hosts.
19074 Usually such routers are configured to send the message to a remote host via an
19075 &(smtp)& transport. The &%self%& option specifies what happens when the first
19076 host on the list turns out to be the local host.
19077 The way in which Exim checks for the local host is described in section
19078 &<<SECTreclocipadd>>&.
19079
19080 Normally this situation indicates either an error in Exim's configuration (for
19081 example, the router should be configured not to process this domain), or an
19082 error in the DNS (for example, the MX should not point to this host). For this
19083 reason, the default action is to log the incident, defer the address, and
19084 freeze the message. The following alternatives are provided for use in special
19085 cases:
19086
19087 .vlist
19088 .vitem &%defer%&
19089 Delivery of the message is tried again later, but the message is not frozen.
19090
19091 .vitem "&%reroute%&: <&'domain'&>"
19092 The domain is changed to the given domain, and the address is passed back to
19093 be reprocessed by the routers. No rewriting of headers takes place. This
19094 behaviour is essentially a redirection.
19095
19096 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19097 The domain is changed to the given domain, and the address is passed back to be
19098 reprocessed by the routers. Any headers that contain the original domain are
19099 rewritten.
19100
19101 .vitem &%pass%&
19102 .oindex "&%more%&"
19103 .vindex "&$self_hostname$&"
19104 The router passes the address to the next router, or to the router named in the
19105 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19106 subsequent routing and delivery, the variable &$self_hostname$& contains the
19107 name of the local host that the router encountered. This can be used to
19108 distinguish between different cases for hosts with multiple names. The
19109 combination
19110 .code
19111 self = pass
19112 no_more
19113 .endd
19114 ensures that only those addresses that routed to the local host are passed on.
19115 Without &%no_more%&, addresses that were declined for other reasons would also
19116 be passed to the next router.
19117
19118 .vitem &%fail%&
19119 Delivery fails and an error report is generated.
19120
19121 .vitem &%send%&
19122 .cindex "local host" "sending to"
19123 The anomaly is ignored and the address is queued for the transport. This
19124 setting should be used with extreme caution. For an &(smtp)& transport, it
19125 makes sense only in cases where the program that is listening on the SMTP port
19126 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19127 different configuration file that handles the domain in another way.
19128 .endlist
19129
19130
19131
19132 .option senders routers&!? "address list&!!" unset
19133 .cindex "router" "checking senders"
19134 If this option is set, the router is skipped unless the message's sender
19135 address matches something on the list.
19136 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19137 are evaluated.
19138
19139 There are issues concerning verification when the running of routers is
19140 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19141 setting, it sets the sender to the null string. When using the &%-bt%& option
19142 to check a configuration file, it is necessary also to use the &%-f%& option to
19143 set an appropriate sender. For incoming mail, the sender is unset when
19144 verifying the sender, but is available when verifying any recipients. If the
19145 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19146 matters.
19147
19148
19149 .new
19150 .option set routers "string list" unset
19151 .cindex router variables
19152 This option may be used multiple times on a router;
19153 because of this the list aspect is mostly irrelevant.
19154 The list separator is a semicolon but can be changed in the
19155 usual way.
19156
19157 Each list-element given must be of the form &"name = value"&
19158 and the names used must start with the string &"r_"&.
19159 Values containing a list-separator should have them doubled.
19160 When a router runs, the strings are evaluated in order,
19161 to create variables which are added to the set associated with
19162 the address.
19163 The variable is set with the expansion of the value.
19164 The variables can be used by the router options
19165 (not including any preconditions)
19166 and by the transport.
19167 Later definitions of a given named variable will override former ones.
19168 Variable use is via the usual &$r_...$& syntax.
19169
19170 This is similar to the &%address_data%& option, except that
19171 many independent variables can be used, with choice of naming.
19172 .wen
19173
19174
19175 .option translate_ip_address routers string&!! unset
19176 .cindex "IP address" "translating"
19177 .cindex "packet radio"
19178 .cindex "router" "IP address translation"
19179 There exist some rare networking situations (for example, packet radio) where
19180 it is helpful to be able to translate IP addresses generated by normal routing
19181 mechanisms into other IP addresses, thus performing a kind of manual IP
19182 routing. This should be done only if the normal IP routing of the TCP/IP stack
19183 is inadequate or broken. Because this is an extremely uncommon requirement, the
19184 code to support this option is not included in the Exim binary unless
19185 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19186
19187 .vindex "&$host_address$&"
19188 The &%translate_ip_address%& string is expanded for every IP address generated
19189 by the router, with the generated address set in &$host_address$&. If the
19190 expansion is forced to fail, no action is taken.
19191 For any other expansion error, delivery of the message is deferred.
19192 If the result of the expansion is an IP address, that replaces the original
19193 address; otherwise the result is assumed to be a host name &-- this is looked
19194 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19195 produce one or more replacement IP addresses. For example, to subvert all IP
19196 addresses in some specific networks, this could be added to a router:
19197 .code
19198 translate_ip_address = \
19199   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19200     {$value}fail}}
19201 .endd
19202 The file would contain lines like
19203 .code
19204 10.2.3.128/26    some.host
19205 10.8.4.34/26     10.44.8.15
19206 .endd
19207 You should not make use of this facility unless you really understand what you
19208 are doing.
19209
19210
19211
19212 .option transport routers string&!! unset
19213 This option specifies the transport to be used when a router accepts an address
19214 and sets it up for delivery. A transport is never needed if a router is used
19215 only for verification. The value of the option is expanded at routing time,
19216 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19217 and result must be the name of one of the configured transports. If it is not,
19218 delivery is deferred.
19219
19220 The &%transport%& option is not used by the &(redirect)& router, but it does
19221 have some private options that set up transports for pipe and file deliveries
19222 (see chapter &<<CHAPredirect>>&).
19223
19224
19225
19226 .option transport_current_directory routers string&!! unset
19227 .cindex "current directory for local transport"
19228 This option associates a current directory with any address that is routed
19229 to a local transport. This can happen either because a transport is
19230 explicitly configured for the router, or because it generates a delivery to a
19231 file or a pipe. During the delivery process (that is, at transport time), this
19232 option string is expanded and is set as the current directory, unless
19233 overridden by a setting on the transport.
19234 If the expansion fails for any reason, including forced failure, an error is
19235 logged, and delivery is deferred.
19236 See chapter &<<CHAPenvironment>>& for details of the local delivery
19237 environment.
19238
19239
19240
19241
19242 .option transport_home_directory routers string&!! "see below"
19243 .cindex "home directory" "for local transport"
19244 This option associates a home directory with any address that is routed to a
19245 local transport. This can happen either because a transport is explicitly
19246 configured for the router, or because it generates a delivery to a file or a
19247 pipe. During the delivery process (that is, at transport time), the option
19248 string is expanded and is set as the home directory, unless overridden by a
19249 setting of &%home_directory%& on the transport.
19250 If the expansion fails for any reason, including forced failure, an error is
19251 logged, and delivery is deferred.
19252
19253 If the transport does not specify a home directory, and
19254 &%transport_home_directory%& is not set for the router, the home directory for
19255 the transport is taken from the password data if &%check_local_user%& is set for
19256 the router. Otherwise it is taken from &%router_home_directory%& if that option
19257 is set; if not, no home directory is set for the transport.
19258
19259 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19260 environment.
19261
19262
19263
19264
19265 .option unseen routers boolean&!! false
19266 .cindex "router" "carrying on after success"
19267 The result of string expansion for this option must be a valid boolean value,
19268 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19269 result causes an error, and delivery is deferred. If the expansion is forced to
19270 fail, the default value for the option (false) is used. Other failures cause
19271 delivery to be deferred.
19272
19273 When this option is set true, routing does not cease if the router accepts the
19274 address. Instead, a copy of the incoming address is passed to the next router,
19275 overriding a false setting of &%more%&. There is little point in setting
19276 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19277 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19278 sometimes true and sometimes false).
19279
19280 .cindex "copy of message (&%unseen%& option)"
19281 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19282 qualifier in filter files. It can be used to cause copies of messages to be
19283 delivered to some other destination, while also carrying out a normal delivery.
19284 In effect, the current address is made into a &"parent"& that has two children
19285 &-- one that is delivered as specified by this router, and a clone that goes on
19286 to be routed further. For this reason, &%unseen%& may not be combined with the
19287 &%one_time%& option in a &(redirect)& router.
19288
19289 &*Warning*&: Header lines added to the address (or specified for removal) by
19290 this router or by previous routers affect the &"unseen"& copy of the message
19291 only. The clone that continues to be processed by further routers starts with
19292 no added headers and none specified for removal. For a &%redirect%& router, if
19293 a generated address is the same as the incoming address, this can lead to
19294 duplicate addresses with different header modifications. Exim does not do
19295 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19296 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19297 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19298 &%redirect%& router may be of help.
19299
19300 Unlike the handling of header modifications, any data that was set by the
19301 &%address_data%& option in the current or previous routers &'is'& passed on to
19302 subsequent routers.
19303
19304
19305 .option user routers string&!! "see below"
19306 .cindex "uid (user id)" "local delivery"
19307 .cindex "local transports" "uid and gid"
19308 .cindex "transport" "local"
19309 .cindex "router" "user for filter processing"
19310 .cindex "filter" "user for processing"
19311 When a router queues an address for a transport, and the transport does not
19312 specify a user, the user given here is used when running the delivery process.
19313 The user may be specified numerically or by name. If expansion fails, the
19314 error is logged and delivery is deferred.
19315 This user is also used by the &(redirect)& router when running a filter file.
19316 The default is unset, except when &%check_local_user%& is set. In this case,
19317 the default is taken from the password information. If the user is specified as
19318 a name, and &%group%& is not set, the group associated with the user is used.
19319 See also &%initgroups%& and &%group%& and the discussion in chapter
19320 &<<CHAPenvironment>>&.
19321
19322
19323
19324 .option verify routers&!? boolean true
19325 Setting this option has the effect of setting &%verify_sender%& and
19326 &%verify_recipient%& to the same value.
19327
19328
19329 .option verify_only routers&!? boolean false
19330 .cindex "EXPN" "with &%verify_only%&"
19331 .oindex "&%-bv%&"
19332 .cindex "router" "used only when verifying"
19333 If this option is set, the router is used only when verifying an address,
19334 delivering in cutthrough mode or
19335 testing with the &%-bv%& option, not when actually doing a delivery, testing
19336 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19337 restricted to verifying only senders or recipients by means of
19338 &%verify_sender%& and &%verify_recipient%&.
19339
19340 &*Warning*&: When the router is being run to verify addresses for an incoming
19341 SMTP message, Exim is not running as root, but under its own uid. If the router
19342 accesses any files, you need to make sure that they are accessible to the Exim
19343 user or group.
19344
19345
19346 .option verify_recipient routers&!? boolean true
19347 If this option is false, the router is skipped when verifying recipient
19348 addresses,
19349 delivering in cutthrough mode
19350 or testing recipient verification using &%-bv%&.
19351 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19352 are evaluated.
19353 See also the &$verify_mode$& variable.
19354
19355
19356 .option verify_sender routers&!? boolean true
19357 If this option is false, the router is skipped when verifying sender addresses
19358 or testing sender verification using &%-bvs%&.
19359 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19360 are evaluated.
19361 See also the &$verify_mode$& variable.
19362 .ecindex IIDgenoprou1
19363 .ecindex IIDgenoprou2
19364
19365
19366
19367
19368
19369
19370 . ////////////////////////////////////////////////////////////////////////////
19371 . ////////////////////////////////////////////////////////////////////////////
19372
19373 .chapter "The accept router" "CHID4"
19374 .cindex "&(accept)& router"
19375 .cindex "routers" "&(accept)&"
19376 The &(accept)& router has no private options of its own. Unless it is being
19377 used purely for verification (see &%verify_only%&) a transport is required to
19378 be defined by the generic &%transport%& option. If the preconditions that are
19379 specified by generic options are met, the router accepts the address and queues
19380 it for the given transport. The most common use of this router is for setting
19381 up deliveries to local mailboxes. For example:
19382 .code
19383 localusers:
19384   driver = accept
19385   domains = mydomain.example
19386   check_local_user
19387   transport = local_delivery
19388 .endd
19389 The &%domains%& condition in this example checks the domain of the address, and
19390 &%check_local_user%& checks that the local part is the login of a local user.
19391 When both preconditions are met, the &(accept)& router runs, and queues the
19392 address for the &(local_delivery)& transport.
19393
19394
19395
19396
19397
19398
19399 . ////////////////////////////////////////////////////////////////////////////
19400 . ////////////////////////////////////////////////////////////////////////////
19401
19402 .chapter "The dnslookup router" "CHAPdnslookup"
19403 .scindex IIDdnsrou1 "&(dnslookup)& router"
19404 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19405 The &(dnslookup)& router looks up the hosts that handle mail for the
19406 recipient's domain in the DNS. A transport must always be set for this router,
19407 unless &%verify_only%& is set.
19408
19409 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19410 SRV records. If none are found, or if SRV support is not configured,
19411 MX records are looked up. If no MX records exist, address records are sought.
19412 However, &%mx_domains%& can be set to disable the direct use of address
19413 records.
19414
19415 MX records of equal priority are sorted by Exim into a random order. Exim then
19416 looks for address records for the host names obtained from MX or SRV records.
19417 When a host has more than one IP address, they are sorted into a random order,
19418 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19419 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19420 generic option, the router declines.
19421
19422 Unless they have the highest priority (lowest MX value), MX records that point
19423 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19424 are discarded, together with any other MX records of equal or lower priority.
19425
19426 .cindex "MX record" "pointing to local host"
19427 .cindex "local host" "MX pointing to"
19428 .oindex "&%self%&" "in &(dnslookup)& router"
19429 If the host pointed to by the highest priority MX record, or looked up as an
19430 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19431 happens is controlled by the generic &%self%& option.
19432
19433
19434 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19435 There have been problems with DNS servers when SRV records are looked up.
19436 Some misbehaving servers return a DNS error or timeout when a non-existent
19437 SRV record is sought. Similar problems have in the past been reported for
19438 MX records. The global &%dns_again_means_nonexist%& option can help with this
19439 problem, but it is heavy-handed because it is a global option.
19440
19441 For this reason, there are two options, &%srv_fail_domains%& and
19442 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19443 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19444 an attempt to look up an SRV or MX record causes one of these results, and the
19445 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19446 such record"&. In the case of an SRV lookup, this means that the router
19447 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19448 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19449 case routing fails.
19450
19451
19452 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19453 .cindex "&(dnslookup)& router" "declines"
19454 There are a few cases where a &(dnslookup)& router will decline to accept
19455 an address; if such a router is expected to handle "all remaining non-local
19456 domains", then it is important to set &%no_more%&.
19457
19458 The router will defer rather than decline if the domain
19459 is found in the &%fail_defer_domains%& router option.
19460
19461 Reasons for a &(dnslookup)& router to decline currently include:
19462 .ilist
19463 The domain does not exist in DNS
19464 .next
19465 The domain exists but the MX record's host part is just "."; this is a common
19466 convention (borrowed from SRV) used to indicate that there is no such service
19467 for this domain and to not fall back to trying A/AAAA records.
19468 .next
19469 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19470 .next
19471 MX record points to a non-existent host.
19472 .next
19473 MX record points to an IP address and the main section option
19474 &%allow_mx_to_ip%& is not set.
19475 .next
19476 MX records exist and point to valid hosts, but all hosts resolve only to
19477 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19478 .next
19479 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19480 &%dns_check_names_pattern%& for handling one variant of this)
19481 .next
19482 &%check_secondary_mx%& is set on this router but the local host can
19483 not be found in the MX records (see below)
19484 .endlist
19485
19486
19487
19488
19489 .section "Private options for dnslookup" "SECID118"
19490 .cindex "options" "&(dnslookup)& router"
19491 The private options for the &(dnslookup)& router are as follows:
19492
19493 .option check_secondary_mx dnslookup boolean false
19494 .cindex "MX record" "checking for secondary"
19495 If this option is set, the router declines unless the local host is found in
19496 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19497 process domains for which the local host is a secondary mail exchanger
19498 differently to other domains. The way in which Exim decides whether a host is
19499 the local host is described in section &<<SECTreclocipadd>>&.
19500
19501
19502 .option check_srv dnslookup string&!! unset
19503 .cindex "SRV record" "enabling use of"
19504 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19505 addition to MX and address records. The support is disabled by default. To
19506 enable SRV support, set the &%check_srv%& option to the name of the service
19507 required. For example,
19508 .code
19509 check_srv = smtp
19510 .endd
19511 looks for SRV records that refer to the normal smtp service. The option is
19512 expanded, so the service name can vary from message to message or address
19513 to address. This might be helpful if SRV records are being used for a
19514 submission service. If the expansion is forced to fail, the &%check_srv%&
19515 option is ignored, and the router proceeds to look for MX records in the
19516 normal way.
19517
19518 When the expansion succeeds, the router searches first for SRV records for
19519 the given service (it assumes TCP protocol). A single SRV record with a
19520 host name that consists of just a single dot indicates &"no such service for
19521 this domain"&; if this is encountered, the router declines. If other kinds of
19522 SRV record are found, they are used to construct a host list for delivery
19523 according to the rules of RFC 2782. MX records are not sought in this case.
19524
19525 When no SRV records are found, MX records (and address records) are sought in
19526 the traditional way. In other words, SRV records take precedence over MX
19527 records, just as MX records take precedence over address records. Note that
19528 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19529 defined it. It is apparently believed that MX records are sufficient for email
19530 and that SRV records should not be used for this purpose. However, SRV records
19531 have an additional &"weight"& feature which some people might find useful when
19532 trying to split an SMTP load between hosts of different power.
19533
19534 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19535 when there is a DNS lookup error.
19536
19537
19538
19539
19540 .option fail_defer_domains dnslookup "domain list&!!" unset
19541 .cindex "MX record" "not found"
19542 DNS lookups for domains matching &%fail_defer_domains%&
19543 which find no matching record will cause the router to defer
19544 rather than the default behaviour of decline.
19545 This maybe be useful for queueing messages for a newly created
19546 domain while the DNS configuration is not ready.
19547 However, it will result in any message with mistyped domains
19548 also being queued.
19549
19550
19551 .option ipv4_only "string&!!" unset
19552 .cindex IPv6 disabling
19553 .cindex DNS "IPv6 disabling"
19554 The string is expanded, and if the result is anything but a forced failure,
19555 or an empty string, or one of the strings “0” or “no” or “false”
19556 (checked without regard to the case of the letters),
19557 only A records are used.
19558
19559 .option ipv4_prefer "string&!!" unset
19560 .cindex IPv4 preference
19561 .cindex DNS "IPv4 preference"
19562 The string is expanded, and if the result is anything but a forced failure,
19563 or an empty string, or one of the strings “0” or “no” or “false”
19564 (checked without regard to the case of the letters),
19565 A records are sorted before AAAA records (inverting the default).
19566
19567 .option mx_domains dnslookup "domain list&!!" unset
19568 .cindex "MX record" "required to exist"
19569 .cindex "SRV record" "required to exist"
19570 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19571 record in order to be recognized. (The name of this option could be improved.)
19572 For example, if all the mail hosts in &'fict.example'& are known to have MX
19573 records, except for those in &'discworld.fict.example'&, you could use this
19574 setting:
19575 .code
19576 mx_domains = ! *.discworld.fict.example : *.fict.example
19577 .endd
19578 This specifies that messages addressed to a domain that matches the list but
19579 has no MX record should be bounced immediately instead of being routed using
19580 the address record.
19581
19582
19583 .option mx_fail_domains dnslookup "domain list&!!" unset
19584 If the DNS lookup for MX records for one of the domains in this list causes a
19585 DNS lookup error, Exim behaves as if no MX records were found. See section
19586 &<<SECTprowitdnsloo>>& for more discussion.
19587
19588
19589
19590
19591 .option qualify_single dnslookup boolean true
19592 .cindex "DNS" "resolver options"
19593 .cindex "DNS" "qualifying single-component names"
19594 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19595 lookups. Typically, but not standardly, this causes the resolver to qualify
19596 single-component names with the default domain. For example, on a machine
19597 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19598 &'thesaurus.ref.example'& inside the resolver. For details of what your
19599 resolver actually does, consult your man pages for &'resolver'& and
19600 &'resolv.conf'&.
19601
19602
19603
19604 .option rewrite_headers dnslookup boolean true
19605 .cindex "rewriting" "header lines"
19606 .cindex "header lines" "rewriting"
19607 If the domain name in the address that is being processed is not fully
19608 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19609 an address is specified as &'dormouse@teaparty'&, the domain might be
19610 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19611 occur as a result of setting the &%widen_domains%& option. If
19612 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19613 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19614 header lines of the message are rewritten with the full domain name.
19615
19616 This option should be turned off only when it is known that no message is
19617 ever going to be sent outside an environment where the abbreviation makes
19618 sense.
19619
19620 When an MX record is looked up in the DNS and matches a wildcard record, name
19621 servers normally return a record containing the name that has been looked up,
19622 making it impossible to detect whether a wildcard was present or not. However,
19623 some name servers have recently been seen to return the wildcard entry. If the
19624 name returned by a DNS lookup begins with an asterisk, it is not used for
19625 header rewriting.
19626
19627
19628 .option same_domain_copy_routing dnslookup boolean false
19629 .cindex "address" "copying routing"
19630 Addresses with the same domain are normally routed by the &(dnslookup)& router
19631 to the same list of hosts. However, this cannot be presumed, because the router
19632 options and preconditions may refer to the local part of the address. By
19633 default, therefore, Exim routes each address in a message independently. DNS
19634 servers run caches, so repeated DNS lookups are not normally expensive, and in
19635 any case, personal messages rarely have more than a few recipients.
19636
19637 If you are running mailing lists with large numbers of subscribers at the same
19638 domain, and you are using a &(dnslookup)& router which is independent of the
19639 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19640 lookups for identical domains in one message. In this case, when &(dnslookup)&
19641 routes an address to a remote transport, any other unrouted addresses in the
19642 message that have the same domain are automatically given the same routing
19643 without processing them independently,
19644 provided the following conditions are met:
19645
19646 .ilist
19647 No router that processed the address specified &%headers_add%& or
19648 &%headers_remove%&.
19649 .next
19650 The router did not change the address in any way, for example, by &"widening"&
19651 the domain.
19652 .endlist
19653
19654
19655
19656
19657 .option search_parents dnslookup boolean false
19658 .cindex "DNS" "resolver options"
19659 When this option is true, the resolver option RES_DNSRCH is set for DNS
19660 lookups. This is different from the &%qualify_single%& option in that it
19661 applies to domains containing dots. Typically, but not standardly, it causes
19662 the resolver to search for the name in the current domain and in parent
19663 domains. For example, on a machine in the &'fict.example'& domain, if looking
19664 up &'teaparty.wonderland'& failed, the resolver would try
19665 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19666 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19667
19668 Setting this option true can cause problems in domains that have a wildcard MX
19669 record, because any domain that does not have its own MX record matches the
19670 local wildcard.
19671
19672
19673
19674 .option srv_fail_domains dnslookup "domain list&!!" unset
19675 If the DNS lookup for SRV records for one of the domains in this list causes a
19676 DNS lookup error, Exim behaves as if no SRV records were found. See section
19677 &<<SECTprowitdnsloo>>& for more discussion.
19678
19679
19680
19681
19682 .option widen_domains dnslookup "string list" unset
19683 .cindex "domain" "partial; widening"
19684 If a DNS lookup fails and this option is set, each of its strings in turn is
19685 added onto the end of the domain, and the lookup is tried again. For example,
19686 if
19687 .code
19688 widen_domains = fict.example:ref.example
19689 .endd
19690 is set and a lookup of &'klingon.dictionary'& fails,
19691 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19692 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19693 and &%search_parents%& options can cause some widening to be undertaken inside
19694 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19695 when verifying, unless &%rewrite_headers%& is false (not the default).
19696
19697
19698 .section "Effect of qualify_single and search_parents" "SECID119"
19699 When a domain from an envelope recipient is changed by the resolver as a result
19700 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19701 corresponding address in the message's header lines unless &%rewrite_headers%&
19702 is set false. Exim then re-routes the address, using the full domain.
19703
19704 These two options affect only the DNS lookup that takes place inside the router
19705 for the domain of the address that is being routed. They do not affect lookups
19706 such as that implied by
19707 .code
19708 domains = @mx_any
19709 .endd
19710 that may happen while processing a router precondition before the router is
19711 entered. No widening ever takes place for these lookups.
19712 .ecindex IIDdnsrou1
19713 .ecindex IIDdnsrou2
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723 . ////////////////////////////////////////////////////////////////////////////
19724 . ////////////////////////////////////////////////////////////////////////////
19725
19726 .chapter "The ipliteral router" "CHID5"
19727 .cindex "&(ipliteral)& router"
19728 .cindex "domain literal" "routing"
19729 .cindex "routers" "&(ipliteral)&"
19730 This router has no private options. Unless it is being used purely for
19731 verification (see &%verify_only%&) a transport is required to be defined by the
19732 generic &%transport%& option. The router accepts the address if its domain part
19733 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19734 router handles the address
19735 .code
19736 root@[192.168.1.1]
19737 .endd
19738 by setting up delivery to the host with that IP address. IPv4 domain literals
19739 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19740 are similar, but the address is preceded by &`ipv6:`&. For example:
19741 .code
19742 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19743 .endd
19744 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19745 grounds that sooner or later somebody will try it.
19746
19747 .oindex "&%self%&" "in &(ipliteral)& router"
19748 If the IP address matches something in &%ignore_target_hosts%&, the router
19749 declines. If an IP literal turns out to refer to the local host, the generic
19750 &%self%& option determines what happens.
19751
19752 The RFCs require support for domain literals; however, their use is
19753 controversial in today's Internet. If you want to use this router, you must
19754 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19755 Exim will not recognize the domain literal syntax in addresses.
19756
19757
19758
19759 . ////////////////////////////////////////////////////////////////////////////
19760 . ////////////////////////////////////////////////////////////////////////////
19761
19762 .chapter "The iplookup router" "CHID6"
19763 .cindex "&(iplookup)& router"
19764 .cindex "routers" "&(iplookup)&"
19765 The &(iplookup)& router was written to fulfil a specific requirement in
19766 Cambridge University (which in fact no longer exists). For this reason, it is
19767 not included in the binary of Exim by default. If you want to include it, you
19768 must set
19769 .code
19770 ROUTER_IPLOOKUP=yes
19771 .endd
19772 in your &_Local/Makefile_& configuration file.
19773
19774 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19775 connection to one or more specific hosts. The host can then return the same or
19776 a different address &-- in effect rewriting the recipient address in the
19777 message's envelope. The new address is then passed on to subsequent routers. If
19778 this process fails, the address can be passed on to other routers, or delivery
19779 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19780 must not be specified for it.
19781
19782 .cindex "options" "&(iplookup)& router"
19783 .option hosts iplookup string unset
19784 This option must be supplied. Its value is a colon-separated list of host
19785 names. The hosts are looked up using &[gethostbyname()]&
19786 (or &[getipnodebyname()]& when available)
19787 and are tried in order until one responds to the query. If none respond, what
19788 happens is controlled by &%optional%&.
19789
19790
19791 .option optional iplookup boolean false
19792 If &%optional%& is true, if no response is obtained from any host, the address
19793 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19794 delivery to the address is deferred.
19795
19796
19797 .option port iplookup integer 0
19798 .cindex "port" "&(iplookup)& router"
19799 This option must be supplied. It specifies the port number for the TCP or UDP
19800 call.
19801
19802
19803 .option protocol iplookup string udp
19804 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19805 protocols is to be used.
19806
19807
19808 .option query iplookup string&!! "see below"
19809 This defines the content of the query that is sent to the remote hosts. The
19810 default value is:
19811 .code
19812 $local_part@$domain $local_part@$domain
19813 .endd
19814 The repetition serves as a way of checking that a response is to the correct
19815 query in the default case (see &%response_pattern%& below).
19816
19817
19818 .option reroute iplookup string&!! unset
19819 If this option is not set, the rerouted address is precisely the byte string
19820 returned by the remote host, up to the first white space, if any. If set, the
19821 string is expanded to form the rerouted address. It can include parts matched
19822 in the response by &%response_pattern%& by means of numeric variables such as
19823 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19824 whether or not a pattern is in use. In all cases, the rerouted address must end
19825 up in the form &'local_part@domain'&.
19826
19827
19828 .option response_pattern iplookup string unset
19829 This option can be set to a regular expression that is applied to the string
19830 returned from the remote host. If the pattern does not match the response, the
19831 router declines. If &%response_pattern%& is not set, no checking of the
19832 response is done, unless the query was defaulted, in which case there is a
19833 check that the text returned after the first white space is the original
19834 address. This checks that the answer that has been received is in response to
19835 the correct question. For example, if the response is just a new domain, the
19836 following could be used:
19837 .code
19838 response_pattern = ^([^@]+)$
19839 reroute = $local_part@$1
19840 .endd
19841
19842 .option timeout iplookup time 5s
19843 This specifies the amount of time to wait for a response from the remote
19844 machine. The same timeout is used for the &[connect()]& function for a TCP
19845 call. It does not apply to UDP.
19846
19847
19848
19849
19850 . ////////////////////////////////////////////////////////////////////////////
19851 . ////////////////////////////////////////////////////////////////////////////
19852
19853 .chapter "The manualroute router" "CHID7"
19854 .scindex IIDmanrou1 "&(manualroute)& router"
19855 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19856 .cindex "domain" "manually routing"
19857 The &(manualroute)& router is so-called because it provides a way of manually
19858 routing an address according to its domain. It is mainly used when you want to
19859 route addresses to remote hosts according to your own rules, bypassing the
19860 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19861 route to local transports, a facility that may be useful if you want to save
19862 messages for dial-in hosts in local files.
19863
19864 The &(manualroute)& router compares a list of domain patterns with the domain
19865 it is trying to route. If there is no match, the router declines. Each pattern
19866 has associated with it a list of hosts and some other optional data, which may
19867 include a transport. The combination of a pattern and its data is called a
19868 &"routing rule"&. For patterns that do not have an associated transport, the
19869 generic &%transport%& option must specify a transport, unless the router is
19870 being used purely for verification (see &%verify_only%&).
19871
19872 .vindex "&$host$&"
19873 In the case of verification, matching the domain pattern is sufficient for the
19874 router to accept the address. When actually routing an address for delivery,
19875 an address that matches a domain pattern is queued for the associated
19876 transport. If the transport is not a local one, a host list must be associated
19877 with the pattern; IP addresses are looked up for the hosts, and these are
19878 passed to the transport along with the mail address. For local transports, a
19879 host list is optional. If it is present, it is passed in &$host$& as a single
19880 text string.
19881
19882 The list of routing rules can be provided as an inline string in
19883 &%route_list%&, or the data can be obtained by looking up the domain in a file
19884 or database by setting &%route_data%&. Only one of these settings may appear in
19885 any one instance of &(manualroute)&. The format of routing rules is described
19886 below, following the list of private options.
19887
19888
19889 .section "Private options for manualroute" "SECTprioptman"
19890
19891 .cindex "options" "&(manualroute)& router"
19892 The private options for the &(manualroute)& router are as follows:
19893
19894 .option host_all_ignored manualroute string defer
19895 See &%host_find_failed%&.
19896
19897 .option host_find_failed manualroute string freeze
19898 This option controls what happens when &(manualroute)& tries to find an IP
19899 address for a host, and the host does not exist. The option can be set to one
19900 of the following values:
19901 .code
19902 decline
19903 defer
19904 fail
19905 freeze
19906 ignore
19907 pass
19908 .endd
19909 The default (&"freeze"&) assumes that this state is a serious configuration
19910 error. The difference between &"pass"& and &"decline"& is that the former
19911 forces the address to be passed to the next router (or the router defined by
19912 &%pass_router%&),
19913 .oindex "&%more%&"
19914 overriding &%no_more%&, whereas the latter passes the address to the next
19915 router only if &%more%& is true.
19916
19917 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19918 cannot be found. If all the hosts in the list are ignored, the behaviour is
19919 controlled by the &%host_all_ignored%& option. This takes the same values
19920 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19921
19922 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19923 state; if a host lookup gets a temporary error, delivery is deferred unless the
19924 generic &%pass_on_timeout%& option is set.
19925
19926
19927 .option hosts_randomize manualroute boolean false
19928 .cindex "randomized host list"
19929 .cindex "host" "list of; randomized"
19930 If this option is set, the order of the items in a host list in a routing rule
19931 is randomized each time the list is used, unless an option in the routing rule
19932 overrides (see below). Randomizing the order of a host list can be used to do
19933 crude load sharing. However, if more than one mail address is routed by the
19934 same router to the same host list, the host lists are considered to be the same
19935 (even though they may be randomized into different orders) for the purpose of
19936 deciding whether to batch the deliveries into a single SMTP transaction.
19937
19938 When &%hosts_randomize%& is true, a host list may be split
19939 into groups whose order is separately randomized. This makes it possible to
19940 set up MX-like behaviour. The boundaries between groups are indicated by an
19941 item that is just &`+`& in the host list. For example:
19942 .code
19943 route_list = * host1:host2:host3:+:host4:host5
19944 .endd
19945 The order of the first three hosts and the order of the last two hosts is
19946 randomized for each use, but the first three always end up before the last two.
19947 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19948 randomized host list is passed to an &(smtp)& transport that also has
19949 &%hosts_randomize set%&, the list is not re-randomized.
19950
19951
19952 .option route_data manualroute string&!! unset
19953 If this option is set, it must expand to yield the data part of a routing rule.
19954 Typically, the expansion string includes a lookup based on the domain. For
19955 example:
19956 .code
19957 route_data = ${lookup{$domain}dbm{/etc/routes}}
19958 .endd
19959 If the expansion is forced to fail, or the result is an empty string, the
19960 router declines. Other kinds of expansion failure cause delivery to be
19961 deferred.
19962
19963
19964 .option route_list manualroute "string list" unset
19965 This string is a list of routing rules, in the form defined below. Note that,
19966 unlike most string lists, the items are separated by semicolons. This is so
19967 that they may contain colon-separated host lists.
19968
19969
19970 .option same_domain_copy_routing manualroute boolean false
19971 .cindex "address" "copying routing"
19972 Addresses with the same domain are normally routed by the &(manualroute)&
19973 router to the same list of hosts. However, this cannot be presumed, because the
19974 router options and preconditions may refer to the local part of the address. By
19975 default, therefore, Exim routes each address in a message independently. DNS
19976 servers run caches, so repeated DNS lookups are not normally expensive, and in
19977 any case, personal messages rarely have more than a few recipients.
19978
19979 If you are running mailing lists with large numbers of subscribers at the same
19980 domain, and you are using a &(manualroute)& router which is independent of the
19981 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19982 lookups for identical domains in one message. In this case, when
19983 &(manualroute)& routes an address to a remote transport, any other unrouted
19984 addresses in the message that have the same domain are automatically given the
19985 same routing without processing them independently. However, this is only done
19986 if &%headers_add%& and &%headers_remove%& are unset.
19987
19988
19989
19990
19991 .section "Routing rules in route_list" "SECID120"
19992 The value of &%route_list%& is a string consisting of a sequence of routing
19993 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19994 entered as two semicolons. Alternatively, the list separator can be changed as
19995 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19996 Empty rules are ignored. The format of each rule is
19997 .display
19998 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19999 .endd
20000 The following example contains two rules, each with a simple domain pattern and
20001 no options:
20002 .code
20003 route_list = \
20004   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20005   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20006 .endd
20007 The three parts of a rule are separated by white space. The pattern and the
20008 list of hosts can be enclosed in quotes if necessary, and if they are, the
20009 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20010 single domain pattern, which is the only mandatory item in the rule. The
20011 pattern is in the same format as one item in a domain list (see section
20012 &<<SECTdomainlist>>&),
20013 except that it may not be the name of an interpolated file.
20014 That is, it may be wildcarded, or a regular expression, or a file or database
20015 lookup (with semicolons doubled, because of the use of semicolon as a separator
20016 in a &%route_list%&).
20017
20018 The rules in &%route_list%& are searched in order until one of the patterns
20019 matches the domain that is being routed. The list of hosts and then options are
20020 then used as described below. If there is no match, the router declines. When
20021 &%route_list%& is set, &%route_data%& must not be set.
20022
20023
20024
20025 .section "Routing rules in route_data" "SECID121"
20026 The use of &%route_list%& is convenient when there are only a small number of
20027 routing rules. For larger numbers, it is easier to use a file or database to
20028 hold the routing information, and use the &%route_data%& option instead.
20029 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20030 Most commonly, &%route_data%& is set as a string that contains an
20031 expansion lookup. For example, suppose we place two routing rules in a file
20032 like this:
20033 .code
20034 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20035 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20036 .endd
20037 This data can be accessed by setting
20038 .code
20039 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20040 .endd
20041 Failure of the lookup results in an empty string, causing the router to
20042 decline. However, you do not have to use a lookup in &%route_data%&. The only
20043 requirement is that the result of expanding the string is a list of hosts,
20044 possibly followed by options, separated by white space. The list of hosts must
20045 be enclosed in quotes if it contains white space.
20046
20047
20048
20049
20050 .section "Format of the list of hosts" "SECID122"
20051 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20052 always separately expanded before use. If the expansion fails, the router
20053 declines. The result of the expansion must be a colon-separated list of names
20054 and/or IP addresses, optionally also including ports.
20055 If the list is written with spaces, it must be protected with quotes.
20056 The format of each item
20057 in the list is described in the next section. The list separator can be changed
20058 as described in section &<<SECTlistsepchange>>&.
20059
20060 If the list of hosts was obtained from a &%route_list%& item, the following
20061 variables are set during its expansion:
20062
20063 .ilist
20064 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20065 If the domain was matched against a regular expression, the numeric variables
20066 &$1$&, &$2$&, etc. may be set. For example:
20067 .code
20068 route_list = ^domain(\d+)   host-$1.text.example
20069 .endd
20070 .next
20071 &$0$& is always set to the entire domain.
20072 .next
20073 &$1$& is also set when partial matching is done in a file lookup.
20074
20075 .next
20076 .vindex "&$value$&"
20077 If the pattern that matched the domain was a lookup item, the data that was
20078 looked up is available in the expansion variable &$value$&. For example:
20079 .code
20080 route_list = lsearch;;/some/file.routes  $value
20081 .endd
20082 .endlist
20083
20084 Note the doubling of the semicolon in the pattern that is necessary because
20085 semicolon is the default route list separator.
20086
20087
20088
20089 .section "Format of one host item" "SECTformatonehostitem"
20090 Each item in the list of hosts is either a host name or an IP address,
20091 optionally with an attached port number. When no port is given, an IP address
20092 is not enclosed in brackets. When a port is specified, it overrides the port
20093 specification on the transport. The port is separated from the name or address
20094 by a colon. This leads to some complications:
20095
20096 .ilist
20097 Because colon is the default separator for the list of hosts, either
20098 the colon that specifies a port must be doubled, or the list separator must
20099 be changed. The following two examples have the same effect:
20100 .code
20101 route_list = * "host1.tld::1225 : host2.tld::1226"
20102 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20103 .endd
20104 .next
20105 When IPv6 addresses are involved, it gets worse, because they contain
20106 colons of their own. To make this case easier, it is permitted to
20107 enclose an IP address (either v4 or v6) in square brackets if a port
20108 number follows. For example:
20109 .code
20110 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20111 .endd
20112 .endlist
20113
20114 .section "How the list of hosts is used" "SECThostshowused"
20115 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20116 the hosts is tried, in the order specified, when carrying out the SMTP
20117 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20118 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20119 transport.
20120
20121 Hosts may be listed by name or by IP address. An unadorned name in the list of
20122 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20123 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20124 records in the DNS. For example:
20125 .code
20126 route_list = *  x.y.z:p.q.r/MX:e.f.g
20127 .endd
20128 If this feature is used with a port specifier, the port must come last. For
20129 example:
20130 .code
20131 route_list = *  dom1.tld/mx::1225
20132 .endd
20133 If the &%hosts_randomize%& option is set, the order of the items in the list is
20134 randomized before any lookups are done. Exim then scans the list; for any name
20135 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20136 be an interface on the local host and the item is not the first in the list,
20137 Exim discards it and any subsequent items. If it is the first item, what
20138 happens is controlled by the
20139 .oindex "&%self%&" "in &(manualroute)& router"
20140 &%self%& option of the router.
20141
20142 A name on the list that is followed by &`/MX`& is replaced with the list of
20143 hosts obtained by looking up MX records for the name. This is always a DNS
20144 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20145 below) are not relevant here. The order of these hosts is determined by the
20146 preference values in the MX records, according to the usual rules. Because
20147 randomizing happens before the MX lookup, it does not affect the order that is
20148 defined by MX preferences.
20149
20150 If the local host is present in the sublist obtained from MX records, but is
20151 not the most preferred host in that list, it and any equally or less
20152 preferred hosts are removed before the sublist is inserted into the main list.
20153
20154 If the local host is the most preferred host in the MX list, what happens
20155 depends on where in the original list of hosts the &`/MX`& item appears. If it
20156 is not the first item (that is, there are previous hosts in the main list),
20157 Exim discards this name and any subsequent items in the main list.
20158
20159 If the MX item is first in the list of hosts, and the local host is the
20160 most preferred host, what happens is controlled by the &%self%& option of the
20161 router.
20162
20163 DNS failures when lookup up the MX records are treated in the same way as DNS
20164 failures when looking up IP addresses: &%pass_on_timeout%& and
20165 &%host_find_failed%& are used when relevant.
20166
20167 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20168 whether obtained from an MX lookup or not.
20169
20170
20171
20172 .section "How the options are used" "SECThowoptused"
20173 The options are a sequence of words, space-separated.
20174 One of the words can be the name of a transport; this overrides the
20175 &%transport%& option on the router for this particular routing rule only. The
20176 other words (if present) control randomization of the list of hosts on a
20177 per-rule basis, and how the IP addresses of the hosts are to be found when
20178 routing to a remote transport. These options are as follows:
20179
20180 .ilist
20181 &%randomize%&: randomize the order of the hosts in this list, overriding the
20182 setting of &%hosts_randomize%& for this routing rule only.
20183 .next
20184 &%no_randomize%&: do not randomize the order of the hosts in this list,
20185 overriding the setting of &%hosts_randomize%& for this routing rule only.
20186 .next
20187 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20188 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20189 also look in &_/etc/hosts_& or other sources of information.
20190 .next
20191 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20192 no address records are found. If there is a temporary DNS error (such as a
20193 timeout), delivery is deferred.
20194 .next
20195 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20196 .next
20197 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20198 .endlist
20199
20200 For example:
20201 .code
20202 route_list = domain1  host1:host2:host3  randomize bydns;\
20203              domain2  host4:host5
20204 .endd
20205 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20206 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20207 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20208 or &[gethostbyname()]&, and the result of the lookup is the result of that
20209 call.
20210
20211 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20212 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20213 instead of TRY_AGAIN. That is why the default action is to try a DNS
20214 lookup first. Only if that gives a definite &"no such host"& is the local
20215 function called.
20216
20217 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20218 inadvertent constraint that a transport name as an option had to be the last
20219 option specified.
20220
20221
20222
20223 If no IP address for a host can be found, what happens is controlled by the
20224 &%host_find_failed%& option.
20225
20226 .vindex "&$host$&"
20227 When an address is routed to a local transport, IP addresses are not looked up.
20228 The host list is passed to the transport in the &$host$& variable.
20229
20230
20231
20232 .section "Manualroute examples" "SECID123"
20233 In some of the examples that follow, the presence of the &%remote_smtp%&
20234 transport, as defined in the default configuration file, is assumed:
20235
20236 .ilist
20237 .cindex "smart host" "example router"
20238 The &(manualroute)& router can be used to forward all external mail to a
20239 &'smart host'&. If you have set up, in the main part of the configuration, a
20240 named domain list that contains your local domains, for example:
20241 .code
20242 domainlist local_domains = my.domain.example
20243 .endd
20244 You can arrange for all other domains to be routed to a smart host by making
20245 your first router something like this:
20246 .code
20247 smart_route:
20248   driver = manualroute
20249   domains = !+local_domains
20250   transport = remote_smtp
20251   route_list = * smarthost.ref.example
20252 .endd
20253 This causes all non-local addresses to be sent to the single host
20254 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20255 they are tried in order
20256 (but you can use &%hosts_randomize%& to vary the order each time).
20257 Another way of configuring the same thing is this:
20258 .code
20259 smart_route:
20260   driver = manualroute
20261   transport = remote_smtp
20262   route_list = !+local_domains  smarthost.ref.example
20263 .endd
20264 There is no difference in behaviour between these two routers as they stand.
20265 However, they behave differently if &%no_more%& is added to them. In the first
20266 example, the router is skipped if the domain does not match the &%domains%&
20267 precondition; the following router is always tried. If the router runs, it
20268 always matches the domain and so can never decline. Therefore, &%no_more%&
20269 would have no effect. In the second case, the router is never skipped; it
20270 always runs. However, if it doesn't match the domain, it declines. In this case
20271 &%no_more%& would prevent subsequent routers from running.
20272
20273 .next
20274 .cindex "mail hub example"
20275 A &'mail hub'& is a host which receives mail for a number of domains via MX
20276 records in the DNS and delivers it via its own private routing mechanism. Often
20277 the final destinations are behind a firewall, with the mail hub being the one
20278 machine that can connect to machines both inside and outside the firewall. The
20279 &(manualroute)& router is usually used on a mail hub to route incoming messages
20280 to the correct hosts. For a small number of domains, the routing can be inline,
20281 using the &%route_list%& option, but for a larger number a file or database
20282 lookup is easier to manage.
20283
20284 If the domain names are in fact the names of the machines to which the mail is
20285 to be sent by the mail hub, the configuration can be quite simple. For
20286 example:
20287 .code
20288 hub_route:
20289   driver = manualroute
20290   transport = remote_smtp
20291   route_list = *.rhodes.tvs.example  $domain
20292 .endd
20293 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20294 whose names are the same as the mail domains. A similar approach can be taken
20295 if the host name can be obtained from the domain name by a string manipulation
20296 that the expansion facilities can handle. Otherwise, a lookup based on the
20297 domain can be used to find the host:
20298 .code
20299 through_firewall:
20300   driver = manualroute
20301   transport = remote_smtp
20302   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20303 .endd
20304 The result of the lookup must be the name or IP address of the host (or
20305 hosts) to which the address is to be routed. If the lookup fails, the route
20306 data is empty, causing the router to decline. The address then passes to the
20307 next router.
20308
20309 .next
20310 .cindex "batched SMTP output example"
20311 .cindex "SMTP" "batched outgoing; example"
20312 You can use &(manualroute)& to deliver messages to pipes or files in batched
20313 SMTP format for onward transportation by some other means. This is one way of
20314 storing mail for a dial-up host when it is not connected. The route list entry
20315 can be as simple as a single domain name in a configuration like this:
20316 .code
20317 save_in_file:
20318   driver = manualroute
20319   transport = batchsmtp_appendfile
20320   route_list = saved.domain.example
20321 .endd
20322 though often a pattern is used to pick up more than one domain. If there are
20323 several domains or groups of domains with different transport requirements,
20324 different transports can be listed in the routing information:
20325 .code
20326 save_in_file:
20327   driver = manualroute
20328   route_list = \
20329     *.saved.domain1.example  $domain  batch_appendfile; \
20330     *.saved.domain2.example  \
20331       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20332       batch_pipe
20333 .endd
20334 .vindex "&$domain$&"
20335 .vindex "&$host$&"
20336 The first of these just passes the domain in the &$host$& variable, which
20337 doesn't achieve much (since it is also in &$domain$&), but the second does a
20338 file lookup to find a value to pass, causing the router to decline to handle
20339 the address if the lookup fails.
20340
20341 .next
20342 .cindex "UUCP" "example of router for"
20343 Routing mail directly to UUCP software is a specific case of the use of
20344 &(manualroute)& in a gateway to another mail environment. This is an example of
20345 one way it can be done:
20346 .code
20347 # Transport
20348 uucp:
20349   driver = pipe
20350   user = nobody
20351   command = /usr/local/bin/uux -r - \
20352     ${substr_-5:$host}!rmail ${local_part}
20353   return_fail_output = true
20354
20355 # Router
20356 uucphost:
20357   transport = uucp
20358   driver = manualroute
20359   route_data = \
20360     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20361 .endd
20362 The file &_/usr/local/exim/uucphosts_& contains entries like
20363 .code
20364 darksite.ethereal.example:           darksite.UUCP
20365 .endd
20366 It can be set up more simply without adding and removing &".UUCP"& but this way
20367 makes clear the distinction between the domain name
20368 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20369 .endlist
20370 .ecindex IIDmanrou1
20371 .ecindex IIDmanrou2
20372
20373
20374
20375
20376
20377
20378
20379
20380 . ////////////////////////////////////////////////////////////////////////////
20381 . ////////////////////////////////////////////////////////////////////////////
20382
20383 .chapter "The queryprogram router" "CHAPdriverlast"
20384 .scindex IIDquerou1 "&(queryprogram)& router"
20385 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20386 .cindex "routing" "by external program"
20387 The &(queryprogram)& router routes an address by running an external command
20388 and acting on its output. This is an expensive way to route, and is intended
20389 mainly for use in lightly-loaded systems, or for performing experiments.
20390 However, if it is possible to use the precondition options (&%domains%&,
20391 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20392 be used in special cases, even on a busy host. There are the following private
20393 options:
20394 .cindex "options" "&(queryprogram)& router"
20395
20396 .option command queryprogram string&!! unset
20397 This option must be set. It specifies the command that is to be run. The
20398 command is split up into a command name and arguments, and then each is
20399 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20400 &<<CHAPpipetransport>>&).
20401
20402
20403 .option command_group queryprogram string unset
20404 .cindex "gid (group id)" "in &(queryprogram)& router"
20405 This option specifies a gid to be set when running the command while routing an
20406 address for deliver. It must be set if &%command_user%& specifies a numerical
20407 uid. If it begins with a digit, it is interpreted as the numerical value of the
20408 gid. Otherwise it is looked up using &[getgrnam()]&.
20409
20410
20411 .option command_user queryprogram string unset
20412 .cindex "uid (user id)" "for &(queryprogram)&"
20413 This option must be set. It specifies the uid which is set when running the
20414 command while routing an address for delivery. If the value begins with a digit,
20415 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20416 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20417 not set, a value for the gid also.
20418
20419 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20420 root, which it does during a normal delivery in a conventional configuration.
20421 However, when an address is being verified during message reception, Exim is
20422 usually running as the Exim user, not as root. If the &(queryprogram)& router
20423 is called from a non-root process, Exim cannot change uid or gid before running
20424 the command. In this circumstance the command runs under the current uid and
20425 gid.
20426
20427
20428 .option current_directory queryprogram string /
20429 This option specifies an absolute path which is made the current directory
20430 before running the command.
20431
20432
20433 .option timeout queryprogram time 1h
20434 If the command does not complete within the timeout period, its process group
20435 is killed and the message is frozen. A value of zero time specifies no
20436 timeout.
20437
20438
20439 The standard output of the command is connected to a pipe, which is read when
20440 the command terminates. It should consist of a single line of output,
20441 containing up to five fields, separated by white space. The maximum length of
20442 the line is 1023 characters. Longer lines are silently truncated. The first
20443 field is one of the following words (case-insensitive):
20444
20445 .ilist
20446 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20447 below).
20448 .next
20449 &'Decline'&: the router declines; pass the address to the next router, unless
20450 &%no_more%& is set.
20451 .next
20452 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20453 subsequent text on the line is an error message. If the router is run as part
20454 of address verification during an incoming SMTP message, the message is
20455 included in the SMTP response.
20456 .next
20457 &'Defer'&: routing could not be completed at this time; try again later. Any
20458 subsequent text on the line is an error message which is logged. It is not
20459 included in any SMTP response.
20460 .next
20461 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20462 .next
20463 &'Pass'&: pass the address to the next router (or the router specified by
20464 &%pass_router%&), overriding &%no_more%&.
20465 .next
20466 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20467 new addresses, which are routed independently, starting with the first router,
20468 or the router specified by &%redirect_router%&, if set.
20469 .endlist
20470
20471 When the first word is &'accept'&, the remainder of the line consists of a
20472 number of keyed data values, as follows (split into two lines here, to fit on
20473 the page):
20474 .code
20475 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20476 LOOKUP=byname|bydns DATA=<text>
20477 .endd
20478 The data items can be given in any order, and all are optional. If no transport
20479 is included, the transport specified by the generic &%transport%& option is
20480 used. The list of hosts and the lookup type are needed only if the transport is
20481 an &(smtp)& transport that does not itself supply a list of hosts.
20482
20483 The format of the list of hosts is the same as for the &(manualroute)& router.
20484 As well as host names and IP addresses with optional port numbers, as described
20485 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20486 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20487 (see section &<<SECThostshowused>>&).
20488
20489 If the lookup type is not specified, Exim behaves as follows when trying to
20490 find an IP address for each host: First, a DNS lookup is done. If this yields
20491 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20492 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20493 result of the lookup is the result of that call.
20494
20495 .vindex "&$address_data$&"
20496 If the DATA field is set, its value is placed in the &$address_data$&
20497 variable. For example, this return line
20498 .code
20499 accept hosts=x1.y.example:x2.y.example data="rule1"
20500 .endd
20501 routes the address to the default transport, passing a list of two hosts. When
20502 the transport runs, the string &"rule1"& is in &$address_data$&.
20503 .ecindex IIDquerou1
20504 .ecindex IIDquerou2
20505
20506
20507
20508
20509 . ////////////////////////////////////////////////////////////////////////////
20510 . ////////////////////////////////////////////////////////////////////////////
20511
20512 .chapter "The redirect router" "CHAPredirect"
20513 .scindex IIDredrou1 "&(redirect)& router"
20514 .scindex IIDredrou2 "routers" "&(redirect)&"
20515 .cindex "alias file" "in a &(redirect)& router"
20516 .cindex "address redirection" "&(redirect)& router"
20517 The &(redirect)& router handles several kinds of address redirection. Its most
20518 common uses are for resolving local part aliases from a central alias file
20519 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20520 files, but it has many other potential uses. The incoming address can be
20521 redirected in several different ways:
20522
20523 .ilist
20524 It can be replaced by one or more new addresses which are themselves routed
20525 independently.
20526 .next
20527 It can be routed to be delivered to a given file or directory.
20528 .next
20529 It can be routed to be delivered to a specified pipe command.
20530 .next
20531 It can cause an automatic reply to be generated.
20532 .next
20533 It can be forced to fail, optionally with a custom error message.
20534 .next
20535 It can be temporarily deferred, optionally with a custom message.
20536 .next
20537 It can be discarded.
20538 .endlist
20539
20540 The generic &%transport%& option must not be set for &(redirect)& routers.
20541 However, there are some private options which define transports for delivery to
20542 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20543 &%pipe_transport%& and &%reply_transport%& descriptions below.
20544
20545 If success DSNs have been requested
20546 .cindex "DSN" "success"
20547 .cindex "Delivery Status Notification" "success"
20548 redirection triggers one and the DSN options are not passed any further.
20549
20550
20551
20552 .section "Redirection data" "SECID124"
20553 The router operates by interpreting a text string which it obtains either by
20554 expanding the contents of the &%data%& option, or by reading the entire
20555 contents of a file whose name is given in the &%file%& option. These two
20556 options are mutually exclusive. The first is commonly used for handling system
20557 aliases, in a configuration like this:
20558 .code
20559 system_aliases:
20560   driver = redirect
20561   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20562 .endd
20563 If the lookup fails, the expanded string in this example is empty. When the
20564 expansion of &%data%& results in an empty string, the router declines. A forced
20565 expansion failure also causes the router to decline; other expansion failures
20566 cause delivery to be deferred.
20567
20568 A configuration using &%file%& is commonly used for handling users'
20569 &_.forward_& files, like this:
20570 .code
20571 userforward:
20572   driver = redirect
20573   check_local_user
20574   file = $home/.forward
20575   no_verify
20576 .endd
20577 If the file does not exist, or causes no action to be taken (for example, it is
20578 empty or consists only of comments), the router declines. &*Warning*&: This
20579 is not the case when the file contains syntactically valid items that happen to
20580 yield empty addresses, for example, items containing only RFC 2822 address
20581 comments.
20582
20583
20584
20585 .section "Forward files and address verification" "SECID125"
20586 .cindex "address redirection" "while verifying"
20587 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20588 &_.forward_& files, as in the example above. There are two reasons for this:
20589
20590 .ilist
20591 When Exim is receiving an incoming SMTP message from a remote host, it is
20592 running under the Exim uid, not as root. Exim is unable to change uid to read
20593 the file as the user, and it may not be able to read it as the Exim user. So in
20594 practice the router may not be able to operate.
20595 .next
20596 However, even when the router can operate, the existence of a &_.forward_& file
20597 is unimportant when verifying an address. What should be checked is whether the
20598 local part is a valid user name or not. Cutting out the redirection processing
20599 saves some resources.
20600 .endlist
20601
20602
20603
20604
20605
20606
20607 .section "Interpreting redirection data" "SECID126"
20608 .cindex "Sieve filter" "specifying in redirection data"
20609 .cindex "filter" "specifying in redirection data"
20610 The contents of the data string, whether obtained from &%data%& or &%file%&,
20611 can be interpreted in two different ways:
20612
20613 .ilist
20614 If the &%allow_filter%& option is set true, and the data begins with the text
20615 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20616 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20617 respectively. Details of the syntax and semantics of filter files are described
20618 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20619 document is intended for use by end users.
20620 .next
20621 Otherwise, the data must be a comma-separated list of redirection items, as
20622 described in the next section.
20623 .endlist
20624
20625 When a message is redirected to a file (a &"mail folder"&), the filename given
20626 in a non-filter redirection list must always be an absolute path. A filter may
20627 generate a relative path &-- how this is handled depends on the transport's
20628 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20629 for the &(appendfile)& transport.
20630
20631
20632
20633 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20634 .cindex "address redirection" "non-filter list items"
20635 When the redirection data is not an Exim or Sieve filter, for example, if it
20636 comes from a conventional alias or forward file, it consists of a list of
20637 addresses, filenames, pipe commands, or certain special items (see section
20638 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20639 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20640 depending on their default values. The items in the list are separated by
20641 commas or newlines.
20642 If a comma is required in an item, the entire item must be enclosed in double
20643 quotes.
20644
20645 Lines starting with a # character are comments, and are ignored, and # may
20646 also appear following a comma, in which case everything between the # and the
20647 next newline character is ignored.
20648
20649 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20650 double quotes are retained because some forms of mail address require their use
20651 (but never to enclose the entire address). In the following description,
20652 &"item"& refers to what remains after any surrounding double quotes have been
20653 removed.
20654
20655 .vindex "&$local_part$&"
20656 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20657 and the expansion contains a reference to &$local_part$&, you should make use
20658 of the &%quote_local_part%& expansion operator, in case the local part contains
20659 special characters. For example, to redirect all mail for the domain
20660 &'obsolete.example'&, retaining the existing local part, you could use this
20661 setting:
20662 .code
20663 data = ${quote_local_part:$local_part}@newdomain.example
20664 .endd
20665
20666
20667 .section "Redirecting to a local mailbox" "SECTredlocmai"
20668 .cindex "routing" "loops in"
20669 .cindex "loop" "while routing, avoidance of"
20670 .cindex "address redirection" "to local mailbox"
20671 A redirection item may safely be the same as the address currently under
20672 consideration. This does not cause a routing loop, because a router is
20673 automatically skipped if any ancestor of the address that is being processed
20674 is the same as the current address and was processed by the current router.
20675 Such an address is therefore passed to the following routers, so it is handled
20676 as if there were no redirection. When making this loop-avoidance test, the
20677 complete local part, including any prefix or suffix, is used.
20678
20679 .cindex "address redirection" "local part without domain"
20680 Specifying the same local part without a domain is a common usage in personal
20681 filter files when the user wants to have messages delivered to the local
20682 mailbox and also forwarded elsewhere. For example, the user whose login is
20683 &'cleo'& might have a &_.forward_& file containing this:
20684 .code
20685 cleo, cleopatra@egypt.example
20686 .endd
20687 .cindex "backslash in alias file"
20688 .cindex "alias file" "backslash in"
20689 For compatibility with other MTAs, such unqualified local parts may be
20690 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20691 it does make a difference if more than one domain is being handled
20692 synonymously.
20693
20694 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20695 2822 address that does not include a domain, the item is qualified using the
20696 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20697 addresses are qualified using the value in &%qualify_recipient%&, but you can
20698 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20699
20700 Care must be taken if there are alias names for local users.
20701 Consider an MTA handling a single local domain where the system alias file
20702 contains:
20703 .code
20704 Sam.Reman: spqr
20705 .endd
20706 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20707 messages in the local mailbox, and also forward copies elsewhere. He creates
20708 this forward file:
20709 .code
20710 Sam.Reman, spqr@reme.elsewhere.example
20711 .endd
20712 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20713 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20714 second time round, because it has previously routed it,
20715 and the following routers presumably cannot handle the alias. The forward file
20716 should really contain
20717 .code
20718 spqr, spqr@reme.elsewhere.example
20719 .endd
20720 but because this is such a common error, the &%check_ancestor%& option (see
20721 below) exists to provide a way to get round it. This is normally set on a
20722 &(redirect)& router that is handling users' &_.forward_& files.
20723
20724
20725
20726 .section "Special items in redirection lists" "SECTspecitredli"
20727 In addition to addresses, the following types of item may appear in redirection
20728 lists (that is, in non-filter redirection data):
20729
20730 .ilist
20731 .cindex "pipe" "in redirection list"
20732 .cindex "address redirection" "to pipe"
20733 An item is treated as a pipe command if it begins with &"|"& and does not parse
20734 as a valid RFC 2822 address that includes a domain. A transport for running the
20735 command must be specified by the &%pipe_transport%& option.
20736 Normally, either the router or the transport specifies a user and a group under
20737 which to run the delivery. The default is to use the Exim user and group.
20738
20739 Single or double quotes can be used for enclosing the individual arguments of
20740 the pipe command; no interpretation of escapes is done for single quotes. If
20741 the command contains a comma character, it is necessary to put the whole item
20742 in double quotes, for example:
20743 .code
20744 "|/some/command ready,steady,go"
20745 .endd
20746 since items in redirection lists are terminated by commas. Do not, however,
20747 quote just the command. An item such as
20748 .code
20749 |"/some/command ready,steady,go"
20750 .endd
20751 is interpreted as a pipe with a rather strange command name, and no arguments.
20752
20753 Note that the above example assumes that the text comes from a lookup source
20754 of some sort, so that the quotes are part of the data.  If composing a
20755 redirect router with a &%data%& option directly specifying this command, the
20756 quotes will be used by the configuration parser to define the extent of one
20757 string, but will not be passed down into the redirect router itself.  There
20758 are two main approaches to get around this: escape quotes to be part of the
20759 data itself, or avoid using this mechanism and instead create a custom
20760 transport with the &%command%& option set and reference that transport from
20761 an &%accept%& router.
20762
20763 .next
20764 .cindex "file" "in redirection list"
20765 .cindex "address redirection" "to file"
20766 An item is interpreted as a path name if it begins with &"/"& and does not
20767 parse as a valid RFC 2822 address that includes a domain. For example,
20768 .code
20769 /home/world/minbari
20770 .endd
20771 is treated as a filename, but
20772 .code
20773 /s=molari/o=babylon/@x400gate.way
20774 .endd
20775 is treated as an address. For a filename, a transport must be specified using
20776 the &%file_transport%& option. However, if the generated path name ends with a
20777 forward slash character, it is interpreted as a directory name rather than a
20778 filename, and &%directory_transport%& is used instead.
20779
20780 Normally, either the router or the transport specifies a user and a group under
20781 which to run the delivery. The default is to use the Exim user and group.
20782
20783 .cindex "&_/dev/null_&"
20784 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20785 bypassed at a high level, and the log entry shows &"**bypassed**"&
20786 instead of a transport name. In this case the user and group are not used.
20787
20788 .next
20789 .cindex "included address list"
20790 .cindex "address redirection" "included external list"
20791 If an item is of the form
20792 .code
20793 :include:<path name>
20794 .endd
20795 a list of further items is taken from the given file and included at that
20796 point. &*Note*&: Such a file can not be a filter file; it is just an
20797 out-of-line addition to the list. The items in the included list are separated
20798 by commas or newlines and are not subject to expansion. If this is the first
20799 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20800 the alias name. This example is incorrect:
20801 .code
20802 list1    :include:/opt/lists/list1
20803 .endd
20804 It must be given as
20805 .code
20806 list1:   :include:/opt/lists/list1
20807 .endd
20808 .next
20809 .cindex "address redirection" "to black hole"
20810 .cindex "delivery" "discard"
20811 .cindex "delivery" "blackhole"
20812 .cindex "black hole"
20813 .cindex "abandoning mail"
20814 Sometimes you want to throw away mail to a particular local part.  Making the
20815 &%data%& option expand to an empty string does not work, because that causes
20816 the router to decline. Instead, the alias item
20817 .code
20818 :blackhole:
20819 .endd
20820 can be used. It does what its name implies. No delivery is
20821 done, and no error message is generated. This has the same effect as specifying
20822 &_/dev/null_& as a destination, but it can be independently disabled.
20823
20824 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20825 delivery is done for the original local part, even if other redirection items
20826 are present. If you are generating a multi-item list (for example, by reading a
20827 database) and need the ability to provide a no-op item, you must use
20828 &_/dev/null_&.
20829
20830 .next
20831 .cindex "delivery" "forcing failure"
20832 .cindex "delivery" "forcing deferral"
20833 .cindex "failing delivery" "forcing"
20834 .cindex "deferred delivery, forcing"
20835 .cindex "customizing" "failure message"
20836 An attempt to deliver a particular address can be deferred or forced to fail by
20837 redirection items of the form
20838 .code
20839 :defer:
20840 :fail:
20841 .endd
20842 respectively. When a redirection list contains such an item, it applies
20843 to the entire redirection; any other items in the list are ignored. Any
20844 text following &':fail:'& or &':defer:'& is placed in the error text
20845 associated with the failure. For example, an alias file might contain:
20846 .code
20847 X.Employee:  :fail: Gone away, no forwarding address
20848 .endd
20849 In the case of an address that is being verified from an ACL or as the subject
20850 of a
20851 .cindex "VRFY" "error text, display of"
20852 VRFY command, the text is included in the SMTP error response by
20853 default.
20854 .cindex "EXPN" "error text, display of"
20855 The text is not included in the response to an EXPN command. In non-SMTP cases
20856 the text is included in the error message that Exim generates.
20857
20858 .cindex "SMTP" "error codes"
20859 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20860 &':fail:'&. However, if the message starts with three digits followed by a
20861 space, optionally followed by an extended code of the form &'n.n.n'&, also
20862 followed by a space, and the very first digit is the same as the default error
20863 code, the code from the message is used instead. If the very first digit is
20864 incorrect, a panic error is logged, and the default code is used. You can
20865 suppress the use of the supplied code in a redirect router by setting the
20866 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20867 ignored.
20868
20869 .vindex "&$acl_verify_message$&"
20870 In an ACL, an explicitly provided message overrides the default, but the
20871 default message is available in the variable &$acl_verify_message$& and can
20872 therefore be included in a custom message if this is desired.
20873
20874 Normally the error text is the rest of the redirection list &-- a comma does
20875 not terminate it &-- but a newline does act as a terminator. Newlines are not
20876 normally present in alias expansions. In &(lsearch)& lookups they are removed
20877 as part of the continuation process, but they may exist in other kinds of
20878 lookup and in &':include:'& files.
20879
20880 During routing for message delivery (as opposed to verification), a redirection
20881 containing &':fail:'& causes an immediate failure of the incoming address,
20882 whereas &':defer:'& causes the message to remain in the queue so that a
20883 subsequent delivery attempt can happen at a later time. If an address is
20884 deferred for too long, it will ultimately fail, because the normal retry
20885 rules still apply.
20886
20887 .next
20888 .cindex "alias file" "exception to default"
20889 Sometimes it is useful to use a single-key search type with a default (see
20890 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20891 for exceptions to the default. These can be handled by aliasing them to
20892 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20893 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20894 results in an empty redirection list has the same effect.
20895 .endlist
20896
20897
20898 .section "Duplicate addresses" "SECTdupaddr"
20899 .cindex "duplicate addresses"
20900 .cindex "address duplicate, discarding"
20901 .cindex "pipe" "duplicated"
20902 Exim removes duplicate addresses from the list to which it is delivering, so as
20903 to deliver just one copy to each address. This does not apply to deliveries
20904 routed to pipes by different immediate parent addresses, but an indirect
20905 aliasing scheme of the type
20906 .code
20907 pipe:       |/some/command $local_part
20908 localpart1: pipe
20909 localpart2: pipe
20910 .endd
20911 does not work with a message that is addressed to both local parts, because
20912 when the second is aliased to the intermediate local part &"pipe"& it gets
20913 discarded as being the same as a previously handled address. However, a scheme
20914 such as
20915 .code
20916 localpart1: |/some/command $local_part
20917 localpart2: |/some/command $local_part
20918 .endd
20919 does result in two different pipe deliveries, because the immediate parents of
20920 the pipes are distinct.
20921
20922
20923
20924 .section "Repeated redirection expansion" "SECID128"
20925 .cindex "repeated redirection expansion"
20926 .cindex "address redirection" "repeated for each delivery attempt"
20927 When a message cannot be delivered to all of its recipients immediately,
20928 leading to two or more delivery attempts, redirection expansion is carried out
20929 afresh each time for those addresses whose children were not all previously
20930 delivered. If redirection is being used as a mailing list, this can lead to new
20931 members of the list receiving copies of old messages. The &%one_time%& option
20932 can be used to avoid this.
20933
20934
20935 .section "Errors in redirection lists" "SECID129"
20936 .cindex "address redirection" "errors"
20937 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20938 error is skipped, and an entry is written to the main log. This may be useful
20939 for mailing lists that are automatically managed. Otherwise, if an error is
20940 detected while generating the list of new addresses, the original address is
20941 deferred. See also &%syntax_errors_to%&.
20942
20943
20944
20945 .section "Private options for the redirect router" "SECID130"
20946
20947 .cindex "options" "&(redirect)& router"
20948 The private options for the &(redirect)& router are as follows:
20949
20950
20951 .option allow_defer redirect boolean false
20952 Setting this option allows the use of &':defer:'& in non-filter redirection
20953 data, or the &%defer%& command in an Exim filter file.
20954
20955
20956 .option allow_fail redirect boolean false
20957 .cindex "failing delivery" "from filter"
20958 If this option is true, the &':fail:'& item can be used in a redirection list,
20959 and the &%fail%& command may be used in an Exim filter file.
20960
20961
20962 .option allow_filter redirect boolean false
20963 .cindex "filter" "enabling use of"
20964 .cindex "Sieve filter" "enabling use of"
20965 Setting this option allows Exim to interpret redirection data that starts with
20966 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20967 are some features of Exim filter files that some administrators may wish to
20968 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20969
20970 It is also possible to lock out Exim filters or Sieve filters while allowing
20971 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20972
20973
20974 The filter is run using the uid and gid set by the generic &%user%& and
20975 &%group%& options. These take their defaults from the password data if
20976 &%check_local_user%& is set, so in the normal case of users' personal filter
20977 files, the filter is run as the relevant user. When &%allow_filter%& is set
20978 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20979
20980
20981
20982 .option allow_freeze redirect boolean false
20983 .cindex "freezing messages" "allowing in filter"
20984 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20985 This command is more normally encountered in system filters, and is disabled by
20986 default for redirection filters because it isn't something you usually want to
20987 let ordinary users do.
20988
20989
20990
20991 .option check_ancestor redirect boolean false
20992 This option is concerned with handling generated addresses that are the same
20993 as some address in the list of redirection ancestors of the current address.
20994 Although it is turned off by default in the code, it is set in the default
20995 configuration file for handling users' &_.forward_& files. It is recommended
20996 for this use of the &(redirect)& router.
20997
20998 When &%check_ancestor%& is set, if a generated address (including the domain)
20999 is the same as any ancestor of the current address, it is replaced by a copy of
21000 the current address. This helps in the case where local part A is aliased to B,
21001 and B has a &_.forward_& file pointing back to A. For example, within a single
21002 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21003 &_&~jb/.forward_& contains:
21004 .code
21005 \Joe.Bloggs, <other item(s)>
21006 .endd
21007 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21008 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21009 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21010 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21011 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21012 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21013 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21014 original address. See also the &%repeat_use%& option below.
21015
21016
21017 .option check_group redirect boolean "see below"
21018 When the &%file%& option is used, the group owner of the file is checked only
21019 when this option is set. The permitted groups are those listed in the
21020 &%owngroups%& option, together with the user's default group if
21021 &%check_local_user%& is set. If the file has the wrong group, routing is
21022 deferred. The default setting for this option is true if &%check_local_user%&
21023 is set and the &%modemask%& option permits the group write bit, or if the
21024 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21025
21026
21027
21028 .option check_owner redirect boolean "see below"
21029 When the &%file%& option is used, the owner of the file is checked only when
21030 this option is set. If &%check_local_user%& is set, the local user is
21031 permitted; otherwise the owner must be one of those listed in the &%owners%&
21032 option. The default value for this option is true if &%check_local_user%& or
21033 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21034
21035
21036 .option data redirect string&!! unset
21037 This option is mutually exclusive with &%file%&. One or other of them must be
21038 set, but not both. The contents of &%data%& are expanded, and then used as the
21039 list of forwarding items, or as a set of filtering instructions. If the
21040 expansion is forced to fail, or the result is an empty string or a string that
21041 has no effect (consists entirely of comments), the router declines.
21042
21043 When filtering instructions are used, the string must begin with &"#Exim
21044 filter"&, and all comments in the string, including this initial one, must be
21045 terminated with newline characters. For example:
21046 .code
21047 data = #Exim filter\n\
21048        if $h_to: contains Exim then save $home/mail/exim endif
21049 .endd
21050 If you are reading the data from a database where newlines cannot be included,
21051 you can use the &${sg}$& expansion item to turn the escape string of your
21052 choice into a newline.
21053
21054
21055 .option directory_transport redirect string&!! unset
21056 A &(redirect)& router sets up a direct delivery to a directory when a path name
21057 ending with a slash is specified as a new &"address"&. The transport used is
21058 specified by this option, which, after expansion, must be the name of a
21059 configured transport. This should normally be an &(appendfile)& transport.
21060
21061
21062 .option file redirect string&!! unset
21063 This option specifies the name of a file that contains the redirection data. It
21064 is mutually exclusive with the &%data%& option. The string is expanded before
21065 use; if the expansion is forced to fail, the router declines. Other expansion
21066 failures cause delivery to be deferred. The result of a successful expansion
21067 must be an absolute path. The entire file is read and used as the redirection
21068 data. If the data is an empty string or a string that has no effect (consists
21069 entirely of comments), the router declines.
21070
21071 .cindex "NFS" "checking for file existence"
21072 If the attempt to open the file fails with a &"does not exist"& error, Exim
21073 runs a check on the containing directory,
21074 unless &%ignore_enotdir%& is true (see below).
21075 If the directory does not appear to exist, delivery is deferred. This can
21076 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21077 is a mount problem. If the containing directory does exist, but the file does
21078 not, the router declines.
21079
21080
21081 .option file_transport redirect string&!! unset
21082 .vindex "&$address_file$&"
21083 A &(redirect)& router sets up a direct delivery to a file when a path name not
21084 ending in a slash is specified as a new &"address"&. The transport used is
21085 specified by this option, which, after expansion, must be the name of a
21086 configured transport. This should normally be an &(appendfile)& transport. When
21087 it is running, the filename is in &$address_file$&.
21088
21089
21090 .option filter_prepend_home redirect boolean true
21091 When this option is true, if a &(save)& command in an Exim filter specifies a
21092 relative path, and &$home$& is defined, it is automatically prepended to the
21093 relative path. If this option is set false, this action does not happen. The
21094 relative path is then passed to the transport unmodified.
21095
21096
21097 .option forbid_blackhole redirect boolean false
21098 .cindex "restricting access to features"
21099 .cindex "filter" "locking out certain features"
21100 If this option is true, the &':blackhole:'& item may not appear in a
21101 redirection list.
21102
21103
21104 .option forbid_exim_filter redirect boolean false
21105 .cindex "restricting access to features"
21106 .cindex "filter" "locking out certain features"
21107 If this option is set true, only Sieve filters are permitted when
21108 &%allow_filter%& is true.
21109
21110
21111
21112
21113 .option forbid_file redirect boolean false
21114 .cindex "restricting access to features"
21115 .cindex "delivery" "to file; forbidding"
21116 .cindex "filter" "locking out certain features"
21117 .cindex "Sieve filter" "forbidding delivery to a file"
21118 .cindex "Sieve filter" "&""keep""& facility; disabling"
21119 If this option is true, this router may not generate a new address that
21120 specifies delivery to a local file or directory, either from a filter or from a
21121 conventional forward file. This option is forced to be true if &%one_time%& is
21122 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21123 locks out the Sieve's &"keep"& facility.
21124
21125
21126 .option forbid_filter_dlfunc redirect boolean false
21127 .cindex "restricting access to features"
21128 .cindex "filter" "locking out certain features"
21129 If this option is true, string expansions in Exim filters are not allowed to
21130 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21131 functions.
21132
21133 .option forbid_filter_existstest redirect boolean false
21134 .cindex "restricting access to features"
21135 .cindex "filter" "locking out certain features"
21136 .cindex "expansion" "statting a file"
21137 If this option is true, string expansions in Exim filters are not allowed to
21138 make use of the &%exists%& condition or the &%stat%& expansion item.
21139
21140 .option forbid_filter_logwrite redirect boolean false
21141 .cindex "restricting access to features"
21142 .cindex "filter" "locking out certain features"
21143 If this option is true, use of the logging facility in Exim filters is not
21144 permitted. Logging is in any case available only if the filter is being run
21145 under some unprivileged uid (which is normally the case for ordinary users'
21146 &_.forward_& files).
21147
21148
21149 .option forbid_filter_lookup redirect boolean false
21150 .cindex "restricting access to features"
21151 .cindex "filter" "locking out certain features"
21152 If this option is true, string expansions in Exim filter files are not allowed
21153 to make use of &%lookup%& items.
21154
21155
21156 .option forbid_filter_perl redirect boolean false
21157 .cindex "restricting access to features"
21158 .cindex "filter" "locking out certain features"
21159 This option has an effect only if Exim is built with embedded Perl support. If
21160 it is true, string expansions in Exim filter files are not allowed to make use
21161 of the embedded Perl support.
21162
21163
21164 .option forbid_filter_readfile redirect boolean false
21165 .cindex "restricting access to features"
21166 .cindex "filter" "locking out certain features"
21167 If this option is true, string expansions in Exim filter files are not allowed
21168 to make use of &%readfile%& items.
21169
21170
21171 .option forbid_filter_readsocket redirect boolean false
21172 .cindex "restricting access to features"
21173 .cindex "filter" "locking out certain features"
21174 If this option is true, string expansions in Exim filter files are not allowed
21175 to make use of &%readsocket%& items.
21176
21177
21178 .option forbid_filter_reply redirect boolean false
21179 .cindex "restricting access to features"
21180 .cindex "filter" "locking out certain features"
21181 If this option is true, this router may not generate an automatic reply
21182 message. Automatic replies can be generated only from Exim or Sieve filter
21183 files, not from traditional forward files. This option is forced to be true if
21184 &%one_time%& is set.
21185
21186
21187 .option forbid_filter_run redirect boolean false
21188 .cindex "restricting access to features"
21189 .cindex "filter" "locking out certain features"
21190 If this option is true, string expansions in Exim filter files are not allowed
21191 to make use of &%run%& items.
21192
21193
21194 .option forbid_include redirect boolean false
21195 .cindex "restricting access to features"
21196 .cindex "filter" "locking out certain features"
21197 If this option is true, items of the form
21198 .code
21199 :include:<path name>
21200 .endd
21201 are not permitted in non-filter redirection lists.
21202
21203
21204 .option forbid_pipe redirect boolean false
21205 .cindex "restricting access to features"
21206 .cindex "filter" "locking out certain features"
21207 .cindex "delivery" "to pipe; forbidding"
21208 If this option is true, this router may not generate a new address which
21209 specifies delivery to a pipe, either from an Exim filter or from a conventional
21210 forward file. This option is forced to be true if &%one_time%& is set.
21211
21212
21213 .option forbid_sieve_filter redirect boolean false
21214 .cindex "restricting access to features"
21215 .cindex "filter" "locking out certain features"
21216 If this option is set true, only Exim filters are permitted when
21217 &%allow_filter%& is true.
21218
21219
21220 .cindex "SMTP" "error codes"
21221 .option forbid_smtp_code redirect boolean false
21222 If this option is set true, any SMTP error codes that are present at the start
21223 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21224 the default codes (451 and 550, respectively) are always used.
21225
21226
21227
21228
21229 .option hide_child_in_errmsg redirect boolean false
21230 .cindex "bounce message" "redirection details; suppressing"
21231 If this option is true, it prevents Exim from quoting a child address if it
21232 generates a bounce or delay message for it. Instead it says &"an address
21233 generated from <&'the top level address'&>"&. Of course, this applies only to
21234 bounces generated locally. If a message is forwarded to another host, &'its'&
21235 bounce may well quote the generated address.
21236
21237
21238 .option ignore_eacces redirect boolean false
21239 .cindex "EACCES"
21240 If this option is set and an attempt to open a redirection file yields the
21241 EACCES error (permission denied), the &(redirect)& router behaves as if the
21242 file did not exist.
21243
21244
21245 .option ignore_enotdir redirect boolean false
21246 .cindex "ENOTDIR"
21247 If this option is set and an attempt to open a redirection file yields the
21248 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21249 router behaves as if the file did not exist.
21250
21251 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21252 router that has the &%file%& option set discovers that the file does not exist
21253 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21254 against unmounted NFS directories. If the parent can not be statted, delivery
21255 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21256 is set, because that option tells Exim to ignore &"something on the path is not
21257 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21258 that some operating systems give ENOENT where others give ENOTDIR.
21259
21260
21261
21262 .option include_directory redirect string unset
21263 If this option is set, the path names of any &':include:'& items in a
21264 redirection list must start with this directory.
21265
21266
21267 .option modemask redirect "octal integer" 022
21268 This specifies mode bits which must not be set for a file specified by the
21269 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21270
21271
21272 .option one_time redirect boolean false
21273 .cindex "one-time aliasing/forwarding expansion"
21274 .cindex "alias file" "one-time expansion"
21275 .cindex "forward file" "one-time expansion"
21276 .cindex "mailing lists" "one-time expansion"
21277 .cindex "address redirection" "one-time expansion"
21278 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21279 files each time it tries to deliver a message causes a problem when one or more
21280 of the generated addresses fails be delivered at the first attempt. The problem
21281 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21282 but of what happens when the redirection list changes during the time that the
21283 message is on Exim's queue. This is particularly true in the case of mailing
21284 lists, where new subscribers might receive copies of messages that were posted
21285 before they subscribed.
21286
21287 If &%one_time%& is set and any addresses generated by the router fail to
21288 deliver at the first attempt, the failing addresses are added to the message as
21289 &"top level"& addresses, and the parent address that generated them is marked
21290 &"delivered"&. Thus, redirection does not happen again at the next delivery
21291 attempt.
21292
21293 &*Warning 1*&: Any header line addition or removal that is specified by this
21294 router would be lost if delivery did not succeed at the first attempt. For this
21295 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21296 permitted when &%one_time%& is set.
21297
21298 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21299 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21300 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21301
21302 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21303 &%one_time%&.
21304
21305 The original top-level address is remembered with each of the generated
21306 addresses, and is output in any log messages. However, any intermediate parent
21307 addresses are not recorded. This makes a difference to the log only if
21308 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21309 typically be used for mailing lists, where there is normally just one level of
21310 expansion.
21311
21312
21313 .option owners redirect "string list" unset
21314 .cindex "ownership" "alias file"
21315 .cindex "ownership" "forward file"
21316 .cindex "alias file" "ownership"
21317 .cindex "forward file" "ownership"
21318 This specifies a list of permitted owners for the file specified by &%file%&.
21319 This list is in addition to the local user when &%check_local_user%& is set.
21320 See &%check_owner%& above.
21321
21322
21323 .option owngroups redirect "string list" unset
21324 This specifies a list of permitted groups for the file specified by &%file%&.
21325 The list is in addition to the local user's primary group when
21326 &%check_local_user%& is set. See &%check_group%& above.
21327
21328
21329 .option pipe_transport redirect string&!! unset
21330 .vindex "&$address_pipe$&"
21331 A &(redirect)& router sets up a direct delivery to a pipe when a string
21332 starting with a vertical bar character is specified as a new &"address"&. The
21333 transport used is specified by this option, which, after expansion, must be the
21334 name of a configured transport. This should normally be a &(pipe)& transport.
21335 When the transport is run, the pipe command is in &$address_pipe$&.
21336
21337
21338 .option qualify_domain redirect string&!! unset
21339 .vindex "&$qualify_recipient$&"
21340 If this option is set, and an unqualified address (one without a domain) is
21341 generated, and that address would normally be qualified by the global setting
21342 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21343 expanding this string. If the expansion fails, the router declines. If you want
21344 to revert to the default, you can have the expansion generate
21345 &$qualify_recipient$&.
21346
21347 This option applies to all unqualified addresses generated by Exim filters,
21348 but for traditional &_.forward_& files, it applies only to addresses that are
21349 not preceded by a backslash. Sieve filters cannot generate unqualified
21350 addresses.
21351
21352 .option qualify_preserve_domain redirect boolean false
21353 .cindex "domain" "in redirection; preserving"
21354 .cindex "preserving domain in redirection"
21355 .cindex "address redirection" "domain; preserving"
21356 If this option is set, the router's local &%qualify_domain%& option must not be
21357 set (a configuration error occurs if it is). If an unqualified address (one
21358 without a domain) is generated, it is qualified with the domain of the parent
21359 address (the immediately preceding ancestor) instead of the global
21360 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21361 this applies whether or not the address is preceded by a backslash.
21362
21363
21364 .option repeat_use redirect boolean true
21365 If this option is set false, the router is skipped for a child address that has
21366 any ancestor that was routed by this router. This test happens before any of
21367 the other preconditions are tested. Exim's default anti-looping rules skip
21368 only when the ancestor is the same as the current address. See also
21369 &%check_ancestor%& above and the generic &%redirect_router%& option.
21370
21371
21372 .option reply_transport redirect string&!! unset
21373 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21374 &%vacation%& command is used in a filter file. The transport used is specified
21375 by this option, which, after expansion, must be the name of a configured
21376 transport. This should normally be an &(autoreply)& transport. Other transports
21377 are unlikely to do anything sensible or useful.
21378
21379
21380 .option rewrite redirect boolean true
21381 .cindex "address redirection" "disabling rewriting"
21382 If this option is set false, addresses generated by the router are not
21383 subject to address rewriting. Otherwise, they are treated like new addresses
21384 and are rewritten according to the global rewriting rules.
21385
21386
21387 .option sieve_subaddress redirect string&!! unset
21388 The value of this option is passed to a Sieve filter to specify the
21389 :subaddress part of an address.
21390
21391 .option sieve_useraddress redirect string&!! unset
21392 The value of this option is passed to a Sieve filter to specify the :user part
21393 of an address. However, if it is unset, the entire original local part
21394 (including any prefix or suffix) is used for :user.
21395
21396
21397 .option sieve_vacation_directory redirect string&!! unset
21398 .cindex "Sieve filter" "vacation directory"
21399 To enable the &"vacation"& extension for Sieve filters, you must set
21400 &%sieve_vacation_directory%& to the directory where vacation databases are held
21401 (do not put anything else in that directory), and ensure that the
21402 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21403 needs their own directory; Exim will create it if necessary.
21404
21405
21406
21407 .option skip_syntax_errors redirect boolean false
21408 .cindex "forward file" "broken"
21409 .cindex "address redirection" "broken files"
21410 .cindex "alias file" "broken"
21411 .cindex "broken alias or forward files"
21412 .cindex "ignoring faulty addresses"
21413 .cindex "skipping faulty addresses"
21414 .cindex "error" "skipping bad syntax"
21415 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21416 non-filter redirection data are skipped, and each failing address is logged. If
21417 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21418 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21419 are expanded and placed at the head of the error message generated by
21420 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21421 be the same address as the generic &%errors_to%& option. The
21422 &%skip_syntax_errors%& option is often used when handling mailing lists.
21423
21424 If all the addresses in a redirection list are skipped because of syntax
21425 errors, the router declines to handle the original address, and it is passed to
21426 the following routers.
21427
21428 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21429 error in the filter causes filtering to be abandoned without any action being
21430 taken. The incident is logged, and the router declines to handle the address,
21431 so it is passed to the following routers.
21432
21433 .cindex "Sieve filter" "syntax errors in"
21434 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21435 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21436 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21437
21438 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21439 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21440 option, used with an address that does not get redirected, can be used to
21441 notify users of these errors, by means of a router like this:
21442 .code
21443 userforward:
21444   driver = redirect
21445   allow_filter
21446   check_local_user
21447   file = $home/.forward
21448   file_transport = address_file
21449   pipe_transport = address_pipe
21450   reply_transport = address_reply
21451   no_verify
21452   skip_syntax_errors
21453   syntax_errors_to = real-$local_part@$domain
21454   syntax_errors_text = \
21455    This is an automatically generated message. An error has\n\
21456    been found in your .forward file. Details of the error are\n\
21457    reported below. While this error persists, you will receive\n\
21458    a copy of this message for every message that is addressed\n\
21459    to you. If your .forward file is a filter file, or if it is\n\
21460    a non-filter file containing no valid forwarding addresses,\n\
21461    a copy of each incoming message will be put in your normal\n\
21462    mailbox. If a non-filter file contains at least one valid\n\
21463    forwarding address, forwarding to the valid addresses will\n\
21464    happen, and those will be the only deliveries that occur.
21465 .endd
21466 You also need a router to ensure that local addresses that are prefixed by
21467 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21468 put this immediately before the &(userforward)& router:
21469 .code
21470 real_localuser:
21471   driver = accept
21472   check_local_user
21473   local_part_prefix = real-
21474   transport = local_delivery
21475 .endd
21476 For security, it would probably be a good idea to restrict the use of this
21477 router to locally-generated messages, using a condition such as this:
21478 .code
21479   condition = ${if match {$sender_host_address}\
21480                          {\N^(|127\.0\.0\.1)$\N}}
21481 .endd
21482
21483
21484 .option syntax_errors_text redirect string&!! unset
21485 See &%skip_syntax_errors%& above.
21486
21487
21488 .option syntax_errors_to redirect string unset
21489 See &%skip_syntax_errors%& above.
21490 .ecindex IIDredrou1
21491 .ecindex IIDredrou2
21492
21493
21494
21495
21496
21497
21498 . ////////////////////////////////////////////////////////////////////////////
21499 . ////////////////////////////////////////////////////////////////////////////
21500
21501 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21502          "Environment for local transports"
21503 .scindex IIDenvlotra1 "local transports" "environment for"
21504 .scindex IIDenvlotra2 "environment" "local transports"
21505 .scindex IIDenvlotra3 "transport" "local; environment for"
21506 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21507 transport can be thought of as similar to a pipe.) Exim always runs transports
21508 in subprocesses, under specified uids and gids. Typical deliveries to local
21509 mailboxes run under the uid and gid of the local user.
21510
21511 Exim also sets a specific current directory while running the transport; for
21512 some transports a home directory setting is also relevant. The &(pipe)&
21513 transport is the only one that sets up environment variables; see section
21514 &<<SECTpipeenv>>& for details.
21515
21516 The values used for the uid, gid, and the directories may come from several
21517 different places. In many cases, the router that handles the address associates
21518 settings with that address as a result of its &%check_local_user%&, &%group%&,
21519 or &%user%& options. However, values may also be given in the transport's own
21520 configuration, and these override anything that comes from the router.
21521
21522
21523
21524 .section "Concurrent deliveries" "SECID131"
21525 .cindex "concurrent deliveries"
21526 .cindex "simultaneous deliveries"
21527 If two different messages for the same local recipient arrive more or less
21528 simultaneously, the two delivery processes are likely to run concurrently. When
21529 the &(appendfile)& transport is used to write to a file, Exim applies locking
21530 rules to stop concurrent processes from writing to the same file at the same
21531 time.
21532
21533 However, when you use a &(pipe)& transport, it is up to you to arrange any
21534 locking that is needed. Here is a silly example:
21535 .code
21536 my_transport:
21537   driver = pipe
21538   command = /bin/sh -c 'cat >>/some/file'
21539 .endd
21540 This is supposed to write the message at the end of the file. However, if two
21541 messages arrive at the same time, the file will be scrambled. You can use the
21542 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21543 file using the same algorithm that Exim itself uses.
21544
21545
21546
21547
21548 .section "Uids and gids" "SECTenvuidgid"
21549 .cindex "local transports" "uid and gid"
21550 .cindex "transport" "local; uid and gid"
21551 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21552 overrides any group that the router set in the address, even if &%user%& is not
21553 set for the transport. This makes it possible, for example, to run local mail
21554 delivery under the uid of the recipient (set by the router), but in a special
21555 group (set by the transport). For example:
21556 .code
21557 # Routers ...
21558 # User/group are set by check_local_user in this router
21559 local_users:
21560   driver = accept
21561   check_local_user
21562   transport = group_delivery
21563
21564 # Transports ...
21565 # This transport overrides the group
21566 group_delivery:
21567   driver = appendfile
21568   file = /var/spool/mail/$local_part
21569   group = mail
21570 .endd
21571 If &%user%& is set for a transport, its value overrides what is set in the
21572 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21573 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21574 set.
21575
21576 .oindex "&%initgroups%&"
21577 When the uid is taken from the transport's configuration, the &[initgroups()]&
21578 function is called for the groups associated with that uid if the
21579 &%initgroups%& option is set for the transport. When the uid is not specified
21580 by the transport, but is associated with the address by a router, the option
21581 for calling &[initgroups()]& is taken from the router configuration.
21582
21583 .cindex "&(pipe)& transport" "uid for"
21584 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21585 is set and &%user%& is not set, the uid of the process that called Exim to
21586 receive the message is used, and if &%group%& is not set, the corresponding
21587 original gid is also used.
21588
21589 This is the detailed preference order for obtaining a gid; the first of the
21590 following that is set is used:
21591
21592 .ilist
21593 A &%group%& setting of the transport;
21594 .next
21595 A &%group%& setting of the router;
21596 .next
21597 A gid associated with a user setting of the router, either as a result of
21598 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21599 .next
21600 The group associated with a non-numeric &%user%& setting of the transport;
21601 .next
21602 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21603 the uid is the creator's uid;
21604 .next
21605 The Exim gid if the Exim uid is being used as a default.
21606 .endlist
21607
21608 If, for example, the user is specified numerically on the router and there are
21609 no group settings, no gid is available. In this situation, an error occurs.
21610 This is different for the uid, for which there always is an ultimate default.
21611 The first of the following that is set is used:
21612
21613 .ilist
21614 A &%user%& setting of the transport;
21615 .next
21616 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21617 .next
21618 A &%user%& setting of the router;
21619 .next
21620 A &%check_local_user%& setting of the router;
21621 .next
21622 The Exim uid.
21623 .endlist
21624
21625 Of course, an error will still occur if the uid that is chosen is on the
21626 &%never_users%& list.
21627
21628
21629
21630
21631
21632 .section "Current and home directories" "SECID132"
21633 .cindex "current directory for local transport"
21634 .cindex "home directory" "for local transport"
21635 .cindex "transport" "local; home directory for"
21636 .cindex "transport" "local; current directory for"
21637 Routers may set current and home directories for local transports by means of
21638 the &%transport_current_directory%& and &%transport_home_directory%& options.
21639 However, if the transport's &%current_directory%& or &%home_directory%& options
21640 are set, they override the router's values. In detail, the home directory
21641 for a local transport is taken from the first of these values that is set:
21642
21643 .ilist
21644 The &%home_directory%& option on the transport;
21645 .next
21646 The &%transport_home_directory%& option on the router;
21647 .next
21648 The password data if &%check_local_user%& is set on the router;
21649 .next
21650 The &%router_home_directory%& option on the router.
21651 .endlist
21652
21653 The current directory is taken from the first of these values that is set:
21654
21655 .ilist
21656 The &%current_directory%& option on the transport;
21657 .next
21658 The &%transport_current_directory%& option on the router.
21659 .endlist
21660
21661
21662 If neither the router nor the transport sets a current directory, Exim uses the
21663 value of the home directory, if it is set. Otherwise it sets the current
21664 directory to &_/_& before running a local transport.
21665
21666
21667
21668 .section "Expansion variables derived from the address" "SECID133"
21669 .vindex "&$domain$&"
21670 .vindex "&$local_part$&"
21671 .vindex "&$original_domain$&"
21672 Normally a local delivery is handling a single address, and in that case the
21673 variables such as &$domain$& and &$local_part$& are set during local
21674 deliveries. However, in some circumstances more than one address may be handled
21675 at once (for example, while writing batch SMTP for onward transmission by some
21676 other means). In this case, the variables associated with the local part are
21677 never set, &$domain$& is set only if all the addresses have the same domain,
21678 and &$original_domain$& is never set.
21679 .ecindex IIDenvlotra1
21680 .ecindex IIDenvlotra2
21681 .ecindex IIDenvlotra3
21682
21683
21684
21685
21686
21687
21688
21689 . ////////////////////////////////////////////////////////////////////////////
21690 . ////////////////////////////////////////////////////////////////////////////
21691
21692 .chapter "Generic options for transports" "CHAPtransportgeneric"
21693 .scindex IIDgenoptra1 "generic options" "transport"
21694 .scindex IIDgenoptra2 "options" "generic; for transports"
21695 .scindex IIDgenoptra3 "transport" "generic options for"
21696 The following generic options apply to all transports:
21697
21698
21699 .option body_only transports boolean false
21700 .cindex "transport" "body only"
21701 .cindex "message" "transporting body only"
21702 .cindex "body of message" "transporting"
21703 If this option is set, the message's headers are not transported. It is
21704 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21705 or &(pipe)& transports, the settings of &%message_prefix%& and
21706 &%message_suffix%& should be checked, because this option does not
21707 automatically suppress them.
21708
21709
21710 .option current_directory transports string&!! unset
21711 .cindex "transport" "current directory for"
21712 This specifies the current directory that is to be set while running the
21713 transport, overriding any value that may have been set by the router.
21714 If the expansion fails for any reason, including forced failure, an error is
21715 logged, and delivery is deferred.
21716
21717
21718 .option disable_logging transports boolean false
21719 If this option is set true, nothing is logged for any
21720 deliveries by the transport or for any
21721 transport errors. You should not set this option unless you really, really know
21722 what you are doing.
21723
21724
21725 .option debug_print transports string&!! unset
21726 .cindex "testing" "variables in drivers"
21727 If this option is set and debugging is enabled (see the &%-d%& command line
21728 option), the string is expanded and included in the debugging output when the
21729 transport is run.
21730 If expansion of the string fails, the error message is written to the debugging
21731 output, and Exim carries on processing.
21732 This facility is provided to help with checking out the values of variables and
21733 so on when debugging driver configurations. For example, if a &%headers_add%&
21734 option is not working properly, &%debug_print%& could be used to output the
21735 variables it references. A newline is added to the text if it does not end with
21736 one.
21737 The variables &$transport_name$& and &$router_name$& contain the name of the
21738 transport and the router that called it.
21739
21740 .option delivery_date_add transports boolean false
21741 .cindex "&'Delivery-date:'& header line"
21742 If this option is true, a &'Delivery-date:'& header is added to the message.
21743 This gives the actual time the delivery was made. As this is not a standard
21744 header, Exim has a configuration option (&%delivery_date_remove%&) which
21745 requests its removal from incoming messages, so that delivered messages can
21746 safely be resent to other recipients.
21747
21748
21749 .option driver transports string unset
21750 This specifies which of the available transport drivers is to be used.
21751 There is no default, and this option must be set for every transport.
21752
21753
21754 .option envelope_to_add transports boolean false
21755 .cindex "&'Envelope-to:'& header line"
21756 If this option is true, an &'Envelope-to:'& header is added to the message.
21757 This gives the original address(es) in the incoming envelope that caused this
21758 delivery to happen. More than one address may be present if the transport is
21759 configured to handle several addresses at once, or if more than one original
21760 address was redirected to the same final address. As this is not a standard
21761 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21762 its removal from incoming messages, so that delivered messages can safely be
21763 resent to other recipients.
21764
21765
21766 .option event_action transports string&!! unset
21767 .cindex events
21768 This option declares a string to be expanded for Exim's events mechanism.
21769 For details see chapter &<<CHAPevents>>&.
21770
21771
21772 .option group transports string&!! "Exim group"
21773 .cindex "transport" "group; specifying"
21774 This option specifies a gid for running the transport process, overriding any
21775 value that the router supplies, and also overriding any value associated with
21776 &%user%& (see below).
21777
21778
21779 .option headers_add transports list&!! unset
21780 .cindex "header lines" "adding in transport"
21781 .cindex "transport" "header lines; adding"
21782 This option specifies a list of text headers,
21783 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21784 which are (separately) expanded and added to the header
21785 portion of a message as it is transported, as described in section
21786 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21787 routers. If the result of the expansion is an empty string, or if the expansion
21788 is forced to fail, no action is taken. Other expansion failures are treated as
21789 errors and cause the delivery to be deferred.
21790
21791 Unlike most options, &%headers_add%& can be specified multiple times
21792 for a transport; all listed headers are added.
21793
21794
21795 .option headers_only transports boolean false
21796 .cindex "transport" "header lines only"
21797 .cindex "message" "transporting headers only"
21798 .cindex "header lines" "transporting"
21799 If this option is set, the message's body is not transported. It is mutually
21800 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21801 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21802 checked, since this option does not automatically suppress them.
21803
21804
21805 .option headers_remove transports list&!! unset
21806 .cindex "header lines" "removing"
21807 .cindex "transport" "header lines; removing"
21808 This option specifies a list of header names,
21809 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21810 these headers are omitted from the message as it is transported, as described
21811 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21812 routers.
21813 Each list item is separately expanded.
21814 If the result of the expansion is an empty string, or if the expansion
21815 is forced to fail, no action is taken. Other expansion failures are treated as
21816 errors and cause the delivery to be deferred.
21817
21818 Unlike most options, &%headers_remove%& can be specified multiple times
21819 for a transport; all listed headers are removed.
21820
21821 &*Warning*&: Because of the separate expansion of the list items,
21822 items that contain a list separator must have it doubled.
21823 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21824
21825
21826
21827 .option headers_rewrite transports string unset
21828 .cindex "transport" "header lines; rewriting"
21829 .cindex "rewriting" "at transport time"
21830 This option allows addresses in header lines to be rewritten at transport time,
21831 that is, as the message is being copied to its destination. The contents of the
21832 option are a colon-separated list of rewriting rules. Each rule is in exactly
21833 the same form as one of the general rewriting rules that are applied when a
21834 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21835 example,
21836 .code
21837 headers_rewrite = a@b c@d f : \
21838                   x@y w@z
21839 .endd
21840 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21841 &'w@z'& in all address-bearing header lines. The rules are applied to the
21842 header lines just before they are written out at transport time, so they affect
21843 only those copies of the message that pass through the transport. However, only
21844 the message's original header lines, and any that were added by a system
21845 filter, are rewritten. If a router or transport adds header lines, they are not
21846 affected by this option. These rewriting rules are &'not'& applied to the
21847 envelope. You can change the return path using &%return_path%&, but you cannot
21848 change envelope recipients at this time.
21849
21850
21851 .option home_directory transports string&!! unset
21852 .cindex "transport" "home directory for"
21853 .vindex "&$home$&"
21854 This option specifies a home directory setting for a local transport,
21855 overriding any value that may be set by the router. The home directory is
21856 placed in &$home$& while expanding the transport's private options. It is also
21857 used as the current directory if no current directory is set by the
21858 &%current_directory%& option on the transport or the
21859 &%transport_current_directory%& option on the router. If the expansion fails
21860 for any reason, including forced failure, an error is logged, and delivery is
21861 deferred.
21862
21863
21864 .option initgroups transports boolean false
21865 .cindex "additional groups"
21866 .cindex "groups" "additional"
21867 .cindex "transport" "group; additional"
21868 If this option is true and the uid for the delivery process is provided by the
21869 transport, the &[initgroups()]& function is called when running the transport
21870 to ensure that any additional groups associated with the uid are set up.
21871
21872
21873 .option max_parallel transports integer&!! unset
21874 .cindex limit "transport parallelism"
21875 .cindex transport "parallel processes"
21876 .cindex transport "concurrency limit"
21877 .cindex "delivery" "parallelism for transport"
21878 If this option is set and expands to an integer greater than zero
21879 it limits the number of concurrent runs of the transport.
21880 The control does not apply to shadow transports.
21881
21882 .cindex "hints database" "transport concurrency control"
21883 Exim implements this control by means of a hints database in which a record is
21884 incremented whenever a transport process is being created. The record
21885 is decremented and possibly removed when the process terminates.
21886 Obviously there is scope for
21887 records to get left lying around if there is a system or program crash. To
21888 guard against this, Exim ignores any records that are more than six hours old.
21889
21890 If you use this option, you should also arrange to delete the
21891 relevant hints database whenever your system reboots. The names of the files
21892 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21893 may be one or two files, depending on the type of DBM in use. The same files
21894 are used for ETRN and smtp transport serialization.
21895
21896
21897 .option message_size_limit transports string&!! 0
21898 .cindex "limit" "message size per transport"
21899 .cindex "size" "of message, limit"
21900 .cindex "transport" "message size; limiting"
21901 This option controls the size of messages passed through the transport. It is
21902 expanded before use; the result of the expansion must be a sequence of decimal
21903 digits, optionally followed by K or M. If the expansion fails for any reason,
21904 including forced failure, or if the result is not of the required form,
21905 delivery is deferred. If the value is greater than zero and the size of a
21906 message exceeds this limit, the address is failed. If there is any chance that
21907 the resulting bounce message could be routed to the same transport, you should
21908 ensure that &%return_size_limit%& is less than the transport's
21909 &%message_size_limit%&, as otherwise the bounce message will fail to get
21910 delivered.
21911
21912
21913
21914 .option rcpt_include_affixes transports boolean false
21915 .cindex "prefix" "for local part, including in envelope"
21916 .cindex "suffix for local part" "including in envelope"
21917 .cindex "local part" "prefix"
21918 .cindex "local part" "suffix"
21919 When this option is false (the default), and an address that has had any
21920 affixes (prefixes or suffixes) removed from the local part is delivered by any
21921 form of SMTP or LMTP, the affixes are not included. For example, if a router
21922 that contains
21923 .code
21924 local_part_prefix = *-
21925 .endd
21926 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21927 is delivered with
21928 .code
21929 RCPT TO:<xyz@some.domain>
21930 .endd
21931 This is also the case when an ACL-time callout is being used to verify a
21932 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21933 whole local part is included in the RCPT command. This option applies to BSMTP
21934 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21935 &(lmtp)& and &(smtp)& transports.
21936
21937
21938 .option retry_use_local_part transports boolean "see below"
21939 .cindex "hints database" "retry keys"
21940 When a delivery suffers a temporary failure, a retry record is created
21941 in Exim's hints database. For remote deliveries, the key for the retry record
21942 is based on the name and/or IP address of the failing remote host. For local
21943 deliveries, the key is normally the entire address, including both the local
21944 part and the domain. This is suitable for most common cases of local delivery
21945 temporary failure &-- for example, exceeding a mailbox quota should delay only
21946 deliveries to that mailbox, not to the whole domain.
21947
21948 However, in some special cases you may want to treat a temporary local delivery
21949 as a failure associated with the domain, and not with a particular local part.
21950 (For example, if you are storing all mail for some domain in files.) You can do
21951 this by setting &%retry_use_local_part%& false.
21952
21953 For all the local transports, its default value is true. For remote transports,
21954 the default value is false for tidiness, but changing the value has no effect
21955 on a remote transport in the current implementation.
21956
21957
21958 .option return_path transports string&!! unset
21959 .cindex "envelope sender"
21960 .cindex "envelope from"
21961 .cindex "transport" "return path; changing"
21962 .cindex "return path" "changing in transport"
21963 If this option is set, the string is expanded at transport time and replaces
21964 the existing return path (envelope sender) value in the copy of the message
21965 that is being delivered. An empty return path is permitted. This feature is
21966 designed for remote deliveries, where the value of this option is used in the
21967 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21968 only effect is to change the address that is placed in the &'Return-path:'&
21969 header line, if one is added to the message (see the next option).
21970
21971 &*Note:*& A changed return path is not logged unless you add
21972 &%return_path_on_delivery%& to the log selector.
21973
21974 .vindex "&$return_path$&"
21975 The expansion can refer to the existing value via &$return_path$&. This is
21976 either the message's envelope sender, or an address set by the
21977 &%errors_to%& option on a router. If the expansion is forced to fail, no
21978 replacement occurs; if it fails for another reason, delivery is deferred. This
21979 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21980 section &<<SECTverp>>&.
21981
21982 &*Note*&: If a delivery error is detected locally, including the case when a
21983 remote server rejects a message at SMTP time, the bounce message is not sent to
21984 the value of this option. It is sent to the previously set errors address.
21985 This defaults to the incoming sender address, but can be changed by setting
21986 &%errors_to%& in a router.
21987
21988
21989
21990 .option return_path_add transports boolean false
21991 .cindex "&'Return-path:'& header line"
21992 If this option is true, a &'Return-path:'& header is added to the message.
21993 Although the return path is normally available in the prefix line of BSD
21994 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21995 have easy access to it.
21996
21997 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21998 the delivery SMTP server makes the final delivery"&. This implies that this
21999 header should not be present in incoming messages. Exim has a configuration
22000 option, &%return_path_remove%&, which requests removal of this header from
22001 incoming messages, so that delivered messages can safely be resent to other
22002 recipients.
22003
22004
22005 .option shadow_condition transports string&!! unset
22006 See &%shadow_transport%& below.
22007
22008
22009 .option shadow_transport transports string unset
22010 .cindex "shadow transport"
22011 .cindex "transport" "shadow"
22012 A local transport may set the &%shadow_transport%& option to the name of
22013 another local transport. Shadow remote transports are not supported.
22014
22015 Whenever a delivery to the main transport succeeds, and either
22016 &%shadow_condition%& is unset, or its expansion does not result in the empty
22017 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22018 passed to the shadow transport, with the same delivery address or addresses. If
22019 expansion fails, no action is taken except that non-forced expansion failures
22020 cause a log line to be written.
22021
22022 The result of the shadow transport is discarded and does not affect the
22023 subsequent processing of the message. Only a single level of shadowing is
22024 provided; the &%shadow_transport%& option is ignored on any transport when it
22025 is running as a shadow. Options concerned with output from pipes are also
22026 ignored. The log line for the successful delivery has an item added on the end,
22027 of the form
22028 .code
22029 ST=<shadow transport name>
22030 .endd
22031 If the shadow transport did not succeed, the error message is put in
22032 parentheses afterwards. Shadow transports can be used for a number of different
22033 purposes, including keeping more detailed log information than Exim normally
22034 provides, and implementing automatic acknowledgment policies based on message
22035 headers that some sites insist on.
22036
22037
22038 .option transport_filter transports string&!! unset
22039 .cindex "transport" "filter"
22040 .cindex "filter" "transport filter"
22041 This option sets up a filtering (in the Unix shell sense) process for messages
22042 at transport time. It should not be confused with mail filtering as set up by
22043 individual users or via a system filter.
22044 If unset, or expanding to an empty string, no filtering is done.
22045
22046 When the message is about to be written out, the command specified by
22047 &%transport_filter%& is started up in a separate, parallel process, and
22048 the entire message, including the header lines, is passed to it on its standard
22049 input (this in fact is done from a third process, to avoid deadlock). The
22050 command must be specified as an absolute path.
22051
22052 The lines of the message that are written to the transport filter are
22053 terminated by newline (&"\n"&). The message is passed to the filter before any
22054 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22055 lines beginning with a dot, and also before any processing implied by the
22056 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22057 &(pipe)& transports.
22058
22059 The standard error for the filter process is set to the same destination as its
22060 standard output; this is read and written to the message's ultimate
22061 destination. The process that writes the message to the filter, the
22062 filter itself, and the original process that reads the result and delivers it
22063 are all run in parallel, like a shell pipeline.
22064
22065 The filter can perform any transformations it likes, but of course should take
22066 care not to break RFC 2822 syntax. Exim does not check the result, except to
22067 test for a final newline when SMTP is in use. All messages transmitted over
22068 SMTP must end with a newline, so Exim supplies one if it is missing.
22069
22070 .cindex "content scanning" "per user"
22071 A transport filter can be used to provide content-scanning on a per-user basis
22072 at delivery time if the only required effect of the scan is to modify the
22073 message. For example, a content scan could insert a new header line containing
22074 a spam score. This could be interpreted by a filter in the user's MUA. It is
22075 not possible to discard a message at this stage.
22076
22077 .cindex "SMTP" "SIZE"
22078 A problem might arise if the filter increases the size of a message that is
22079 being sent down an SMTP connection. If the receiving SMTP server has indicated
22080 support for the SIZE parameter, Exim will have sent the size of the message
22081 at the start of the SMTP session. If what is actually sent is substantially
22082 more, the server might reject the message. This can be worked round by setting
22083 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22084 additions to the message, or to disable the use of SIZE altogether.
22085
22086 .vindex "&$pipe_addresses$&"
22087 The value of the &%transport_filter%& option is the command string for starting
22088 the filter, which is run directly from Exim, not under a shell. The string is
22089 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22090 Exim breaks it up into arguments and then expands each argument separately (see
22091 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22092 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22093 of arguments, one for each address that applies to this delivery. (This isn't
22094 an ideal name for this feature here, but as it was already implemented for the
22095 &(pipe)& transport, it seemed sensible not to change it.)
22096
22097 .vindex "&$host$&"
22098 .vindex "&$host_address$&"
22099 The expansion variables &$host$& and &$host_address$& are available when the
22100 transport is a remote one. They contain the name and IP address of the host to
22101 which the message is being sent. For example:
22102 .code
22103 transport_filter = /some/directory/transport-filter.pl \
22104   $host $host_address $sender_address $pipe_addresses
22105 .endd
22106
22107 Two problems arise if you want to use more complicated expansion items to
22108 generate transport filter commands, both of which due to the fact that the
22109 command is split up &'before'& expansion.
22110 .ilist
22111 If an expansion item contains white space, you must quote it, so that it is all
22112 part of the same command item. If the entire option setting is one such
22113 expansion item, you have to take care what kind of quoting you use. For
22114 example:
22115 .code
22116 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22117 .endd
22118 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22119 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22120 stripped by Exim when it read the option's value. When the value is used, if
22121 the single quotes were missing, the line would be split into two items,
22122 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22123 Exim tried to expand the first one.
22124 .next
22125 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22126 expansion cannot generate multiple arguments, or a command name followed by
22127 arguments. Consider this example:
22128 .code
22129 transport_filter = ${lookup{$host}lsearch{/a/file}\
22130                     {$value}{/bin/cat}}
22131 .endd
22132 The result of the lookup is interpreted as the name of the command, even
22133 if it contains white space. The simplest way round this is to use a shell:
22134 .code
22135 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22136                                {$value}{/bin/cat}}
22137 .endd
22138 .endlist
22139
22140 The filter process is run under the same uid and gid as the normal delivery.
22141 For remote deliveries this is the Exim uid/gid by default. The command should
22142 normally yield a zero return code. Transport filters are not supposed to fail.
22143 A non-zero code is taken to mean that the transport filter encountered some
22144 serious problem. Delivery of the message is deferred; the message remains on
22145 the queue and is tried again later. It is not possible to cause a message to be
22146 bounced from a transport filter.
22147
22148 If a transport filter is set on an autoreply transport, the original message is
22149 passed through the filter as it is being copied into the newly generated
22150 message, which happens if the &%return_message%& option is set.
22151
22152
22153 .option transport_filter_timeout transports time 5m
22154 .cindex "transport" "filter, timeout"
22155 When Exim is reading the output of a transport filter, it applies a timeout
22156 that can be set by this option. Exceeding the timeout is normally treated as a
22157 temporary delivery failure. However, if a transport filter is used with a
22158 &(pipe)& transport, a timeout in the transport filter is treated in the same
22159 way as a timeout in the pipe command itself. By default, a timeout is a hard
22160 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22161 becomes a temporary error.
22162
22163
22164 .option user transports string&!! "Exim user"
22165 .cindex "uid (user id)" "local delivery"
22166 .cindex "transport" "user, specifying"
22167 This option specifies the user under whose uid the delivery process is to be
22168 run, overriding any uid that may have been set by the router. If the user is
22169 given as a name, the uid is looked up from the password data, and the
22170 associated group is taken as the value of the gid to be used if the &%group%&
22171 option is not set.
22172
22173 For deliveries that use local transports, a user and group are normally
22174 specified explicitly or implicitly (for example, as a result of
22175 &%check_local_user%&) by the router or transport.
22176
22177 .cindex "hints database" "access by remote transport"
22178 For remote transports, you should leave this option unset unless you really are
22179 sure you know what you are doing. When a remote transport is running, it needs
22180 to be able to access Exim's hints databases, because each host may have its own
22181 retry data.
22182 .ecindex IIDgenoptra1
22183 .ecindex IIDgenoptra2
22184 .ecindex IIDgenoptra3
22185
22186
22187
22188
22189
22190
22191 . ////////////////////////////////////////////////////////////////////////////
22192 . ////////////////////////////////////////////////////////////////////////////
22193
22194 .chapter "Address batching in local transports" "CHAPbatching" &&&
22195          "Address batching"
22196 .cindex "transport" "local; address batching in"
22197 The only remote transport (&(smtp)&) is normally configured to handle more than
22198 one address at a time, so that when several addresses are routed to the same
22199 remote host, just one copy of the message is sent. Local transports, however,
22200 normally handle one address at a time. That is, a separate instance of the
22201 transport is run for each address that is routed to the transport. A separate
22202 copy of the message is delivered each time.
22203
22204 .cindex "batched local delivery"
22205 .oindex "&%batch_max%&"
22206 .oindex "&%batch_id%&"
22207 In special cases, it may be desirable to handle several addresses at once in a
22208 local transport, for example:
22209
22210 .ilist
22211 In an &(appendfile)& transport, when storing messages in files for later
22212 delivery by some other means, a single copy of the message with multiple
22213 recipients saves space.
22214 .next
22215 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22216 a single copy saves time, and is the normal way LMTP is expected to work.
22217 .next
22218 In a &(pipe)& transport, when passing the message
22219 to a scanner program or
22220 to some other delivery mechanism such as UUCP, multiple recipients may be
22221 acceptable.
22222 .endlist
22223
22224 These three local transports all have the same options for controlling multiple
22225 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22226 repeating the information for each transport, these options are described here.
22227
22228 The &%batch_max%& option specifies the maximum number of addresses that can be
22229 delivered together in a single run of the transport. Its default value is one
22230 (no batching). When more than one address is routed to a transport that has a
22231 &%batch_max%& value greater than one, the addresses are delivered in a batch
22232 (that is, in a single run of the transport with multiple recipients), subject
22233 to certain conditions:
22234
22235 .ilist
22236 .vindex "&$local_part$&"
22237 If any of the transport's options contain a reference to &$local_part$&, no
22238 batching is possible.
22239 .next
22240 .vindex "&$domain$&"
22241 If any of the transport's options contain a reference to &$domain$&, only
22242 addresses with the same domain are batched.
22243 .next
22244 .cindex "customizing" "batching condition"
22245 If &%batch_id%& is set, it is expanded for each address, and only those
22246 addresses with the same expanded value are batched. This allows you to specify
22247 customized batching conditions. Failure of the expansion for any reason,
22248 including forced failure, disables batching, but it does not stop the delivery
22249 from taking place.
22250 .next
22251 Batched addresses must also have the same errors address (where to send
22252 delivery errors), the same header additions and removals, the same user and
22253 group for the transport, and if a host list is present, the first host must
22254 be the same.
22255 .endlist
22256
22257 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22258 both when the file or pipe command is specified in the transport, and when it
22259 is specified by a &(redirect)& router, but all the batched addresses must of
22260 course be routed to the same file or pipe command. These two transports have an
22261 option called &%use_bsmtp%&, which causes them to deliver the message in
22262 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22263 &%check_string%& and &%escape_string%& options are forced to the values
22264 .code
22265 check_string = "."
22266 escape_string = ".."
22267 .endd
22268 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22269 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22270 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22271
22272 .cindex "&'Envelope-to:'& header line"
22273 If the generic &%envelope_to_add%& option is set for a batching transport, the
22274 &'Envelope-to:'& header that is added to the message contains all the addresses
22275 that are being processed together. If you are using a batching &(appendfile)&
22276 transport without &%use_bsmtp%&, the only way to preserve the recipient
22277 addresses is to set the &%envelope_to_add%& option.
22278
22279 .cindex "&(pipe)& transport" "with multiple addresses"
22280 .vindex "&$pipe_addresses$&"
22281 If you are using a &(pipe)& transport without BSMTP, and setting the
22282 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22283 the command. This is not a true variable; it is a bit of magic that causes each
22284 of the recipient addresses to be inserted into the command as a separate
22285 argument. This provides a way of accessing all the addresses that are being
22286 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22287 are specified by a &(redirect)& router.
22288
22289
22290
22291
22292 . ////////////////////////////////////////////////////////////////////////////
22293 . ////////////////////////////////////////////////////////////////////////////
22294
22295 .chapter "The appendfile transport" "CHAPappendfile"
22296 .scindex IIDapptra1 "&(appendfile)& transport"
22297 .scindex IIDapptra2 "transports" "&(appendfile)&"
22298 .cindex "directory creation"
22299 .cindex "creating directories"
22300 The &(appendfile)& transport delivers a message by appending it to an existing
22301 file, or by creating an entirely new file in a specified directory. Single
22302 files to which messages are appended can be in the traditional Unix mailbox
22303 format, or optionally in the MBX format supported by the Pine MUA and
22304 University of Washington IMAP daemon, &'inter alia'&. When each message is
22305 being delivered as a separate file, &"maildir"& format can optionally be used
22306 to give added protection against failures that happen part-way through the
22307 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22308 supported. For all file formats, Exim attempts to create as many levels of
22309 directory as necessary, provided that &%create_directory%& is set.
22310
22311 The code for the optional formats is not included in the Exim binary by
22312 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22313 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22314 included.
22315
22316 .cindex "quota" "system"
22317 Exim recognizes system quota errors, and generates an appropriate message. Exim
22318 also supports its own quota control within the transport, for use when the
22319 system facility is unavailable or cannot be used for some reason.
22320
22321 If there is an error while appending to a file (for example, quota exceeded or
22322 partition filled), Exim attempts to reset the file's length and last
22323 modification time back to what they were before. If there is an error while
22324 creating an entirely new file, the new file is removed.
22325
22326 Before appending to a file, a number of security checks are made, and the
22327 file is locked. A detailed description is given below, after the list of
22328 private options.
22329
22330 The &(appendfile)& transport is most commonly used for local deliveries to
22331 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22332 putting messages into files for remote delivery by some means other than Exim.
22333 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22334 option).
22335
22336
22337
22338 .section "The file and directory options" "SECTfildiropt"
22339 The &%file%& option specifies a single file, to which the message is appended;
22340 the &%directory%& option specifies a directory, in which a new file containing
22341 the message is created. Only one of these two options can be set, and for
22342 normal deliveries to mailboxes, one of them &'must'& be set.
22343
22344 .vindex "&$address_file$&"
22345 .vindex "&$local_part$&"
22346 However, &(appendfile)& is also used for delivering messages to files or
22347 directories whose names (or parts of names) are obtained from alias,
22348 forwarding, or filtering operations (for example, a &%save%& command in a
22349 user's Exim filter). When such a transport is running, &$local_part$& contains
22350 the local part that was aliased or forwarded, and &$address_file$& contains the
22351 name (or partial name) of the file or directory generated by the redirection
22352 operation. There are two cases:
22353
22354 .ilist
22355 If neither &%file%& nor &%directory%& is set, the redirection operation
22356 must specify an absolute path (one that begins with &`/`&). This is the most
22357 common case when users with local accounts use filtering to sort mail into
22358 different folders. See for example, the &(address_file)& transport in the
22359 default configuration. If the path ends with a slash, it is assumed to be the
22360 name of a directory. A delivery to a directory can also be forced by setting
22361 &%maildir_format%& or &%mailstore_format%&.
22362 .next
22363 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22364 used to determine the file or directory name for the delivery. Normally, the
22365 contents of &$address_file$& are used in some way in the string expansion.
22366 .endlist
22367
22368
22369 .cindex "Sieve filter" "configuring &(appendfile)&"
22370 .cindex "Sieve filter" "relative mailbox path handling"
22371 As an example of the second case, consider an environment where users do not
22372 have home directories. They may be permitted to use Exim filter commands of the
22373 form:
22374 .code
22375 save folder23
22376 .endd
22377 or Sieve filter commands of the form:
22378 .code
22379 require "fileinto";
22380 fileinto "folder23";
22381 .endd
22382 In this situation, the expansion of &%file%& or &%directory%& in the transport
22383 must transform the relative path into an appropriate absolute filename. In the
22384 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22385 is used as a result of a &"keep"& action in the filter. This example shows one
22386 way of handling this requirement:
22387 .code
22388 file = ${if eq{$address_file}{inbox} \
22389             {/var/mail/$local_part} \
22390             {${if eq{${substr_0_1:$address_file}}{/} \
22391                   {$address_file} \
22392                   {$home/mail/$address_file} \
22393             }} \
22394        }
22395 .endd
22396 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22397 location, absolute paths are used without change, and other folders are in the
22398 &_mail_& directory within the home directory.
22399
22400 &*Note 1*&: While processing an Exim filter, a relative path such as
22401 &_folder23_& is turned into an absolute path if a home directory is known to
22402 the router. In particular, this is the case if &%check_local_user%& is set. If
22403 you want to prevent this happening at routing time, you can set
22404 &%router_home_directory%& empty. This forces the router to pass the relative
22405 path to the transport.
22406
22407 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22408 the &%file%& or &%directory%& option is still used if it is set.
22409
22410
22411
22412
22413 .section "Private options for appendfile" "SECID134"
22414 .cindex "options" "&(appendfile)& transport"
22415
22416
22417
22418 .option allow_fifo appendfile boolean false
22419 .cindex "fifo (named pipe)"
22420 .cindex "named pipe (fifo)"
22421 .cindex "pipe" "named (fifo)"
22422 Setting this option permits delivery to named pipes (FIFOs) as well as to
22423 regular files. If no process is reading the named pipe at delivery time, the
22424 delivery is deferred.
22425
22426
22427 .option allow_symlink appendfile boolean false
22428 .cindex "symbolic link" "to mailbox"
22429 .cindex "mailbox" "symbolic link"
22430 By default, &(appendfile)& will not deliver if the path name for the file is
22431 that of a symbolic link. Setting this option relaxes that constraint, but there
22432 are security issues involved in the use of symbolic links. Be sure you know
22433 what you are doing if you set this. Details of exactly what this option affects
22434 are included in the discussion which follows this list of options.
22435
22436
22437 .option batch_id appendfile string&!! unset
22438 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22439 However, batching is automatically disabled for &(appendfile)& deliveries that
22440 happen as a result of forwarding or aliasing or other redirection directly to a
22441 file.
22442
22443
22444 .option batch_max appendfile integer 1
22445 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22446
22447
22448 .option check_group appendfile boolean false
22449 When this option is set, the group owner of the file defined by the &%file%&
22450 option is checked to see that it is the same as the group under which the
22451 delivery process is running. The default setting is false because the default
22452 file mode is 0600, which means that the group is irrelevant.
22453
22454
22455 .option check_owner appendfile boolean true
22456 When this option is set, the owner of the file defined by the &%file%& option
22457 is checked to ensure that it is the same as the user under which the delivery
22458 process is running.
22459
22460
22461 .option check_string appendfile string "see below"
22462 .cindex "&""From""& line"
22463 As &(appendfile)& writes the message, the start of each line is tested for
22464 matching &%check_string%&, and if it does, the initial matching characters are
22465 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22466 a literal string, not a regular expression, and the case of any letters it
22467 contains is significant.
22468
22469 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22470 are forced to &"."& and &".."& respectively, and any settings in the
22471 configuration are ignored. Otherwise, they default to &"From&~"& and
22472 &">From&~"& when the &%file%& option is set, and unset when any of the
22473 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22474
22475 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22476 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22477 &"From&~"& indicates the start of a new message. All four options need changing
22478 if another format is used. For example, to deliver to mailboxes in MMDF format:
22479 .cindex "MMDF format mailbox"
22480 .cindex "mailbox" "MMDF format"
22481 .code
22482 check_string = "\1\1\1\1\n"
22483 escape_string = "\1\1\1\1 \n"
22484 message_prefix = "\1\1\1\1\n"
22485 message_suffix = "\1\1\1\1\n"
22486 .endd
22487 .option create_directory appendfile boolean true
22488 .cindex "directory creation"
22489 When this option is true, Exim attempts to create any missing superior
22490 directories for the file that it is about to write. A created directory's mode
22491 is given by the &%directory_mode%& option.
22492
22493 The group ownership of a newly created directory is highly dependent on the
22494 operating system (and possibly the file system) that is being used. For
22495 example, in Solaris, if the parent directory has the setgid bit set, its group
22496 is propagated to the child; if not, the currently set group is used. However,
22497 in FreeBSD, the parent's group is always used.
22498
22499
22500
22501 .option create_file appendfile string anywhere
22502 This option constrains the location of files and directories that are created
22503 by this transport. It applies to files defined by the &%file%& option and
22504 directories defined by the &%directory%& option. In the case of maildir
22505 delivery, it applies to the top level directory, not the maildir directories
22506 beneath.
22507
22508 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22509 &"belowhome"&. In the second and third cases, a home directory must have been
22510 set for the transport. This option is not useful when an explicit filename is
22511 given for normal mailbox deliveries. It is intended for the case when filenames
22512 are generated from users' &_.forward_& files. These are usually handled
22513 by an &(appendfile)& transport called &%address_file%&. See also
22514 &%file_must_exist%&.
22515
22516
22517 .option directory appendfile string&!! unset
22518 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22519 or &%directory%& must be set, unless the delivery is the direct result of a
22520 redirection (see section &<<SECTfildiropt>>&).
22521
22522 When &%directory%& is set, the string is expanded, and the message is delivered
22523 into a new file or files in or below the given directory, instead of being
22524 appended to a single mailbox file. A number of different formats are provided
22525 (see &%maildir_format%& and &%mailstore_format%&), and see section
22526 &<<SECTopdir>>& for further details of this form of delivery.
22527
22528
22529 .option directory_file appendfile string&!! "see below"
22530 .cindex "base62"
22531 .vindex "&$inode$&"
22532 When &%directory%& is set, but neither &%maildir_format%& nor
22533 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22534 whose name is obtained by expanding this string. The default value is:
22535 .code
22536 q${base62:$tod_epoch}-$inode
22537 .endd
22538 This generates a unique name from the current time, in base 62 form, and the
22539 inode of the file. The variable &$inode$& is available only when expanding this
22540 option.
22541
22542
22543 .option directory_mode appendfile "octal integer" 0700
22544 If &(appendfile)& creates any directories as a result of the
22545 &%create_directory%& option, their mode is specified by this option.
22546
22547
22548 .option escape_string appendfile string "see description"
22549 See &%check_string%& above.
22550
22551
22552 .option file appendfile string&!! unset
22553 This option is mutually exclusive with the &%directory%& option, but one of
22554 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22555 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22556 specifies a single file, to which the message is appended. One or more of
22557 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22558 &%file%&.
22559
22560 .cindex "NFS" "lock file"
22561 .cindex "locking files"
22562 .cindex "lock files"
22563 If you are using more than one host to deliver over NFS into the same
22564 mailboxes, you should always use lock files.
22565
22566 The string value is expanded for each delivery, and must yield an absolute
22567 path. The most common settings of this option are variations on one of these
22568 examples:
22569 .code
22570 file = /var/spool/mail/$local_part
22571 file = /home/$local_part/inbox
22572 file = $home/inbox
22573 .endd
22574 .cindex "&""sticky""& bit"
22575 In the first example, all deliveries are done into the same directory. If Exim
22576 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22577 create a file in the directory, so the &"sticky"& bit must be turned on for
22578 deliveries to be possible, or alternatively the &%group%& option can be used to
22579 run the delivery under a group id which has write access to the directory.
22580
22581
22582
22583 .option file_format appendfile string unset
22584 .cindex "file" "mailbox; checking existing format"
22585 This option requests the transport to check the format of an existing file
22586 before adding to it. The check consists of matching a specific string at the
22587 start of the file. The value of the option consists of an even number of
22588 colon-separated strings. The first of each pair is the test string, and the
22589 second is the name of a transport. If the transport associated with a matched
22590 string is not the current transport, control is passed over to the other
22591 transport. For example, suppose the standard &(local_delivery)& transport has
22592 this added to it:
22593 .code
22594 file_format = "From       : local_delivery :\
22595                \1\1\1\1\n : local_mmdf_delivery"
22596 .endd
22597 Mailboxes that begin with &"From"& are still handled by this transport, but if
22598 a mailbox begins with four binary ones followed by a newline, control is passed
22599 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22600 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22601 is assumed to match the current transport. If the start of a mailbox doesn't
22602 match any string, or if the transport named for a given string is not defined,
22603 delivery is deferred.
22604
22605
22606 .option file_must_exist appendfile boolean false
22607 If this option is true, the file specified by the &%file%& option must exist.
22608 A temporary error occurs if it does not, causing delivery to be deferred.
22609 If this option is false, the file is created if it does not exist.
22610
22611
22612 .option lock_fcntl_timeout appendfile time 0s
22613 .cindex "timeout" "mailbox locking"
22614 .cindex "mailbox" "locking, blocking and non-blocking"
22615 .cindex "locking files"
22616 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22617 when locking an open mailbox file. If the call fails, the delivery process
22618 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22619 Non-blocking calls are used so that the file is not kept open during the wait
22620 for the lock; the reason for this is to make it as safe as possible for
22621 deliveries over NFS in the case when processes might be accessing an NFS
22622 mailbox without using a lock file. This should not be done, but
22623 misunderstandings and hence misconfigurations are not unknown.
22624
22625 On a busy system, however, the performance of a non-blocking lock approach is
22626 not as good as using a blocking lock with a timeout. In this case, the waiting
22627 is done inside the system call, and Exim's delivery process acquires the lock
22628 and can proceed as soon as the previous lock holder releases it.
22629
22630 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22631 timeout, are used. There may still be some retrying: the maximum number of
22632 retries is
22633 .code
22634 (lock_retries * lock_interval) / lock_fcntl_timeout
22635 .endd
22636 rounded up to the next whole number. In other words, the total time during
22637 which &(appendfile)& is trying to get a lock is roughly the same, unless
22638 &%lock_fcntl_timeout%& is set very large.
22639
22640 You should consider setting this option if you are getting a lot of delayed
22641 local deliveries because of errors of the form
22642 .code
22643 failed to lock mailbox /some/file (fcntl)
22644 .endd
22645
22646 .option lock_flock_timeout appendfile time 0s
22647 This timeout applies to file locking when using &[flock()]& (see
22648 &%use_flock%&); the timeout operates in a similar manner to
22649 &%lock_fcntl_timeout%&.
22650
22651
22652 .option lock_interval appendfile time 3s
22653 This specifies the time to wait between attempts to lock the file. See below
22654 for details of locking.
22655
22656
22657 .option lock_retries appendfile integer 10
22658 This specifies the maximum number of attempts to lock the file. A value of zero
22659 is treated as 1. See below for details of locking.
22660
22661
22662 .option lockfile_mode appendfile "octal integer" 0600
22663 This specifies the mode of the created lock file, when a lock file is being
22664 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22665
22666
22667 .option lockfile_timeout appendfile time 30m
22668 .cindex "timeout" "mailbox locking"
22669 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22670 exists and is older than this value, it is assumed to have been left behind by
22671 accident, and Exim attempts to remove it.
22672
22673
22674 .option mailbox_filecount appendfile string&!! unset
22675 .cindex "mailbox" "specifying size of"
22676 .cindex "size" "of mailbox"
22677 If this option is set, it is expanded, and the result is taken as the current
22678 number of files in the mailbox. It must be a decimal number, optionally
22679 followed by K or M. This provides a way of obtaining this information from an
22680 external source that maintains the data.
22681
22682
22683 .option mailbox_size appendfile string&!! unset
22684 .cindex "mailbox" "specifying size of"
22685 .cindex "size" "of mailbox"
22686 If this option is set, it is expanded, and the result is taken as the current
22687 size the mailbox. It must be a decimal number, optionally followed by K or M.
22688 This provides a way of obtaining this information from an external source that
22689 maintains the data. This is likely to be helpful for maildir deliveries where
22690 it is computationally expensive to compute the size of a mailbox.
22691
22692
22693
22694 .option maildir_format appendfile boolean false
22695 .cindex "maildir format" "specifying"
22696 If this option is set with the &%directory%& option, the delivery is into a new
22697 file, in the &"maildir"& format that is used by other mail software. When the
22698 transport is activated directly from a &(redirect)& router (for example, the
22699 &(address_file)& transport in the default configuration), setting
22700 &%maildir_format%& causes the path received from the router to be treated as a
22701 directory, whether or not it ends with &`/`&. This option is available only if
22702 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22703 &<<SECTmaildirdelivery>>& below for further details.
22704
22705
22706 .option maildir_quota_directory_regex appendfile string "See below"
22707 .cindex "maildir format" "quota; directories included in"
22708 .cindex "quota" "maildir; directories included in"
22709 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22710 a regular expression for specifying directories, relative to the quota
22711 directory (see &%quota_directory%&), that should be included in the quota
22712 calculation. The default value is:
22713 .code
22714 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22715 .endd
22716 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22717 (directories whose names begin with a dot). If you want to exclude the
22718 &_Trash_&
22719 folder from the count (as some sites do), you need to change this setting to
22720 .code
22721 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22722 .endd
22723 This uses a negative lookahead in the regular expression to exclude the
22724 directory whose name is &_.Trash_&. When a directory is excluded from quota
22725 calculations, quota processing is bypassed for any messages that are delivered
22726 directly into that directory.
22727
22728
22729 .option maildir_retries appendfile integer 10
22730 This option specifies the number of times to retry when writing a file in
22731 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22732
22733
22734 .option maildir_tag appendfile string&!! unset
22735 This option applies only to deliveries in maildir format, and is described in
22736 section &<<SECTmaildirdelivery>>& below.
22737
22738
22739 .option maildir_use_size_file appendfile&!! boolean false
22740 .cindex "maildir format" "&_maildirsize_& file"
22741 The result of string expansion for this option must be a valid boolean value.
22742 If it is true, it enables support for &_maildirsize_& files. Exim
22743 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22744 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22745 value is zero. See &%maildir_quota_directory_regex%& above and section
22746 &<<SECTmaildirdelivery>>& below for further details.
22747
22748 .option maildirfolder_create_regex appendfile string unset
22749 .cindex "maildir format" "&_maildirfolder_& file"
22750 .cindex "&_maildirfolder_&, creating"
22751 The value of this option is a regular expression. If it is unset, it has no
22752 effect. Otherwise, before a maildir delivery takes place, the pattern is
22753 matched against the name of the maildir directory, that is, the directory
22754 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22755 delivery. If there is a match, Exim checks for the existence of a file called
22756 &_maildirfolder_& in the directory, and creates it if it does not exist.
22757 See section &<<SECTmaildirdelivery>>& for more details.
22758
22759
22760 .option mailstore_format appendfile boolean false
22761 .cindex "mailstore format" "specifying"
22762 If this option is set with the &%directory%& option, the delivery is into two
22763 new files in  &"mailstore"& format. The option is available only if
22764 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22765 below for further details.
22766
22767
22768 .option mailstore_prefix appendfile string&!! unset
22769 This option applies only to deliveries in mailstore format, and is described in
22770 section &<<SECTopdir>>& below.
22771
22772
22773 .option mailstore_suffix appendfile string&!! unset
22774 This option applies only to deliveries in mailstore format, and is described in
22775 section &<<SECTopdir>>& below.
22776
22777
22778 .option mbx_format appendfile boolean false
22779 .cindex "locking files"
22780 .cindex "file" "locking"
22781 .cindex "file" "MBX format"
22782 .cindex "MBX format, specifying"
22783 This option is available only if Exim has been compiled with SUPPORT_MBX
22784 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22785 the message is appended to the mailbox file in MBX format instead of
22786 traditional Unix format. This format is supported by Pine4 and its associated
22787 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22788
22789 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22790 automatically changed by the use of &%mbx_format%&. They should normally be set
22791 empty when using MBX format, so this option almost always appears in this
22792 combination:
22793 .code
22794 mbx_format = true
22795 message_prefix =
22796 message_suffix =
22797 .endd
22798 If none of the locking options are mentioned in the configuration,
22799 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22800 is possible to specify the other kinds of locking with &%mbx_format%&, but
22801 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22802 interworks with &'c-client'&, providing for shared access to the mailbox. It
22803 should not be used if any program that does not use this form of locking is
22804 going to access the mailbox, nor should it be used if the mailbox file is NFS
22805 mounted, because it works only when the mailbox is accessed from a single host.
22806
22807 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22808 the standard version of &'c-client'&, because as long as it has a mailbox open
22809 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22810 append messages to it.
22811
22812
22813 .option message_prefix appendfile string&!! "see below"
22814 .cindex "&""From""& line"
22815 The string specified here is expanded and output at the start of every message.
22816 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22817 in which case it is:
22818 .code
22819 message_prefix = "From ${if def:return_path{$return_path}\
22820   {MAILER-DAEMON}} $tod_bsdinbox\n"
22821 .endd
22822 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22823 &`\n`& to &`\r\n`& in &%message_prefix%&.
22824
22825 .option message_suffix appendfile string&!! "see below"
22826 The string specified here is expanded and output at the end of every message.
22827 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22828 in which case it is a single newline character. The suffix can be suppressed by
22829 setting
22830 .code
22831 message_suffix =
22832 .endd
22833 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22834 &`\n`& to &`\r\n`& in &%message_suffix%&.
22835
22836 .option mode appendfile "octal integer" 0600
22837 If the output file is created, it is given this mode. If it already exists and
22838 has wider permissions, they are reduced to this mode. If it has narrower
22839 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22840 if the delivery is the result of a &%save%& command in a filter file specifying
22841 a particular mode, the mode of the output file is always forced to take that
22842 value, and this option is ignored.
22843
22844
22845 .option mode_fail_narrower appendfile boolean true
22846 This option applies in the case when an existing mailbox file has a narrower
22847 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22848 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22849 continues with the delivery attempt, using the existing mode of the file.
22850
22851
22852 .option notify_comsat appendfile boolean false
22853 If this option is true, the &'comsat'& daemon is notified after every
22854 successful delivery to a user mailbox. This is the daemon that notifies logged
22855 on users about incoming mail.
22856
22857
22858 .option quota appendfile string&!! unset
22859 .cindex "quota" "imposed by Exim"
22860 This option imposes a limit on the size of the file to which Exim is appending,
22861 or to the total space used in the directory tree when the &%directory%& option
22862 is set. In the latter case, computation of the space used is expensive, because
22863 all the files in the directory (and any sub-directories) have to be
22864 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22865 &%maildir_use_size_file%& for ways to avoid this in environments where users
22866 have no shell access to their mailboxes).
22867
22868 As there is no interlock against two simultaneous deliveries into a
22869 multi-file mailbox, it is possible for the quota to be overrun in this case.
22870 For single-file mailboxes, of course, an interlock is a necessity.
22871
22872 A file's size is taken as its &'used'& value. Because of blocking effects, this
22873 may be a lot less than the actual amount of disk space allocated to the file.
22874 If the sizes of a number of files are being added up, the rounding effect can
22875 become quite noticeable, especially on systems that have large block sizes.
22876 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22877 the obvious value which users understand most easily.
22878
22879 The value of the option is expanded, and must then be a numerical value
22880 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22881 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22882 and further option modifiers. If Exim is running on a system with
22883 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22884 be handled.
22885
22886 The option modifier &%no_check%& can be used to force delivery even if the over
22887 quota condition is met. The quota gets updated as usual.
22888
22889 &*Note*&: A value of zero is interpreted as &"no quota"&.
22890
22891 The expansion happens while Exim is running as root, before it changes uid for
22892 the delivery. This means that files that are inaccessible to the end user can
22893 be used to hold quota values that are looked up in the expansion. When delivery
22894 fails because this quota is exceeded, the handling of the error is as for
22895 system quota failures.
22896
22897 By default, Exim's quota checking mimics system quotas, and restricts the
22898 mailbox to the specified maximum size, though the value is not accurate to the
22899 last byte, owing to separator lines and additional headers that may get added
22900 during message delivery. When a mailbox is nearly full, large messages may get
22901 refused even though small ones are accepted, because the size of the current
22902 message is added to the quota when the check is made. This behaviour can be
22903 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22904 for exceeding the quota does not include the current message. Thus, deliveries
22905 continue until the quota has been exceeded; thereafter, no further messages are
22906 delivered. See also &%quota_warn_threshold%&.
22907
22908
22909 .option quota_directory appendfile string&!! unset
22910 This option defines the directory to check for quota purposes when delivering
22911 into individual files. The default is the delivery directory, or, if a file
22912 called &_maildirfolder_& exists in a maildir directory, the parent of the
22913 delivery directory.
22914
22915
22916 .option quota_filecount appendfile string&!! 0
22917 This option applies when the &%directory%& option is set. It limits the total
22918 number of files in the directory (compare the inode limit in system quotas). It
22919 can only be used if &%quota%& is also set. The value is expanded; an expansion
22920 failure causes delivery to be deferred. A value of zero is interpreted as
22921 &"no quota"&.
22922
22923 The option modifier &%no_check%& can be used to force delivery even if the over
22924 quota condition is met. The quota gets updated as usual.
22925
22926 .option quota_is_inclusive appendfile boolean true
22927 See &%quota%& above.
22928
22929
22930 .option quota_size_regex appendfile string unset
22931 This option applies when one of the delivery modes that writes a separate file
22932 for each message is being used. When Exim wants to find the size of one of
22933 these files in order to test the quota, it first checks &%quota_size_regex%&.
22934 If this is set to a regular expression that matches the filename, and it
22935 captures one string, that string is interpreted as a representation of the
22936 file's size. The value of &%quota_size_regex%& is not expanded.
22937
22938 This feature is useful only when users have no shell access to their mailboxes
22939 &-- otherwise they could defeat the quota simply by renaming the files. This
22940 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22941 the file length to the filename. For example:
22942 .code
22943 maildir_tag = ,S=$message_size
22944 quota_size_regex = ,S=(\d+)
22945 .endd
22946 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22947 number of lines in the message.
22948
22949 The regular expression should not assume that the length is at the end of the
22950 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22951 sometimes add other information onto the ends of message filenames.
22952
22953 Section &<<SECID136>>& contains further information.
22954
22955 .new
22956 This option should not be used when other message-handling software
22957 may duplicate messages by making hardlinks to the files.  When that is done Exim
22958 will count the message size once for each filename, in contrast with the actual
22959 disk usage.  When the option is not set, calculating total usage requires
22960 a system-call per file to get the size; the number of links is then available also
22961 as is used to adjust the effective size.
22962 .wen
22963
22964
22965 .option quota_warn_message appendfile string&!! "see below"
22966 See below for the use of this option. If it is not set when
22967 &%quota_warn_threshold%& is set, it defaults to
22968 .code
22969 quota_warn_message = "\
22970   To: $local_part@$domain\n\
22971   Subject: Your mailbox\n\n\
22972   This message is automatically created \
22973   by mail delivery software.\n\n\
22974   The size of your mailbox has exceeded \
22975   a warning threshold that is\n\
22976   set by the system administrator.\n"
22977 .endd
22978
22979
22980 .option quota_warn_threshold appendfile string&!! 0
22981 .cindex "quota" "warning threshold"
22982 .cindex "mailbox" "size warning"
22983 .cindex "size" "of mailbox"
22984 This option is expanded in the same way as &%quota%& (see above). If the
22985 resulting value is greater than zero, and delivery of the message causes the
22986 size of the file or total space in the directory tree to cross the given
22987 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22988 may be specified as a percentage of it by following the value with a percent
22989 sign. For example:
22990 .code
22991 quota = 10M
22992 quota_warn_threshold = 75%
22993 .endd
22994 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22995 percent sign is ignored.
22996
22997 The warning message itself is specified by the &%quota_warn_message%& option,
22998 and it must start with a &'To:'& header line containing the recipient(s) of the
22999 warning message. These do not necessarily have to include the recipient(s) of
23000 the original message. A &'Subject:'& line should also normally be supplied. You
23001 can include any other header lines that you want. If you do not include a
23002 &'From:'& line, the default is:
23003 .code
23004 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23005 .endd
23006 .oindex &%errors_reply_to%&
23007 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23008 option.
23009
23010 The &%quota%& option does not have to be set in order to use this option; they
23011 are independent of one another except when the threshold is specified as a
23012 percentage.
23013
23014
23015 .option use_bsmtp appendfile boolean false
23016 .cindex "envelope from"
23017 .cindex "envelope sender"
23018 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23019 format, with the envelope sender and recipient(s) included as SMTP commands. If
23020 you want to include a leading HELO command with such messages, you can do
23021 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23022 for details of batch SMTP.
23023
23024
23025 .option use_crlf appendfile boolean false
23026 .cindex "carriage return"
23027 .cindex "linefeed"
23028 This option causes lines to be terminated with the two-character CRLF sequence
23029 (carriage return, linefeed) instead of just a linefeed character. In the case
23030 of batched SMTP, the byte sequence written to the file is then an exact image
23031 of what would be sent down a real SMTP connection.
23032
23033 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23034 (which are used to supply the traditional &"From&~"& and blank line separators
23035 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23036 carriage return characters if these are needed. In cases where these options
23037 have non-empty defaults, the values end with a single linefeed, so they must be
23038 changed to end with &`\r\n`& if &%use_crlf%& is set.
23039
23040
23041 .option use_fcntl_lock appendfile boolean "see below"
23042 This option controls the use of the &[fcntl()]& function to lock a file for
23043 exclusive use when a message is being appended. It is set by default unless
23044 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23045 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23046 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23047
23048
23049 .option use_flock_lock appendfile boolean false
23050 This option is provided to support the use of &[flock()]& for file locking, for
23051 the few situations where it is needed. Most modern operating systems support
23052 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23053 each other. Exim uses &[fcntl()]& locking by default.
23054
23055 This option is required only if you are using an operating system where
23056 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23057 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23058 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23059
23060 .cindex "Solaris" "&[flock()]& support"
23061 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23062 have it (and some, I think, provide a not quite right version built on top of
23063 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23064 the ability to use it, and any attempt to do so will cause a configuration
23065 error.
23066
23067 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23068 is just being mapped onto &[fcntl()]& by the OS).
23069
23070
23071 .option use_lockfile appendfile boolean "see below"
23072 If this option is turned off, Exim does not attempt to create a lock file when
23073 appending to a mailbox file. In this situation, the only locking is by
23074 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23075 sure that every MUA that is ever going to look at your users' mailboxes uses
23076 &[fcntl()]& rather than a lock file, and even then only when you are not
23077 delivering over NFS from more than one host.
23078
23079 .cindex "NFS" "lock file"
23080 In order to append to an NFS file safely from more than one host, it is
23081 necessary to take out a lock &'before'& opening the file, and the lock file
23082 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23083 file corruption.
23084
23085 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23086 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23087 except when &%mbx_format%& is set.
23088
23089
23090 .option use_mbx_lock appendfile boolean "see below"
23091 This option is available only if Exim has been compiled with SUPPORT_MBX
23092 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23093 locking rules be used. It is set by default if &%mbx_format%& is set and none
23094 of the locking options are mentioned in the configuration. The locking rules
23095 are the same as are used by the &'c-client'& library that underlies Pine and
23096 the IMAP4 and POP daemons that come with it (see the discussion below). The
23097 rules allow for shared access to the mailbox. However, this kind of locking
23098 does not work when the mailbox is NFS mounted.
23099
23100 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23101 &%use_flock_lock%& to control what kind of locking is used in implementing the
23102 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23103 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23104
23105
23106
23107
23108 .section "Operational details for appending" "SECTopappend"
23109 .cindex "appending to a file"
23110 .cindex "file" "appending"
23111 Before appending to a file, the following preparations are made:
23112
23113 .ilist
23114 If the name of the file is &_/dev/null_&, no action is taken, and a success
23115 return is given.
23116
23117 .next
23118 .cindex "directory creation"
23119 If any directories on the file's path are missing, Exim creates them if the
23120 &%create_directory%& option is set. A created directory's mode is given by the
23121 &%directory_mode%& option.
23122
23123 .next
23124 If &%file_format%& is set, the format of an existing file is checked. If this
23125 indicates that a different transport should be used, control is passed to that
23126 transport.
23127
23128 .next
23129 .cindex "file" "locking"
23130 .cindex "locking files"
23131 .cindex "NFS" "lock file"
23132 If &%use_lockfile%& is set, a lock file is built in a way that will work
23133 reliably over NFS, as follows:
23134
23135 .olist
23136 Create a &"hitching post"& file whose name is that of the lock file with the
23137 current time, primary host name, and process id added, by opening for writing
23138 as a new file. If this fails with an access error, delivery is deferred.
23139 .next
23140 Close the hitching post file, and hard link it to the lock filename.
23141 .next
23142 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23143 Unlink the hitching post name.
23144 .next
23145 Otherwise, use &[stat()]& to get information about the hitching post file, and
23146 then unlink hitching post name. If the number of links is exactly two, creation
23147 of the lock file succeeded but something (for example, an NFS server crash and
23148 restart) caused this fact not to be communicated to the &[link()]& call.
23149 .next
23150 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23151 up to &%lock_retries%& times. However, since any program that writes to a
23152 mailbox should complete its task very quickly, it is reasonable to time out old
23153 lock files that are normally the result of user agent and system crashes. If an
23154 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23155 it before trying again.
23156 .endlist olist
23157
23158 .next
23159 A call is made to &[lstat()]& to discover whether the main file exists, and if
23160 so, what its characteristics are. If &[lstat()]& fails for any reason other
23161 than non-existence, delivery is deferred.
23162
23163 .next
23164 .cindex "symbolic link" "to mailbox"
23165 .cindex "mailbox" "symbolic link"
23166 If the file does exist and is a symbolic link, delivery is deferred, unless the
23167 &%allow_symlink%& option is set, in which case the ownership of the link is
23168 checked, and then &[stat()]& is called to find out about the real file, which
23169 is then subjected to the checks below. The check on the top-level link
23170 ownership prevents one user creating a link for another's mailbox in a sticky
23171 directory, though allowing symbolic links in this case is definitely not a good
23172 idea. If there is a chain of symbolic links, the intermediate ones are not
23173 checked.
23174
23175 .next
23176 If the file already exists but is not a regular file, or if the file's owner
23177 and group (if the group is being checked &-- see &%check_group%& above) are
23178 different from the user and group under which the delivery is running,
23179 delivery is deferred.
23180
23181 .next
23182 If the file's permissions are more generous than specified, they are reduced.
23183 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23184 is set false, in which case the delivery is tried using the existing
23185 permissions.
23186
23187 .next
23188 The file's inode number is saved, and the file is then opened for appending.
23189 If this fails because the file has vanished, &(appendfile)& behaves as if it
23190 hadn't existed (see below). For any other failures, delivery is deferred.
23191
23192 .next
23193 If the file is opened successfully, check that the inode number hasn't
23194 changed, that it is still a regular file, and that the owner and permissions
23195 have not changed. If anything is wrong, defer delivery and freeze the message.
23196
23197 .next
23198 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23199 option is set. Otherwise, check that the file is being created in a permitted
23200 directory if the &%create_file%& option is set (deferring on failure), and then
23201 open for writing as a new file, with the O_EXCL and O_CREAT options,
23202 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23203 set). In this case, which can happen if the link points to a non-existent file,
23204 the file is opened for writing using O_CREAT but not O_EXCL, because
23205 that prevents link following.
23206
23207 .next
23208 .cindex "loop" "while file testing"
23209 If opening fails because the file exists, obey the tests given above for
23210 existing files. However, to avoid looping in a situation where the file is
23211 being continuously created and destroyed, the exists/not-exists loop is broken
23212 after 10 repetitions, and the message is then frozen.
23213
23214 .next
23215 If opening fails with any other error, defer delivery.
23216
23217 .next
23218 .cindex "file" "locking"
23219 .cindex "locking files"
23220 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23221 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23222 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23223 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23224 file, and an exclusive lock on the file whose name is
23225 .code
23226 /tmp/.<device-number>.<inode-number>
23227 .endd
23228 using the device and inode numbers of the open mailbox file, in accordance with
23229 the MBX locking rules. This file is created with a mode that is specified by
23230 the &%lockfile_mode%& option.
23231
23232 If Exim fails to lock the file, there are two possible courses of action,
23233 depending on the value of the locking timeout. This is obtained from
23234 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23235
23236 If the timeout value is zero, the file is closed, Exim waits for
23237 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23238 to lock it again. This happens up to &%lock_retries%& times, after which the
23239 delivery is deferred.
23240
23241 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23242 &[flock()]& are used (with the given timeout), so there has already been some
23243 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23244 immediately. It retries up to
23245 .code
23246 (lock_retries * lock_interval) / <timeout>
23247 .endd
23248 times (rounded up).
23249 .endlist
23250
23251 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23252 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23253
23254
23255 .section "Operational details for delivery to a new file" "SECTopdir"
23256 .cindex "delivery" "to single file"
23257 .cindex "&""From""& line"
23258 When the &%directory%& option is set instead of &%file%&, each message is
23259 delivered into a newly-created file or set of files. When &(appendfile)& is
23260 activated directly from a &(redirect)& router, neither &%file%& nor
23261 &%directory%& is normally set, because the path for delivery is supplied by the
23262 router. (See for example, the &(address_file)& transport in the default
23263 configuration.) In this case, delivery is to a new file if either the path name
23264 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23265
23266 No locking is required while writing the message to a new file, so the various
23267 locking options of the transport are ignored. The &"From"& line that by default
23268 separates messages in a single file is not normally needed, nor is the escaping
23269 of message lines that start with &"From"&, and there is no need to ensure a
23270 newline at the end of each message. Consequently, the default values for
23271 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23272 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23273
23274 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23275 the files in the delivery directory by default. However, you can specify a
23276 different directory by setting &%quota_directory%&. Also, for maildir
23277 deliveries (see below) the &_maildirfolder_& convention is honoured.
23278
23279
23280 .cindex "maildir format"
23281 .cindex "mailstore format"
23282 There are three different ways in which delivery to individual files can be
23283 done, controlled by the settings of the &%maildir_format%& and
23284 &%mailstore_format%& options. Note that code to support maildir or mailstore
23285 formats is not included in the binary unless SUPPORT_MAILDIR or
23286 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23287
23288 .cindex "directory creation"
23289 In all three cases an attempt is made to create the directory and any necessary
23290 sub-directories if they do not exist, provided that the &%create_directory%&
23291 option is set (the default). The location of a created directory can be
23292 constrained by setting &%create_file%&. A created directory's mode is given by
23293 the &%directory_mode%& option. If creation fails, or if the
23294 &%create_directory%& option is not set when creation is required, delivery is
23295 deferred.
23296
23297
23298
23299 .section "Maildir delivery" "SECTmaildirdelivery"
23300 .cindex "maildir format" "description of"
23301 If the &%maildir_format%& option is true, Exim delivers each message by writing
23302 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23303 directory that is defined by the &%directory%& option (the &"delivery
23304 directory"&). If the delivery is successful, the file is renamed into the
23305 &_new_& subdirectory.
23306
23307 In the filename, <&'stime'&> is the current time of day in seconds, and
23308 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23309 Exim checks that the time-of-day clock has moved on by at least one microsecond
23310 before terminating the delivery process. This guarantees uniqueness for the
23311 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23312 opening it. If any response other than ENOENT (does not exist) is given,
23313 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23314
23315 Before Exim carries out a maildir delivery, it ensures that subdirectories
23316 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23317 do not exist, Exim tries to create them and any superior directories in their
23318 path, subject to the &%create_directory%& and &%create_file%& options. If the
23319 &%maildirfolder_create_regex%& option is set, and the regular expression it
23320 contains matches the delivery directory, Exim also ensures that a file called
23321 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23322 &_maildirfolder_& file cannot be created, delivery is deferred.
23323
23324 These features make it possible to use Exim to create all the necessary files
23325 and directories in a maildir mailbox, including subdirectories for maildir++
23326 folders. Consider this example:
23327 .code
23328 maildir_format = true
23329 directory = /var/mail/$local_part\
23330            ${if eq{$local_part_suffix}{}{}\
23331            {/.${substr_1:$local_part_suffix}}}
23332 maildirfolder_create_regex = /\.[^/]+$
23333 .endd
23334 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23335 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23336 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23337 not match this name, so Exim will not look for or create the file
23338 &_/var/mail/pimbo/maildirfolder_&, though it will create
23339 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23340
23341 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23342 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23343 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23344 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23345 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23346
23347 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23348 not inadvertently match the toplevel maildir directory, because a
23349 &_maildirfolder_& file at top level would completely break quota calculations.
23350
23351 .cindex "quota" "in maildir delivery"
23352 .cindex "maildir++"
23353 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23354 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23355 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23356 Exim assumes the directory is a maildir++ folder directory, which is one level
23357 down from the user's top level mailbox directory. This causes it to start at
23358 the parent directory instead of the current directory when calculating the
23359 amount of space used.
23360
23361 One problem with delivering into a multi-file mailbox is that it is
23362 computationally expensive to compute the size of the mailbox for quota
23363 checking. Various approaches have been taken to reduce the amount of work
23364 needed. The next two sections describe two of them. A third alternative is to
23365 use some external process for maintaining the size data, and use the expansion
23366 of the &%mailbox_size%& option as a way of importing it into Exim.
23367
23368
23369
23370
23371 .section "Using tags to record message sizes" "SECID135"
23372 If &%maildir_tag%& is set, the string is expanded for each delivery.
23373 When the maildir file is renamed into the &_new_& sub-directory, the
23374 tag is added to its name. However, if adding the tag takes the length of the
23375 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23376 the tag is dropped and the maildir file is created with no tag.
23377
23378
23379 .vindex "&$message_size$&"
23380 Tags can be used to encode the size of files in their names; see
23381 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23382 happens after the message has been written. The value of the &$message_size$&
23383 variable is set to the number of bytes actually written. If the expansion is
23384 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23385 be deferred. The expanded tag may contain any printing characters except &"/"&.
23386 Non-printing characters in the string are ignored; if the resulting string is
23387 empty, it is ignored. If it starts with an alphanumeric character, a leading
23388 colon is inserted; this default has not proven to be the path that popular
23389 maildir implementations have chosen (but changing it in Exim would break
23390 backwards compatibility).
23391
23392 For one common implementation, you might set:
23393 .code
23394 maildir_tag = ,S=${message_size}
23395 .endd
23396 but you should check the documentation of the other software to be sure.
23397
23398 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23399 as this allows Exim to extract the size from your tag, instead of having to
23400 &[stat()]& each message file.
23401
23402
23403 .section "Using a maildirsize file" "SECID136"
23404 .cindex "quota" "in maildir delivery"
23405 .cindex "maildir format" "&_maildirsize_& file"
23406 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23407 storing quota and message size information in a file called &_maildirsize_&
23408 within the toplevel maildir directory. If this file does not exist, Exim
23409 creates it, setting the quota from the &%quota%& option of the transport. If
23410 the maildir directory itself does not exist, it is created before any attempt
23411 to write a &_maildirsize_& file.
23412
23413 The &_maildirsize_& file is used to hold information about the sizes of
23414 messages in the maildir, thus speeding up quota calculations. The quota value
23415 in the file is just a cache; if the quota is changed in the transport, the new
23416 value overrides the cached value when the next message is delivered. The cache
23417 is maintained for the benefit of other programs that access the maildir and
23418 need to know the quota.
23419
23420 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23421 file is maintained (with a zero quota setting), but no quota is imposed.
23422
23423 A regular expression is available for controlling which directories in the
23424 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23425 See the description of the &%maildir_quota_directory_regex%& option above for
23426 details.
23427
23428
23429 .section "Mailstore delivery" "SECID137"
23430 .cindex "mailstore format" "description of"
23431 If the &%mailstore_format%& option is true, each message is written as two
23432 files in the given directory. A unique base name is constructed from the
23433 message id and the current delivery process, and the files that are written use
23434 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23435 contains the message's envelope, and the &_.msg_& file contains the message
23436 itself. The base name is placed in the variable &$mailstore_basename$&.
23437
23438 During delivery, the envelope is first written to a file with the suffix
23439 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23440 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23441 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23442 file before accessing either of them. An alternative approach is to wait for
23443 the absence of a &_.tmp_& file.
23444
23445 The envelope file starts with any text defined by the &%mailstore_prefix%&
23446 option, expanded and terminated by a newline if there isn't one. Then follows
23447 the sender address on one line, then all the recipient addresses, one per line.
23448 There can be more than one recipient only if the &%batch_max%& option is set
23449 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23450 appended to the file, followed by a newline if it does not end with one.
23451
23452 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23453 failure, it is ignored. Other expansion errors are treated as serious
23454 configuration errors, and delivery is deferred. The variable
23455 &$mailstore_basename$& is available for use during these expansions.
23456
23457
23458 .section "Non-special new file delivery" "SECID138"
23459 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23460 file is created directly in the named directory. For example, when delivering
23461 messages into files in batched SMTP format for later delivery to some host (see
23462 section &<<SECTbatchSMTP>>&), a setting such as
23463 .code
23464 directory = /var/bsmtp/$host
23465 .endd
23466 might be used. A message is written to a file with a temporary name, which is
23467 then renamed when the delivery is complete. The final name is obtained by
23468 expanding the contents of the &%directory_file%& option.
23469 .ecindex IIDapptra1
23470 .ecindex IIDapptra2
23471
23472
23473
23474
23475
23476
23477 . ////////////////////////////////////////////////////////////////////////////
23478 . ////////////////////////////////////////////////////////////////////////////
23479
23480 .chapter "The autoreply transport" "CHID8"
23481 .scindex IIDauttra1 "transports" "&(autoreply)&"
23482 .scindex IIDauttra2 "&(autoreply)& transport"
23483 The &(autoreply)& transport is not a true transport in that it does not cause
23484 the message to be transmitted. Instead, it generates a new mail message as an
23485 automatic reply to the incoming message. &'References:'& and
23486 &'Auto-Submitted:'& header lines are included. These are constructed according
23487 to the rules in RFCs 2822 and 3834, respectively.
23488
23489 If the router that passes the message to this transport does not have the
23490 &%unseen%& option set, the original message (for the current recipient) is not
23491 delivered anywhere. However, when the &%unseen%& option is set on the router
23492 that passes the message to this transport, routing of the address continues, so
23493 another router can set up a normal message delivery.
23494
23495
23496 The &(autoreply)& transport is usually run as the result of mail filtering, a
23497 &"vacation"& message being the standard example. However, it can also be run
23498 directly from a router like any other transport. To reduce the possibility of
23499 message cascades, messages created by the &(autoreply)& transport always have
23500 empty envelope sender addresses, like bounce messages.
23501
23502 The parameters of the message to be sent can be specified in the configuration
23503 by options described below. However, these are used only when the address
23504 passed to the transport does not contain its own reply information. When the
23505 transport is run as a consequence of a
23506 &%mail%&
23507 or &%vacation%& command in a filter file, the parameters of the message are
23508 supplied by the filter, and passed with the address. The transport's options
23509 that define the message are then ignored (so they are not usually set in this
23510 case). The message is specified entirely by the filter or by the transport; it
23511 is never built from a mixture of options. However, the &%file_optional%&,
23512 &%mode%&, and &%return_message%& options apply in all cases.
23513
23514 &(Autoreply)& is implemented as a local transport. When used as a result of a
23515 command in a user's filter file, &(autoreply)& normally runs under the uid and
23516 gid of the user, and with appropriate current and home directories (see chapter
23517 &<<CHAPenvironment>>&).
23518
23519 There is a subtle difference between routing a message to a &(pipe)& transport
23520 that generates some text to be returned to the sender, and routing it to an
23521 &(autoreply)& transport. This difference is noticeable only if more than one
23522 address from the same message is so handled. In the case of a pipe, the
23523 separate outputs from the different addresses are gathered up and returned to
23524 the sender in a single message, whereas if &(autoreply)& is used, a separate
23525 message is generated for each address that is passed to it.
23526
23527 Non-printing characters are not permitted in the header lines generated for the
23528 message that &(autoreply)& creates, with the exception of newlines that are
23529 immediately followed by white space. If any non-printing characters are found,
23530 the transport defers.
23531 Whether characters with the top bit set count as printing characters or not is
23532 controlled by the &%print_topbitchars%& global option.
23533
23534 If any of the generic options for manipulating headers (for example,
23535 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23536 of the original message that is included in the generated message when
23537 &%return_message%& is set. They do not apply to the generated message itself.
23538
23539 .vindex "&$sender_address$&"
23540 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23541 the message, indicating that there were no recipients, it does not treat this
23542 as an error. This means that autoreplies sent to &$sender_address$& when this
23543 is empty (because the incoming message is a bounce message) do not cause
23544 problems. They are just discarded.
23545
23546
23547
23548 .section "Private options for autoreply" "SECID139"
23549 .cindex "options" "&(autoreply)& transport"
23550
23551 .option bcc autoreply string&!! unset
23552 This specifies the addresses that are to receive &"blind carbon copies"& of the
23553 message when the message is specified by the transport.
23554
23555
23556 .option cc autoreply string&!! unset
23557 This specifies recipients of the message and the contents of the &'Cc:'& header
23558 when the message is specified by the transport.
23559
23560
23561 .option file autoreply string&!! unset
23562 The contents of the file are sent as the body of the message when the message
23563 is specified by the transport. If both &%file%& and &%text%& are set, the text
23564 string comes first.
23565
23566
23567 .option file_expand autoreply boolean false
23568 If this is set, the contents of the file named by the &%file%& option are
23569 subjected to string expansion as they are added to the message.
23570
23571
23572 .option file_optional autoreply boolean false
23573 If this option is true, no error is generated if the file named by the &%file%&
23574 option or passed with the address does not exist or cannot be read.
23575
23576
23577 .option from autoreply string&!! unset
23578 This specifies the contents of the &'From:'& header when the message is
23579 specified by the transport.
23580
23581
23582 .option headers autoreply string&!! unset
23583 This specifies additional RFC 2822 headers that are to be added to the message
23584 when the message is specified by the transport. Several can be given by using
23585 &"\n"& to separate them. There is no check on the format.
23586
23587
23588 .option log autoreply string&!! unset
23589 This option names a file in which a record of every message sent is logged when
23590 the message is specified by the transport.
23591
23592
23593 .option mode autoreply "octal integer" 0600
23594 If either the log file or the &"once"& file has to be created, this mode is
23595 used.
23596
23597
23598 .option never_mail autoreply "address list&!!" unset
23599 If any run of the transport creates a message with a recipient that matches any
23600 item in the list, that recipient is quietly discarded. If all recipients are
23601 discarded, no message is created. This applies both when the recipients are
23602 generated by a filter and when they are specified in the transport.
23603
23604
23605
23606 .option once autoreply string&!! unset
23607 This option names a file or DBM database in which a record of each &'To:'&
23608 recipient is kept when the message is specified by the transport. &*Note*&:
23609 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23610
23611 If &%once%& is unset, or is set to an empty string, the message is always sent.
23612 By default, if &%once%& is set to a non-empty filename, the message
23613 is not sent if a potential recipient is already listed in the database.
23614 However, if the &%once_repeat%& option specifies a time greater than zero, the
23615 message is sent if that much time has elapsed since a message was last sent to
23616 this recipient. A setting of zero time for &%once_repeat%& (the default)
23617 prevents a message from being sent a second time &-- in this case, zero means
23618 infinity.
23619
23620 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23621 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23622 greater than zero, it changes the way Exim implements the &%once%& option.
23623 Instead of using a DBM file to record every recipient it sends to, it uses a
23624 regular file, whose size will never get larger than the given value.
23625
23626 In the file, Exim keeps a linear list of recipient addresses and the times at
23627 which they were sent messages. If the file is full when a new address needs to
23628 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23629 means that a given recipient may receive multiple messages, but at
23630 unpredictable intervals that depend on the rate of turnover of addresses in the
23631 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23632
23633
23634 .option once_file_size autoreply integer 0
23635 See &%once%& above.
23636
23637
23638 .option once_repeat autoreply time&!! 0s
23639 See &%once%& above.
23640 After expansion, the value of this option must be a valid time value.
23641
23642
23643 .option reply_to autoreply string&!! unset
23644 This specifies the contents of the &'Reply-To:'& header when the message is
23645 specified by the transport.
23646
23647
23648 .option return_message autoreply boolean false
23649 If this is set, a copy of the original message is returned with the new
23650 message, subject to the maximum size set in the &%return_size_limit%& global
23651 configuration option.
23652
23653
23654 .option subject autoreply string&!! unset
23655 This specifies the contents of the &'Subject:'& header when the message is
23656 specified by the transport. It is tempting to quote the original subject in
23657 automatic responses. For example:
23658 .code
23659 subject = Re: $h_subject:
23660 .endd
23661 There is a danger in doing this, however. It may allow a third party to
23662 subscribe your users to an opt-in mailing list, provided that the list accepts
23663 bounce messages as subscription confirmations. Well-managed lists require a
23664 non-bounce message to confirm a subscription, so the danger is relatively
23665 small.
23666
23667
23668
23669 .option text autoreply string&!! unset
23670 This specifies a single string to be used as the body of the message when the
23671 message is specified by the transport. If both &%text%& and &%file%& are set,
23672 the text comes first.
23673
23674
23675 .option to autoreply string&!! unset
23676 This specifies recipients of the message and the contents of the &'To:'& header
23677 when the message is specified by the transport.
23678 .ecindex IIDauttra1
23679 .ecindex IIDauttra2
23680
23681
23682
23683
23684 . ////////////////////////////////////////////////////////////////////////////
23685 . ////////////////////////////////////////////////////////////////////////////
23686
23687 .chapter "The lmtp transport" "CHAPLMTP"
23688 .cindex "transports" "&(lmtp)&"
23689 .cindex "&(lmtp)& transport"
23690 .cindex "LMTP" "over a pipe"
23691 .cindex "LMTP" "over a socket"
23692 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23693 specified command
23694 or by interacting with a Unix domain socket.
23695 This transport is something of a cross between the &(pipe)& and &(smtp)&
23696 transports. Exim also has support for using LMTP over TCP/IP; this is
23697 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23698 to be of minority interest, the default build-time configure in &_src/EDITME_&
23699 has it commented out. You need to ensure that
23700 .code
23701 TRANSPORT_LMTP=yes
23702 .endd
23703 .cindex "options" "&(lmtp)& transport"
23704 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23705 included in the Exim binary. The private options of the &(lmtp)& transport are
23706 as follows:
23707
23708 .option batch_id lmtp string&!! unset
23709 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23710
23711
23712 .option batch_max lmtp integer 1
23713 This limits the number of addresses that can be handled in a single delivery.
23714 Most LMTP servers can handle several addresses at once, so it is normally a
23715 good idea to increase this value. See the description of local delivery
23716 batching in chapter &<<CHAPbatching>>&.
23717
23718
23719 .option command lmtp string&!! unset
23720 This option must be set if &%socket%& is not set. The string is a command which
23721 is run in a separate process. It is split up into a command name and list of
23722 arguments, each of which is separately expanded (so expansion cannot change the
23723 number of arguments). The command is run directly, not via a shell. The message
23724 is passed to the new process using the standard input and output to operate the
23725 LMTP protocol.
23726
23727 .option ignore_quota lmtp boolean false
23728 .cindex "LMTP" "ignoring quota errors"
23729 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23730 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23731 in its response to the LHLO command.
23732
23733 .option socket lmtp string&!! unset
23734 This option must be set if &%command%& is not set. The result of expansion must
23735 be the name of a Unix domain socket. The transport connects to the socket and
23736 delivers the message to it using the LMTP protocol.
23737
23738
23739 .option timeout lmtp time 5m
23740 The transport is aborted if the created process or Unix domain socket does not
23741 respond to LMTP commands or message input within this timeout. Delivery
23742 is deferred, and will be tried again later. Here is an example of a typical
23743 LMTP transport:
23744 .code
23745 lmtp:
23746   driver = lmtp
23747   command = /some/local/lmtp/delivery/program
23748   batch_max = 20
23749   user = exim
23750 .endd
23751 This delivers up to 20 addresses at a time, in a mixture of domains if
23752 necessary, running as the user &'exim'&.
23753
23754
23755
23756 . ////////////////////////////////////////////////////////////////////////////
23757 . ////////////////////////////////////////////////////////////////////////////
23758
23759 .chapter "The pipe transport" "CHAPpipetransport"
23760 .scindex IIDpiptra1 "transports" "&(pipe)&"
23761 .scindex IIDpiptra2 "&(pipe)& transport"
23762 The &(pipe)& transport is used to deliver messages via a pipe to a command
23763 running in another process. One example is the use of &(pipe)& as a
23764 pseudo-remote transport for passing messages to some other delivery mechanism
23765 (such as UUCP). Another is the use by individual users to automatically process
23766 their incoming messages. The &(pipe)& transport can be used in one of the
23767 following ways:
23768
23769 .ilist
23770 .vindex "&$local_part$&"
23771 A router routes one address to a transport in the normal way, and the
23772 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23773 contains the local part of the address (as usual), and the command that is run
23774 is specified by the &%command%& option on the transport.
23775 .next
23776 .vindex "&$pipe_addresses$&"
23777 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23778 transport can handle more than one address in a single run. In this case, when
23779 more than one address is routed to the transport, &$local_part$& is not set
23780 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23781 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23782 that are routed to the transport.
23783 .next
23784 .vindex "&$address_pipe$&"
23785 A router redirects an address directly to a pipe command (for example, from an
23786 alias or forward file). In this case, &$address_pipe$& contains the text of the
23787 pipe command, and the &%command%& option on the transport is ignored unless
23788 &%force_command%& is set. If only one address is being transported
23789 (&%batch_max%& is not greater than one, or only one address was redirected to
23790 this pipe command), &$local_part$& contains the local part that was redirected.
23791 .endlist
23792
23793
23794 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23795 deliver messages over pipes using the LMTP interactive protocol. This is
23796 implemented by the &(lmtp)& transport.
23797
23798 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23799 &_.forward_& file, the command runs under the uid and gid of that user. In
23800 other cases, the uid and gid have to be specified explicitly, either on the
23801 transport or on the router that handles the address. Current and &"home"&
23802 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23803 details of the local delivery environment and chapter &<<CHAPbatching>>&
23804 for a discussion of local delivery batching.
23805
23806
23807 .section "Concurrent delivery" "SECID140"
23808 If two messages arrive at almost the same time, and both are routed to a pipe
23809 delivery, the two pipe transports may be run concurrently. You must ensure that
23810 any pipe commands you set up are robust against this happening. If the commands
23811 write to a file, the &%exim_lock%& utility might be of use.
23812 Alternatively the &%max_parallel%& option could be used with a value
23813 of "1" to enforce serialization.
23814
23815
23816
23817
23818 .section "Returned status and data" "SECID141"
23819 .cindex "&(pipe)& transport" "returned data"
23820 If the command exits with a non-zero return code, the delivery is deemed to
23821 have failed, unless either the &%ignore_status%& option is set (in which case
23822 the return code is treated as zero), or the return code is one of those listed
23823 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23824 later"&. In this case, delivery is deferred. Details of a permanent failure are
23825 logged, but are not included in the bounce message, which merely contains
23826 &"local delivery failed"&.
23827
23828 If the command exits on a signal and the &%freeze_signal%& option is set then
23829 the message will be frozen in the queue. If that option is not set, a bounce
23830 will be sent as normal.
23831
23832 If the return code is greater than 128 and the command being run is a shell
23833 script, it normally means that the script was terminated by a signal whose
23834 value is the return code minus 128. The &%freeze_signal%& option does not
23835 apply in this case.
23836
23837 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23838 return code is set to 127. This is the value that a shell returns if it is
23839 asked to run a non-existent command. The wording for the log line suggests that
23840 a non-existent command may be the problem.
23841
23842 The &%return_output%& option can affect the result of a pipe delivery. If it is
23843 set and the command produces any output on its standard output or standard
23844 error streams, the command is considered to have failed, even if it gave a zero
23845 return code or if &%ignore_status%& is set. The output from the command is
23846 included as part of the bounce message. The &%return_fail_output%& option is
23847 similar, except that output is returned only when the command exits with a
23848 failure return code, that is, a value other than zero or a code that matches
23849 &%temp_errors%&.
23850
23851
23852
23853 .section "How the command is run" "SECThowcommandrun"
23854 .cindex "&(pipe)& transport" "path for command"
23855 The command line is (by default) broken down into a command name and arguments
23856 by the &(pipe)& transport itself. The &%allow_commands%& and
23857 &%restrict_to_path%& options can be used to restrict the commands that may be
23858 run.
23859
23860 .cindex "quoting" "in pipe command"
23861 Unquoted arguments are delimited by white space. If an argument appears in
23862 double quotes, backslash is interpreted as an escape character in the usual
23863 way. If an argument appears in single quotes, no escaping is done.
23864
23865 String expansion is applied to the command line except when it comes from a
23866 traditional &_.forward_& file (commands from a filter file are expanded). The
23867 expansion is applied to each argument in turn rather than to the whole line.
23868 For this reason, any string expansion item that contains white space must be
23869 quoted so as to be contained within a single argument. A setting such as
23870 .code
23871 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23872 .endd
23873 will not work, because the expansion item gets split between several
23874 arguments. You have to write
23875 .code
23876 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23877 .endd
23878 to ensure that it is all in one argument. The expansion is done in this way,
23879 argument by argument, so that the number of arguments cannot be changed as a
23880 result of expansion, and quotes or backslashes in inserted variables do not
23881 interact with external quoting. However, this leads to problems if you want to
23882 generate multiple arguments (or the command name plus arguments) from a single
23883 expansion. In this situation, the simplest solution is to use a shell. For
23884 example:
23885 .code
23886 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23887 .endd
23888
23889 .cindex "transport" "filter"
23890 .cindex "filter" "transport filter"
23891 .vindex "&$pipe_addresses$&"
23892 Special handling takes place when an argument consists of precisely the text
23893 &`$pipe_addresses`& (no quotes).
23894 This is not a general expansion variable; the only
23895 place this string is recognized is when it appears as an argument for a pipe or
23896 transport filter command. It causes each address that is being handled to be
23897 inserted in the argument list at that point &'as a separate argument'&. This
23898 avoids any problems with spaces or shell metacharacters, and is of use when a
23899 &(pipe)& transport is handling groups of addresses in a batch.
23900
23901 If &%force_command%& is enabled on the transport, special handling takes place
23902 for an argument that consists of precisely the text &`$address_pipe`&.  It
23903 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23904 argument is inserted in the argument list at that point
23905 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23906 the only item in the argument; in fact, if it were then &%force_command%&
23907 should behave as a no-op.  Rather, it should be used to adjust the command
23908 run while preserving the argument vector separation.
23909
23910 After splitting up into arguments and expansion, the resulting command is run
23911 in a subprocess directly from the transport, &'not'& under a shell. The
23912 message that is being delivered is supplied on the standard input, and the
23913 standard output and standard error are both connected to a single pipe that is
23914 read by Exim. The &%max_output%& option controls how much output the command
23915 may produce, and the &%return_output%& and &%return_fail_output%& options
23916 control what is done with it.
23917
23918 Not running the command under a shell (by default) lessens the security risks
23919 in cases when a command from a user's filter file is built out of data that was
23920 taken from an incoming message. If a shell is required, it can of course be
23921 explicitly specified as the command to be run. However, there are circumstances
23922 where existing commands (for example, in &_.forward_& files) expect to be run
23923 under a shell and cannot easily be modified. To allow for these cases, there is
23924 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23925 works. Instead of breaking up the command line as just described, it expands it
23926 as a single string and passes the result to &_/bin/sh_&. The
23927 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23928 with &%use_shell%&, and the whole mechanism is inherently less secure.
23929
23930
23931
23932 .section "Environment variables" "SECTpipeenv"
23933 .cindex "&(pipe)& transport" "environment for command"
23934 .cindex "environment" "&(pipe)& transport"
23935 The environment variables listed below are set up when the command is invoked.
23936 This list is a compromise for maximum compatibility with other MTAs. Note that
23937 the &%environment%& option can be used to add additional variables to this
23938 environment. The environment for the &(pipe)& transport is not subject
23939 to the &%add_environment%& and &%keep_environment%& main config options.
23940 .display
23941 &`DOMAIN            `&   the domain of the address
23942 &`HOME              `&   the home directory, if set
23943 &`HOST              `&   the host name when called from a router (see below)
23944 &`LOCAL_PART        `&   see below
23945 &`LOCAL_PART_PREFIX `&   see below
23946 &`LOCAL_PART_SUFFIX `&   see below
23947 &`LOGNAME           `&   see below
23948 &`MESSAGE_ID        `&   Exim's local ID for the message
23949 &`PATH              `&   as specified by the &%path%& option below
23950 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23951 &`RECIPIENT         `&   the complete recipient address
23952 &`SENDER            `&   the sender of the message (empty if a bounce)
23953 &`SHELL             `&   &`/bin/sh`&
23954 &`TZ                `&   the value of the &%timezone%& option, if set
23955 &`USER              `&   see below
23956 .endd
23957 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23958 router, LOCAL_PART is set to the local part of the address. When it is
23959 called as a result of a forward or alias expansion, LOCAL_PART is set to
23960 the local part of the address that was expanded. In both cases, any affixes are
23961 removed from the local part, and made available in LOCAL_PART_PREFIX and
23962 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23963 same value as LOCAL_PART for compatibility with other MTAs.
23964
23965 .cindex "HOST"
23966 HOST is set only when a &(pipe)& transport is called from a router that
23967 associates hosts with an address, typically when using &(pipe)& as a
23968 pseudo-remote transport. HOST is set to the first host name specified by
23969 the router.
23970
23971 .cindex "HOME"
23972 If the transport's generic &%home_directory%& option is set, its value is used
23973 for the HOME environment variable. Otherwise, a home directory may be set
23974 by the router's &%transport_home_directory%& option, which defaults to the
23975 user's home directory if &%check_local_user%& is set.
23976
23977
23978 .section "Private options for pipe" "SECID142"
23979 .cindex "options" "&(pipe)& transport"
23980
23981
23982
23983 .option allow_commands pipe "string list&!!" unset
23984 .cindex "&(pipe)& transport" "permitted commands"
23985 The string is expanded, and is then interpreted as a colon-separated list of
23986 permitted commands. If &%restrict_to_path%& is not set, the only commands
23987 permitted are those in the &%allow_commands%& list. They need not be absolute
23988 paths; the &%path%& option is still used for relative paths. If
23989 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23990 in the &%allow_commands%& list, or a name without any slashes that is found on
23991 the path. In other words, if neither &%allow_commands%& nor
23992 &%restrict_to_path%& is set, there is no restriction on the command, but
23993 otherwise only commands that are permitted by one or the other are allowed. For
23994 example, if
23995 .code
23996 allow_commands = /usr/bin/vacation
23997 .endd
23998 and &%restrict_to_path%& is not set, the only permitted command is
23999 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24000 &%use_shell%& is set.
24001
24002
24003 .option batch_id pipe string&!! unset
24004 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24005
24006
24007 .option batch_max pipe integer 1
24008 This limits the number of addresses that can be handled in a single delivery.
24009 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24010
24011
24012 .option check_string pipe string unset
24013 As &(pipe)& writes the message, the start of each line is tested for matching
24014 &%check_string%&, and if it does, the initial matching characters are replaced
24015 by the contents of &%escape_string%&, provided both are set. The value of
24016 &%check_string%& is a literal string, not a regular expression, and the case of
24017 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24018 of &%check_string%& and &%escape_string%& are forced to values that implement
24019 the SMTP escaping protocol. Any settings made in the configuration file are
24020 ignored.
24021
24022
24023 .option command pipe string&!! unset
24024 This option need not be set when &(pipe)& is being used to deliver to pipes
24025 obtained directly from address redirections. In other cases, the option must be
24026 set, to provide a command to be run. It need not yield an absolute path (see
24027 the &%path%& option below). The command is split up into separate arguments by
24028 Exim, and each argument is separately expanded, as described in section
24029 &<<SECThowcommandrun>>& above.
24030
24031
24032 .option environment pipe string&!! unset
24033 .cindex "&(pipe)& transport" "environment for command"
24034 .cindex "environment" "&(pipe)& transport"
24035 This option is used to add additional variables to the environment in which the
24036 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24037 a string which is expanded, and then interpreted as a colon-separated list of
24038 environment settings of the form <&'name'&>=<&'value'&>.
24039
24040
24041 .option escape_string pipe string unset
24042 See &%check_string%& above.
24043
24044
24045 .option freeze_exec_fail pipe boolean false
24046 .cindex "exec failure"
24047 .cindex "failure of exec"
24048 .cindex "&(pipe)& transport" "failure of exec"
24049 Failure to exec the command in a pipe transport is by default treated like
24050 any other failure while running the command. However, if &%freeze_exec_fail%&
24051 is set, failure to exec is treated specially, and causes the message to be
24052 frozen, whatever the setting of &%ignore_status%&.
24053
24054
24055 .option freeze_signal pipe boolean false
24056 .cindex "signal exit"
24057 .cindex "&(pipe)& transport", "signal exit"
24058 Normally if the process run by a command in a pipe transport exits on a signal,
24059 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24060 frozen in Exim's queue instead.
24061
24062
24063 .option force_command pipe boolean false
24064 .cindex "force command"
24065 .cindex "&(pipe)& transport", "force command"
24066 Normally when a router redirects an address directly to a pipe command
24067 the &%command%& option on the transport is ignored.  If &%force_command%&
24068 is set, the &%command%& option will used. This is especially
24069 useful for forcing a wrapper or additional argument to be added to the
24070 command. For example:
24071 .code
24072 command = /usr/bin/remote_exec myhost -- $address_pipe
24073 force_command
24074 .endd
24075
24076 Note that &$address_pipe$& is handled specially in &%command%& when
24077 &%force_command%& is set, expanding out to the original argument vector as
24078 separate items, similarly to a Unix shell &`"$@"`& construct.
24079
24080
24081 .option ignore_status pipe boolean false
24082 If this option is true, the status returned by the subprocess that is set up to
24083 run the command is ignored, and Exim behaves as if zero had been returned.
24084 Otherwise, a non-zero status or termination by signal causes an error return
24085 from the transport unless the status value is one of those listed in
24086 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24087
24088 &*Note*&: This option does not apply to timeouts, which do not return a status.
24089 See the &%timeout_defer%& option for how timeouts are handled.
24090
24091
24092 .option log_defer_output pipe boolean false
24093 .cindex "&(pipe)& transport" "logging output"
24094 If this option is set, and the status returned by the command is
24095 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24096 and any output was produced on stdout or stderr, the first line of it is
24097 written to the main log.
24098
24099
24100 .option log_fail_output pipe boolean false
24101 If this option is set, and the command returns any output on stdout or
24102 stderr, and also ends with a return code that is neither zero nor one of
24103 the return codes listed in &%temp_errors%& (that is, the delivery
24104 failed), the first line of output is written to the main log. This
24105 option and &%log_output%& are mutually exclusive.  Only one of them may
24106 be set.
24107
24108
24109 .option log_output pipe boolean false
24110 If this option is set and the command returns any output on stdout or
24111 stderr, the first line of output is written to the main log, whatever
24112 the return code. This option and &%log_fail_output%& are mutually
24113 exclusive. Only one of them may be set.
24114
24115
24116 .option max_output pipe integer 20K
24117 This specifies the maximum amount of output that the command may produce on its
24118 standard output and standard error file combined. If the limit is exceeded, the
24119 process running the command is killed. This is intended as a safety measure to
24120 catch runaway processes. The limit is applied independently of the settings of
24121 the options that control what is done with such output (for example,
24122 &%return_output%&). Because of buffering effects, the amount of output may
24123 exceed the limit by a small amount before Exim notices.
24124
24125
24126 .option message_prefix pipe string&!! "see below"
24127 The string specified here is expanded and output at the start of every message.
24128 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24129 .code
24130 message_prefix = \
24131   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24132   ${tod_bsdinbox}\n
24133 .endd
24134 .cindex "Cyrus"
24135 .cindex "&%tmail%&"
24136 .cindex "&""From""& line"
24137 This is required by the commonly used &_/usr/bin/vacation_& program.
24138 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24139 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24140 setting
24141 .code
24142 message_prefix =
24143 .endd
24144 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24145 &`\n`& to &`\r\n`& in &%message_prefix%&.
24146
24147
24148 .option message_suffix pipe string&!! "see below"
24149 The string specified here is expanded and output at the end of every message.
24150 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24151 The suffix can be suppressed by setting
24152 .code
24153 message_suffix =
24154 .endd
24155 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24156 &`\n`& to &`\r\n`& in &%message_suffix%&.
24157
24158
24159 .option path pipe string&!! "/bin:/usr/bin"
24160 This option is expanded and
24161 specifies the string that is set up in the PATH environment
24162 variable of the subprocess.
24163 If the &%command%& option does not yield an absolute path name, the command is
24164 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24165 apply to a command specified as a transport filter.
24166
24167
24168 .option permit_coredump pipe boolean false
24169 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24170 a core-dump of a pipe command, enable this command.  This enables core-dumps
24171 during delivery and affects both the Exim binary and the pipe command run.
24172 It is recommended that this option remain off unless and until you have a need
24173 for it and that this only be enabled when needed, as the risk of excessive
24174 resource consumption can be quite high.  Note also that Exim is typically
24175 installed as a setuid binary and most operating systems will inhibit coredumps
24176 of these by default, so further OS-specific action may be required.
24177
24178
24179 .option pipe_as_creator pipe boolean false
24180 .cindex "uid (user id)" "local delivery"
24181 If the generic &%user%& option is not set and this option is true, the delivery
24182 process is run under the uid that was in force when Exim was originally called
24183 to accept the message. If the group id is not otherwise set (via the generic
24184 &%group%& option), the gid that was in force when Exim was originally called to
24185 accept the message is used.
24186
24187
24188 .option restrict_to_path pipe boolean false
24189 When this option is set, any command name not listed in &%allow_commands%& must
24190 contain no slashes. The command is searched for only in the directories listed
24191 in the &%path%& option. This option is intended for use in the case when a pipe
24192 command has been generated from a user's &_.forward_& file. This is usually
24193 handled by a &(pipe)& transport called &%address_pipe%&.
24194
24195
24196 .option return_fail_output pipe boolean false
24197 If this option is true, and the command produced any output and ended with a
24198 return code other than zero or one of the codes listed in &%temp_errors%& (that
24199 is, the delivery failed), the output is returned in the bounce message.
24200 However, if the message has a null sender (that is, it is itself a bounce
24201 message), output from the command is discarded. This option and
24202 &%return_output%& are mutually exclusive. Only one of them may be set.
24203
24204
24205
24206 .option return_output pipe boolean false
24207 If this option is true, and the command produced any output, the delivery is
24208 deemed to have failed whatever the return code from the command, and the output
24209 is returned in the bounce message. Otherwise, the output is just discarded.
24210 However, if the message has a null sender (that is, it is a bounce message),
24211 output from the command is always discarded, whatever the setting of this
24212 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24213 of them may be set.
24214
24215
24216
24217 .option temp_errors pipe "string list" "see below"
24218 .cindex "&(pipe)& transport" "temporary failure"
24219 This option contains either a colon-separated list of numbers, or a single
24220 asterisk. If &%ignore_status%& is false
24221 and &%return_output%& is not set,
24222 and the command exits with a non-zero return code, the failure is treated as
24223 temporary and the delivery is deferred if the return code matches one of the
24224 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24225 codes are treated as permanent errors. The default setting contains the codes
24226 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24227 compiled on a system that does not define these macros, it assumes values of 75
24228 and 73, respectively.
24229
24230
24231 .option timeout pipe time 1h
24232 If the command fails to complete within this time, it is killed. This normally
24233 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24234 specifies no timeout. In order to ensure that any subprocesses created by the
24235 command are also killed, Exim makes the initial process a process group leader,
24236 and kills the whole process group on a timeout. However, this can be defeated
24237 if one of the processes starts a new process group.
24238
24239 .option timeout_defer pipe boolean false
24240 A timeout in a &(pipe)& transport, either in the command that the transport
24241 runs, or in a transport filter that is associated with it, is by default
24242 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24243 is set true, both kinds of timeout become temporary errors, causing the
24244 delivery to be deferred.
24245
24246 .option umask pipe "octal integer" 022
24247 This specifies the umask setting for the subprocess that runs the command.
24248
24249
24250 .option use_bsmtp pipe boolean false
24251 .cindex "envelope sender"
24252 If this option is set true, the &(pipe)& transport writes messages in &"batch
24253 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24254 commands. If you want to include a leading HELO command with such messages,
24255 you can do so by setting the &%message_prefix%& option. See section
24256 &<<SECTbatchSMTP>>& for details of batch SMTP.
24257
24258 .option use_classresources pipe boolean false
24259 .cindex "class resources (BSD)"
24260 This option is available only when Exim is running on FreeBSD, NetBSD, or
24261 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24262 resource limits when a &(pipe)& transport is run to perform a delivery. The
24263 limits for the uid under which the pipe is to run are obtained from the login
24264 class database.
24265
24266
24267 .option use_crlf pipe boolean false
24268 .cindex "carriage return"
24269 .cindex "linefeed"
24270 This option causes lines to be terminated with the two-character CRLF sequence
24271 (carriage return, linefeed) instead of just a linefeed character. In the case
24272 of batched SMTP, the byte sequence written to the pipe is then an exact image
24273 of what would be sent down a real SMTP connection.
24274
24275 The contents of the &%message_prefix%& and &%message_suffix%& options are
24276 written verbatim, so must contain their own carriage return characters if these
24277 are needed. When &%use_bsmtp%& is not set, the default values for both
24278 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24279 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24280
24281
24282 .option use_shell pipe boolean false
24283 .vindex "&$pipe_addresses$&"
24284 If this option is set, it causes the command to be passed to &_/bin/sh_&
24285 instead of being run directly from the transport, as described in section
24286 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24287 where the command is expected to be run under a shell and cannot easily be
24288 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24289 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24290 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24291 its &%-c%& option.
24292
24293
24294
24295 .section "Using an external local delivery agent" "SECID143"
24296 .cindex "local delivery" "using an external agent"
24297 .cindex "&'procmail'&"
24298 .cindex "external local delivery"
24299 .cindex "delivery" "&'procmail'&"
24300 .cindex "delivery" "by external agent"
24301 The &(pipe)& transport can be used to pass all messages that require local
24302 delivery to a separate local delivery agent such as &%procmail%&. When doing
24303 this, care must be taken to ensure that the pipe is run under an appropriate
24304 uid and gid. In some configurations one wants this to be a uid that is trusted
24305 by the delivery agent to supply the correct sender of the message. It may be
24306 necessary to recompile or reconfigure the delivery agent so that it trusts an
24307 appropriate user. The following is an example transport and router
24308 configuration for &%procmail%&:
24309 .code
24310 # transport
24311 procmail_pipe:
24312   driver = pipe
24313   command = /usr/local/bin/procmail -d $local_part
24314   return_path_add
24315   delivery_date_add
24316   envelope_to_add
24317   check_string = "From "
24318   escape_string = ">From "
24319   umask = 077
24320   user = $local_part
24321   group = mail
24322
24323 # router
24324 procmail:
24325   driver = accept
24326   check_local_user
24327   transport = procmail_pipe
24328 .endd
24329 In this example, the pipe is run as the local user, but with the group set to
24330 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24331 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24332 user to supply a correct sender address. If you do not specify either a
24333 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24334 home directory is the user's home directory by default.
24335
24336 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24337 .code
24338 IFS=" "
24339 .endd
24340 as shown in some &%procmail%& documentation, because Exim does not by default
24341 use a shell to run pipe commands.
24342
24343 .cindex "Cyrus"
24344 The next example shows a transport and a router for a system where local
24345 deliveries are handled by the Cyrus IMAP server.
24346 .code
24347 # transport
24348 local_delivery_cyrus:
24349   driver = pipe
24350   command = /usr/cyrus/bin/deliver \
24351             -m ${substr_1:$local_part_suffix} -- $local_part
24352   user = cyrus
24353   group = mail
24354   return_output
24355   log_output
24356   message_prefix =
24357   message_suffix =
24358
24359 # router
24360 local_user_cyrus:
24361   driver = accept
24362   check_local_user
24363   local_part_suffix = .*
24364   transport = local_delivery_cyrus
24365 .endd
24366 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24367 &%return_output%& to cause any text written by Cyrus to be returned to the
24368 sender.
24369 .ecindex IIDpiptra1
24370 .ecindex IIDpiptra2
24371
24372
24373 . ////////////////////////////////////////////////////////////////////////////
24374 . ////////////////////////////////////////////////////////////////////////////
24375
24376 .chapter "The smtp transport" "CHAPsmtptrans"
24377 .scindex IIDsmttra1 "transports" "&(smtp)&"
24378 .scindex IIDsmttra2 "&(smtp)& transport"
24379 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24380 or LMTP protocol. The list of hosts to try can either be taken from the address
24381 that is being processed (having been set up by the router), or specified
24382 explicitly for the transport. Timeout and retry processing (see chapter
24383 &<<CHAPretry>>&) is applied to each IP address independently.
24384
24385
24386 .section "Multiple messages on a single connection" "SECID144"
24387 The sending of multiple messages over a single TCP/IP connection can arise in
24388 two ways:
24389
24390 .ilist
24391 If a message contains more than &%max_rcpt%& (see below) addresses that are
24392 routed to the same host, more than one copy of the message has to be sent to
24393 that host. In this situation, multiple copies may be sent in a single run of
24394 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24395 does when it has too many addresses to send in one message also depends on the
24396 value of the global &%remote_max_parallel%& option. Details are given in
24397 section &<<SECToutSMTPTCP>>&.)
24398 .next
24399 .cindex "hints database" "remembering routing"
24400 When a message has been successfully delivered over a TCP/IP connection, Exim
24401 looks in its hints database to see if there are any other messages awaiting a
24402 connection to the same host. If there are, a new delivery process is started
24403 for one of them, and the current TCP/IP connection is passed on to it. The new
24404 process may in turn send multiple copies and possibly create yet another
24405 process.
24406 .endlist
24407
24408
24409 For each copy sent over the same TCP/IP connection, a sequence counter is
24410 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24411 no further messages are sent over that connection.
24412
24413
24414
24415 .section "Use of the $host and $host_address variables" "SECID145"
24416 .vindex "&$host$&"
24417 .vindex "&$host_address$&"
24418 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24419 &$host_address$& are the name and IP address of the first host on the host list
24420 passed by the router. However, when the transport is about to connect to a
24421 specific host, and while it is connected to that host, &$host$& and
24422 &$host_address$& are set to the values for that host. These are the values
24423 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24424 &%serialize_hosts%&, and the various TLS options are expanded.
24425
24426
24427 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24428 .vindex &$tls_bits$&
24429 .vindex &$tls_cipher$&
24430 .vindex &$tls_peerdn$&
24431 .vindex &$tls_sni$&
24432 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24433 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24434 are the values that were set when the message was received.
24435 These are the values that are used for options that are expanded before any
24436 SMTP connections are made. Just before each connection is made, these four
24437 variables are emptied. If TLS is subsequently started, they are set to the
24438 appropriate values for the outgoing connection, and these are the values that
24439 are in force when any authenticators are run and when the
24440 &%authenticated_sender%& option is expanded.
24441
24442 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24443 and will be removed in a future release.
24444
24445
24446 .section "Private options for smtp" "SECID146"
24447 .cindex "options" "&(smtp)& transport"
24448 The private options of the &(smtp)& transport are as follows:
24449
24450
24451 .option address_retry_include_sender smtp boolean true
24452 .cindex "4&'xx'& responses" "retrying after"
24453 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24454 is the combination of sender and recipient that is delayed in subsequent queue
24455 runs until the retry time is reached. You can delay the recipient without
24456 reference to the sender (which is what earlier versions of Exim did), by
24457 setting &%address_retry_include_sender%& false. However, this can lead to
24458 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24459
24460 .option allow_localhost smtp boolean false
24461 .cindex "local host" "sending to"
24462 .cindex "fallback" "hosts specified on transport"
24463 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24464 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24465 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24466 the delivery anyway. This should be used only in special cases when the
24467 configuration ensures that no looping will result (for example, a differently
24468 configured Exim is listening on the port to which the message is sent).
24469
24470
24471 .option authenticated_sender smtp string&!! unset
24472 .cindex "Cyrus"
24473 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24474 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24475 overriding any existing authenticated sender value. If the string expansion is
24476 forced to fail, the option is ignored. Other expansion failures cause delivery
24477 to be deferred. If the result of expansion is an empty string, that is also
24478 ignored.
24479
24480 The expansion happens after the outgoing connection has been made and TLS
24481 started, if required. This means that the &$host$&, &$host_address$&,
24482 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24483 particular connection.
24484
24485 If the SMTP session is not authenticated, the expansion of
24486 &%authenticated_sender%& still happens (and can cause the delivery to be
24487 deferred if it fails), but no AUTH= item is added to MAIL commands
24488 unless &%authenticated_sender_force%& is true.
24489
24490 This option allows you to use the &(smtp)& transport in LMTP mode to
24491 deliver mail to Cyrus IMAP and provide the proper local part as the
24492 &"authenticated sender"&, via a setting such as:
24493 .code
24494 authenticated_sender = $local_part
24495 .endd
24496 This removes the need for IMAP subfolders to be assigned special ACLs to
24497 allow direct delivery to those subfolders.
24498
24499 Because of expected uses such as that just described for Cyrus (when no
24500 domain is involved), there is no checking on the syntax of the provided
24501 value.
24502
24503
24504 .option authenticated_sender_force smtp boolean false
24505 If this option is set true, the &%authenticated_sender%& option's value
24506 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24507 authenticated as a client.
24508
24509
24510 .option command_timeout smtp time 5m
24511 This sets a timeout for receiving a response to an SMTP command that has been
24512 sent out. It is also used when waiting for the initial banner line from the
24513 remote host. Its value must not be zero.
24514
24515
24516 .option connect_timeout smtp time 5m
24517 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24518 to a remote host. A setting of zero allows the system timeout (typically
24519 several minutes) to act. To have any effect, the value of this option must be
24520 less than the system timeout. However, it has been observed that on some
24521 systems there is no system timeout, which is why the default value for this
24522 option is 5 minutes, a value recommended by RFC 1123.
24523
24524
24525 .option connection_max_messages smtp integer 500
24526 .cindex "SMTP" "passed connection"
24527 .cindex "SMTP" "multiple deliveries"
24528 .cindex "multiple SMTP deliveries"
24529 This controls the maximum number of separate message deliveries that are sent
24530 over a single TCP/IP connection. If the value is zero, there is no limit.
24531 For testing purposes, this value can be overridden by the &%-oB%& command line
24532 option.
24533
24534
24535 .option dane_require_tls_ciphers smtp string&!! unset
24536 .cindex "TLS" "requiring specific ciphers for DANE"
24537 .cindex "cipher" "requiring specific"
24538 .cindex DANE "TLS ciphers"
24539 This option may be used to override &%tls_require_ciphers%& for connections
24540 where DANE has been determined to be in effect.
24541 If not set, then &%tls_require_ciphers%& will be used.
24542 Normal SMTP delivery is not able to make strong demands of TLS cipher
24543 configuration, because delivery will fall back to plaintext.  Once DANE has
24544 been determined to be in effect, there is no plaintext fallback and making the
24545 TLS cipherlist configuration stronger will increase security, rather than
24546 counter-intuitively decreasing it.
24547 If the option expands to be empty or is forced to fail, then it will
24548 be treated as unset and &%tls_require_ciphers%& will be used instead.
24549
24550
24551 .option data_timeout smtp time 5m
24552 This sets a timeout for the transmission of each block in the data portion of
24553 the message. As a result, the overall timeout for a message depends on the size
24554 of the message. Its value must not be zero. See also &%final_timeout%&.
24555
24556
24557 .option dkim_canon smtp string&!! unset
24558 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24559 .option dkim_domain smtp string list&!! unset
24560 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24561 .option dkim_hash smtp string&!! sha256
24562 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24563 .option dkim_identity smtp string&!! unset
24564 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24565 .option dkim_private_key smtp string&!! unset
24566 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24567 .option dkim_selector smtp string&!! unset
24568 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24569 .option dkim_strict smtp string&!! unset
24570 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24571 .option dkim_sign_headers smtp string&!! "per RFC"
24572 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24573 .option dkim_timestamps smtp string&!! unset
24574 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24575
24576
24577 .option delay_after_cutoff smtp boolean true
24578 .cindex "final cutoff" "retries, controlling"
24579 .cindex retry "final cutoff"
24580 This option controls what happens when all remote IP addresses for a given
24581 domain have been inaccessible for so long that they have passed their retry
24582 cutoff times.
24583
24584 In the default state, if the next retry time has not been reached for any of
24585 them, the address is bounced without trying any deliveries. In other words,
24586 Exim delays retrying an IP address after the final cutoff time until a new
24587 retry time is reached, and can therefore bounce an address without ever trying
24588 a delivery, when machines have been down for a long time. Some people are
24589 unhappy at this prospect, so...
24590
24591 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24592 addresses are past their final cutoff time, Exim tries to deliver to those
24593 IP addresses that have not been tried since the message arrived. If there are
24594 none, of if they all fail, the address is bounced. In other words, it does not
24595 delay when a new message arrives, but immediately tries those expired IP
24596 addresses that haven't been tried since the message arrived. If there is a
24597 continuous stream of messages for the dead hosts, unsetting
24598 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24599 to them.
24600
24601
24602 .option dns_qualify_single smtp boolean true
24603 If the &%hosts%& or &%fallback_hosts%& option is being used,
24604 and the &%gethostbyname%& option is false,
24605 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24606 in chapter &<<CHAPdnslookup>>& for more details.
24607
24608
24609 .option dns_search_parents smtp boolean false
24610 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24611 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24612 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24613 details.
24614
24615
24616 .option dnssec_request_domains smtp "domain list&!!" *
24617 .cindex "MX record" "security"
24618 .cindex "DNSSEC" "MX lookup"
24619 .cindex "security" "MX lookup"
24620 .cindex "DNS" "DNSSEC"
24621 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24622 the dnssec request bit set. Setting this transport option is only useful if the
24623 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24624 router option.
24625
24626
24627
24628 .option dnssec_require_domains smtp "domain list&!!" unset
24629 .cindex "MX record" "security"
24630 .cindex "DNSSEC" "MX lookup"
24631 .cindex "security" "MX lookup"
24632 .cindex "DNS" "DNSSEC"
24633 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24634 the dnssec request bit set.  Setting this transport option is only
24635 useful if the transport overrides or sets the host names. See the
24636 &%dnssec_require_domains%& router option.
24637
24638
24639
24640 .option dscp smtp string&!! unset
24641 .cindex "DCSP" "outbound"
24642 This option causes the DSCP value associated with a socket to be set to one
24643 of a number of fixed strings or to numeric value.
24644 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24645 Common values include &`throughput`&, &`mincost`&, and on newer systems
24646 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24647
24648 The outbound packets from Exim will be marked with this value in the header
24649 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24650 that these values will have any effect, not be stripped by networking
24651 equipment, or do much of anything without cooperation with your Network
24652 Engineer and those of all network operators between the source and destination.
24653
24654
24655 .option fallback_hosts smtp "string list" unset
24656 .cindex "fallback" "hosts specified on transport"
24657 String expansion is not applied to this option. The argument must be a
24658 colon-separated list of host names or IP addresses, optionally also including
24659 port numbers, though the separator can be changed, as described in section
24660 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24661 item in a &%route_list%& setting for the &(manualroute)& router, as described
24662 in section &<<SECTformatonehostitem>>&.
24663
24664 Fallback hosts can also be specified on routers, which associate them with the
24665 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24666 &%fallback_hosts%& specified on the transport is used only if the address does
24667 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24668 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24669 However, &%hosts_randomize%& does apply to fallback host lists.
24670
24671 If Exim is unable to deliver to any of the hosts for a particular address, and
24672 the errors are not permanent rejections, the address is put on a separate
24673 transport queue with its host list replaced by the fallback hosts, unless the
24674 address was routed via MX records and the current host was in the original MX
24675 list. In that situation, the fallback host list is not used.
24676
24677 Once normal deliveries are complete, the fallback queue is delivered by
24678 re-running the same transports with the new host lists. If several failing
24679 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24680 copy of the message is sent.
24681
24682 The resolution of the host names on the fallback list is controlled by the
24683 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24684 both to cases when the host list comes with the address and when it is taken
24685 from &%hosts%&. This option provides a &"use a smart host only if delivery
24686 fails"& facility.
24687
24688
24689 .option final_timeout smtp time 10m
24690 This is the timeout that applies while waiting for the response to the final
24691 line containing just &"."& that terminates a message. Its value must not be
24692 zero.
24693
24694 .option gethostbyname smtp boolean false
24695 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24696 being used, names are looked up using &[gethostbyname()]&
24697 (or &[getipnodebyname()]& when available)
24698 instead of using the DNS. Of course, that function may in fact use the DNS, but
24699 it may also consult other sources of information such as &_/etc/hosts_&.
24700
24701 .option gnutls_compat_mode smtp boolean unset
24702 This option controls whether GnuTLS is used in compatibility mode in an Exim
24703 server. This reduces security slightly, but improves interworking with older
24704 implementations of TLS.
24705
24706 .option helo_data smtp string&!! "see below"
24707 .cindex "HELO" "argument, setting"
24708 .cindex "EHLO" "argument, setting"
24709 .cindex "LHLO argument setting"
24710 The value of this option is expanded after a connection to a another host has
24711 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24712 command that starts the outgoing SMTP or LMTP session. The default value of the
24713 option is:
24714 .code
24715 $primary_hostname
24716 .endd
24717 During the expansion, the variables &$host$& and &$host_address$& are set to
24718 the identity of the remote host, and the variables &$sending_ip_address$& and
24719 &$sending_port$& are set to the local IP address and port number that are being
24720 used. These variables can be used to generate different values for different
24721 servers or different local IP addresses. For example, if you want the string
24722 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24723 interface address, you could use this:
24724 .code
24725 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24726   {$primary_hostname}}
24727 .endd
24728 The use of &%helo_data%& applies both to sending messages and when doing
24729 callouts.
24730
24731 .option hosts smtp "string list&!!" unset
24732 Hosts are associated with an address by a router such as &(dnslookup)&, which
24733 finds the hosts by looking up the address domain in the DNS, or by
24734 &(manualroute)&, which has lists of hosts in its configuration. However,
24735 email addresses can be passed to the &(smtp)& transport by any router, and not
24736 all of them can provide an associated list of hosts.
24737
24738 The &%hosts%& option specifies a list of hosts to be used if the address being
24739 processed does not have any hosts associated with it. The hosts specified by
24740 &%hosts%& are also used, whether or not the address has its own hosts, if
24741 &%hosts_override%& is set.
24742
24743 The string is first expanded, before being interpreted as a colon-separated
24744 list of host names or IP addresses, possibly including port numbers. The
24745 separator may be changed to something other than colon, as described in section
24746 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24747 item in a &%route_list%& setting for the &(manualroute)& router, as described
24748 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24749 of the &(manualroute)& router is not available here.
24750
24751 If the expansion fails, delivery is deferred. Unless the failure was caused by
24752 the inability to complete a lookup, the error is logged to the panic log as
24753 well as the main log. Host names are looked up either by searching directly for
24754 address records in the DNS or by calling &[gethostbyname()]& (or
24755 &[getipnodebyname()]& when available), depending on the setting of the
24756 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24757 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24758 address are used.
24759
24760 During delivery, the hosts are tried in order, subject to their retry status,
24761 unless &%hosts_randomize%& is set.
24762
24763
24764 .option hosts_avoid_esmtp smtp "host list&!!" unset
24765 .cindex "ESMTP, avoiding use of"
24766 .cindex "HELO" "forcing use of"
24767 .cindex "EHLO" "avoiding use of"
24768 .cindex "PIPELINING" "avoiding the use of"
24769 This option is for use with broken hosts that announce ESMTP facilities (for
24770 example, PIPELINING) and then fail to implement them properly. When a host
24771 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24772 start of the SMTP session. This means that it cannot use any of the ESMTP
24773 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24774
24775
24776 .option hosts_avoid_pipelining smtp "host list&!!" unset
24777 .cindex "PIPELINING" "avoiding the use of"
24778 Exim will not use the SMTP PIPELINING extension when delivering to any host
24779 that matches this list, even if the server host advertises PIPELINING support.
24780
24781 .new
24782 .option hosts_pipe_connect smtp "host list&!!" unset
24783 .cindex "pipelining" "early connection"
24784 .cindex "pipelining" PIPE_CONNECT
24785 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24786 this option controls which to hosts the facility watched for
24787 and recorded, and used for subsequent connections.
24788
24789 The retry hints database is used for the record,
24790 and records are subject to the &%retry_data_expire%& option.
24791 When used, the pipelining saves on roundtrip times.
24792 It also turns SMTP into a client-first protocol
24793 so combines well with TCP Fast Open.
24794
24795 See also the &%pipelining_connect_advertise_hosts%& main option.
24796
24797 Note:
24798 When the facility is used, the transport &%helo_data%& option
24799 will be expanded before the &$sending_ip_address$& variable
24800 is filled in.
24801 A check is made for the use of that variable, without the
24802 presence of a &"def:"& test on it, but suitably complex coding
24803 can avoid the check and produce unexpected results.
24804 You have been warned.
24805 .wen
24806
24807
24808 .option hosts_avoid_tls smtp "host list&!!" unset
24809 .cindex "TLS" "avoiding for certain hosts"
24810 Exim will not try to start a TLS session when delivering to any host that
24811 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24812
24813 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24814 .cindex "TLS" "avoiding for certain hosts"
24815 Exim will not try to start a TLS session for a verify callout,
24816 or when delivering in cutthrough mode,
24817 to any host that matches this list.
24818
24819
24820 .option hosts_max_try smtp integer 5
24821 .cindex "host" "maximum number to try"
24822 .cindex "limit" "number of hosts tried"
24823 .cindex "limit" "number of MX tried"
24824 .cindex "MX record" "maximum tried"
24825 This option limits the number of IP addresses that are tried for any one
24826 delivery in cases where there are temporary delivery errors. Section
24827 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24828
24829
24830 .option hosts_max_try_hardlimit smtp integer 50
24831 This is an additional check on the maximum number of IP addresses that Exim
24832 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24833 why it exists.
24834
24835
24836
24837 .option hosts_nopass_tls smtp "host list&!!" unset
24838 .cindex "TLS" "passing connection"
24839 .cindex "multiple SMTP deliveries"
24840 .cindex "TLS" "multiple message deliveries"
24841 For any host that matches this list, a connection on which a TLS session has
24842 been started will not be passed to a new delivery process for sending another
24843 message on the same connection. See section &<<SECTmulmessam>>& for an
24844 explanation of when this might be needed.
24845
24846 .new
24847 .option hosts_noproxy_tls smtp "host list&!!" unset
24848 .cindex "TLS" "passing connection"
24849 .cindex "multiple SMTP deliveries"
24850 .cindex "TLS" "multiple message deliveries"
24851 For any host that matches this list, a TLS session which has
24852 been started will not be passed to a new delivery process for sending another
24853 message on the same session.
24854 .wen
24855
24856 The traditional implementation closes down TLS and re-starts it in the new
24857 process, on the same open TCP connection, for each successive message
24858 sent.  If permitted by this option a pipe to to the new process is set up
24859 instead, and the original process maintains the TLS connection and proxies
24860 the SMTP connection from and to the new process and any subsequents.
24861 The new process has no access to TLS information, so cannot include it in
24862 logging.
24863
24864
24865
24866 .option hosts_override smtp boolean false
24867 If this option is set and the &%hosts%& option is also set, any hosts that are
24868 attached to the address are ignored, and instead the hosts specified by the
24869 &%hosts%& option are always used. This option does not apply to
24870 &%fallback_hosts%&.
24871
24872
24873 .option hosts_randomize smtp boolean false
24874 .cindex "randomized host list"
24875 .cindex "host" "list of; randomized"
24876 .cindex "fallback" "randomized hosts"
24877 If this option is set, and either the list of hosts is taken from the
24878 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24879 were not obtained from MX records (this includes fallback hosts from the
24880 router), and were not randomized by the router, the order of trying the hosts
24881 is randomized each time the transport runs. Randomizing the order of a host
24882 list can be used to do crude load sharing.
24883
24884 When &%hosts_randomize%& is true, a host list may be split into groups whose
24885 order is separately randomized. This makes it possible to set up MX-like
24886 behaviour. The boundaries between groups are indicated by an item that is just
24887 &`+`& in the host list. For example:
24888 .code
24889 hosts = host1:host2:host3:+:host4:host5
24890 .endd
24891 The order of the first three hosts and the order of the last two hosts is
24892 randomized for each use, but the first three always end up before the last two.
24893 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24894
24895 .option hosts_require_auth smtp "host list&!!" unset
24896 .cindex "authentication" "required by client"
24897 This option provides a list of servers for which authentication must succeed
24898 before Exim will try to transfer a message. If authentication fails for
24899 servers which are not in this list, Exim tries to send unauthenticated. If
24900 authentication fails for one of these servers, delivery is deferred. This
24901 temporary error is detectable in the retry rules, so it can be turned into a
24902 hard failure if required. See also &%hosts_try_auth%&, and chapter
24903 &<<CHAPSMTPAUTH>>& for details of authentication.
24904
24905
24906 .option hosts_request_ocsp smtp "host list&!!" *
24907 .cindex "TLS" "requiring for certain servers"
24908 Exim will request a Certificate Status on a
24909 TLS session for any host that matches this list.
24910 &%tls_verify_certificates%& should also be set for the transport.
24911
24912 .option hosts_require_dane smtp "host list&!!" unset
24913 .cindex DANE "transport options"
24914 .cindex DANE "requiring for certain servers"
24915 If built with DANE support, Exim  will require that a DNSSEC-validated
24916 TLSA record is present for any host matching the list,
24917 and that a DANE-verified TLS connection is made. See
24918 the &%dnssec_request_domains%& router and transport options.
24919 There will be no fallback to in-clear communication.
24920 See section &<<SECDANE>>&.
24921
24922 .option hosts_require_ocsp smtp "host list&!!" unset
24923 .cindex "TLS" "requiring for certain servers"
24924 Exim will request, and check for a valid Certificate Status being given, on a
24925 TLS session for any host that matches this list.
24926 &%tls_verify_certificates%& should also be set for the transport.
24927
24928 .option hosts_require_tls smtp "host list&!!" unset
24929 .cindex "TLS" "requiring for certain servers"
24930 Exim will insist on using a TLS session when delivering to any host that
24931 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24932 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24933 incoming messages, use an appropriate ACL.
24934
24935 .option hosts_try_auth smtp "host list&!!" unset
24936 .cindex "authentication" "optional in client"
24937 This option provides a list of servers to which, provided they announce
24938 authentication support, Exim will attempt to authenticate as a client when it
24939 connects. If authentication fails, Exim will try to transfer the message
24940 unauthenticated. See also &%hosts_require_auth%&, and chapter
24941 &<<CHAPSMTPAUTH>>& for details of authentication.
24942
24943 .option hosts_try_chunking smtp "host list&!!" *
24944 .cindex CHUNKING "enabling, in client"
24945 .cindex BDAT "SMTP command"
24946 .cindex "RFC 3030" "CHUNKING"
24947 This option provides a list of servers to which, provided they announce
24948 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24949 BDAT will not be used in conjunction with a transport filter.
24950
24951 .option hosts_try_dane smtp "host list&!!" *
24952 .cindex DANE "transport options"
24953 .cindex DANE "attempting for certain servers"
24954 If built with DANE support, Exim  will require that a DNSSEC-validated
24955 TLSA record is present for any host matching the list,
24956 and that a DANE-verified TLS connection is made. See
24957 the &%dnssec_request_domains%& router and transport options.
24958 There will be no fallback to in-clear communication.
24959 See section &<<SECDANE>>&.
24960
24961 .option hosts_try_fastopen smtp "host list&!!" *
24962 .cindex "fast open, TCP" "enabling, in client"
24963 .cindex "TCP Fast Open" "enabling, in client"
24964 .cindex "RFC 7413" "TCP Fast Open"
24965 This option provides a list of servers to which, provided
24966 the facility is supported by this system, Exim will attempt to
24967 perform a TCP Fast Open.
24968 No data is sent on the SYN segment but, if the remote server also
24969 supports the facility, it can send its SMTP banner immediately after
24970 the SYN,ACK segment.  This can save up to one round-trip time.
24971
24972 The facility is only active for previously-contacted servers,
24973 as the initiator must present a cookie in the SYN segment.
24974
24975 On (at least some) current Linux distributions the facility must be enabled
24976 in the kernel by the sysadmin before the support is usable.
24977 There is no option for control of the server side; if the system supports
24978 it it is always enabled.  Note that lengthy operations in the connect ACL,
24979 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24980
24981 .option hosts_try_prdr smtp "host list&!!" *
24982 .cindex "PRDR" "enabling, optional in client"
24983 This option provides a list of servers to which, provided they announce
24984 PRDR support, Exim will attempt to negotiate PRDR
24985 for multi-recipient messages.
24986 The option can usually be left as default.
24987
24988 .option interface smtp "string list&!!" unset
24989 .cindex "bind IP address"
24990 .cindex "IP address" "binding"
24991 .vindex "&$host$&"
24992 .vindex "&$host_address$&"
24993 This option specifies which interface to bind to when making an outgoing SMTP
24994 call. The value is an IP address, not an interface name such as
24995 &`eth0`&. Do not confuse this with the interface address that was used when a
24996 message was received, which is in &$received_ip_address$&, formerly known as
24997 &$interface_address$&. The name was changed to minimize confusion with the
24998 outgoing interface address. There is no variable that contains an outgoing
24999 interface address because, unless it is set by this option, its value is
25000 unknown.
25001
25002 During the expansion of the &%interface%& option the variables &$host$& and
25003 &$host_address$& refer to the host to which a connection is about to be made
25004 during the expansion of the string. Forced expansion failure, or an empty
25005 string result causes the option to be ignored. Otherwise, after expansion, the
25006 string must be a list of IP addresses, colon-separated by default, but the
25007 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25008 For example:
25009 .code
25010 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25011 .endd
25012 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25013 connection. If none of them are the correct type, the option is ignored. If
25014 &%interface%& is not set, or is ignored, the system's IP functions choose which
25015 interface to use if the host has more than one.
25016
25017
25018 .option keepalive smtp boolean true
25019 .cindex "keepalive" "on outgoing connection"
25020 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25021 connections. When set, it causes the kernel to probe idle connections
25022 periodically, by sending packets with &"old"& sequence numbers. The other end
25023 of the connection should send a acknowledgment if the connection is still okay
25024 or a reset if the connection has been aborted. The reason for doing this is
25025 that it has the beneficial effect of freeing up certain types of connection
25026 that can get stuck when the remote host is disconnected without tidying up the
25027 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25028 unreachable hosts.
25029
25030
25031 .option lmtp_ignore_quota smtp boolean false
25032 .cindex "LMTP" "ignoring quota errors"
25033 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25034 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25035 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25036
25037 .option max_rcpt smtp integer 100
25038 .cindex "RCPT" "maximum number of outgoing"
25039 This option limits the number of RCPT commands that are sent in a single
25040 SMTP message transaction. Each set of addresses is treated independently, and
25041 so can cause parallel connections to the same host if &%remote_max_parallel%&
25042 permits this.
25043
25044
25045 .option multi_domain smtp boolean&!! true
25046 .vindex "&$domain$&"
25047 When this option is set, the &(smtp)& transport can handle a number of
25048 addresses containing a mixture of different domains provided they all resolve
25049 to the same list of hosts. Turning the option off restricts the transport to
25050 handling only one domain at a time. This is useful if you want to use
25051 &$domain$& in an expansion for the transport, because it is set only when there
25052 is a single domain involved in a remote delivery.
25053
25054 It is expanded per-address and can depend on any of
25055 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25056 &$host$&, &$host_address$& and &$host_port$&.
25057
25058 .option port smtp string&!! "see below"
25059 .cindex "port" "sending TCP/IP"
25060 .cindex "TCP/IP" "setting outgoing port"
25061 This option specifies the TCP/IP port on the server to which Exim connects.
25062 &*Note:*& Do not confuse this with the port that was used when a message was
25063 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25064 The name was changed to minimize confusion with the outgoing port. There is no
25065 variable that contains an outgoing port.
25066
25067 If the value of this option begins with a digit it is taken as a port number;
25068 otherwise it is looked up using &[getservbyname()]&. The default value is
25069 normally &"smtp"&,
25070 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25071 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25072 If the expansion fails, or if a port number cannot be found, delivery
25073 is deferred.
25074
25075 Note that at least one Linux distribution has been seen failing
25076 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25077
25078
25079
25080 .option protocol smtp string smtp
25081 .cindex "LMTP" "over TCP/IP"
25082 .cindex "ssmtp protocol" "outbound"
25083 .cindex "TLS" "SSL-on-connect outbound"
25084 .vindex "&$port$&"
25085 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25086 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25087 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25088 deliveries into closed message stores. Exim also has support for running LMTP
25089 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25090
25091 If this option is set to &"smtps"&, the default value for the &%port%& option
25092 changes to &"smtps"&, and the transport initiates TLS immediately after
25093 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25094 The Internet standards bodies used to strongly discourage use of this mode,
25095 but as of RFC 8314 it is perferred over STARTTLS for message submission
25096 (as distinct from MTA-MTA communication).
25097
25098
25099 .option retry_include_ip_address smtp boolean&!! true
25100 Exim normally includes both the host name and the IP address in the key it
25101 constructs for indexing retry data after a temporary delivery failure. This
25102 means that when one of several IP addresses for a host is failing, it gets
25103 tried periodically (controlled by the retry rules), but use of the other IP
25104 addresses is not affected.
25105
25106 However, in some dialup environments hosts are assigned a different IP address
25107 each time they connect. In this situation the use of the IP address as part of
25108 the retry key leads to undesirable behaviour. Setting this option false causes
25109 Exim to use only the host name.
25110 Since it is expanded it can be made to depend on the host or domain.
25111
25112
25113 .option serialize_hosts smtp "host list&!!" unset
25114 .cindex "serializing connections"
25115 .cindex "host" "serializing connections"
25116 Because Exim operates in a distributed manner, if several messages for the same
25117 host arrive at around the same time, more than one simultaneous connection to
25118 the remote host can occur. This is not usually a problem except when there is a
25119 slow link between the hosts. In that situation it may be helpful to restrict
25120 Exim to one connection at a time. This can be done by setting
25121 &%serialize_hosts%& to match the relevant hosts.
25122
25123 .cindex "hints database" "serializing deliveries to a host"
25124 Exim implements serialization by means of a hints database in which a record is
25125 written whenever a process connects to one of the restricted hosts. The record
25126 is deleted when the connection is completed. Obviously there is scope for
25127 records to get left lying around if there is a system or program crash. To
25128 guard against this, Exim ignores any records that are more than six hours old.
25129
25130 If you set up this kind of serialization, you should also arrange to delete the
25131 relevant hints database whenever your system reboots. The names of the files
25132 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25133 may be one or two files, depending on the type of DBM in use. The same files
25134 are used for ETRN serialization.
25135
25136 See also the &%max_parallel%& generic transport option.
25137
25138
25139 .option size_addition smtp integer 1024
25140 .cindex "SMTP" "SIZE"
25141 .cindex "message" "size issue for transport filter"
25142 .cindex "size" "of message"
25143 .cindex "transport" "filter"
25144 .cindex "filter" "transport filter"
25145 If a remote SMTP server indicates that it supports the SIZE option of the
25146 MAIL command, Exim uses this to pass over the message size at the start of
25147 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25148 sends, to allow for headers and other text that may be added during delivery by
25149 configuration options or in a transport filter. It may be necessary to increase
25150 this if a lot of text is added to messages.
25151
25152 Alternatively, if the value of &%size_addition%& is set negative, it disables
25153 the use of the SIZE option altogether.
25154
25155
25156 .option socks_proxy smtp string&!! unset
25157 .cindex proxy SOCKS
25158 This option enables use of SOCKS proxies for connections made by the
25159 transport.  For details see section &<<SECTproxySOCKS>>&.
25160
25161
25162 .option tls_certificate smtp string&!! unset
25163 .cindex "TLS" "client certificate, location of"
25164 .cindex "certificate" "client, location of"
25165 .vindex "&$host$&"
25166 .vindex "&$host_address$&"
25167 The value of this option must be the absolute path to a file which contains the
25168 client's certificate, for possible use when sending a message over an encrypted
25169 connection. The values of &$host$& and &$host_address$& are set to the name and
25170 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25171 details of TLS.
25172
25173 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25174 certificate when sending messages as a client. The global option of the same
25175 name specifies the certificate for Exim as a server; it is not automatically
25176 assumed that the same certificate should be used when Exim is operating as a
25177 client.
25178
25179
25180 .option tls_crl smtp string&!! unset
25181 .cindex "TLS" "client certificate revocation list"
25182 .cindex "certificate" "revocation list for client"
25183 This option specifies a certificate revocation list. The expanded value must
25184 be the name of a file that contains a CRL in PEM format.
25185
25186
25187 .option tls_dh_min_bits smtp integer 1024
25188 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25189 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25190 key agreement is negotiated, the server will provide a large prime number
25191 for use.  This option establishes the minimum acceptable size of that number.
25192 If the parameter offered by the server is too small, then the TLS handshake
25193 will fail.
25194
25195 Only supported when using GnuTLS.
25196
25197
25198 .option tls_privatekey smtp string&!! unset
25199 .cindex "TLS" "client private key, location of"
25200 .vindex "&$host$&"
25201 .vindex "&$host_address$&"
25202 The value of this option must be the absolute path to a file which contains the
25203 client's private key. This is used when sending a message over an encrypted
25204 connection using a client certificate. The values of &$host$& and
25205 &$host_address$& are set to the name and address of the server during the
25206 expansion. If this option is unset, or the expansion is forced to fail, or the
25207 result is an empty string, the private key is assumed to be in the same file as
25208 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25209
25210
25211 .option tls_require_ciphers smtp string&!! unset
25212 .cindex "TLS" "requiring specific ciphers"
25213 .cindex "cipher" "requiring specific"
25214 .vindex "&$host$&"
25215 .vindex "&$host_address$&"
25216 The value of this option must be a list of permitted cipher suites, for use
25217 when setting up an outgoing encrypted connection. (There is a global option of
25218 the same name for controlling incoming connections.) The values of &$host$& and
25219 &$host_address$& are set to the name and address of the server during the
25220 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25221 is used in different ways by OpenSSL and GnuTLS (see sections
25222 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25223 ciphers is a preference order.
25224
25225
25226
25227 .option tls_sni smtp string&!! unset
25228 .cindex "TLS" "Server Name Indication"
25229 .vindex "&$tls_sni$&"
25230 If this option is set then it sets the $tls_out_sni variable and causes any
25231 TLS session to pass this value as the Server Name Indication extension to
25232 the remote side, which can be used by the remote side to select an appropriate
25233 certificate and private key for the session.
25234
25235 See &<<SECTtlssni>>& for more information.
25236
25237 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25238 TLS extensions.
25239
25240
25241
25242
25243 .option tls_tempfail_tryclear smtp boolean true
25244 .cindex "4&'xx'& responses" "to STARTTLS"
25245 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25246 setting up a TLS session, this option determines whether or not Exim should try
25247 to deliver the message unencrypted. If it is set false, delivery to the
25248 current host is deferred; if there are other hosts, they are tried. If this
25249 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25250 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25251 TLS negotiation fails, Exim closes the current connection (because it is in an
25252 unknown state), opens a new one to the same host, and then tries the delivery
25253 in clear.
25254
25255
25256 .option tls_try_verify_hosts smtp "host list&!!" *
25257 .cindex "TLS" "server certificate verification"
25258 .cindex "certificate" "verification of server"
25259 This option gives a list of hosts for which, on encrypted connections,
25260 certificate verification will be tried but need not succeed.
25261 The &%tls_verify_certificates%& option must also be set.
25262 Note that unless the host is in this list
25263 TLS connections will be denied to hosts using self-signed certificates
25264 when &%tls_verify_certificates%& is matched.
25265 The &$tls_out_certificate_verified$& variable is set when
25266 certificate verification succeeds.
25267
25268
25269 .option tls_verify_cert_hostnames smtp "host list&!!" *
25270 .cindex "TLS" "server certificate hostname verification"
25271 .cindex "certificate" "verification of server"
25272 This option give a list of hosts for which,
25273 while verifying the server certificate,
25274 checks will be included on the host name
25275 (note that this will generally be the result of a DNS MX lookup)
25276 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25277 limited to being the initial component of a 3-or-more component FQDN.
25278
25279 There is no equivalent checking on client certificates.
25280
25281
25282 .option tls_verify_certificates smtp string&!! system
25283 .cindex "TLS" "server certificate verification"
25284 .cindex "certificate" "verification of server"
25285 .vindex "&$host$&"
25286 .vindex "&$host_address$&"
25287 The value of this option must be either the
25288 word "system"
25289 or the absolute path to
25290 a file or directory containing permitted certificates for servers,
25291 for use when setting up an encrypted connection.
25292
25293 The "system" value for the option will use a location compiled into the SSL library.
25294 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25295 is taken as empty and an explicit location
25296 must be specified.
25297
25298 The use of a directory for the option value is not available for GnuTLS versions
25299 preceding 3.3.6 and a single file must be used.
25300
25301 With OpenSSL the certificates specified
25302 explicitly
25303 either by file or directory
25304 are added to those given by the system default location.
25305
25306 The values of &$host$& and
25307 &$host_address$& are set to the name and address of the server during the
25308 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25309
25310 For back-compatibility,
25311 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25312 (a single-colon empty list counts as being set)
25313 and certificate verification fails the TLS connection is closed.
25314
25315
25316 .option tls_verify_hosts smtp "host list&!!" unset
25317 .cindex "TLS" "server certificate verification"
25318 .cindex "certificate" "verification of server"
25319 This option gives a list of hosts for which, on encrypted connections,
25320 certificate verification must succeed.
25321 The &%tls_verify_certificates%& option must also be set.
25322 If both this option and &%tls_try_verify_hosts%& are unset
25323 operation is as if this option selected all hosts.
25324
25325 .option utf8_downconvert smtp integer!! unset
25326 .cindex utf8 "address downconversion"
25327 .cindex i18n "utf8 address downconversion"
25328 If built with internationalization support,
25329 this option controls conversion of UTF-8 in message addresses
25330 to a-label form.
25331 For details see section &<<SECTi18nMTA>>&.
25332
25333
25334
25335
25336 .section "How the limits for the number of hosts to try are used" &&&
25337          "SECTvalhosmax"
25338 .cindex "host" "maximum number to try"
25339 .cindex "limit" "hosts; maximum number tried"
25340 There are two options that are concerned with the number of hosts that are
25341 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25342 &%hosts_max_try_hardlimit%&.
25343
25344
25345 The &%hosts_max_try%& option limits the number of hosts that are tried
25346 for a single delivery. However, despite the term &"host"& in its name, the
25347 option actually applies to each IP address independently. In other words, a
25348 multihomed host is treated as several independent hosts, just as it is for
25349 retrying.
25350
25351 Many of the larger ISPs have multiple MX records which often point to
25352 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25353 created as a result of routing one of these domains.
25354
25355 Trying every single IP address on such a long list does not seem sensible; if
25356 several at the top of the list fail, it is reasonable to assume there is some
25357 problem that is likely to affect all of them. Roughly speaking, the value of
25358 &%hosts_max_try%& is the maximum number that are tried before deferring the
25359 delivery. However, the logic cannot be quite that simple.
25360
25361 Firstly, IP addresses that are skipped because their retry times have not
25362 arrived do not count, and in addition, addresses that are past their retry
25363 limits are also not counted, even when they are tried. This means that when
25364 some IP addresses are past their retry limits, more than the value of
25365 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25366 that all IP addresses are considered before timing out an email address (but
25367 see below for an exception).
25368
25369 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25370 list to see if there is a subsequent host with a different (higher valued) MX.
25371 If there is, that host is considered next, and the current IP address is used
25372 but not counted. This behaviour helps in the case of a domain with a retry rule
25373 that hardly ever delays any hosts, as is now explained:
25374
25375 Consider the case of a long list of hosts with one MX value, and a few with a
25376 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25377 hosts at the top of the list are tried at first. With the default retry rule,
25378 which specifies increasing retry times, the higher MX hosts are eventually
25379 tried when those at the top of the list are skipped because they have not
25380 reached their retry times.
25381
25382 However, it is common practice to put a fixed short retry time on domains for
25383 large ISPs, on the grounds that their servers are rarely down for very long.
25384 Unfortunately, these are exactly the domains that tend to resolve to long lists
25385 of hosts. The short retry time means that the lowest MX hosts are tried every
25386 time. The attempts may be in a different order because of random sorting, but
25387 without the special MX check, the higher MX hosts would never be tried until
25388 all the lower MX hosts had timed out (which might be several days), because
25389 there are always some lower MX hosts that have reached their retry times. With
25390 the special check, Exim considers at least one IP address from each MX value at
25391 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25392 reached.
25393
25394 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25395 particular, Exim normally eventually tries all the IP addresses before timing
25396 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25397 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25398 been set up with hundreds of IP addresses for some domains. It can
25399 take a very long time indeed for an address to time out in these cases.
25400
25401 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25402 Exim never tries more than this number of IP addresses; if it hits this limit
25403 and they are all timed out, the email address is bounced, even though not all
25404 possible IP addresses have been tried.
25405 .ecindex IIDsmttra1
25406 .ecindex IIDsmttra2
25407
25408
25409
25410
25411
25412 . ////////////////////////////////////////////////////////////////////////////
25413 . ////////////////////////////////////////////////////////////////////////////
25414
25415 .chapter "Address rewriting" "CHAPrewrite"
25416 .scindex IIDaddrew "rewriting" "addresses"
25417 There are some circumstances in which Exim automatically rewrites domains in
25418 addresses. The two most common are when an address is given without a domain
25419 (referred to as an &"unqualified address"&) or when an address contains an
25420 abbreviated domain that is expanded by DNS lookup.
25421
25422 Unqualified envelope addresses are accepted only for locally submitted
25423 messages, or for messages that are received from hosts matching
25424 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25425 appropriate. Unqualified addresses in header lines are qualified if they are in
25426 locally submitted messages, or messages from hosts that are permitted to send
25427 unqualified envelope addresses. Otherwise, unqualified addresses in header
25428 lines are neither qualified nor rewritten.
25429
25430 One situation in which Exim does &'not'& automatically rewrite a domain is
25431 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25432 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25433 do this. The new RFCs do not contain this suggestion.
25434
25435
25436 .section "Explicitly configured address rewriting" "SECID147"
25437 This chapter describes the rewriting rules that can be used in the
25438 main rewrite section of the configuration file, and also in the generic
25439 &%headers_rewrite%& option that can be set on any transport.
25440
25441 Some people believe that configured address rewriting is a Mortal Sin.
25442 Others believe that life is not possible without it. Exim provides the
25443 facility; you do not have to use it.
25444
25445 The main rewriting rules that appear in the &"rewrite"& section of the
25446 configuration file are applied to addresses in incoming messages, both envelope
25447 addresses and addresses in header lines. Each rule specifies the types of
25448 address to which it applies.
25449
25450 Whether or not addresses in header lines are rewritten depends on the origin of
25451 the headers and the type of rewriting. Global rewriting, that is, rewriting
25452 rules from the rewrite section of the configuration file, is applied only to
25453 those headers that were received with the message. Header lines that are added
25454 by ACLs or by a system filter or by individual routers or transports (which
25455 are specific to individual recipient addresses) are not rewritten by the global
25456 rules.
25457
25458 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25459 applies all headers except those added by routers and transports. That is, as
25460 well as the headers that were received with the message, it also applies to
25461 headers that were added by an ACL or a system filter.
25462
25463
25464 In general, rewriting addresses from your own system or domain has some
25465 legitimacy. Rewriting other addresses should be done only with great care and
25466 in special circumstances. The author of Exim believes that rewriting should be
25467 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25468 Although it can sometimes be used as a routing tool, this is very strongly
25469 discouraged.
25470
25471 There are two commonly encountered circumstances where rewriting is used, as
25472 illustrated by these examples:
25473
25474 .ilist
25475 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25476 exchange mail with each other behind a firewall, but there is only a single
25477 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25478 &'hitch.fict.example'& when sending mail off-site.
25479 .next
25480 A host rewrites the local parts of its own users so that, for example,
25481 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25482 .endlist
25483
25484
25485
25486 .section "When does rewriting happen?" "SECID148"
25487 .cindex "rewriting" "timing of"
25488 .cindex "&ACL;" "rewriting addresses in"
25489 Configured address rewriting can take place at several different stages of a
25490 message's processing.
25491
25492 .vindex "&$sender_address$&"
25493 At the start of an ACL for MAIL, the sender address may have been rewritten
25494 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25495 ordinary rewrite rules have yet been applied. If, however, the sender address
25496 is verified in the ACL, it is rewritten before verification, and remains
25497 rewritten thereafter. The subsequent value of &$sender_address$& is the
25498 rewritten address. This also applies if sender verification happens in a
25499 RCPT ACL. Otherwise, when the sender address is not verified, it is
25500 rewritten as soon as a message's header lines have been received.
25501
25502 .vindex "&$domain$&"
25503 .vindex "&$local_part$&"
25504 Similarly, at the start of an ACL for RCPT, the current recipient's address
25505 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25506 rewrite rules have yet been applied to it. However, the behaviour is different
25507 from the sender address when a recipient is verified. The address is rewritten
25508 for the verification, but the rewriting is not remembered at this stage. The
25509 value of &$local_part$& and &$domain$& after verification are always the same
25510 as they were before (that is, they contain the unrewritten &-- except for
25511 SMTP-time rewriting &-- address).
25512
25513 As soon as a message's header lines have been received, all the envelope
25514 recipient addresses are permanently rewritten, and rewriting is also applied to
25515 the addresses in the header lines (if configured). This happens before adding
25516 any header lines that were specified in MAIL or RCPT ACLs, and
25517 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25518 before the DATA ACL and &[local_scan()]& functions are run.
25519
25520 When an address is being routed, either for delivery or for verification,
25521 rewriting is applied immediately to child addresses that are generated by
25522 redirection, unless &%no_rewrite%& is set on the router.
25523
25524 .cindex "envelope from"
25525 .cindex "envelope sender" "rewriting at transport time"
25526 .cindex "rewriting" "at transport time"
25527 .cindex "header lines" "rewriting at transport time"
25528 At transport time, additional rewriting of addresses in header lines can be
25529 specified by setting the generic &%headers_rewrite%& option on a transport.
25530 This option contains rules that are identical in form to those in the rewrite
25531 section of the configuration file. They are applied to the original message
25532 header lines and any that were added by ACLs or a system filter. They are not
25533 applied to header lines that are added by routers or the transport.
25534
25535 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25536 transport option. However, it is not possible to rewrite envelope recipients at
25537 transport time.
25538
25539
25540
25541
25542 .section "Testing the rewriting rules that apply on input" "SECID149"
25543 .cindex "rewriting" "testing"
25544 .cindex "testing" "rewriting"
25545 Exim's input rewriting configuration appears in a part of the runtime
25546 configuration file headed by &"begin rewrite"&. It can be tested by the
25547 &%-brw%& command line option. This takes an address (which can be a full RFC
25548 2822 address) as its argument. The output is a list of how the address would be
25549 transformed by the rewriting rules for each of the different places it might
25550 appear in an incoming message, that is, for each different header and for the
25551 envelope sender and recipient fields. For example,
25552 .code
25553 exim -brw ph10@exim.workshop.example
25554 .endd
25555 might produce the output
25556 .code
25557 sender: Philip.Hazel@exim.workshop.example
25558 from: Philip.Hazel@exim.workshop.example
25559 to: ph10@exim.workshop.example
25560 cc: ph10@exim.workshop.example
25561 bcc: ph10@exim.workshop.example
25562 reply-to: Philip.Hazel@exim.workshop.example
25563 env-from: Philip.Hazel@exim.workshop.example
25564 env-to: ph10@exim.workshop.example
25565 .endd
25566 which shows that rewriting has been set up for that address when used in any of
25567 the source fields, but not when it appears as a recipient address. At the
25568 present time, there is no equivalent way of testing rewriting rules that are
25569 set for a particular transport.
25570
25571
25572 .section "Rewriting rules" "SECID150"
25573 .cindex "rewriting" "rules"
25574 The rewrite section of the configuration file consists of lines of rewriting
25575 rules in the form
25576 .display
25577 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25578 .endd
25579 Rewriting rules that are specified for the &%headers_rewrite%& generic
25580 transport option are given as a colon-separated list. Each item in the list
25581 takes the same form as a line in the main rewriting configuration (except that
25582 any colons must be doubled, of course).
25583
25584 The formats of source patterns and replacement strings are described below.
25585 Each is terminated by white space, unless enclosed in double quotes, in which
25586 case normal quoting conventions apply inside the quotes. The flags are single
25587 characters which may appear in any order. Spaces and tabs between them are
25588 ignored.
25589
25590 For each address that could potentially be rewritten, the rules are scanned in
25591 order, and replacements for the address from earlier rules can themselves be
25592 replaced by later rules (but see the &"q"& and &"R"& flags).
25593
25594 The order in which addresses are rewritten is undefined, may change between
25595 releases, and must not be relied on, with one exception: when a message is
25596 received, the envelope sender is always rewritten first, before any header
25597 lines are rewritten. For example, the replacement string for a rewrite of an
25598 address in &'To:'& must not assume that the message's address in &'From:'& has
25599 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25600 that the envelope sender has already been rewritten.
25601
25602 .vindex "&$domain$&"
25603 .vindex "&$local_part$&"
25604 The variables &$local_part$& and &$domain$& can be used in the replacement
25605 string to refer to the address that is being rewritten. Note that lookup-driven
25606 rewriting can be done by a rule of the form
25607 .code
25608 *@*   ${lookup ...
25609 .endd
25610 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25611 refer to the address that is being rewritten.
25612
25613
25614 .section "Rewriting patterns" "SECID151"
25615 .cindex "rewriting" "patterns"
25616 .cindex "address list" "in a rewriting pattern"
25617 The source pattern in a rewriting rule is any item which may appear in an
25618 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25619 single-item address list, which means that it is expanded before being tested
25620 against the address. As always, if you use a regular expression as a pattern,
25621 you must take care to escape dollar and backslash characters, or use the &`\N`&
25622 facility to suppress string expansion within the regular expression.
25623
25624 Domains in patterns should be given in lower case. Local parts in patterns are
25625 case-sensitive. If you want to do case-insensitive matching of local parts, you
25626 can use a regular expression that starts with &`^(?i)`&.
25627
25628 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25629 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25630 depending on the type of match which occurred. These can be used in the
25631 replacement string to insert portions of the incoming address. &$0$& always
25632 refers to the complete incoming address. When a regular expression is used, the
25633 numerical variables are set from its capturing subexpressions. For other types
25634 of pattern they are set as follows:
25635
25636 .ilist
25637 If a local part or domain starts with an asterisk, the numerical variables
25638 refer to the character strings matched by asterisks, with &$1$& associated with
25639 the first asterisk, and &$2$& with the second, if present. For example, if the
25640 pattern
25641 .code
25642 *queen@*.fict.example
25643 .endd
25644 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25645 .code
25646 $0 = hearts-queen@wonderland.fict.example
25647 $1 = hearts-
25648 $2 = wonderland
25649 .endd
25650 Note that if the local part does not start with an asterisk, but the domain
25651 does, it is &$1$& that contains the wild part of the domain.
25652
25653 .next
25654 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25655 of the domain are placed in the next available numerical variables. Suppose,
25656 for example, that the address &'foo@bar.baz.example'& is processed by a
25657 rewriting rule of the form
25658 .display
25659 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25660 .endd
25661 and the key in the file that matches the domain is &`*.baz.example`&. Then
25662 .code
25663 $1 = foo
25664 $2 = bar
25665 $3 = baz.example
25666 .endd
25667 If the address &'foo@baz.example'& is looked up, this matches the same
25668 wildcard file entry, and in this case &$2$& is set to the empty string, but
25669 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25670 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25671 whole domain. For non-partial domain lookups, no numerical variables are set.
25672 .endlist
25673
25674
25675 .section "Rewriting replacements" "SECID152"
25676 .cindex "rewriting" "replacements"
25677 If the replacement string for a rule is a single asterisk, addresses that
25678 match the pattern and the flags are &'not'& rewritten, and no subsequent
25679 rewriting rules are scanned. For example,
25680 .code
25681 hatta@lookingglass.fict.example  *  f
25682 .endd
25683 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25684 &'From:'& headers.
25685
25686 .vindex "&$domain$&"
25687 .vindex "&$local_part$&"
25688 If the replacement string is not a single asterisk, it is expanded, and must
25689 yield a fully qualified address. Within the expansion, the variables
25690 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25691 Any letters they contain retain their original case &-- they are not lower
25692 cased. The numerical variables are set up according to the type of pattern that
25693 matched the address, as described above. If the expansion is forced to fail by
25694 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25695 current rule is abandoned, but subsequent rules may take effect. Any other
25696 expansion failure causes the entire rewriting operation to be abandoned, and an
25697 entry written to the panic log.
25698
25699
25700
25701 .section "Rewriting flags" "SECID153"
25702 There are three different kinds of flag that may appear on rewriting rules:
25703
25704 .ilist
25705 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25706 c, f, h, r, s, t.
25707 .next
25708 A flag that specifies rewriting at SMTP time: S.
25709 .next
25710 Flags that control the rewriting process: Q, q, R, w.
25711 .endlist
25712
25713 For rules that are part of the &%headers_rewrite%& generic transport option,
25714 E, F, T, and S are not permitted.
25715
25716
25717
25718 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25719          "SECID154"
25720 .cindex "rewriting" "flags"
25721 If none of the following flag letters, nor the &"S"& flag (see section
25722 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25723 and to both the sender and recipient fields of the envelope, whereas a
25724 transport-time rewriting rule just applies to all headers. Otherwise, the
25725 rewriting rule is skipped unless the relevant addresses are being processed.
25726 .display
25727 &`E`&       rewrite all envelope fields
25728 &`F`&       rewrite the envelope From field
25729 &`T`&       rewrite the envelope To field
25730 &`b`&       rewrite the &'Bcc:'& header
25731 &`c`&       rewrite the &'Cc:'& header
25732 &`f`&       rewrite the &'From:'& header
25733 &`h`&       rewrite all headers
25734 &`r`&       rewrite the &'Reply-To:'& header
25735 &`s`&       rewrite the &'Sender:'& header
25736 &`t`&       rewrite the &'To:'& header
25737 .endd
25738 "All headers" means all of the headers listed above that can be selected
25739 individually, plus their &'Resent-'& versions. It does not include
25740 other headers such as &'Subject:'& etc.
25741
25742 You should be particularly careful about rewriting &'Sender:'& headers, and
25743 restrict this to special known cases in your own domains.
25744
25745
25746 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25747 .cindex "SMTP" "rewriting malformed addresses"
25748 .cindex "RCPT" "rewriting argument of"
25749 .cindex "MAIL" "rewriting argument of"
25750 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25751 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25752 before any other processing; even before syntax checking. The pattern is
25753 required to be a regular expression, and it is matched against the whole of the
25754 data for the command, including any surrounding angle brackets.
25755
25756 .vindex "&$domain$&"
25757 .vindex "&$local_part$&"
25758 This form of rewrite rule allows for the handling of addresses that are not
25759 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25760 input). Because the input is not required to be a syntactically valid address,
25761 the variables &$local_part$& and &$domain$& are not available during the
25762 expansion of the replacement string. The result of rewriting replaces the
25763 original address in the MAIL or RCPT command.
25764
25765
25766 .section "Flags controlling the rewriting process" "SECID155"
25767 There are four flags which control the way the rewriting process works. These
25768 take effect only when a rule is invoked, that is, when the address is of the
25769 correct type (matches the flags) and matches the pattern:
25770
25771 .ilist
25772 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25773 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25774 absence of &"Q"& the rewritten address must always include a domain.
25775 .next
25776 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25777 even if no rewriting actually takes place because of a &"fail"& in the
25778 expansion. The &"q"& flag is not effective if the address is of the wrong type
25779 (does not match the flags) or does not match the pattern.
25780 .next
25781 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25782 address, up to ten times. It can be combined with the &"q"& flag, to stop
25783 rewriting once it fails to match (after at least one successful rewrite).
25784 .next
25785 .cindex "rewriting" "whole addresses"
25786 When an address in a header is rewritten, the rewriting normally applies only
25787 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25788 left unchanged. For example, rewriting might change
25789 .code
25790 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25791 .endd
25792 into
25793 .code
25794 From: Ford Prefect <prefectf@hitch.fict.example>
25795 .endd
25796 .cindex "RFC 2047"
25797 Sometimes there is a need to replace the whole address item, and this can be
25798 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25799 causes an address in a header line to be rewritten, the entire address is
25800 replaced, not just the working part. The replacement must be a complete RFC
25801 2822 address, including the angle brackets if necessary. If text outside angle
25802 brackets contains a character whose value is greater than 126 or less than 32
25803 (except for tab), the text is encoded according to RFC 2047. The character set
25804 is taken from &%headers_charset%&, which gets its default at build time.
25805
25806 When the &"w"& flag is set on a rule that causes an envelope address to be
25807 rewritten, all but the working part of the replacement address is discarded.
25808 .endlist
25809
25810
25811 .section "Rewriting examples" "SECID156"
25812 Here is an example of the two common rewriting paradigms:
25813 .code
25814 *@*.hitch.fict.example  $1@hitch.fict.example
25815 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25816                      {$value}fail}@hitch.fict.example bctfrF
25817 .endd
25818 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25819 the string expansion to fail if the lookup does not succeed. In this context it
25820 has the effect of leaving the original address unchanged, but Exim goes on to
25821 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25822 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25823 explicitly, which would cause the rewritten address to be the same as before,
25824 at the cost of a small bit of processing. Not supplying either of these is an
25825 error, since the rewritten address would then contain no local part.
25826
25827 The first example above replaces the domain with a superior, more general
25828 domain. This may not be desirable for certain local parts. If the rule
25829 .code
25830 root@*.hitch.fict.example  *
25831 .endd
25832 were inserted before the first rule, rewriting would be suppressed for the
25833 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25834
25835 Rewriting can be made conditional on a number of tests, by making use of
25836 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25837 messages that originate outside the local host:
25838 .code
25839 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25840                          {$1@hitch.fict.example}fail}"
25841 .endd
25842 The replacement string is quoted in this example because it contains white
25843 space.
25844
25845 .cindex "rewriting" "bang paths"
25846 .cindex "bang paths" "rewriting"
25847 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25848 an address it treats it as an unqualified local part which it qualifies with
25849 the local qualification domain (if the source of the message is local or if the
25850 remote host is permitted to send unqualified addresses). Rewriting can
25851 sometimes be used to handle simple bang paths with a fixed number of
25852 components. For example, the rule
25853 .code
25854 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25855 .endd
25856 rewrites a two-component bang path &'host.name!user'& as the domain address
25857 &'user@host.name'&. However, there is a security implication in using this as
25858 a global rewriting rule for envelope addresses. It can provide a backdoor
25859 method for using your system as a relay, because the incoming addresses appear
25860 to be local. If the bang path addresses are received via SMTP, it is safer to
25861 use the &"S"& flag to rewrite them as they are received, so that relay checking
25862 can be done on the rewritten addresses.
25863 .ecindex IIDaddrew
25864
25865
25866
25867
25868
25869 . ////////////////////////////////////////////////////////////////////////////
25870 . ////////////////////////////////////////////////////////////////////////////
25871
25872 .chapter "Retry configuration" "CHAPretry"
25873 .scindex IIDretconf1 "retry" "configuration, description of"
25874 .scindex IIDregconf2 "configuration file" "retry section"
25875 The &"retry"& section of the runtime configuration file contains a list of
25876 retry rules that control how often Exim tries to deliver messages that cannot
25877 be delivered at the first attempt. If there are no retry rules (the section is
25878 empty or not present), there are no retries. In this situation, temporary
25879 errors are treated as permanent. The default configuration contains a single,
25880 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25881 line option can be used to test which retry rule will be used for a given
25882 address, domain and error.
25883
25884 The most common cause of retries is temporary failure to deliver to a remote
25885 host because the host is down, or inaccessible because of a network problem.
25886 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25887 address) basis, not on a per-message basis. Thus, if one message has recently
25888 been delayed, delivery of a new message to the same host is not immediately
25889 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25890 log selector is set, the message
25891 .cindex "retry" "time not reached"
25892 &"retry time not reached"& is written to the main log whenever a delivery is
25893 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25894 the handling of errors during remote deliveries.
25895
25896 Retry processing applies to routing as well as to delivering, except as covered
25897 in the next paragraph. The retry rules do not distinguish between these
25898 actions. It is not possible, for example, to specify different behaviour for
25899 failures to route the domain &'snark.fict.example'& and failures to deliver to
25900 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25901 added complication, so did not implement it. However, although they share the
25902 same retry rule, the actual retry times for routing and transporting a given
25903 domain are maintained independently.
25904
25905 When a delivery is not part of a queue run (typically an immediate delivery on
25906 receipt of a message), the routers are always run, and local deliveries are
25907 always attempted, even if retry times are set for them. This makes for better
25908 behaviour if one particular message is causing problems (for example, causing
25909 quota overflow, or provoking an error in a filter file). If such a delivery
25910 suffers a temporary failure, the retry data is updated as normal, and
25911 subsequent delivery attempts from queue runs occur only when the retry time for
25912 the local address is reached.
25913
25914 .section "Changing retry rules" "SECID157"
25915 If you change the retry rules in your configuration, you should consider
25916 whether or not to delete the retry data that is stored in Exim's spool area in
25917 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25918 always safe; that is why they are called &"hints"&.
25919
25920 The hints retry data contains suggested retry times based on the previous
25921 rules. In the case of a long-running problem with a remote host, it might
25922 record the fact that the host has timed out. If your new rules increase the
25923 timeout time for such a host, you should definitely remove the old retry data
25924 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25925 messages that it should now be retaining.
25926
25927
25928
25929 .section "Format of retry rules" "SECID158"
25930 .cindex "retry" "rules"
25931 Each retry rule occupies one line and consists of three or four parts,
25932 separated by white space: a pattern, an error name, an optional list of sender
25933 addresses, and a list of retry parameters. The pattern and sender lists must be
25934 enclosed in double quotes if they contain white space. The rules are searched
25935 in order until one is found where the pattern, error name, and sender list (if
25936 present) match the failing host or address, the error that occurred, and the
25937 message's sender, respectively.
25938
25939
25940 The pattern is any single item that may appear in an address list (see section
25941 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25942 which means that it is expanded before being tested against the address that
25943 has been delayed. A negated address list item is permitted. Address
25944 list processing treats a plain domain name as if it were preceded by &"*@"&,
25945 which makes it possible for many retry rules to start with just a domain. For
25946 example,
25947 .code
25948 lookingglass.fict.example        *  F,24h,30m;
25949 .endd
25950 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25951 whereas
25952 .code
25953 alice@lookingglass.fict.example  *  F,24h,30m;
25954 .endd
25955 applies only to temporary failures involving the local part &%alice%&.
25956 In practice, almost all rules start with a domain name pattern without a local
25957 part.
25958
25959 .cindex "regular expressions" "in retry rules"
25960 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25961 must match a complete address, not just a domain, because that is how regular
25962 expressions work in address lists.
25963 .display
25964 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25965 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25966 .endd
25967
25968
25969 .section "Choosing which retry rule to use for address errors" "SECID159"
25970 When Exim is looking for a retry rule after a routing attempt has failed (for
25971 example, after a DNS timeout), each line in the retry configuration is tested
25972 against the complete address only if &%retry_use_local_part%& is set for the
25973 router. Otherwise, only the domain is used, except when matching against a
25974 regular expression, when the local part of the address is replaced with &"*"&.
25975 A domain on its own can match a domain pattern, or a pattern that starts with
25976 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25977 &%check_local_user%& is true, and false for other routers.
25978
25979 Similarly, when Exim is looking for a retry rule after a local delivery has
25980 failed (for example, after a mailbox full error), each line in the retry
25981 configuration is tested against the complete address only if
25982 &%retry_use_local_part%& is set for the transport (it defaults true for all
25983 local transports).
25984
25985 .cindex "4&'xx'& responses" "retry rules for"
25986 However, when Exim is looking for a retry rule after a remote delivery attempt
25987 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25988 whole address is always used as the key when searching the retry rules. The
25989 rule that is found is used to create a retry time for the combination of the
25990 failing address and the message's sender. It is the combination of sender and
25991 recipient that is delayed in subsequent queue runs until its retry time is
25992 reached. You can delay the recipient without regard to the sender by setting
25993 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25994 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25995 commands.
25996
25997
25998
25999 .section "Choosing which retry rule to use for host and message errors" &&&
26000          "SECID160"
26001 For a temporary error that is not related to an individual address (for
26002 example, a connection timeout), each line in the retry configuration is checked
26003 twice. First, the name of the remote host is used as a domain name (preceded by
26004 &"*@"& when matching a regular expression). If this does not match the line,
26005 the domain from the email address is tried in a similar fashion. For example,
26006 suppose the MX records for &'a.b.c.example'& are
26007 .code
26008 a.b.c.example  MX  5  x.y.z.example
26009                MX  6  p.q.r.example
26010                MX  7  m.n.o.example
26011 .endd
26012 and the retry rules are
26013 .code
26014 p.q.r.example    *      F,24h,30m;
26015 a.b.c.example    *      F,4d,45m;
26016 .endd
26017 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26018 first rule matches neither the host nor the domain, so Exim looks at the second
26019 rule. This does not match the host, but it does match the domain, so it is used
26020 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26021 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26022 first retry rule is used, because it matches the host.
26023
26024 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26025 first rule to determine retry times, but for all the other hosts for the domain
26026 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26027 routing to &'a.b.c.example'& suffers a temporary failure.
26028
26029 &*Note*&: The host name is used when matching the patterns, not its IP address.
26030 However, if a message is routed directly to an IP address without the use of a
26031 host name, for example, if a &(manualroute)& router contains a setting such as:
26032 .code
26033 route_list = *.a.example  192.168.34.23
26034 .endd
26035 then the &"host name"& that is used when searching for a retry rule is the
26036 textual form of the IP address.
26037
26038 .section "Retry rules for specific errors" "SECID161"
26039 .cindex "retry" "specific errors; specifying"
26040 The second field in a retry rule is the name of a particular error, or an
26041 asterisk, which matches any error. The errors that can be tested for are:
26042
26043 .vlist
26044 .vitem &%auth_failed%&
26045 Authentication failed when trying to send to a host in the
26046 &%hosts_require_auth%& list in an &(smtp)& transport.
26047
26048 .vitem &%data_4xx%&
26049 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26050 after the command, or after sending the message's data.
26051
26052 .vitem &%mail_4xx%&
26053 A 4&'xx'& error was received for an outgoing MAIL command.
26054
26055 .vitem &%rcpt_4xx%&
26056 A 4&'xx'& error was received for an outgoing RCPT command.
26057 .endlist
26058
26059 For the three 4&'xx'& errors, either the first or both of the x's can be given
26060 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26061 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26062 and have retries every ten minutes with a one-hour timeout, you could set up a
26063 retry rule of this form:
26064 .code
26065 the.domain.name  rcpt_452   F,1h,10m
26066 .endd
26067 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26068 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26069
26070 .vlist
26071 .vitem &%lost_connection%&
26072 A server unexpectedly closed the SMTP connection. There may, of course,
26073 legitimate reasons for this (host died, network died), but if it repeats a lot
26074 for the same host, it indicates something odd.
26075
26076 .vitem &%lookup%&
26077 A DNS lookup for a host failed.
26078 Note that a &%dnslookup%& router will need to have matched
26079 its &%fail_defer_domains%& option for this retry type to be usable.
26080 Also note that a &%manualroute%& router will probably need
26081 its &%host_find_failed%& option set to &%defer%&.
26082
26083 .vitem &%refused_MX%&
26084 A connection to a host obtained from an MX record was refused.
26085
26086 .vitem &%refused_A%&
26087 A connection to a host not obtained from an MX record was refused.
26088
26089 .vitem &%refused%&
26090 A connection was refused.
26091
26092 .vitem &%timeout_connect_MX%&
26093 A connection attempt to a host obtained from an MX record timed out.
26094
26095 .vitem &%timeout_connect_A%&
26096 A connection attempt to a host not obtained from an MX record timed out.
26097
26098 .vitem &%timeout_connect%&
26099 A connection attempt timed out.
26100
26101 .vitem &%timeout_MX%&
26102 There was a timeout while connecting or during an SMTP session with a host
26103 obtained from an MX record.
26104
26105 .vitem &%timeout_A%&
26106 There was a timeout while connecting or during an SMTP session with a host not
26107 obtained from an MX record.
26108
26109 .vitem &%timeout%&
26110 There was a timeout while connecting or during an SMTP session.
26111
26112 .vitem &%tls_required%&
26113 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26114 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26115 to STARTTLS, or there was a problem setting up the TLS connection.
26116
26117 .vitem &%quota%&
26118 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26119 transport.
26120
26121 .vitem &%quota_%&<&'time'&>
26122 .cindex "quota" "error testing in retry rule"
26123 .cindex "retry" "quota error testing"
26124 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26125 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26126 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26127 for four days.
26128 .endlist
26129
26130 .cindex "mailbox" "time of last read"
26131 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26132 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26133 it should be based on the last time that the user accessed the mailbox.
26134 However, it is not always possible to determine this. Exim uses the following
26135 heuristic rules:
26136
26137 .ilist
26138 If the mailbox is a single file, the time of last access (the &"atime"&) is
26139 used. As no new messages are being delivered (because the mailbox is over
26140 quota), Exim does not access the file, so this is the time of last user access.
26141 .next
26142 .cindex "maildir format" "time of last read"
26143 For a maildir delivery, the time of last modification of the &_new_&
26144 subdirectory is used. As the mailbox is over quota, no new files are created in
26145 the &_new_& subdirectory, because no new messages are being delivered. Any
26146 change to the &_new_& subdirectory is therefore assumed to be the result of an
26147 MUA moving a new message to the &_cur_& directory when it is first read. The
26148 time that is used is therefore the last time that the user read a new message.
26149 .next
26150 For other kinds of multi-file mailbox, the time of last access cannot be
26151 obtained, so a retry rule that uses this type of error field is never matched.
26152 .endlist
26153
26154 The quota errors apply both to system-enforced quotas and to Exim's own quota
26155 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26156 when a local delivery is deferred because a partition is full (the ENOSPC
26157 error).
26158
26159
26160
26161 .section "Retry rules for specified senders" "SECID162"
26162 .cindex "retry" "rules; sender-specific"
26163 You can specify retry rules that apply only when the failing message has a
26164 specific sender. In particular, this can be used to define retry rules that
26165 apply only to bounce messages. The third item in a retry rule can be of this
26166 form:
26167 .display
26168 &`senders=`&<&'address list'&>
26169 .endd
26170 The retry timings themselves are then the fourth item. For example:
26171 .code
26172 *   rcpt_4xx   senders=:   F,1h,30m
26173 .endd
26174 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26175 host. If the address list contains white space, it must be enclosed in quotes.
26176 For example:
26177 .code
26178 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26179 .endd
26180 &*Warning*&: This facility can be unhelpful if it is used for host errors
26181 (which do not depend on the recipient). The reason is that the sender is used
26182 only to match the retry rule. Once the rule has been found for a host error,
26183 its contents are used to set a retry time for the host, and this will apply to
26184 all messages, not just those with specific senders.
26185
26186 When testing retry rules using &%-brt%&, you can supply a sender using the
26187 &%-f%& command line option, like this:
26188 .code
26189 exim -f "" -brt user@dom.ain
26190 .endd
26191 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26192 list is never matched.
26193
26194
26195
26196
26197
26198 .section "Retry parameters" "SECID163"
26199 .cindex "retry" "parameters in rules"
26200 The third (or fourth, if a senders list is present) field in a retry rule is a
26201 sequence of retry parameter sets, separated by semicolons. Each set consists of
26202 .display
26203 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26204 .endd
26205 The letter identifies the algorithm for computing a new retry time; the cutoff
26206 time is the time beyond which this algorithm no longer applies, and the
26207 arguments vary the algorithm's action. The cutoff time is measured from the
26208 time that the first failure for the domain (combined with the local part if
26209 relevant) was detected, not from the time the message was received.
26210
26211 .cindex "retry" "algorithms"
26212 .cindex "retry" "fixed intervals"
26213 .cindex "retry" "increasing intervals"
26214 .cindex "retry" "random intervals"
26215 The available algorithms are:
26216
26217 .ilist
26218 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26219 the interval.
26220 .next
26221 &'G'&: retry at geometrically increasing intervals. The first argument
26222 specifies a starting value for the interval, and the second a multiplier, which
26223 is used to increase the size of the interval at each retry.
26224 .next
26225 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26226 retry, the previous interval is multiplied by the factor in order to get a
26227 maximum for the next interval. The minimum interval is the first argument of
26228 the parameter, and an actual interval is chosen randomly between them. Such a
26229 rule has been found to be helpful in cluster configurations when all the
26230 members of the cluster restart at once, and may therefore synchronize their
26231 queue processing times.
26232 .endlist
26233
26234 When computing the next retry time, the algorithm definitions are scanned in
26235 order until one whose cutoff time has not yet passed is reached. This is then
26236 used to compute a new retry time that is later than the current time. In the
26237 case of fixed interval retries, this simply means adding the interval to the
26238 current time. For geometrically increasing intervals, retry intervals are
26239 computed from the rule's parameters until one that is greater than the previous
26240 interval is found. The main configuration variable
26241 .cindex "limit" "retry interval"
26242 .cindex "retry" "interval, maximum"
26243 .oindex "&%retry_interval_max%&"
26244 &%retry_interval_max%& limits the maximum interval between retries. It
26245 cannot be set greater than &`24h`&, which is its default value.
26246
26247 A single remote domain may have a number of hosts associated with it, and each
26248 host may have more than one IP address. Retry algorithms are selected on the
26249 basis of the domain name, but are applied to each IP address independently. If,
26250 for example, a host has two IP addresses and one is unusable, Exim will
26251 generate retry times for it and will not try to use it until its next retry
26252 time comes. Thus the good IP address is likely to be tried first most of the
26253 time.
26254
26255 .cindex "hints database" "use for retrying"
26256 Retry times are hints rather than promises. Exim does not make any attempt to
26257 run deliveries exactly at the computed times. Instead, a queue runner process
26258 starts delivery processes for delayed messages periodically, and these attempt
26259 new deliveries only for those addresses that have passed their next retry time.
26260 If a new message arrives for a deferred address, an immediate delivery attempt
26261 occurs only if the address has passed its retry time. In the absence of new
26262 messages, the minimum time between retries is the interval between queue runner
26263 processes. There is not much point in setting retry times of five minutes if
26264 your queue runners happen only once an hour, unless there are a significant
26265 number of incoming messages (which might be the case on a system that is
26266 sending everything to a smart host, for example).
26267
26268 The data in the retry hints database can be inspected by using the
26269 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26270 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26271 &'exinext'& utility script can be used to find out what the next retry times
26272 are for the hosts associated with a particular mail domain, and also for local
26273 deliveries that have been deferred.
26274
26275
26276 .section "Retry rule examples" "SECID164"
26277 Here are some example retry rules:
26278 .code
26279 alice@wonderland.fict.example quota_5d  F,7d,3h
26280 wonderland.fict.example       quota_5d
26281 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26282 lookingglass.fict.example     *         F,24h,30m;
26283 *                 refused_A   F,2h,20m;
26284 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26285 .endd
26286 The first rule sets up special handling for mail to
26287 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26288 mailbox has not been read for at least 5 days. Retries continue every three
26289 hours for 7 days. The second rule handles over-quota errors for all other local
26290 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26291 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26292 fail are bounced immediately if the mailbox has not been read for at least 5
26293 days.
26294
26295 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26296 happen every 15 minutes for an hour, then with geometrically increasing
26297 intervals until two days have passed since a delivery first failed. After the
26298 first hour there is a delay of one hour, then two hours, then four hours, and
26299 so on (this is a rather extreme example).
26300
26301 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26302 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26303 all other domains, with special action for connection refusal from hosts that
26304 were not obtained from an MX record.
26305
26306 The final rule in a retry configuration should always have asterisks in the
26307 first two fields so as to provide a general catch-all for any addresses that do
26308 not have their own special handling. This example tries every 15 minutes for 2
26309 hours, then with intervals starting at one hour and increasing by a factor of
26310 1.5 up to 16 hours, then every 8 hours up to 5 days.
26311
26312
26313
26314 .section "Timeout of retry data" "SECID165"
26315 .cindex "timeout" "of retry data"
26316 .oindex "&%retry_data_expire%&"
26317 .cindex "hints database" "data expiry"
26318 .cindex "retry" "timeout of data"
26319 Exim timestamps the data that it writes to its retry hints database. When it
26320 consults the data during a delivery it ignores any that is older than the value
26321 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26322 been tried for 7 days, Exim will try to deliver to it immediately a message
26323 arrives, and if that fails, it will calculate a retry time as if it were
26324 failing for the first time.
26325
26326 This improves the behaviour for messages routed to rarely-used hosts such as MX
26327 backups. If such a host was down at one time, and happens to be down again when
26328 Exim tries a month later, using the old retry data would imply that it had been
26329 down all the time, which is not a justified assumption.
26330
26331 If a host really is permanently dead, this behaviour causes a burst of retries
26332 every now and again, but only if messages routed to it are rare. If there is a
26333 message at least once every 7 days the retry data never expires.
26334
26335
26336
26337
26338 .section "Long-term failures" "SECID166"
26339 .cindex "delivery failure, long-term"
26340 .cindex "retry" "after long-term failure"
26341 Special processing happens when an email address has been failing for so long
26342 that the cutoff time for the last algorithm is reached. For example, using the
26343 default retry rule:
26344 .code
26345 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26346 .endd
26347 the cutoff time is four days. Reaching the retry cutoff is independent of how
26348 long any specific message has been failing; it is the length of continuous
26349 failure for the recipient address that counts.
26350
26351 When the cutoff time is reached for a local delivery, or for all the IP
26352 addresses associated with a remote delivery, a subsequent delivery failure
26353 causes Exim to give up on the address, and a bounce message is generated.
26354 In order to cater for new messages that use the failing address, a next retry
26355 time is still computed from the final algorithm, and is used as follows:
26356
26357 For local deliveries, one delivery attempt is always made for any subsequent
26358 messages. If this delivery fails, the address fails immediately. The
26359 post-cutoff retry time is not used.
26360
26361 .cindex "final cutoff" "retries, controlling"
26362 .cindex retry "final cutoff"
26363 If the delivery is remote, there are two possibilities, controlled by the
26364 .oindex "&%delay_after_cutoff%&"
26365 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26366 default. Until the post-cutoff retry time for one of the IP addresses,
26367 as set by the &%retry_data_expire%& option, is
26368 reached, the failing email address is bounced immediately, without a delivery
26369 attempt taking place. After that time, one new delivery attempt is made to
26370 those IP addresses that are past their retry times, and if that still fails,
26371 the address is bounced and new retry times are computed.
26372
26373 In other words, when all the hosts for a given email address have been failing
26374 for a long time, Exim bounces rather then defers until one of the hosts' retry
26375 times is reached. Then it tries once, and bounces if that attempt fails. This
26376 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26377 to a broken destination, but if the host does recover, Exim will eventually
26378 notice.
26379
26380 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26381 addresses are past their final cutoff time, Exim tries to deliver to those IP
26382 addresses that have not been tried since the message arrived. If there are
26383 no suitable IP addresses, or if they all fail, the address is bounced. In other
26384 words, it does not delay when a new message arrives, but tries the expired
26385 addresses immediately, unless they have been tried since the message arrived.
26386 If there is a continuous stream of messages for the failing domains, setting
26387 &%delay_after_cutoff%& false means that there will be many more attempts to
26388 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26389 true.
26390
26391 .section "Deliveries that work intermittently" "SECID167"
26392 .cindex "retry" "intermittently working deliveries"
26393 Some additional logic is needed to cope with cases where a host is
26394 intermittently available, or when a message has some attribute that prevents
26395 its delivery when others to the same address get through. In this situation,
26396 because some messages are successfully delivered, the &"retry clock"& for the
26397 host or address keeps getting reset by the successful deliveries, and so
26398 failing messages remain in the queue for ever because the cutoff time is never
26399 reached.
26400
26401 Two exceptional actions are applied to prevent this happening. The first
26402 applies to errors that are related to a message rather than a remote host.
26403 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26404 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26405 commands, and quota failures. For this type of error, if a message's arrival
26406 time is earlier than the &"first failed"& time for the error, the earlier time
26407 is used when scanning the retry rules to decide when to try next and when to
26408 time out the address.
26409
26410 The exceptional second action applies in all cases. If a message has been on
26411 the queue for longer than the cutoff time of any applicable retry rule for a
26412 given address, a delivery is attempted for that address, even if it is not yet
26413 time, and if this delivery fails, the address is timed out. A new retry time is
26414 not computed in this case, so that other messages for the same address are
26415 considered immediately.
26416 .ecindex IIDretconf1
26417 .ecindex IIDregconf2
26418
26419
26420
26421
26422
26423
26424 . ////////////////////////////////////////////////////////////////////////////
26425 . ////////////////////////////////////////////////////////////////////////////
26426
26427 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26428 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26429 .scindex IIDauthconf2 "authentication"
26430 The &"authenticators"& section of Exim's runtime configuration is concerned
26431 with SMTP authentication. This facility is an extension to the SMTP protocol,
26432 described in RFC 2554, which allows a client SMTP host to authenticate itself
26433 to a server. This is a common way for a server to recognize clients that are
26434 permitted to use it as a relay. SMTP authentication is not of relevance to the
26435 transfer of mail between servers that have no managerial connection with each
26436 other.
26437
26438 .cindex "AUTH" "description of"
26439 Very briefly, the way SMTP authentication works is as follows:
26440
26441 .ilist
26442 The server advertises a number of authentication &'mechanisms'& in response to
26443 the client's EHLO command.
26444 .next
26445 The client issues an AUTH command, naming a specific mechanism. The command
26446 may, optionally, contain some authentication data.
26447 .next
26448 The server may issue one or more &'challenges'&, to which the client must send
26449 appropriate responses. In simple authentication mechanisms, the challenges are
26450 just prompts for user names and passwords. The server does not have to issue
26451 any challenges &-- in some mechanisms the relevant data may all be transmitted
26452 with the AUTH command.
26453 .next
26454 The server either accepts or denies authentication.
26455 .next
26456 If authentication succeeds, the client may optionally make use of the AUTH
26457 option on the MAIL command to pass an authenticated sender in subsequent
26458 mail transactions. Authentication lasts for the remainder of the SMTP
26459 connection.
26460 .next
26461 If authentication fails, the client may give up, or it may try a different
26462 authentication mechanism, or it may try transferring mail over the
26463 unauthenticated connection.
26464 .endlist
26465
26466 If you are setting up a client, and want to know which authentication
26467 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26468 SMTP port) on the server, and issue an EHLO command. The response to this
26469 includes the list of supported mechanisms. For example:
26470 .display
26471 &`$ `&&*&`telnet server.example 25`&*&
26472 &`Trying 192.168.34.25...`&
26473 &`Connected to server.example.`&
26474 &`Escape character is &#x0027;^]&#x0027;.`&
26475 &`220 server.example ESMTP Exim 4.20 ...`&
26476 &*&`ehlo client.example`&*&
26477 &`250-server.example Hello client.example [10.8.4.5]`&
26478 &`250-SIZE 52428800`&
26479 &`250-PIPELINING`&
26480 &`250-AUTH PLAIN`&
26481 &`250 HELP`&
26482 .endd
26483 The second-last line of this example output shows that the server supports
26484 authentication using the PLAIN mechanism. In Exim, the different authentication
26485 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26486 routers and transports, which authenticators are included in the binary is
26487 controlled by build-time definitions. The following are currently available,
26488 included by setting
26489 .code
26490 AUTH_CRAM_MD5=yes
26491 AUTH_CYRUS_SASL=yes
26492 AUTH_DOVECOT=yes
26493 AUTH_EXTERNAL=yes
26494 AUTH_GSASL=yes
26495 AUTH_HEIMDAL_GSSAPI=yes
26496 AUTH_PLAINTEXT=yes
26497 AUTH_SPA=yes
26498 AUTH_TLS=yes
26499 .endd
26500 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26501 authentication mechanism (RFC 2195), and the second provides an interface to
26502 the Cyrus SASL authentication library.
26503 The third is an interface to Dovecot's authentication system, delegating the
26504 work via a socket interface.
26505 .new
26506 The fourth provides for negotiation of authentication done via non-SMTP means,
26507 as defined by RFC 4422 Appendix A.
26508 .wen
26509 The fifth provides an interface to the GNU SASL authentication library, which
26510 provides mechanisms but typically not data sources.
26511 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26512 supporting setting a server keytab.
26513 The seventh can be configured to support
26514 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26515 not formally documented, but used by several MUAs.
26516 The eighth authenticator
26517 supports Microsoft's &'Secure Password Authentication'& mechanism.
26518 The last is an Exim authenticator but not an SMTP one;
26519 instead it can use information from a TLS negotiation.
26520
26521 The authenticators are configured using the same syntax as other drivers (see
26522 section &<<SECTfordricon>>&). If no authenticators are required, no
26523 authentication section need be present in the configuration file. Each
26524 authenticator can in principle have both server and client functions. When Exim
26525 is receiving SMTP mail, it is acting as a server; when it is sending out
26526 messages over SMTP, it is acting as a client. Authenticator configuration
26527 options are provided for use in both these circumstances.
26528
26529 To make it clear which options apply to which situation, the prefixes
26530 &%server_%& and &%client_%& are used on option names that are specific to
26531 either the server or the client function, respectively. Server and client
26532 functions are disabled if none of their options are set. If an authenticator is
26533 to be used for both server and client functions, a single definition, using
26534 both sets of options, is required. For example:
26535 .code
26536 cram:
26537   driver = cram_md5
26538   public_name = CRAM-MD5
26539   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26540   client_name = ph10
26541   client_secret = secret2
26542 .endd
26543 The &%server_%& option is used when Exim is acting as a server, and the
26544 &%client_%& options when it is acting as a client.
26545
26546 Descriptions of the individual authenticators are given in subsequent chapters.
26547 The remainder of this chapter covers the generic options for the
26548 authenticators, followed by general discussion of the way authentication works
26549 in Exim.
26550
26551 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26552 per-mechanism basis.  Please read carefully to determine which variables hold
26553 account labels such as usercodes and which hold passwords or other
26554 authenticating data.
26555
26556 Note that some mechanisms support two different identifiers for accounts: the
26557 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26558 and &'authz'& are commonly encountered.  The American spelling is standard here.
26559 Conceptually, authentication data such as passwords are tied to the identifier
26560 used to authenticate; servers may have rules to permit one user to act as a
26561 second user, so that after login the session is treated as though that second
26562 user had logged in.  That second user is the &'authorization id'&.  A robust
26563 configuration might confirm that the &'authz'& field is empty or matches the
26564 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26565 as verified data, the &'authz'& as an unverified request which the server might
26566 choose to honour.
26567
26568 A &'realm'& is a text string, typically a domain name, presented by a server
26569 to a client to help it select an account and credentials to use.  In some
26570 mechanisms, the client and server provably agree on the realm, but clients
26571 typically can not treat the realm as secure data to be blindly trusted.
26572
26573
26574
26575 .section "Generic options for authenticators" "SECID168"
26576 .cindex "authentication" "generic options"
26577 .cindex "options" "generic; for authenticators"
26578
26579 .option client_condition authenticators string&!! unset
26580 When Exim is authenticating as a client, it skips any authenticator whose
26581 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26582 used, for example, to skip plain text authenticators when the connection is not
26583 encrypted by a setting such as:
26584 .code
26585 client_condition = ${if !eq{$tls_out_cipher}{}}
26586 .endd
26587
26588
26589 .option client_set_id authenticators string&!! unset
26590 When client authentication succeeds, this condition is expanded; the
26591 result is used in the log lines for outbound messages.
26592 Typically it will be the user name used for authentication.
26593
26594
26595 .option driver authenticators string unset
26596 This option must always be set. It specifies which of the available
26597 authenticators is to be used.
26598
26599
26600 .option public_name authenticators string unset
26601 This option specifies the name of the authentication mechanism that the driver
26602 implements, and by which it is known to the outside world. These names should
26603 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26604 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26605 defaults to the driver's instance name.
26606
26607
26608 .option server_advertise_condition authenticators string&!! unset
26609 When a server is about to advertise an authentication mechanism, the condition
26610 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26611 mechanism is not advertised.
26612 If the expansion fails, the mechanism is not advertised. If the failure was not
26613 forced, and was not caused by a lookup defer, the incident is logged.
26614 See section &<<SECTauthexiser>>& below for further discussion.
26615
26616
26617 .option server_condition authenticators string&!! unset
26618 This option must be set for a &%plaintext%& server authenticator, where it
26619 is used directly to control authentication. See section &<<SECTplainserver>>&
26620 for details.
26621
26622 For the &(gsasl)& authenticator, this option is required for various
26623 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26624
26625 For the other authenticators, &%server_condition%& can be used as an additional
26626 authentication or authorization mechanism that is applied after the other
26627 authenticator conditions succeed. If it is set, it is expanded when the
26628 authenticator would otherwise return a success code. If the expansion is forced
26629 to fail, authentication fails. Any other expansion failure causes a temporary
26630 error code to be returned. If the result of a successful expansion is an empty
26631 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26632 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26633 other result, a temporary error code is returned, with the expanded string as
26634 the error text.
26635
26636
26637 .option server_debug_print authenticators string&!! unset
26638 If this option is set and authentication debugging is enabled (see the &%-d%&
26639 command line option), the string is expanded and included in the debugging
26640 output when the authenticator is run as a server. This can help with checking
26641 out the values of variables.
26642 If expansion of the string fails, the error message is written to the debugging
26643 output, and Exim carries on processing.
26644
26645
26646 .option server_set_id authenticators string&!! unset
26647 .vindex "&$authenticated_id$&"
26648 .vindex "&$authenticated_fail_id$&"
26649 When an Exim server successfully authenticates a client, this string is
26650 expanded using data from the authentication, and preserved for any incoming
26651 messages in the variable &$authenticated_id$&. It is also included in the log
26652 lines for incoming messages. For example, a user/password authenticator
26653 configuration might preserve the user name that was used to authenticate, and
26654 refer to it subsequently during delivery of the message.
26655 On a failing authentication the expansion result is instead saved in
26656 the &$authenticated_fail_id$& variable.
26657 If expansion fails, the option is ignored.
26658
26659
26660 .option server_mail_auth_condition authenticators string&!! unset
26661 This option allows a server to discard authenticated sender addresses supplied
26662 as part of MAIL commands in SMTP connections that are authenticated by the
26663 driver on which &%server_mail_auth_condition%& is set. The option is not used
26664 as part of the authentication process; instead its (unexpanded) value is
26665 remembered for later use.
26666 How it is used is described in the following section.
26667
26668
26669
26670
26671
26672 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26673 .cindex "authentication" "sender; authenticated"
26674 .cindex "AUTH" "on MAIL command"
26675 When a client supplied an AUTH= item on a MAIL command, Exim applies
26676 the following checks before accepting it as the authenticated sender of the
26677 message:
26678
26679 .ilist
26680 If the connection is not using extended SMTP (that is, HELO was used rather
26681 than EHLO), the use of AUTH= is a syntax error.
26682 .next
26683 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26684 .next
26685 .vindex "&$authenticated_sender$&"
26686 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26687 running, the value of &$authenticated_sender$& is set to the value obtained
26688 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26689 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26690 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26691 given for the MAIL command.
26692 .next
26693 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26694 is accepted and placed in &$authenticated_sender$& only if the client has
26695 authenticated.
26696 .next
26697 If the AUTH= value was accepted by either of the two previous rules, and
26698 the client has authenticated, and the authenticator has a setting for the
26699 &%server_mail_auth_condition%&, the condition is checked at this point. The
26700 valued that was saved from the authenticator is expanded. If the expansion
26701 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26702 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26703 the value of &$authenticated_sender$& is retained and passed on with the
26704 message.
26705 .endlist
26706
26707
26708 When &$authenticated_sender$& is set for a message, it is passed on to other
26709 hosts to which Exim authenticates as a client. Do not confuse this value with
26710 &$authenticated_id$&, which is a string obtained from the authentication
26711 process, and which is not usually a complete email address.
26712
26713 .vindex "&$sender_address$&"
26714 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26715 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26716 therefore make use of &$authenticated_sender$&. The converse is not true: the
26717 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26718 ACL is run.
26719
26720
26721
26722 .section "Authentication on an Exim server" "SECTauthexiser"
26723 .cindex "authentication" "on an Exim server"
26724 When Exim receives an EHLO command, it advertises the public names of those
26725 authenticators that are configured as servers, subject to the following
26726 conditions:
26727
26728 .ilist
26729 The client host must match &%auth_advertise_hosts%& (default *).
26730 .next
26731 It the &%server_advertise_condition%& option is set, its expansion must not
26732 yield the empty string, &"0"&, &"no"&, or &"false"&.
26733 .endlist
26734
26735 The order in which the authenticators are defined controls the order in which
26736 the mechanisms are advertised.
26737
26738 Some mail clients (for example, some versions of Netscape) require the user to
26739 provide a name and password for authentication whenever AUTH is advertised,
26740 even though authentication may not in fact be needed (for example, Exim may be
26741 set up to allow unconditional relaying from the client by an IP address check).
26742 You can make such clients more friendly by not advertising AUTH to them.
26743 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26744 that runs for RCPT) to relay without authentication, you should set
26745 .code
26746 auth_advertise_hosts = ! 10.9.8.0/24
26747 .endd
26748 so that no authentication mechanisms are advertised to them.
26749
26750 The &%server_advertise_condition%& controls the advertisement of individual
26751 authentication mechanisms. For example, it can be used to restrict the
26752 advertisement of a particular mechanism to encrypted connections, by a setting
26753 such as:
26754 .code
26755 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26756 .endd
26757 .vindex "&$tls_in_cipher$&"
26758 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26759 yields &"yes"&, which allows the advertisement to happen.
26760
26761 When an Exim server receives an AUTH command from a client, it rejects it
26762 immediately if AUTH was not advertised in response to an earlier EHLO
26763 command. This is the case if
26764
26765 .ilist
26766 The client host does not match &%auth_advertise_hosts%&; or
26767 .next
26768 No authenticators are configured with server options; or
26769 .next
26770 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26771 server authenticators.
26772 .endlist
26773
26774
26775 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26776 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26777 AUTH is accepted from any client host.
26778
26779 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26780 server authentication mechanism that was advertised in response to EHLO and
26781 that matches the one named in the AUTH command. If it finds one, it runs
26782 the appropriate authentication protocol, and authentication either succeeds or
26783 fails. If there is no matching advertised mechanism, the AUTH command is
26784 rejected with a 504 error.
26785
26786 .vindex "&$received_protocol$&"
26787 .vindex "&$sender_host_authenticated$&"
26788 When a message is received from an authenticated host, the value of
26789 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26790 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26791 public name) of the authenticator driver that successfully authenticated the
26792 client from which the message was received. This variable is empty if there was
26793 no successful authentication.
26794
26795 .cindex authentication "expansion item"
26796 Successful authentication sets up information used by the
26797 &%authresults%& expansion item.
26798
26799
26800
26801
26802 .section "Testing server authentication" "SECID169"
26803 .cindex "authentication" "testing a server"
26804 .cindex "AUTH" "testing a server"
26805 .cindex "base64 encoding" "creating authentication test data"
26806 Exim's &%-bh%& option can be useful for testing server authentication
26807 configurations. The data for the AUTH command has to be sent using base64
26808 encoding. A quick way to produce such data for testing is the following Perl
26809 script:
26810 .code
26811 use MIME::Base64;
26812 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26813 .endd
26814 .cindex "binary zero" "in authentication data"
26815 This interprets its argument as a Perl string, and then encodes it. The
26816 interpretation as a Perl string allows binary zeros, which are required for
26817 some kinds of authentication, to be included in the data. For example, a
26818 command line to run this script on such data might be
26819 .code
26820 encode '\0user\0password'
26821 .endd
26822 Note the use of single quotes to prevent the shell interpreting the
26823 backslashes, so that they can be interpreted by Perl to specify characters
26824 whose code value is zero.
26825
26826 &*Warning 1*&: If either of the user or password strings starts with an octal
26827 digit, you must use three zeros instead of one after the leading backslash. If
26828 you do not, the octal digit that starts your string will be incorrectly
26829 interpreted as part of the code for the first character.
26830
26831 &*Warning 2*&: If there are characters in the strings that Perl interprets
26832 specially, you must use a Perl escape to prevent them being misinterpreted. For
26833 example, a command such as
26834 .code
26835 encode '\0user@domain.com\0pas$$word'
26836 .endd
26837 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26838
26839 If you have the &%mimencode%& command installed, another way to do produce
26840 base64-encoded strings is to run the command
26841 .code
26842 echo -e -n `\0user\0password' | mimencode
26843 .endd
26844 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26845 in the argument, and the &%-n%& option specifies no newline at the end of its
26846 output. However, not all versions of &%echo%& recognize these options, so you
26847 should check your version before relying on this suggestion.
26848
26849
26850
26851 .section "Authentication by an Exim client" "SECID170"
26852 .cindex "authentication" "on an Exim client"
26853 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26854 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26855 announces support for authentication, and the host matches an entry in either
26856 of these options, Exim (as a client) tries to authenticate as follows:
26857
26858 .ilist
26859 For each authenticator that is configured as a client, in the order in which
26860 they are defined in the configuration, it searches the authentication
26861 mechanisms announced by the server for one whose name matches the public name
26862 of the authenticator.
26863 .next
26864 .vindex "&$host$&"
26865 .vindex "&$host_address$&"
26866 When it finds one that matches, it runs the authenticator's client code. The
26867 variables &$host$& and &$host_address$& are available for any string expansions
26868 that the client might do. They are set to the server's name and IP address. If
26869 any expansion is forced to fail, the authentication attempt is abandoned, and
26870 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26871 delivery to be deferred.
26872 .next
26873 If the result of the authentication attempt is a temporary error or a timeout,
26874 Exim abandons trying to send the message to the host for the moment. It will
26875 try again later. If there are any backup hosts available, they are tried in the
26876 usual way.
26877 .next
26878 If the response to authentication is a permanent error (5&'xx'& code), Exim
26879 carries on searching the list of authenticators and tries another one if
26880 possible. If all authentication attempts give permanent errors, or if there are
26881 no attempts because no mechanisms match (or option expansions force failure),
26882 what happens depends on whether the host matches &%hosts_require_auth%& or
26883 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26884 delivery is deferred. The error can be detected in the retry rules, and thereby
26885 turned into a permanent error if you wish. In the second case, Exim tries to
26886 deliver the message unauthenticated.
26887 .endlist
26888
26889 Note that the hostlist test for whether to do authentication can be
26890 confused if name-IP lookups change between the time the peer is decided
26891 upon and the time that the transport runs.  For example, with a manualroute
26892 router given a host name, and with DNS "round-robin" used by that name: if
26893 the local resolver cache times out between the router and the transport
26894 running, the transport may get an IP for the name for its authentication
26895 check which does not match the connection peer IP.
26896 No authentication will then be done, despite the names being identical.
26897
26898 For such cases use a separate transport which always authenticates.
26899
26900 .cindex "AUTH" "on MAIL command"
26901 When Exim has authenticated itself to a remote server, it adds the AUTH
26902 parameter to the MAIL commands it sends, if it has an authenticated sender for
26903 the message. If the message came from a remote host, the authenticated sender
26904 is the one that was receiving on an incoming MAIL command, provided that the
26905 incoming connection was authenticated and the &%server_mail_auth%& condition
26906 allowed the authenticated sender to be retained. If a local process calls Exim
26907 to send a message, the sender address that is built from the login name and
26908 &%qualify_domain%& is treated as authenticated. However, if the
26909 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26910 the authenticated sender that was received with the message.
26911 .ecindex IIDauthconf1
26912 .ecindex IIDauthconf2
26913
26914
26915
26916
26917
26918
26919 . ////////////////////////////////////////////////////////////////////////////
26920 . ////////////////////////////////////////////////////////////////////////////
26921
26922 .chapter "The plaintext authenticator" "CHAPplaintext"
26923 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26924 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26925 The &(plaintext)& authenticator can be configured to support the PLAIN and
26926 LOGIN authentication mechanisms, both of which transfer authentication data as
26927 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26928 security risk; you are strongly advised to insist on the use of SMTP encryption
26929 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26930 use unencrypted plain text, you should not use the same passwords for SMTP
26931 connections as you do for login accounts.
26932
26933 .new
26934 .section "Avoiding cleartext use" "SECTplain_TLS"
26935 The following generic option settings will disable &(plaintext)& authenticators when
26936 TLS is not being used:
26937 .code
26938   server_advertise_condition = ${if def:tls_in_cipher }
26939   client_condition =           ${if def:tls_out_cipher}
26940 .endd
26941
26942 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
26943 but is still vulnerable to a Man In The Middle attack unless certificates
26944 (including their names) have been properly verified.
26945 .wen
26946
26947 .section "Plaintext server options" "SECID171"
26948 .cindex "options" "&(plaintext)& authenticator (server)"
26949 When configured as a server, &(plaintext)& uses the following options:
26950
26951 .option server_condition authenticators string&!! unset
26952 This is actually a global authentication option, but it must be set in order to
26953 configure the &(plaintext)& driver as a server. Its use is described below.
26954
26955 .option server_prompts plaintext "string list&!!" unset
26956 The contents of this option, after expansion, must be a colon-separated list of
26957 prompt strings. If expansion fails, a temporary authentication rejection is
26958 given.
26959
26960 .section "Using plaintext in a server" "SECTplainserver"
26961 .cindex "AUTH" "in &(plaintext)& authenticator"
26962 .cindex "binary zero" "in &(plaintext)& authenticator"
26963 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26964         "in &(plaintext)& authenticator"
26965 .vindex "&$auth1$&, &$auth2$&, etc"
26966 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26967
26968 When running as a server, &(plaintext)& performs the authentication test by
26969 expanding a string. The data sent by the client with the AUTH command, or in
26970 response to subsequent prompts, is base64 encoded, and so may contain any byte
26971 values when decoded. If any data is supplied with the command, it is treated as
26972 a list of strings, separated by NULs (binary zeros), the first three of which
26973 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26974 (neither LOGIN nor PLAIN uses more than three strings).
26975
26976 For compatibility with previous releases of Exim, the values are also placed in
26977 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26978 variables for this purpose is now deprecated, as it can lead to confusion in
26979 string expansions that also use them for other things.
26980
26981 If there are more strings in &%server_prompts%& than the number of strings
26982 supplied with the AUTH command, the remaining prompts are used to obtain more
26983 data. Each response from the client may be a list of NUL-separated strings.
26984
26985 .vindex "&$authenticated_id$&"
26986 Once a sufficient number of data strings have been received,
26987 &%server_condition%& is expanded. If the expansion is forced to fail,
26988 authentication fails. Any other expansion failure causes a temporary error code
26989 to be returned. If the result of a successful expansion is an empty string,
26990 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26991 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26992 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26993 For any other result, a temporary error code is returned, with the expanded
26994 string as the error text.
26995
26996 &*Warning*&: If you use a lookup in the expansion to find the user's
26997 password, be sure to make the authentication fail if the user is unknown.
26998 There are good and bad examples at the end of the next section.
26999
27000
27001
27002 .section "The PLAIN authentication mechanism" "SECID172"
27003 .cindex "PLAIN authentication mechanism"
27004 .cindex "authentication" "PLAIN mechanism"
27005 .cindex "binary zero" "in &(plaintext)& authenticator"
27006 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27007 sent as one item of data (that is, one combined string containing two NUL
27008 separators). The data is sent either as part of the AUTH command, or
27009 subsequently in response to an empty prompt from the server.
27010
27011 The second and third strings are a user name and a corresponding password.
27012 Using a single fixed user name and password as an example, this could be
27013 configured as follows:
27014 .code
27015 fixed_plain:
27016   driver = plaintext
27017   public_name = PLAIN
27018   server_prompts = :
27019   server_condition = \
27020     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27021   server_set_id = $auth2
27022 .endd
27023 Note that the default result strings from &%if%& (&"true"& or an empty string)
27024 are exactly what we want here, so they need not be specified. Obviously, if the
27025 password contains expansion-significant characters such as dollar, backslash,
27026 or closing brace, they have to be escaped.
27027
27028 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27029 the end of a string list are ignored). If all the data comes as part of the
27030 AUTH command, as is commonly the case, the prompt is not used. This
27031 authenticator is advertised in the response to EHLO as
27032 .code
27033 250-AUTH PLAIN
27034 .endd
27035 and a client host can authenticate itself by sending the command
27036 .code
27037 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27038 .endd
27039 As this contains three strings (more than the number of prompts), no further
27040 data is required from the client. Alternatively, the client may just send
27041 .code
27042 AUTH PLAIN
27043 .endd
27044 to initiate authentication, in which case the server replies with an empty
27045 prompt. The client must respond with the combined data string.
27046
27047 The data string is base64 encoded, as required by the RFC. This example,
27048 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27049 represents a zero byte. This is split up into three strings, the first of which
27050 is empty. The &%server_condition%& option in the authenticator checks that the
27051 second two are &`username`& and &`mysecret`& respectively.
27052
27053 Having just one fixed user name and password, as in this example, is not very
27054 realistic, though for a small organization with only a handful of
27055 authenticating clients it could make sense.
27056
27057 A more sophisticated instance of this authenticator could use the user name in
27058 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27059 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27060 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27061 This is an incorrect example:
27062 .code
27063 server_condition = \
27064   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27065 .endd
27066 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27067 which it then compares to the supplied password (&$auth3$&). Why is this example
27068 incorrect? It works fine for existing users, but consider what happens if a
27069 non-existent user name is given. The lookup fails, but as no success/failure
27070 strings are given for the lookup, it yields an empty string. Thus, to defeat
27071 the authentication, all a client has to do is to supply a non-existent user
27072 name and an empty password. The correct way of writing this test is:
27073 .code
27074 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27075   {${if eq{$value}{$auth3}}} {false}}
27076 .endd
27077 In this case, if the lookup succeeds, the result is checked; if the lookup
27078 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27079 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27080 always fails if its second argument is empty. However, the second way of
27081 writing the test makes the logic clearer.
27082
27083
27084 .section "The LOGIN authentication mechanism" "SECID173"
27085 .cindex "LOGIN authentication mechanism"
27086 .cindex "authentication" "LOGIN mechanism"
27087 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27088 in a number of programs. No data is sent with the AUTH command. Instead, a
27089 user name and password are supplied separately, in response to prompts. The
27090 plaintext authenticator can be configured to support this as in this example:
27091 .code
27092 fixed_login:
27093   driver = plaintext
27094   public_name = LOGIN
27095   server_prompts = User Name : Password
27096   server_condition = \
27097     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27098   server_set_id = $auth1
27099 .endd
27100 Because of the way plaintext operates, this authenticator accepts data supplied
27101 with the AUTH command (in contravention of the specification of LOGIN), but
27102 if the client does not supply it (as is the case for LOGIN clients), the prompt
27103 strings are used to obtain two data items.
27104
27105 Some clients are very particular about the precise text of the prompts. For
27106 example, Outlook Express is reported to recognize only &"Username:"& and
27107 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27108 strings. It uses the &%ldapauth%& expansion condition to check the user
27109 name and password by binding to an LDAP server:
27110 .code
27111 login:
27112   driver = plaintext
27113   public_name = LOGIN
27114   server_prompts = Username:: : Password::
27115   server_condition = ${if and{{ \
27116     !eq{}{$auth1} }{ \
27117     ldapauth{\
27118       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27119       pass=${quote:$auth2} \
27120       ldap://ldap.example.org/} }} }
27121   server_set_id = uid=$auth1,ou=people,o=example.org
27122 .endd
27123 We have to check that the username is not empty before using it, because LDAP
27124 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27125 operator to correctly quote the DN for authentication. However, the basic
27126 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27127 correct one to use for the password, because quoting is needed only to make
27128 the password conform to the Exim syntax. At the LDAP level, the password is an
27129 uninterpreted string.
27130
27131
27132 .section "Support for different kinds of authentication" "SECID174"
27133 A number of string expansion features are provided for the purpose of
27134 interfacing to different ways of user authentication. These include checking
27135 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27136 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27137 &<<SECTexpcond>>&.
27138
27139
27140
27141
27142 .section "Using plaintext in a client" "SECID175"
27143 .cindex "options" "&(plaintext)& authenticator (client)"
27144 The &(plaintext)& authenticator has two client options:
27145
27146 .option client_ignore_invalid_base64 plaintext boolean false
27147 If the client receives a server prompt that is not a valid base64 string,
27148 authentication is abandoned by default. However, if this option is set true,
27149 the error in the challenge is ignored and the client sends the response as
27150 usual.
27151
27152 .option client_send plaintext string&!! unset
27153 The string is a colon-separated list of authentication data strings. Each
27154 string is independently expanded before being sent to the server. The first
27155 string is sent with the AUTH command; any more strings are sent in response
27156 to prompts from the server. Before each string is expanded, the value of the
27157 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27158 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27159 way. Thus, the prompt that is received in response to sending the first string
27160 (with the AUTH command) can be used in the expansion of the second string, and
27161 so on. If an invalid base64 string is received when
27162 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27163 &$auth$&<&'n'&> variable.
27164
27165 &*Note*&: You cannot use expansion to create multiple strings, because
27166 splitting takes priority and happens first.
27167
27168 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27169 the data, further processing is applied to each string before it is sent. If
27170 there are any single circumflex characters in the string, they are converted to
27171 NULs. Should an actual circumflex be required as data, it must be doubled in
27172 the string.
27173
27174 This is an example of a client configuration that implements the PLAIN
27175 authentication mechanism with a fixed user name and password:
27176 .code
27177 fixed_plain:
27178   driver = plaintext
27179   public_name = PLAIN
27180   client_send = ^username^mysecret
27181 .endd
27182 The lack of colons means that the entire text is sent with the AUTH
27183 command, with the circumflex characters converted to NULs. A similar example
27184 that uses the LOGIN mechanism is:
27185 .code
27186 fixed_login:
27187   driver = plaintext
27188   public_name = LOGIN
27189   client_send = : username : mysecret
27190 .endd
27191 The initial colon means that the first string is empty, so no data is sent with
27192 the AUTH command itself. The remaining strings are sent in response to
27193 prompts.
27194 .ecindex IIDplaiauth1
27195 .ecindex IIDplaiauth2
27196
27197
27198
27199
27200 . ////////////////////////////////////////////////////////////////////////////
27201 . ////////////////////////////////////////////////////////////////////////////
27202
27203 .chapter "The cram_md5 authenticator" "CHID9"
27204 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27205 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27206 .cindex "CRAM-MD5 authentication mechanism"
27207 .cindex "authentication" "CRAM-MD5 mechanism"
27208 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27209 sends a challenge string to the client, and the response consists of a user
27210 name and the CRAM-MD5 digest of the challenge string combined with a secret
27211 string (password) which is known to both server and client. Thus, the secret
27212 is not sent over the network as plain text, which makes this authenticator more
27213 secure than &(plaintext)&. However, the downside is that the secret has to be
27214 available in plain text at either end.
27215
27216
27217 .section "Using cram_md5 as a server" "SECID176"
27218 .cindex "options" "&(cram_md5)& authenticator (server)"
27219 This authenticator has one server option, which must be set to configure the
27220 authenticator as a server:
27221
27222 .option server_secret cram_md5 string&!! unset
27223 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27224 When the server receives the client's response, the user name is placed in
27225 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27226 obtain the password for that user. The server then computes the CRAM-MD5 digest
27227 that the client should have sent, and checks that it received the correct
27228 string. If the expansion of &%server_secret%& is forced to fail, authentication
27229 fails. If the expansion fails for some other reason, a temporary error code is
27230 returned to the client.
27231
27232 For compatibility with previous releases of Exim, the user name is also placed
27233 in &$1$&. However, the use of this variables for this purpose is now
27234 deprecated, as it can lead to confusion in string expansions that also use
27235 numeric variables for other things.
27236
27237 For example, the following authenticator checks that the user name given by the
27238 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27239 user name, authentication fails.
27240 .code
27241 fixed_cram:
27242   driver = cram_md5
27243   public_name = CRAM-MD5
27244   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27245   server_set_id = $auth1
27246 .endd
27247 .vindex "&$authenticated_id$&"
27248 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27249 name in &$authenticated_id$&. A more typical configuration might look up the
27250 secret string in a file, using the user name as the key. For example:
27251 .code
27252 lookup_cram:
27253   driver = cram_md5
27254   public_name = CRAM-MD5
27255   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27256                   {$value}fail}
27257   server_set_id = $auth1
27258 .endd
27259 Note that this expansion explicitly forces failure if the lookup fails
27260 because &$auth1$& contains an unknown user name.
27261
27262 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27263 using the relevant libraries, you need to know the realm to specify in the
27264 lookup and then ask for the &"userPassword"& attribute for that user in that
27265 realm, with:
27266 .code
27267 cyrusless_crammd5:
27268   driver = cram_md5
27269   public_name = CRAM-MD5
27270   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27271                   dbmjz{/etc/sasldb2}{$value}fail}
27272   server_set_id = $auth1
27273 .endd
27274
27275 .section "Using cram_md5 as a client" "SECID177"
27276 .cindex "options" "&(cram_md5)& authenticator (client)"
27277 When used as a client, the &(cram_md5)& authenticator has two options:
27278
27279
27280
27281 .option client_name cram_md5 string&!! "the primary host name"
27282 This string is expanded, and the result used as the user name data when
27283 computing the response to the server's challenge.
27284
27285
27286 .option client_secret cram_md5 string&!! unset
27287 This option must be set for the authenticator to work as a client. Its value is
27288 expanded and the result used as the secret string when computing the response.
27289
27290
27291 .vindex "&$host$&"
27292 .vindex "&$host_address$&"
27293 Different user names and secrets can be used for different servers by referring
27294 to &$host$& or &$host_address$& in the options. Forced failure of either
27295 expansion string is treated as an indication that this authenticator is not
27296 prepared to handle this case. Exim moves on to the next configured client
27297 authenticator. Any other expansion failure causes Exim to give up trying to
27298 send the message to the current server.
27299
27300 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27301 strings, is:
27302 .code
27303 fixed_cram:
27304   driver = cram_md5
27305   public_name = CRAM-MD5
27306   client_name = ph10
27307   client_secret = secret
27308 .endd
27309 .ecindex IIDcramauth1
27310 .ecindex IIDcramauth2
27311
27312
27313
27314 . ////////////////////////////////////////////////////////////////////////////
27315 . ////////////////////////////////////////////////////////////////////////////
27316
27317 .chapter "The cyrus_sasl authenticator" "CHID10"
27318 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27319 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27320 .cindex "Cyrus" "SASL library"
27321 .cindex "Kerberos"
27322 The code for this authenticator was provided by Matthew Byng-Maddick while
27323 at A L Digital Ltd.
27324
27325 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27326 library implementation of the RFC 2222 (&"Simple Authentication and Security
27327 Layer"&). This library supports a number of authentication mechanisms,
27328 including PLAIN and LOGIN, but also several others that Exim does not support
27329 directly. In particular, there is support for Kerberos authentication.
27330
27331 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27332 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27333 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27334 name of the driver to determine which mechanism to support.
27335
27336 Where access to some kind of secret file is required, for example, in GSSAPI
27337 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27338 user, and that the Cyrus SASL library has no way of escalating privileges
27339 by default. You may also find you need to set environment variables,
27340 depending on the driver you are using.
27341
27342 The application name provided by Exim is &"exim"&, so various SASL options may
27343 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27344 Kerberos, note that because of limitations in the GSSAPI interface,
27345 changing the server keytab might need to be communicated down to the Kerberos
27346 layer independently. The mechanism for doing so is dependent upon the Kerberos
27347 implementation.
27348
27349 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27350 may be set to point to an alternative keytab file. Exim will pass this
27351 variable through from its own inherited environment when started as root or the
27352 Exim user. The keytab file needs to be readable by the Exim user.
27353 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27354 environment variable.  In practice, for those releases, the Cyrus authenticator
27355 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27356 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27357
27358
27359 .section "Using cyrus_sasl as a server" "SECID178"
27360 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27361 (on a successful authentication) into &$auth1$&. For compatibility with
27362 previous releases of Exim, the username is also placed in &$1$&. However, the
27363 use of this variable for this purpose is now deprecated, as it can lead to
27364 confusion in string expansions that also use numeric variables for other
27365 things.
27366
27367
27368 .option server_hostname cyrus_sasl string&!! "see below"
27369 This option selects the hostname that is used when communicating with the
27370 library. The default value is &`$primary_hostname`&. It is up to the underlying
27371 SASL plug-in what it does with this data.
27372
27373
27374 .option server_mech cyrus_sasl string "see below"
27375 This option selects the authentication mechanism this driver should use. The
27376 default is the value of the generic &%public_name%& option. This option allows
27377 you to use a different underlying mechanism from the advertised name. For
27378 example:
27379 .code
27380 sasl:
27381   driver = cyrus_sasl
27382   public_name = X-ANYTHING
27383   server_mech = CRAM-MD5
27384   server_set_id = $auth1
27385 .endd
27386
27387 .option server_realm cyrus_sasl string&!! unset
27388 This specifies the SASL realm that the server claims to be in.
27389
27390
27391 .option server_service cyrus_sasl string &`smtp`&
27392 This is the SASL service that the server claims to implement.
27393
27394
27395 For straightforward cases, you do not need to set any of the authenticator's
27396 private options. All you need to do is to specify an appropriate mechanism as
27397 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27398 PLAIN, you could have two authenticators as follows:
27399 .code
27400 sasl_cram_md5:
27401   driver = cyrus_sasl
27402   public_name = CRAM-MD5
27403   server_set_id = $auth1
27404
27405 sasl_plain:
27406   driver = cyrus_sasl
27407   public_name = PLAIN
27408   server_set_id = $auth2
27409 .endd
27410 Cyrus SASL does implement the LOGIN authentication method, even though it is
27411 not a standard method. It is disabled by default in the source distribution,
27412 but it is present in many binary distributions.
27413 .ecindex IIDcyrauth1
27414 .ecindex IIDcyrauth2
27415
27416
27417
27418
27419 . ////////////////////////////////////////////////////////////////////////////
27420 . ////////////////////////////////////////////////////////////////////////////
27421 .chapter "The dovecot authenticator" "CHAPdovecot"
27422 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27423 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27424 This authenticator is an interface to the authentication facility of the
27425 Dovecot POP/IMAP server, which can support a number of authentication methods.
27426 Note that Dovecot must be configured to use auth-client not auth-userdb.
27427 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27428 to use the same mechanisms for SMTP authentication. This is a server
27429 authenticator only. There is only one option:
27430
27431 .option server_socket dovecot string unset
27432
27433 This option must specify the UNIX socket that is the interface to Dovecot
27434 authentication. The &%public_name%& option must specify an authentication
27435 mechanism that Dovecot is configured to support. You can have several
27436 authenticators for different mechanisms. For example:
27437 .code
27438 dovecot_plain:
27439   driver = dovecot
27440   public_name = PLAIN
27441   server_socket = /var/run/dovecot/auth-client
27442   server_set_id = $auth1
27443
27444 dovecot_ntlm:
27445   driver = dovecot
27446   public_name = NTLM
27447   server_socket = /var/run/dovecot/auth-client
27448   server_set_id = $auth1
27449 .endd
27450 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27451 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27452 option is passed in the Dovecot authentication command. If, for a TLS
27453 connection, a client certificate has been verified, the &"valid-client-cert"&
27454 option is passed. When authentication succeeds, the identity of the user
27455 who authenticated is placed in &$auth1$&.
27456 .ecindex IIDdcotauth1
27457 .ecindex IIDdcotauth2
27458
27459
27460 . ////////////////////////////////////////////////////////////////////////////
27461 . ////////////////////////////////////////////////////////////////////////////
27462 .chapter "The gsasl authenticator" "CHAPgsasl"
27463 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27464 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27465 .cindex "authentication" "GNU SASL"
27466 .cindex "authentication" "SASL"
27467 .cindex "authentication" "EXTERNAL"
27468 .cindex "authentication" "ANONYMOUS"
27469 .cindex "authentication" "PLAIN"
27470 .cindex "authentication" "LOGIN"
27471 .cindex "authentication" "DIGEST-MD5"
27472 .cindex "authentication" "CRAM-MD5"
27473 .cindex "authentication" "SCRAM-SHA-1"
27474 The &(gsasl)& authenticator provides server integration for the GNU SASL
27475 library and the mechanisms it provides.  This is new as of the 4.80 release
27476 and there are a few areas where the library does not let Exim smoothly
27477 scale to handle future authentication mechanisms, so no guarantee can be
27478 made that any particular new authentication mechanism will be supported
27479 without code changes in Exim.
27480
27481 Exim's &(gsasl)& authenticator does not have client-side support at this
27482 time; only the server-side support is implemented.  Patches welcome.
27483
27484
27485 .option server_channelbinding gsasl boolean false
27486 Do not set this true without consulting a cryptographic engineer.
27487
27488 Some authentication mechanisms are able to use external context at both ends
27489 of the session to bind the authentication to that context, and fail the
27490 authentication process if that context differs.  Specifically, some TLS
27491 ciphersuites can provide identifying information about the cryptographic
27492 context.
27493
27494 This should have meant that certificate identity and verification becomes a
27495 non-issue, as a man-in-the-middle attack will cause the correct client and
27496 server to see different identifiers and authentication will fail.
27497
27498 This is currently only supported when using the GnuTLS library.  This is
27499 only usable by mechanisms which support "channel binding"; at time of
27500 writing, that's the SCRAM family.
27501
27502 This defaults off to ensure smooth upgrade across Exim releases, in case
27503 this option causes some clients to start failing.  Some future release
27504 of Exim might have switched the default to be true.
27505
27506 However, Channel Binding in TLS has proven to be broken in current versions.
27507 Do not plan to rely upon this feature for security, ever, without consulting
27508 with a subject matter expert (a cryptographic engineer).
27509
27510
27511 .option server_hostname gsasl string&!! "see below"
27512 This option selects the hostname that is used when communicating with the
27513 library. The default value is &`$primary_hostname`&.
27514 Some mechanisms will use this data.
27515
27516
27517 .option server_mech gsasl string "see below"
27518 This option selects the authentication mechanism this driver should use. The
27519 default is the value of the generic &%public_name%& option. This option allows
27520 you to use a different underlying mechanism from the advertised name. For
27521 example:
27522 .code
27523 sasl:
27524   driver = gsasl
27525   public_name = X-ANYTHING
27526   server_mech = CRAM-MD5
27527   server_set_id = $auth1
27528 .endd
27529
27530
27531 .option server_password gsasl string&!! unset
27532 Various mechanisms need access to the cleartext password on the server, so
27533 that proof-of-possession can be demonstrated on the wire, without sending
27534 the password itself.
27535
27536 The data available for lookup varies per mechanism.
27537 In all cases, &$auth1$& is set to the &'authentication id'&.
27538 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27539 if available, else the empty string.
27540 The &$auth3$& variable will always be the &'realm'& if available,
27541 else the empty string.
27542
27543 A forced failure will cause authentication to defer.
27544
27545 If using this option, it may make sense to set the &%server_condition%&
27546 option to be simply "true".
27547
27548
27549 .option server_realm gsasl string&!! unset
27550 This specifies the SASL realm that the server claims to be in.
27551 Some mechanisms will use this data.
27552
27553
27554 .option server_scram_iter gsasl string&!! unset
27555 This option provides data for the SCRAM family of mechanisms.
27556 &$auth1$& is not available at evaluation time.
27557 (This may change, as we receive feedback on use)
27558
27559
27560 .option server_scram_salt gsasl string&!! unset
27561 This option provides data for the SCRAM family of mechanisms.
27562 &$auth1$& is not available at evaluation time.
27563 (This may change, as we receive feedback on use)
27564
27565
27566 .option server_service gsasl string &`smtp`&
27567 This is the SASL service that the server claims to implement.
27568 Some mechanisms will use this data.
27569
27570
27571 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27572 .vindex "&$auth1$&, &$auth2$&, etc"
27573 These may be set when evaluating specific options, as detailed above.
27574 They will also be set when evaluating &%server_condition%&.
27575
27576 Unless otherwise stated below, the &(gsasl)& integration will use the following
27577 meanings for these variables:
27578
27579 .ilist
27580 .vindex "&$auth1$&"
27581 &$auth1$&: the &'authentication id'&
27582 .next
27583 .vindex "&$auth2$&"
27584 &$auth2$&: the &'authorization id'&
27585 .next
27586 .vindex "&$auth3$&"
27587 &$auth3$&: the &'realm'&
27588 .endlist
27589
27590 On a per-mechanism basis:
27591
27592 .ilist
27593 .cindex "authentication" "EXTERNAL"
27594 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27595 the &%server_condition%& option must be present.
27596 .next
27597 .cindex "authentication" "ANONYMOUS"
27598 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27599 the &%server_condition%& option must be present.
27600 .next
27601 .cindex "authentication" "GSSAPI"
27602 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27603 &$auth2$& will be set to the &'authorization id'&,
27604 the &%server_condition%& option must be present.
27605 .endlist
27606
27607 An &'anonymous token'& is something passed along as an unauthenticated
27608 identifier; this is analogous to FTP anonymous authentication passing an
27609 email address, or software-identifier@, as the "password".
27610
27611
27612 An example showing the password having the realm specified in the callback
27613 and demonstrating a Cyrus SASL to GSASL migration approach is:
27614 .code
27615 gsasl_cyrusless_crammd5:
27616   driver = gsasl
27617   public_name = CRAM-MD5
27618   server_realm = imap.example.org
27619   server_password = ${lookup{$auth1:$auth3:userPassword}\
27620                     dbmjz{/etc/sasldb2}{$value}fail}
27621   server_set_id = ${quote:$auth1}
27622   server_condition = yes
27623 .endd
27624
27625
27626 . ////////////////////////////////////////////////////////////////////////////
27627 . ////////////////////////////////////////////////////////////////////////////
27628
27629 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27630 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27631 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27632 .cindex "authentication" "GSSAPI"
27633 .cindex "authentication" "Kerberos"
27634 The &(heimdal_gssapi)& authenticator provides server integration for the
27635 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27636 reliably.
27637
27638 .option server_hostname heimdal_gssapi string&!! "see below"
27639 This option selects the hostname that is used, with &%server_service%&,
27640 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27641 identifier.  The default value is &`$primary_hostname`&.
27642
27643 .option server_keytab heimdal_gssapi string&!! unset
27644 If set, then Heimdal will not use the system default keytab (typically
27645 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27646 The value should be a pathname, with no &"file:"& prefix.
27647
27648 .option server_service heimdal_gssapi string&!! "smtp"
27649 This option specifies the service identifier used, in conjunction with
27650 &%server_hostname%&, for building the identifier for finding credentials
27651 from the keytab.
27652
27653
27654 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27655 Beware that these variables will typically include a realm, thus will appear
27656 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27657 not verified, so a malicious client can set it to anything.
27658
27659 The &$auth1$& field should be safely trustable as a value from the Key
27660 Distribution Center.  Note that these are not quite email addresses.
27661 Each identifier is for a role, and so the left-hand-side may include a
27662 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27663
27664 .vindex "&$auth1$&, &$auth2$&, etc"
27665 .ilist
27666 .vindex "&$auth1$&"
27667 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27668 .next
27669 .vindex "&$auth2$&"
27670 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27671 authentication.  If that was empty, this will also be set to the
27672 GSS Display Name.
27673 .endlist
27674
27675
27676 . ////////////////////////////////////////////////////////////////////////////
27677 . ////////////////////////////////////////////////////////////////////////////
27678
27679 .chapter "The spa authenticator" "CHAPspa"
27680 .scindex IIDspaauth1 "&(spa)& authenticator"
27681 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27682 .cindex "authentication" "Microsoft Secure Password"
27683 .cindex "authentication" "NTLM"
27684 .cindex "Microsoft Secure Password Authentication"
27685 .cindex "NTLM authentication"
27686 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27687 Password Authentication'& mechanism,
27688 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27689 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27690 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27691 server side was subsequently contributed by Tom Kistner. The mechanism works as
27692 follows:
27693
27694 .ilist
27695 After the AUTH command has been accepted, the client sends an SPA
27696 authentication request based on the user name and optional domain.
27697 .next
27698 The server sends back a challenge.
27699 .next
27700 The client builds a challenge response which makes use of the user's password
27701 and sends it to the server, which then accepts or rejects it.
27702 .endlist
27703
27704 Encryption is used to protect the password in transit.
27705
27706
27707
27708 .section "Using spa as a server" "SECID179"
27709 .cindex "options" "&(spa)& authenticator (server)"
27710 The &(spa)& authenticator has just one server option:
27711
27712 .option server_password spa string&!! unset
27713 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27714 This option is expanded, and the result must be the cleartext password for the
27715 authenticating user, whose name is at this point in &$auth1$&. For
27716 compatibility with previous releases of Exim, the user name is also placed in
27717 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27718 it can lead to confusion in string expansions that also use numeric variables
27719 for other things. For example:
27720 .code
27721 spa:
27722   driver = spa
27723   public_name = NTLM
27724   server_password = \
27725     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27726 .endd
27727 If the expansion is forced to fail, authentication fails. Any other expansion
27728 failure causes a temporary error code to be returned.
27729
27730
27731
27732
27733
27734 .section "Using spa as a client" "SECID180"
27735 .cindex "options" "&(spa)& authenticator (client)"
27736 The &(spa)& authenticator has the following client options:
27737
27738
27739
27740 .option client_domain spa string&!! unset
27741 This option specifies an optional domain for the authentication.
27742
27743
27744 .option client_password spa string&!! unset
27745 This option specifies the user's password, and must be set.
27746
27747
27748 .option client_username spa string&!! unset
27749 This option specifies the user name, and must be set. Here is an example of a
27750 configuration of this authenticator for use with the mail servers at
27751 &'msn.com'&:
27752 .code
27753 msn:
27754   driver = spa
27755   public_name = MSN
27756   client_username = msn/msn_username
27757   client_password = msn_plaintext_password
27758   client_domain = DOMAIN_OR_UNSET
27759 .endd
27760 .ecindex IIDspaauth1
27761 .ecindex IIDspaauth2
27762
27763
27764
27765
27766
27767 . ////////////////////////////////////////////////////////////////////////////
27768 . ////////////////////////////////////////////////////////////////////////////
27769
27770 .new
27771 .chapter "The external authenticator" "CHAPexternauth"
27772 .scindex IIDexternauth1 "&(external)& authenticator"
27773 .scindex IIDexternauth2 "authenticators" "&(external)&"
27774 .cindex "authentication" "Client Certificate"
27775 .cindex "authentication" "X509"
27776 .cindex "Certificate-based authentication"
27777 The &(external)& authenticator provides support for
27778 authentication based on non-SMTP information.
27779 The specification is in RFC 4422 Appendix A
27780 (&url(https://tools.ietf.org/html/rfc4422)).
27781 It is only a transport and negotiation mechanism;
27782 the process of authentication is entirely controlled
27783 by the server configuration.
27784
27785 The client presents an identity in-clear.
27786 It is probably wise for a server to only advertise,
27787 and for clients to only attempt,
27788 this authentication method on a secure (eg. under TLS) connection.
27789
27790 One possible use, compatible with the
27791 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27792 is for using X509 client certificates.
27793
27794 It thus overlaps in function with the TLS authenticator
27795 (see &<<CHAPtlsauth>>&)
27796 but is a full SMTP SASL authenticator
27797 rather than being implicit for TLS-connection carried
27798 client certificates only.
27799
27800 The examples and discussion in this chapter assume that
27801 client-certificate authentication is being done.
27802
27803 The client must present a certificate,
27804 for which it must have been requested via the
27805 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27806 (see &<<CHAPTLS>>&).
27807 For authentication to be effective the certificate should be
27808 verifiable against a trust-anchor certificate known to the server.
27809
27810 .section "External options" "SECTexternsoptions"
27811 .cindex "options" "&(external)& authenticator (server)"
27812 The &(external)& authenticator has two server options:
27813
27814 .option server_param2 external string&!! unset
27815 .option server_param3 external string&!! unset
27816 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27817 These options are expanded before the &%server_condition%& option
27818 and the result are placed in &$auth2$& and &$auth3$& resectively.
27819 If the expansion is forced to fail, authentication fails. Any other expansion
27820 failure causes a temporary error code to be returned.
27821
27822 They can be used to clarify the coding of a complex &%server_condition%&.
27823
27824 .section "Using external in a server" "SECTexternserver"
27825 .cindex "AUTH" "in &(external)& authenticator"
27826 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27827         "in &(external)& authenticator"
27828 .vindex "&$auth1$&, &$auth2$&, etc"
27829 .cindex "base64 encoding" "in &(external)& authenticator"
27830
27831 When running as a server, &(external)& performs the authentication test by
27832 expanding a string. The data sent by the client with the AUTH command, or in
27833 response to subsequent prompts, is base64 encoded, and so may contain any byte
27834 values when decoded. The decoded value is treated as
27835 an identity for authentication and
27836 placed in the expansion variable &$auth1$&.
27837
27838 For compatibility with previous releases of Exim, the value is also placed in
27839 the expansion variable &$1$&. However, the use of this
27840 variable for this purpose is now deprecated, as it can lead to confusion in
27841 string expansions that also use them for other things.
27842
27843 .vindex "&$authenticated_id$&"
27844 Once an identity has been received,
27845 &%server_condition%& is expanded. If the expansion is forced to fail,
27846 authentication fails. Any other expansion failure causes a temporary error code
27847 to be returned. If the result of a successful expansion is an empty string,
27848 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27849 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27850 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27851 For any other result, a temporary error code is returned, with the expanded
27852 string as the error text.
27853
27854 Example:
27855 .code
27856 ext_ccert_san_mail:
27857   driver =            external
27858   public_name =       EXTERNAL
27859
27860   server_advertise_condition = $tls_in_certificate_verified
27861   server_param2 =     ${certextract {subj_altname,mail,>:} \
27862                                     {$tls_in_peercert}}
27863   server_condition =  ${if forany {$auth2} \
27864                             {eq {$item}{$auth1}}}
27865   server_set_id =     $auth1
27866 .endd
27867 This accepts a client certificate that is verifiable against any
27868 of your configured trust-anchors
27869 (which usually means the full set of public CAs)
27870 and which has a mail-SAN matching the claimed identity sent by the client.
27871
27872 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
27873 The account name is therefore guessable by an opponent.
27874 TLS 1.3 protects both server and client certificates, and is not vulnerable
27875 in this way.
27876
27877
27878 .section "Using external in a client" "SECTexternclient"
27879 .cindex "options" "&(external)& authenticator (client)"
27880 The &(external)& authenticator has one client option:
27881
27882 .option client_send external string&!! unset
27883 This option is expanded and sent with the AUTH command as the
27884 identity being asserted.
27885
27886 Example:
27887 .code
27888 ext_ccert:
27889   driver =      external
27890   public_name = EXTERNAL
27891
27892   client_condition = ${if !eq{$tls_out_cipher}{}}
27893   client_send = myaccount@smarthost.example.net
27894 .endd
27895
27896
27897 .ecindex IIDexternauth1
27898 .ecindex IIDexternauth2
27899 .wen
27900
27901
27902
27903
27904
27905 . ////////////////////////////////////////////////////////////////////////////
27906 . ////////////////////////////////////////////////////////////////////////////
27907
27908 .chapter "The tls authenticator" "CHAPtlsauth"
27909 .scindex IIDtlsauth1 "&(tls)& authenticator"
27910 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27911 .cindex "authentication" "Client Certificate"
27912 .cindex "authentication" "X509"
27913 .cindex "Certificate-based authentication"
27914 The &(tls)& authenticator provides server support for
27915 authentication based on client certificates.
27916
27917 It is not an SMTP authentication mechanism and is not
27918 advertised by the server as part of the SMTP EHLO response.
27919 It is an Exim authenticator in the sense that it affects
27920 the protocol element of the log line, can be tested for
27921 by the &%authenticated%& ACL condition, and can set
27922 the &$authenticated_id$& variable.
27923
27924 The client must present a verifiable certificate,
27925 for which it must have been requested via the
27926 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27927 (see &<<CHAPTLS>>&).
27928
27929 If an authenticator of this type is configured it is
27930 run before any SMTP-level communication is done,
27931 and can authenticate the connection.
27932 If it does, SMTP authentication is not offered.
27933
27934 A maximum of one authenticator of this type may be present.
27935
27936
27937 .cindex "options" "&(tls)& authenticator (server)"
27938 The &(tls)& authenticator has three server options:
27939
27940 .option server_param1 tls string&!! unset
27941 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27942 This option is expanded after the TLS negotiation and
27943 the result is placed in &$auth1$&.
27944 If the expansion is forced to fail, authentication fails. Any other expansion
27945 failure causes a temporary error code to be returned.
27946
27947 .option server_param2 tls string&!! unset
27948 .option server_param3 tls string&!! unset
27949 As above, for &$auth2$& and &$auth3$&.
27950
27951 &%server_param1%& may also be spelled &%server_param%&.
27952
27953
27954 Example:
27955 .code
27956 tls:
27957   driver = tls
27958   server_param1 =     ${certextract {subj_altname,mail,>:} \
27959                                     {$tls_in_peercert}}
27960   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
27961                                  {forany {$auth1} \
27962                             {!= {0} \
27963                                 {${lookup ldap{ldap:///\
27964                          mailname=${quote_ldap_dn:${lc:$item}},\
27965                          ou=users,LDAP_DC?mailid} {$value}{0} \
27966                        }    }  } }}}
27967   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27968 .endd
27969 This accepts a client certificate that is verifiable against any
27970 of your configured trust-anchors
27971 (which usually means the full set of public CAs)
27972 and which has a SAN with a good account name.
27973
27974 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27975 The account name is therefore guessable by an opponent.
27976 TLS 1.3 protects both server and client certificates, and is not vulnerable
27977 in this way.
27978 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27979
27980 . An alternative might use
27981 . .code
27982 .   server_param1 = ${sha256:$tls_in_peercert}
27983 . .endd
27984 . to require one of a set of specific certs that define a given account
27985 . (the verification is still required, but mostly irrelevant).
27986 . This would help for per-device use.
27987 .
27988 . However, for the future we really need support for checking a
27989 . user cert in LDAP - which probably wants a base-64 DER.
27990
27991 .ecindex IIDtlsauth1
27992 .ecindex IIDtlsauth2
27993
27994
27995 Note that because authentication is traditionally an SMTP operation,
27996 the &%authenticated%& ACL condition cannot be used in
27997 a connect- or helo-ACL.
27998
27999
28000
28001 . ////////////////////////////////////////////////////////////////////////////
28002 . ////////////////////////////////////////////////////////////////////////////
28003
28004 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28005          "Encrypted SMTP connections"
28006 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28007 .scindex IIDencsmtp2 "SMTP" "encryption"
28008 .cindex "TLS" "on SMTP connection"
28009 .cindex "OpenSSL"
28010 .cindex "GnuTLS"
28011 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28012 Sockets Layer), is implemented by making use of the OpenSSL library or the
28013 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28014 cryptographic code in the Exim distribution itself for implementing TLS. In
28015 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28016 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28017 You also need to understand the basic concepts of encryption at a managerial
28018 level, and in particular, the way that public keys, private keys, and
28019 certificates are used.
28020
28021 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28022 connection is established, the client issues a STARTTLS command. If the
28023 server accepts this, the client and the server negotiate an encryption
28024 mechanism. If the negotiation succeeds, the data that subsequently passes
28025 between them is encrypted.
28026
28027 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28028 and if so, what cipher suite is in use, whether the client supplied a
28029 certificate, and whether or not that certificate was verified. This makes it
28030 possible for an Exim server to deny or accept certain commands based on the
28031 encryption state.
28032
28033 &*Warning*&: Certain types of firewall and certain anti-virus products can
28034 disrupt TLS connections. You need to turn off SMTP scanning for these products
28035 in order to get TLS to work.
28036
28037
28038
28039 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28040          "SECID284"
28041 .cindex "submissions protocol"
28042 .cindex "ssmtp protocol"
28043 .cindex "smtps protocol"
28044 .cindex "SMTP" "submissions protocol"
28045 .cindex "SMTP" "ssmtp protocol"
28046 .cindex "SMTP" "smtps protocol"
28047 The history of port numbers for TLS in SMTP is a little messy and has been
28048 contentious.  As of RFC 8314, the common practice of using the historically
28049 allocated port 465 for "email submission but with TLS immediately upon connect
28050 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28051 by them in preference to STARTTLS.
28052
28053 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28054 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28055 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28056
28057 This approach was, for a while, officially abandoned when encrypted SMTP was
28058 standardized, but many clients kept using it, even as the TCP port number was
28059 reassigned for other use.
28060 Thus you may encounter guidance claiming that you shouldn't enable use of
28061 this port.
28062 In practice, a number of mail-clients have only ever supported submissions,
28063 not submission with STARTTLS upgrade.
28064 Ideally, offer both submission (587) and submissions (465) service.
28065
28066 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28067 global option. Its value must be a list of port numbers;
28068 the most common use is expected to be:
28069 .code
28070 tls_on_connect_ports = 465
28071 .endd
28072 The port numbers specified by this option apply to all SMTP connections, both
28073 via the daemon and via &'inetd'&. You still need to specify all the ports that
28074 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28075 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28076 an extra port &-- rather, it specifies different behaviour on a port that is
28077 defined elsewhere.
28078
28079 There is also a &%-tls-on-connect%& command line option. This overrides
28080 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28081
28082
28083
28084
28085
28086
28087 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28088 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28089 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28090 .new
28091 To build Exim to use OpenSSL you need to set
28092 .code
28093 USE_OPENSSL=yes
28094 .endd
28095 in Local/Makefile.
28096 .wen
28097
28098 To build Exim to use GnuTLS, you need to set
28099 .code
28100 USE_GNUTLS=yes
28101 .endd
28102 in Local/Makefile.
28103
28104 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28105 include files and libraries for GnuTLS can be found.
28106
28107 There are some differences in usage when using GnuTLS instead of OpenSSL:
28108
28109 .ilist
28110 The &%tls_verify_certificates%& option
28111 cannot be the path of a directory
28112 for GnuTLS versions before 3.3.6
28113 (for later versions, or OpenSSL, it can be either).
28114 .next
28115 The default value for &%tls_dhparam%& differs for historical reasons.
28116 .next
28117 .vindex "&$tls_in_peerdn$&"
28118 .vindex "&$tls_out_peerdn$&"
28119 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28120 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28121 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28122 .next
28123 OpenSSL identifies cipher suites using hyphens as separators, for example:
28124 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28125 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28126 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28127 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28128 to handle its own older variants) when processing lists of cipher suites in the
28129 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28130 option).
28131 .next
28132 The &%tls_require_ciphers%& options operate differently, as described in the
28133 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28134 .next
28135 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28136 When using OpenSSL, this option is ignored.
28137 (If an API is found to let OpenSSL be configured in this way,
28138 let the Exim Maintainers know and we'll likely use it).
28139 .next
28140 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28141 main option, it must be ordered to match the &%tls_certificate%& list.
28142 .next
28143 Some other recently added features may only be available in one or the other.
28144 This should be documented with the feature.  If the documentation does not
28145 explicitly state that the feature is infeasible in the other TLS
28146 implementation, then patches are welcome.
28147 .endlist
28148
28149
28150 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28151 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28152 an explicit path; if the latter, then the text about generation still applies,
28153 but not the chosen filename.
28154 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28155 See the documentation of &%tls_dhparam%& for more information.
28156
28157 GnuTLS uses D-H parameters that may take a substantial amount of time
28158 to compute. It is unreasonable to re-compute them for every TLS session.
28159 Therefore, Exim keeps this data in a file in its spool directory, called
28160 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28161 of bits requested.
28162 The file is owned by the Exim user and is readable only by
28163 its owner. Every Exim process that start up GnuTLS reads the D-H
28164 parameters from this file. If the file does not exist, the first Exim process
28165 that needs it computes the data and writes it to a temporary file which is
28166 renamed once it is complete. It does not matter if several Exim processes do
28167 this simultaneously (apart from wasting a few resources). Once a file is in
28168 place, new Exim processes immediately start using it.
28169
28170 For maximum security, the parameters that are stored in this file should be
28171 recalculated periodically, the frequency depending on your paranoia level.
28172 If you are avoiding using the fixed D-H primes published in RFCs, then you
28173 are concerned about some advanced attacks and will wish to do this; if you do
28174 not regenerate then you might as well stick to the standard primes.
28175
28176 Arranging this is easy in principle; just delete the file when you want new
28177 values to be computed. However, there may be a problem. The calculation of new
28178 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28179 If the system is not very active, &_/dev/random_& may delay returning data
28180 until enough randomness (entropy) is available. This may cause Exim to hang for
28181 a substantial amount of time, causing timeouts on incoming connections.
28182
28183 The solution is to generate the parameters externally to Exim. They are stored
28184 in &_gnutls-params-N_& in PEM format, which means that they can be
28185 generated externally using the &(certtool)& command that is part of GnuTLS.
28186
28187 To replace the parameters with new ones, instead of deleting the file
28188 and letting Exim re-create it, you can generate new parameters using
28189 &(certtool)& and, when this has been done, replace Exim's cache file by
28190 renaming. The relevant commands are something like this:
28191 .code
28192 # ls
28193 [ look for file; assume gnutls-params-2236 is the most recent ]
28194 # rm -f new-params
28195 # touch new-params
28196 # chown exim:exim new-params
28197 # chmod 0600 new-params
28198 # certtool --generate-dh-params --bits 2236 >>new-params
28199 # openssl dhparam -noout -text -in new-params | head
28200 [ check the first line, make sure it's not more than 2236;
28201   if it is, then go back to the start ("rm") and repeat
28202   until the size generated is at most the size requested ]
28203 # chmod 0400 new-params
28204 # mv new-params gnutls-params-2236
28205 .endd
28206 If Exim never has to generate the parameters itself, the possibility of
28207 stalling is removed.
28208
28209 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28210 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28211 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28212 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28213 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28214 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28215 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28216 which applies to all D-H usage, client or server.  If the value returned by
28217 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28218 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28219 limit, which is still much higher than Exim historically used.
28220
28221 The filename and bits used will change as the GnuTLS maintainers change the
28222 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28223 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28224 2432 bits, while NSS is limited to 2236 bits.
28225
28226 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28227 increase the chance of the generated prime actually being within acceptable
28228 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28229 procedure above.  There is no sane procedure available to Exim to double-check
28230 the size of the generated prime, so it might still be too large.
28231
28232
28233 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28234 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28235 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28236 There is a function in the OpenSSL library that can be passed a list of cipher
28237 suites before the cipher negotiation takes place. This specifies which ciphers
28238 are acceptable for TLS versions prior to 1.3.
28239 The list is colon separated and may contain names like
28240 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28241 directly to this function call.
28242 Many systems will install the OpenSSL manual-pages, so you may have
28243 &'ciphers(1)'& available to you.
28244 The following quotation from the OpenSSL
28245 documentation specifies what forms of item are allowed in the cipher string:
28246
28247 .ilist
28248 It can consist of a single cipher suite such as RC4-SHA.
28249 .next
28250 It can represent a list of cipher suites containing a certain algorithm,
28251 or cipher suites of a certain type. For example SHA1 represents all
28252 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28253 SSL v3 algorithms.
28254 .next
28255 Lists of cipher suites can be combined in a single cipher string using
28256 the + character. This is used as a logical and operation. For example
28257 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28258 algorithms.
28259 .endlist
28260
28261 Each cipher string can be optionally preceded by one of the characters &`!`&,
28262 &`-`& or &`+`&.
28263 .ilist
28264 If &`!`& is used, the ciphers are permanently deleted from the list. The
28265 ciphers deleted can never reappear in the list even if they are explicitly
28266 stated.
28267 .next
28268 If &`-`& is used, the ciphers are deleted from the list, but some or all
28269 of the ciphers can be added again by later options.
28270 .next
28271 If &`+`& is used, the ciphers are moved to the end of the list. This
28272 option does not add any new ciphers; it just moves matching existing ones.
28273 .endlist
28274
28275 If none of these characters is present, the string is interpreted as
28276 a list of ciphers to be appended to the current preference list. If the list
28277 includes any ciphers already present they will be ignored: that is, they will
28278 not be moved to the end of the list.
28279 .endlist
28280
28281 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28282 string:
28283 .code
28284 # note single-quotes to get ! past any shell history expansion
28285 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28286 .endd
28287
28288 This example will let the library defaults be permitted on the MX port, where
28289 there's probably no identity verification anyway, but ups the ante on the
28290 submission ports where the administrator might have some influence on the
28291 choice of clients used:
28292 .code
28293 # OpenSSL variant; see man ciphers(1)
28294 tls_require_ciphers = ${if =={$received_port}{25}\
28295                            {DEFAULT}\
28296                            {HIGH:!MD5:!SHA1}}
28297 .endd
28298
28299 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28300 .code
28301 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28302 .endd
28303
28304 For TLS version 1.3 the control available is less fine-grained
28305 and Exim does not provide access to it at present.
28306 The value of the &%tls_require_ciphers%& option is ignored when
28307 TLS version 1.3 is negotiated.
28308
28309 As of writing the library default cipher suite list for TLSv1.3 is
28310 .code
28311 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28312 .endd
28313
28314
28315 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28316          "SECTreqciphgnu"
28317 .cindex "GnuTLS" "specifying parameters for"
28318 .cindex "TLS" "specifying ciphers (GnuTLS)"
28319 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28320 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28321 .cindex "TLS" "specifying protocols (GnuTLS)"
28322 .cindex "TLS" "specifying priority string (GnuTLS)"
28323 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28324 The GnuTLS library allows the caller to provide a "priority string", documented
28325 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28326 ciphersuite specification in OpenSSL.
28327
28328 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28329 and controls both protocols and ciphers.
28330
28331 The &%tls_require_ciphers%& option is available both as an global option,
28332 controlling how Exim behaves as a server, and also as an option of the
28333 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28334 the value is string expanded.  The resulting string is not an Exim list and
28335 the string is given to the GnuTLS library, so that Exim does not need to be
28336 aware of future feature enhancements of GnuTLS.
28337
28338 Documentation of the strings accepted may be found in the GnuTLS manual, under
28339 "Priority strings".  This is online as
28340 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28341 but beware that this relates to GnuTLS 3, which may be newer than the version
28342 installed on your system.  If you are using GnuTLS 3,
28343 then the example code
28344 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28345 on that site can be used to test a given string.
28346
28347 For example:
28348 .code
28349 # Disable older versions of protocols
28350 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28351 .endd
28352
28353 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28354 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28355 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28356
28357 This example will let the library defaults be permitted on the MX port, where
28358 there's probably no identity verification anyway, and lowers security further
28359 by increasing compatibility; but this ups the ante on the submission ports
28360 where the administrator might have some influence on the choice of clients
28361 used:
28362 .code
28363 # GnuTLS variant
28364 tls_require_ciphers = ${if =={$received_port}{25}\
28365                            {NORMAL:%COMPAT}\
28366                            {SECURE128}}
28367 .endd
28368
28369
28370 .section "Configuring an Exim server to use TLS" "SECID182"
28371 .cindex "TLS" "configuring an Exim server"
28372 When Exim has been built with TLS support, it advertises the availability of
28373 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28374 but not to any others. The default value of this option is *, which means
28375 that STARTTLS is always advertised.  Set it to blank to never advertise;
28376 this is reasonable for systems that want to use TLS only as a client.
28377
28378 If STARTTLS is to be used you
28379 need to set some other options in order to make TLS available.
28380
28381 If a client issues a STARTTLS command and there is some configuration
28382 problem in the server, the command is rejected with a 454 error. If the client
28383 persists in trying to issue SMTP commands, all except QUIT are rejected
28384 with the error
28385 .code
28386 554 Security failure
28387 .endd
28388 If a STARTTLS command is issued within an existing TLS session, it is
28389 rejected with a 554 error code.
28390
28391 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28392 must be set to match some hosts. The default is * which matches all hosts.
28393
28394 If this is all you do, TLS encryption will be enabled but not authentication -
28395 meaning that the peer has no assurance it is actually you he is talking to.
28396 You gain protection from a passive sniffer listening on the wire but not
28397 from someone able to intercept the communication.
28398
28399 Further protection requires some further configuration at the server end.
28400
28401 To make TLS work you need to set, in the server,
28402 .code
28403 tls_certificate = /some/file/name
28404 tls_privatekey = /some/file/name
28405 .endd
28406 These options are, in fact, expanded strings, so you can make them depend on
28407 the identity of the client that is connected if you wish. The first file
28408 contains the server's X509 certificate, and the second contains the private key
28409 that goes with it. These files need to be
28410 PEM format and readable by the Exim user, and must
28411 always be given as full path names.
28412 The key must not be password-protected.
28413 They can be the same file if both the
28414 certificate and the key are contained within it. If &%tls_privatekey%& is not
28415 set, or if its expansion is forced to fail or results in an empty string, this
28416 is assumed to be the case. The certificate file may also contain intermediate
28417 certificates that need to be sent to the client to enable it to authenticate
28418 the server's certificate.
28419
28420 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28421 colon-separated lists of file paths.  Ciphers using given authentication
28422 algorithms require the presence of a suitable certificate to supply the
28423 public-key.  The server selects among the certificates to present to the
28424 client depending on the selected cipher, hence the priority ordering for
28425 ciphers will affect which certificate is used.
28426
28427 If you do not understand about certificates and keys, please try to find a
28428 source of this background information, which is not Exim-specific. (There are a
28429 few comments below in section &<<SECTcerandall>>&.)
28430
28431 &*Note*&: These options do not apply when Exim is operating as a client &--
28432 they apply only in the case of a server. If you need to use a certificate in an
28433 Exim client, you must set the options of the same names in an &(smtp)&
28434 transport.
28435
28436 With just these options, an Exim server will be able to use TLS. It does not
28437 require the client to have a certificate (but see below for how to insist on
28438 this). There is one other option that may be needed in other situations. If
28439 .code
28440 tls_dhparam = /some/file/name
28441 .endd
28442 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28443 with the parameters contained in the file.
28444 Set this to &`none`& to disable use of DH entirely, by making no prime
28445 available:
28446 .code
28447 tls_dhparam = none
28448 .endd
28449 This may also be set to a string identifying a standard prime to be used for
28450 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28451 used is &`ike23`&.  There are a few standard primes available, see the
28452 documentation for &%tls_dhparam%& for the complete list.
28453
28454 See the command
28455 .code
28456 openssl dhparam
28457 .endd
28458 for a way of generating file data.
28459
28460 The strings supplied for these three options are expanded every time a client
28461 host connects. It is therefore possible to use different certificates and keys
28462 for different hosts, if you so wish, by making use of the client's IP address
28463 in &$sender_host_address$& to control the expansion. If a string expansion is
28464 forced to fail, Exim behaves as if the option is not set.
28465
28466 .cindex "cipher" "logging"
28467 .cindex "log" "TLS cipher"
28468 .vindex "&$tls_in_cipher$&"
28469 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28470 an incoming TLS connection. It is included in the &'Received:'& header of an
28471 incoming message (by default &-- you can, of course, change this), and it is
28472 also included in the log line that records a message's arrival, keyed by
28473 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28474 condition can be used to test for specific cipher suites in ACLs.
28475
28476 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28477 can check the name of the cipher suite and vary their actions accordingly. The
28478 cipher suite names vary, depending on which TLS library is being used. For
28479 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28480 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28481 documentation for more details.
28482
28483 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28484 (again depending on the &%tls_cipher%& log selector).
28485
28486
28487 .section "Requesting and verifying client certificates" "SECID183"
28488 .cindex "certificate" "verification of client"
28489 .cindex "TLS" "client certificate verification"
28490 If you want an Exim server to request a certificate when negotiating a TLS
28491 session with a client, you must set either &%tls_verify_hosts%& or
28492 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28493 apply to all TLS connections. For any host that matches one of these options,
28494 Exim requests a certificate as part of the setup of the TLS session. The
28495 contents of the certificate are verified by comparing it with a list of
28496 expected trust-anchors or certificates.
28497 These may be the system default set (depending on library version),
28498 an explicit file or,
28499 depending on library version, a directory, identified by
28500 &%tls_verify_certificates%&.
28501
28502 A file can contain multiple certificates, concatenated end to end. If a
28503 directory is used
28504 (OpenSSL only),
28505 each certificate must be in a separate file, with a name (or a symbolic link)
28506 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28507 certificate. You can compute the relevant hash by running the command
28508 .code
28509 openssl x509 -hash -noout -in /cert/file
28510 .endd
28511 where &_/cert/file_& contains a single certificate.
28512
28513 There is no checking of names of the client against the certificate
28514 Subject Name or Subject Alternate Names.
28515
28516 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28517 what happens if the client does not supply a certificate, or if the certificate
28518 does not match any of the certificates in the collection named by
28519 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28520 attempt to set up a TLS session is aborted, and the incoming connection is
28521 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28522 session continues. ACLs that run for subsequent SMTP commands can detect the
28523 fact that no certificate was verified, and vary their actions accordingly. For
28524 example, you can insist on a certificate before accepting a message for
28525 relaying, but not when the message is destined for local delivery.
28526
28527 .vindex "&$tls_in_peerdn$&"
28528 When a client supplies a certificate (whether it verifies or not), the value of
28529 the Distinguished Name of the certificate is made available in the variable
28530 &$tls_in_peerdn$& during subsequent processing of the message.
28531
28532 .cindex "log" "distinguished name"
28533 Because it is often a long text string, it is not included in the log line or
28534 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28535 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28536 &%received_header_text%& to change the &'Received:'& header. When no
28537 certificate is supplied, &$tls_in_peerdn$& is empty.
28538
28539
28540 .section "Revoked certificates" "SECID184"
28541 .cindex "TLS" "revoked certificates"
28542 .cindex "revocation list"
28543 .cindex "certificate" "revocation list"
28544 .cindex "OCSP" "stapling"
28545 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28546 certificates are revoked. If you have such a list, you can pass it to an Exim
28547 server using the global option called &%tls_crl%& and to an Exim client using
28548 an identically named option for the &(smtp)& transport. In each case, the value
28549 of the option is expanded and must then be the name of a file that contains a
28550 CRL in PEM format.
28551 The downside is that clients have to periodically re-download a potentially huge
28552 file from every certificate authority they know of.
28553
28554 The way with most moving parts at query time is Online Certificate
28555 Status Protocol (OCSP), where the client verifies the certificate
28556 against an OCSP server run by the CA.  This lets the CA track all
28557 usage of the certs.  It requires running software with access to the
28558 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28559 is based on HTTP and can be proxied accordingly.
28560
28561 The only widespread OCSP server implementation (known to this writer)
28562 comes as part of OpenSSL and aborts on an invalid request, such as
28563 connecting to the port and then disconnecting.  This requires
28564 re-entering the passphrase each time some random client does this.
28565
28566 The third way is OCSP Stapling; in this, the server using a certificate
28567 issued by the CA periodically requests an OCSP proof of validity from
28568 the OCSP server, then serves it up inline as part of the TLS
28569 negotiation.   This approach adds no extra round trips, does not let the
28570 CA track users, scales well with number of certs issued by the CA and is
28571 resilient to temporary OCSP server failures, as long as the server
28572 starts retrying to fetch an OCSP proof some time before its current
28573 proof expires.  The downside is that it requires server support.
28574
28575 Unless Exim is built with the support disabled,
28576 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28577 support for OCSP stapling is included.
28578
28579 There is a global option called &%tls_ocsp_file%&.
28580 The file specified therein is expected to be in DER format, and contain
28581 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28582 option will be re-expanded for SNI, if the &%tls_certificate%& option
28583 contains &`tls_in_sni`&, as per other TLS options.
28584
28585 Exim does not at this time implement any support for fetching a new OCSP
28586 proof.  The burden is on the administrator to handle this, outside of
28587 Exim.  The file specified should be replaced atomically, so that the
28588 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28589 on each connection, so a new file will be handled transparently on the
28590 next connection.
28591
28592 When built with OpenSSL Exim will check for a valid next update timestamp
28593 in the OCSP proof; if not present, or if the proof has expired, it will be
28594 ignored.
28595
28596 For the client to be able to verify the stapled OCSP the server must
28597 also supply, in its stapled information, any intermediate
28598 certificates for the chain leading to the OCSP proof from the signer
28599 of the server certificate.  There may be zero or one such. These
28600 intermediate certificates should be added to the server OCSP stapling
28601 file named by &%tls_ocsp_file%&.
28602
28603 Note that the proof only covers the terminal server certificate,
28604 not any of the chain from CA to it.
28605
28606 There is no current way to staple a proof for a client certificate.
28607
28608 .code
28609   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28610   OCSP server is supplied.  The server URL may be included in the
28611   server certificate, if the CA is helpful.
28612
28613   One failure mode seen was the OCSP Signer cert expiring before the end
28614   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28615   noted this as invalid overall, but the re-fetch script did not.
28616 .endd
28617
28618
28619
28620
28621 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28622 .cindex "cipher" "logging"
28623 .cindex "log" "TLS cipher"
28624 .cindex "log" "distinguished name"
28625 .cindex "TLS" "configuring an Exim client"
28626 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28627 deliveries as well as to incoming, the latter one causing logging of the
28628 server certificate's DN. The remaining client configuration for TLS is all
28629 within the &(smtp)& transport.
28630
28631 It is not necessary to set any options to have TLS work in the &(smtp)&
28632 transport. If Exim is built with TLS support, and TLS is advertised by a
28633 server, the &(smtp)& transport always tries to start a TLS session. However,
28634 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28635 transport) to a list of server hosts for which TLS should not be used.
28636
28637 If you do not want Exim to attempt to send messages unencrypted when an attempt
28638 to set up an encrypted connection fails in any way, you can set
28639 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28640 those hosts, delivery is always deferred if an encrypted connection cannot be
28641 set up. If there are any other hosts for the address, they are tried in the
28642 usual way.
28643
28644 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28645 the message unencrypted. It always does this if the response to STARTTLS is
28646 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28647 session after a success response code, what happens is controlled by the
28648 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28649 delivery to this host is deferred, and other hosts (if available) are tried. If
28650 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28651 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28652 negotiation fails, Exim closes the current connection (because it is in an
28653 unknown state), opens a new one to the same host, and then tries the delivery
28654 unencrypted.
28655
28656 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28657 transport provide the client with a certificate, which is passed to the server
28658 if it requests it. If the server is Exim, it will request a certificate only if
28659 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28660
28661 .new
28662 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
28663 for client use (they are usable for server use).
28664 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
28665 in failed connections.
28666 .wen
28667
28668 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28669 specifies a collection of expected server certificates.
28670 These may be
28671 the system default set (depending on library version),
28672 a file,
28673 or (depending on library version) a directory.
28674 The client verifies the server's certificate
28675 against this collection, taking into account any revoked certificates that are
28676 in the list defined by &%tls_crl%&.
28677 Failure to verify fails the TLS connection unless either of the
28678 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28679
28680 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28681 certificate verification to the listed servers.  Verification either must
28682 or need not succeed respectively.
28683
28684 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28685 checks are made: that the host name (the one in the DNS A record)
28686 is valid for the certificate.
28687 The option defaults to always checking.
28688
28689 The &(smtp)& transport has two OCSP-related options:
28690 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28691 is requested and required for the connection to proceed.  The default
28692 value is empty.
28693 &%hosts_request_ocsp%&; a host-list for which (additionally)
28694 a Certificate Status is requested (but not necessarily verified).  The default
28695 value is "*" meaning that requests are made unless configured
28696 otherwise.
28697
28698 The host(s) should also be in &%hosts_require_tls%&, and
28699 &%tls_verify_certificates%& configured for the transport,
28700 for OCSP to be relevant.
28701
28702 If
28703 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28704 list of permitted cipher suites. If either of these checks fails, delivery to
28705 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28706 alternative hosts, if any.
28707
28708  &*Note*&:
28709 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28710 is operating as a client. Exim does not assume that a server certificate (set
28711 by the global options of the same name) should also be used when operating as a
28712 client.
28713
28714 .vindex "&$host$&"
28715 .vindex "&$host_address$&"
28716 All the TLS options in the &(smtp)& transport are expanded before use, with
28717 &$host$& and &$host_address$& containing the name and address of the server to
28718 which the client is connected. Forced failure of an expansion causes Exim to
28719 behave as if the relevant option were unset.
28720
28721 .vindex &$tls_out_bits$&
28722 .vindex &$tls_out_cipher$&
28723 .vindex &$tls_out_peerdn$&
28724 .vindex &$tls_out_sni$&
28725 Before an SMTP connection is established, the
28726 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28727 variables are emptied. (Until the first connection, they contain the values
28728 that were set when the message was received.) If STARTTLS is subsequently
28729 successfully obeyed, these variables are set to the relevant values for the
28730 outgoing connection.
28731
28732
28733
28734 .section "Use of TLS Server Name Indication" "SECTtlssni"
28735 .cindex "TLS" "Server Name Indication"
28736 .vindex "&$tls_in_sni$&"
28737 .oindex "&%tls_in_sni%&"
28738 With TLS1.0 or above, there is an extension mechanism by which extra
28739 information can be included at various points in the protocol.  One of these
28740 extensions, documented in RFC 6066 (and before that RFC 4366) is
28741 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28742 client in the initial handshake, so that the server can examine the servername
28743 within and possibly choose to use different certificates and keys (and more)
28744 for this session.
28745
28746 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28747 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28748 address.
28749
28750 With SMTP to MX, there are the same problems here as in choosing the identity
28751 against which to validate a certificate: you can't rely on insecure DNS to
28752 provide the identity which you then cryptographically verify.  So this will
28753 be of limited use in that environment.
28754
28755 With SMTP to Submission, there is a well-defined hostname which clients are
28756 connecting to and can validate certificates against.  Thus clients &*can*&
28757 choose to include this information in the TLS negotiation.  If this becomes
28758 wide-spread, then hosters can choose to present different certificates to
28759 different clients.  Or even negotiate different cipher suites.
28760
28761 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28762 if not empty, will be sent on a TLS session as part of the handshake.  There's
28763 nothing more to it.  Choosing a sensible value not derived insecurely is the
28764 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28765 for the lifetime of the client connection (including during authentication).
28766
28767 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28768 received from a client.
28769 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28770
28771 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28772 option (prior to expansion) then the following options will be re-expanded
28773 during TLS session handshake, to permit alternative values to be chosen:
28774
28775 .ilist
28776 &%tls_certificate%&
28777 .next
28778 &%tls_crl%&
28779 .next
28780 &%tls_privatekey%&
28781 .next
28782 &%tls_verify_certificates%&
28783 .next
28784 &%tls_ocsp_file%&
28785 .endlist
28786
28787 Great care should be taken to deal with matters of case, various injection
28788 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28789 can always be referenced; it is important to remember that &$tls_in_sni$& is
28790 arbitrary unverified data provided prior to authentication.
28791 Further, the initial certificate is loaded before SNI has arrived, so
28792 an expansion for &%tls_certificate%& must have a default which is used
28793 when &$tls_in_sni$& is empty.
28794
28795 The Exim developers are proceeding cautiously and so far no other TLS options
28796 are re-expanded.
28797
28798 When Exim is built against OpenSSL, OpenSSL must have been built with support
28799 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28800 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28801 see &`-servername`& in the output, then OpenSSL has support.
28802
28803 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28804 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28805 built, then you have SNI support).
28806
28807
28808
28809 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28810          "SECTmulmessam"
28811 .cindex "multiple SMTP deliveries with TLS"
28812 .cindex "TLS" "multiple message deliveries"
28813 Exim sends multiple messages down the same TCP/IP connection by starting up
28814 an entirely new delivery process for each message, passing the socket from
28815 one process to the next. This implementation does not fit well with the use
28816 of TLS, because there is quite a lot of state information associated with a TLS
28817 connection, not just a socket identification. Passing all the state information
28818 to a new process is not feasible. Consequently, for sending using TLS Exim
28819 starts an additional proxy process for handling the encryption, piping the
28820 unencrypted data stream from and to the delivery processes.
28821
28822 An older mode of operation can be enabled on a per-host basis by the
28823 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28824 this list the proxy process described above is not used; instead Exim
28825 shuts down an existing TLS session being run by the delivery process
28826 before passing the socket to a new process. The new process may then
28827 try to start a new TLS session, and if successful, may try to re-authenticate
28828 if AUTH is in use, before sending the next message.
28829
28830 The RFC is not clear as to whether or not an SMTP session continues in clear
28831 after TLS has been shut down, or whether TLS may be restarted again later, as
28832 just described. However, if the server is Exim, this shutdown and
28833 reinitialization works. It is not known which (if any) other servers operate
28834 successfully if the client closes a TLS session and continues with unencrypted
28835 SMTP, but there are certainly some that do not work. For such servers, Exim
28836 should not pass the socket to another process, because the failure of the
28837 subsequent attempt to use it would cause Exim to record a temporary host error,
28838 and delay other deliveries to that host.
28839
28840 To test for this case, Exim sends an EHLO command to the server after
28841 closing down the TLS session. If this fails in any way, the connection is
28842 closed instead of being passed to a new delivery process, but no retry
28843 information is recorded.
28844
28845 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28846 &(smtp)& transport to match those hosts for which Exim should not pass
28847 connections to new processes if TLS has been used.
28848
28849
28850
28851
28852 .section "Certificates and all that" "SECTcerandall"
28853 .cindex "certificate" "references to discussion"
28854 In order to understand fully how TLS works, you need to know about
28855 certificates, certificate signing, and certificate authorities.
28856 This is a large topic and an introductory guide is unsuitable for the Exim
28857 reference manual, so instead we provide pointers to existing documentation.
28858
28859 The Apache web-server was for a long time the canonical guide, so their
28860 documentation is a good place to start; their SSL module's Introduction
28861 document is currently at
28862 .display
28863 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28864 .endd
28865 and their FAQ is at
28866 .display
28867 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28868 .endd
28869
28870 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28871 0-201-61598-3) in 2001, contains both introductory and more in-depth
28872 descriptions.
28873 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28874 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28875 Ivan is the author of the popular TLS testing tools at
28876 &url(https://www.ssllabs.com/).
28877
28878
28879 .section "Certificate chains" "SECID186"
28880 The file named by &%tls_certificate%& may contain more than one
28881 certificate. This is useful in the case where the certificate that is being
28882 sent is validated by an intermediate certificate which the other end does
28883 not have. Multiple certificates must be in the correct order in the file.
28884 First the host's certificate itself, then the first intermediate
28885 certificate to validate the issuer of the host certificate, then the next
28886 intermediate certificate to validate the issuer of the first intermediate
28887 certificate, and so on, until finally (optionally) the root certificate.
28888 The root certificate must already be trusted by the recipient for
28889 validation to succeed, of course, but if it's not preinstalled, sending the
28890 root certificate along with the rest makes it available for the user to
28891 install if the receiving end is a client MUA that can interact with a user.
28892
28893 Note that certificates using MD5 are unlikely to work on today's Internet;
28894 even if your libraries allow loading them for use in Exim when acting as a
28895 server, increasingly clients will not accept such certificates.  The error
28896 diagnostics in such a case can be frustratingly vague.
28897
28898
28899
28900 .section "Self-signed certificates" "SECID187"
28901 .cindex "certificate" "self-signed"
28902 You can create a self-signed certificate using the &'req'& command provided
28903 with OpenSSL, like this:
28904 . ==== Do not shorten the duration here without reading and considering
28905 . ==== the text below.  Please leave it at 9999 days.
28906 .code
28907 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28908             -days 9999 -nodes
28909 .endd
28910 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28911 delimited and so can be identified independently. The &%-days%& option
28912 specifies a period for which the certificate is valid. The &%-nodes%& option is
28913 important: if you do not set it, the key is encrypted with a passphrase
28914 that you are prompted for, and any use that is made of the key causes more
28915 prompting for the passphrase. This is not helpful if you are going to use
28916 this certificate and key in an MTA, where prompting is not possible.
28917
28918 . ==== I expect to still be working 26 years from now.  The less technical
28919 . ==== debt I create, in terms of storing up trouble for my later years, the
28920 . ==== happier I will be then.  We really have reached the point where we
28921 . ==== should start, at the very least, provoking thought and making folks
28922 . ==== pause before proceeding, instead of leaving all the fixes until two
28923 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28924 . ==== -pdp, 2012
28925 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28926 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28927 the above command might produce a date in the past.  Think carefully about
28928 the lifetime of the systems you're deploying, and either reduce the duration
28929 of the certificate or reconsider your platform deployment.  (At time of
28930 writing, reducing the duration is the most likely choice, but the inexorable
28931 progression of time takes us steadily towards an era where this will not
28932 be a sensible resolution).
28933
28934 A self-signed certificate made in this way is sufficient for testing, and
28935 may be adequate for all your requirements if you are mainly interested in
28936 encrypting transfers, and not in secure identification.
28937
28938 However, many clients require that the certificate presented by the server be a
28939 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28940 certificate. In this situation, the self-signed certificate described above
28941 must be installed on the client host as a trusted root &'certification
28942 authority'& (CA), and the certificate used by Exim must be a user certificate
28943 signed with that self-signed certificate.
28944
28945 For information on creating self-signed CA certificates and using them to sign
28946 user certificates, see the &'General implementation overview'& chapter of the
28947 Open-source PKI book, available online at
28948 &url(https://sourceforge.net/projects/ospkibook/).
28949 .ecindex IIDencsmtp1
28950 .ecindex IIDencsmtp2
28951
28952
28953
28954 .section DANE "SECDANE"
28955 .cindex DANE
28956 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28957 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28958 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28959 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28960 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28961 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28962
28963 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28964 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28965 by (a) is thought to be smaller than that of the set of root CAs.
28966
28967 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28968 fail to pass on a server's STARTTLS.
28969
28970 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28971 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28972 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28973
28974 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28975 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28976 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28977 DNSSEC.
28978 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28979 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28980
28981 There are no changes to Exim specific to server-side operation of DANE.
28982 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28983 in &_Local/Makefile_&.
28984 If it has been included, the macro "_HAVE_DANE" will be defined.
28985
28986 A TLSA record consist of 4 fields, the "Certificate Usage", the
28987 "Selector", the "Matching type", and the "Certificate Association Data".
28988 For a detailed description of the TLSA record see
28989 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
28990
28991 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
28992 These are the "Trust Anchor" and "End Entity" variants.
28993 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28994 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28995 this is appropriate for a single system, using a self-signed certificate.
28996 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28997 well-known one.
28998 A private CA at simplest is just a self-signed certificate (with certain
28999 attributes) which is used to sign server certificates, but running one securely
29000 does require careful arrangement.
29001 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29002 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29003 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29004 all of which point to a single TLSA record.
29005 DANE-TA and DANE-EE can both be used together.
29006
29007 Our recommendation is to use DANE with a certificate from a public CA,
29008 because this enables a variety of strategies for remote clients to verify
29009 your certificate.
29010 You can then publish information both via DANE and another technology,
29011 "MTA-STS", described below.
29012
29013 When you use DANE-TA to publish trust anchor information, you ask entities
29014 outside your administrative control to trust the Certificate Authority for
29015 connections to you.
29016 If using a private CA then you should expect others to still apply the
29017 technical criteria they'd use for a public CA to your certificates.
29018 In particular, you should probably try to follow current best practices for CA
29019 operation around hash algorithms and key sizes.
29020 Do not expect other organizations to lower their security expectations just
29021 because a particular profile might be reasonable for your own internal use.
29022
29023 When this text was last updated, this in practice means to avoid use of SHA-1
29024 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29025 than 4096, for interoperability); to use keyUsage fields correctly; to use
29026 random serial numbers.
29027 The list of requirements is subject to change as best practices evolve.
29028 If you're not already using a private CA, or it doesn't meet these
29029 requirements, then we encourage you to avoid all these issues and use a public
29030 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29031
29032 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29033 a "Matching Type" (3rd) field of SHA2-512(2).
29034
29035 For the "Certificate Authority Data" (4th) field, commands like
29036
29037 .code
29038   openssl x509 -pubkey -noout <certificate.pem \
29039   | openssl rsa -outform der -pubin 2>/dev/null \
29040   | openssl sha512 \
29041   | awk '{print $2}'
29042 .endd
29043
29044 are workable to create a hash of the certificate's public key.
29045
29046 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29047
29048 .code
29049   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29050 .endd
29051
29052 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29053 is useful for quickly generating TLSA records.
29054
29055
29056 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29057
29058 The Certificate issued by the CA published in the DANE-TA model should be
29059 issued using a strong hash algorithm.
29060 Exim, and importantly various other MTAs sending to you, will not
29061 re-enable hash algorithms which have been disabled by default in TLS
29062 libraries.
29063 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29064 interoperability (and probably the maximum too, in 2018).
29065
29066 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29067 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29068 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29069
29070 .code
29071   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29072                                  {= {4}{$tls_out_tlsa_usage}} } \
29073                          {*}{}}
29074 .endd
29075
29076 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29077 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29078 found. If the definition of &%hosts_request_ocsp%& includes the
29079 string "tls_out_tlsa_usage", they are re-expanded in time to
29080 control the OCSP request.
29081
29082 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29083 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29084
29085
29086 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29087 and &%dane_require_tls_ciphers%&.
29088 The &"require"& variant will result in failure if the target host is not
29089 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29090 the &%dnssec_request_domains%& router or transport option.
29091
29092 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29093
29094 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29095 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29096 will be required for the host.  If it does not, the host will not
29097 be used; there is no fallback to non-DANE or non-TLS.
29098
29099 If DANE is requested and usable, then the TLS cipher list configuration
29100 prefers to use the option &%dane_require_tls_ciphers%& and falls
29101 back to &%tls_require_ciphers%& only if that is unset.
29102 This lets you configure "decent crypto" for DANE and "better than nothing
29103 crypto" as the default.  Note though that while GnuTLS lets the string control
29104 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29105 limited to ciphersuite constraints.
29106
29107 If DANE is requested and useable (see above) the following transport options are ignored:
29108 .code
29109   hosts_require_tls
29110   tls_verify_hosts
29111   tls_try_verify_hosts
29112   tls_verify_certificates
29113   tls_crl
29114   tls_verify_cert_hostnames
29115 .endd
29116
29117 If DANE is not usable, whether requested or not, and CA-anchored
29118 verification evaluation is wanted, the above variables should be set appropriately.
29119
29120 The router and transport option &%dnssec_request_domains%& must not be
29121 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29122
29123 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29124
29125 There is a new variable &$tls_out_dane$& which will have "yes" if
29126 verification succeeded using DANE and "no" otherwise (only useful
29127 in combination with events; see &<<CHAPevents>>&),
29128 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29129
29130 .cindex DANE reporting
29131 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29132 to achieve DANE-verified connection, if one was either requested and offered, or
29133 required.  This is intended to support TLS-reporting as defined in
29134 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29135 The &$event_data$& will be one of the Result Types defined in
29136 Section 4.3 of that document.
29137
29138 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29139
29140 DANE is specified in published RFCs and decouples certificate authority trust
29141 selection from a "race to the bottom" of "you must trust everything for mail
29142 to get through".  There is an alternative technology called MTA-STS, which
29143 instead publishes MX trust anchor information on an HTTPS website.  At the
29144 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29145 Exim has no support for MTA-STS as a client, but Exim mail server operators
29146 can choose to publish information describing their TLS configuration using
29147 MTA-STS to let those clients who do use that protocol derive trust
29148 information.
29149
29150 The MTA-STS design requires a certificate from a public Certificate Authority
29151 which is recognized by clients sending to you.
29152 That selection of which CAs are trusted by others is outside your control.
29153
29154 The most interoperable course of action is probably to use
29155 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29156 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29157 records for DANE clients (such as Exim and Postfix) and to publish anchor
29158 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29159 domain itself (with caveats around occasionally broken MTA-STS because of
29160 incompatible specification changes prior to reaching RFC status).
29161
29162
29163
29164 . ////////////////////////////////////////////////////////////////////////////
29165 . ////////////////////////////////////////////////////////////////////////////
29166
29167 .chapter "Access control lists" "CHAPACL"
29168 .scindex IIDacl "&ACL;" "description"
29169 .cindex "control of incoming mail"
29170 .cindex "message" "controlling incoming"
29171 .cindex "policy control" "access control lists"
29172 Access Control Lists (ACLs) are defined in a separate section of the runtime
29173 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29174 name, terminated by a colon. Here is a complete ACL section that contains just
29175 one very small ACL:
29176 .code
29177 begin acl
29178 small_acl:
29179   accept   hosts = one.host.only
29180 .endd
29181 You can have as many lists as you like in the ACL section, and the order in
29182 which they appear does not matter. The lists are self-terminating.
29183
29184 The majority of ACLs are used to control Exim's behaviour when it receives
29185 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29186 when a local process submits a message using SMTP by specifying the &%-bs%&
29187 option. The most common use is for controlling which recipients are accepted
29188 in incoming messages. In addition, you can define an ACL that is used to check
29189 local non-SMTP messages. The default configuration file contains an example of
29190 a realistic ACL for checking RCPT commands. This is discussed in chapter
29191 &<<CHAPdefconfil>>&.
29192
29193
29194 .section "Testing ACLs" "SECID188"
29195 The &%-bh%& command line option provides a way of testing your ACL
29196 configuration locally by running a fake SMTP session with which you interact.
29197
29198
29199 .section "Specifying when ACLs are used" "SECID189"
29200 .cindex "&ACL;" "options for specifying"
29201 In order to cause an ACL to be used, you have to name it in one of the relevant
29202 options in the main part of the configuration. These options are:
29203 .cindex "AUTH" "ACL for"
29204 .cindex "DATA" "ACLs for"
29205 .cindex "ETRN" "ACL for"
29206 .cindex "EXPN" "ACL for"
29207 .cindex "HELO" "ACL for"
29208 .cindex "EHLO" "ACL for"
29209 .cindex "DKIM" "ACL for"
29210 .cindex "MAIL" "ACL for"
29211 .cindex "QUIT, ACL for"
29212 .cindex "RCPT" "ACL for"
29213 .cindex "STARTTLS, ACL for"
29214 .cindex "VRFY" "ACL for"
29215 .cindex "SMTP" "connection, ACL for"
29216 .cindex "non-SMTP messages" "ACLs for"
29217 .cindex "MIME content scanning" "ACL for"
29218 .cindex "PRDR" "ACL for"
29219
29220 .table2 140pt
29221 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29222 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29223 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29224 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29225 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29226 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29227 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29228 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29229 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29230 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29231 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29232 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29233 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29234 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29235 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29236 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29237 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29238 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29239 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29240 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29241 .endtable
29242
29243 For example, if you set
29244 .code
29245 acl_smtp_rcpt = small_acl
29246 .endd
29247 the little ACL defined above is used whenever Exim receives a RCPT command
29248 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29249 done when RCPT commands arrive. A rejection of RCPT should cause the
29250 sending MTA to give up on the recipient address contained in the RCPT
29251 command, whereas rejection at other times may cause the client MTA to keep on
29252 trying to deliver the message. It is therefore recommended that you do as much
29253 testing as possible at RCPT time.
29254
29255
29256 .section "The non-SMTP ACLs" "SECID190"
29257 .cindex "non-SMTP messages" "ACLs for"
29258 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29259 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29260 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29261 the state of the SMTP connection such as encryption and authentication) are not
29262 relevant and are forbidden in these ACLs. However, the sender and recipients
29263 are known, so the &%senders%& and &%sender_domains%& conditions and the
29264 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29265 &$authenticated_sender$& are also available. You can specify added header lines
29266 in any of these ACLs.
29267
29268 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29269 non-SMTP message, before any of the message has been read. (This is the
29270 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29271 batched SMTP input, it runs after the DATA command has been reached. The
29272 result of this ACL is ignored; it cannot be used to reject a message. If you
29273 really need to, you could set a value in an ACL variable here and reject based
29274 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29275 controls, and in particular, it can be used to set
29276 .code
29277 control = suppress_local_fixups
29278 .endd
29279 This cannot be used in the other non-SMTP ACLs because by the time they are
29280 run, it is too late.
29281
29282 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29283 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29284
29285 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29286 kind of rejection is treated as permanent, because there is no way of sending a
29287 temporary error for these kinds of message.
29288
29289
29290 .section "The SMTP connect ACL" "SECID191"
29291 .cindex "SMTP" "connection, ACL for"
29292 .oindex &%smtp_banner%&
29293 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29294 session, after the test specified by &%host_reject_connection%& (which is now
29295 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29296 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29297 the message override the banner message that is otherwise specified by the
29298 &%smtp_banner%& option.
29299
29300
29301 .section "The EHLO/HELO ACL" "SECID192"
29302 .cindex "EHLO" "ACL for"
29303 .cindex "HELO" "ACL for"
29304 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29305 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29306 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29307 Note that a client may issue more than one EHLO or HELO command in an SMTP
29308 session, and indeed is required to issue a new EHLO or HELO after successfully
29309 setting up encryption following a STARTTLS command.
29310
29311 Note also that a deny neither forces the client to go away nor means that
29312 mail will be refused on the connection.  Consider checking for
29313 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29314
29315 If the command is accepted by an &%accept%& verb that has a &%message%&
29316 modifier, the message may not contain more than one line (it will be truncated
29317 at the first newline and a panic logged if it does). Such a message cannot
29318 affect the EHLO options that are listed on the second and subsequent lines of
29319 an EHLO response.
29320
29321
29322 .section "The DATA ACLs" "SECID193"
29323 .cindex "DATA" "ACLs for"
29324 Two ACLs are associated with the DATA command, because it is two-stage
29325 command, with two responses being sent to the client.
29326 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29327 is obeyed. This gives you control after all the RCPT commands, but before
29328 the message itself is received. It offers the opportunity to give a negative
29329 response to the DATA command before the data is transmitted. Header lines
29330 added by MAIL or RCPT ACLs are not visible at this time, but any that
29331 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29332
29333 You cannot test the contents of the message, for example, to verify addresses
29334 in the headers, at RCPT time or when the DATA command is received. Such
29335 tests have to appear in the ACL that is run after the message itself has been
29336 received, before the final response to the DATA command is sent. This is
29337 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29338 associated with the DATA command.
29339
29340 .cindex CHUNKING "BDAT command"
29341 .cindex BDAT "SMTP command"
29342 .cindex "RFC 3030" CHUNKING
29343 If CHUNKING was advertised and a BDAT command sequence is received,
29344 the &%acl_smtp_predata%& ACL is not run.
29345 . XXX why not?  It should be possible, for the first BDAT.
29346 The &%acl_smtp_data%& is run after the last BDAT command and all of
29347 the data specified is received.
29348
29349 For both of these ACLs, it is not possible to reject individual recipients. An
29350 error response rejects the entire message. Unfortunately, it is known that some
29351 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29352 before or after the data) correctly &-- they keep the message on their queues
29353 and try again later, but that is their problem, though it does waste some of
29354 your resources.
29355
29356 The &%acl_smtp_data%& ACL is run after
29357 the &%acl_smtp_data_prdr%&,
29358 the &%acl_smtp_dkim%&
29359 and the &%acl_smtp_mime%& ACLs.
29360
29361 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29362 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29363 enabled (which is the default).
29364
29365 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29366 received, and is executed for each DKIM signature found in a message.  If not
29367 otherwise specified, the default action is to accept.
29368
29369 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29370
29371 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29372
29373
29374 .section "The SMTP MIME ACL" "SECID194"
29375 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29376 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29377
29378 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29379
29380
29381 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29382 .cindex "PRDR" "ACL for"
29383 .oindex "&%prdr_enable%&"
29384 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29385 with PRDR support enabled (which is the default).
29386 It becomes active only when the PRDR feature is negotiated between
29387 client and server for a message, and more than one recipient
29388 has been accepted.
29389
29390 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29391 has been received, and is executed once for each recipient of the message
29392 with &$local_part$& and &$domain$& valid.
29393 The test may accept, defer or deny for individual recipients.
29394 The &%acl_smtp_data%& will still be called after this ACL and
29395 can reject the message overall, even if this ACL has accepted it
29396 for some or all recipients.
29397
29398 PRDR may be used to support per-user content filtering.  Without it
29399 one must defer any recipient after the first that has a different
29400 content-filter configuration.  With PRDR, the RCPT-time check
29401 .cindex "PRDR" "variable for"
29402 for this can be disabled when the variable &$prdr_requested$&
29403 is &"yes"&.
29404 Any required difference in behaviour of the main DATA-time
29405 ACL should however depend on the PRDR-time ACL having run, as Exim
29406 will avoid doing so in some situations (e.g. single-recipient mails).
29407
29408 See also the &%prdr_enable%& global option
29409 and the &%hosts_try_prdr%& smtp transport option.
29410
29411 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29412 If the ACL is not defined, processing completes as if
29413 the feature was not requested by the client.
29414
29415 .section "The QUIT ACL" "SECTQUITACL"
29416 .cindex "QUIT, ACL for"
29417 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29418 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29419 does not in fact control any access.
29420 For this reason, it may only accept
29421 or warn as its final result.
29422
29423 This ACL can be used for tasks such as custom logging at the end of an SMTP
29424 session. For example, you can use ACL variables in other ACLs to count
29425 messages, recipients, etc., and log the totals at QUIT time using one or
29426 more &%logwrite%& modifiers on a &%warn%& verb.
29427
29428 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29429 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29430
29431 You do not need to have a final &%accept%&, but if you do, you can use a
29432 &%message%& modifier to specify custom text that is sent as part of the 221
29433 response to QUIT.
29434
29435 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29436 failure (for example, failure to open a log file, or when Exim is bombing out
29437 because it has detected an unrecoverable error), all SMTP commands from the
29438 client are given temporary error responses until QUIT is received or the
29439 connection is closed. In these special cases, the QUIT ACL does not run.
29440
29441
29442 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29443 .vindex &$acl_smtp_notquit$&
29444 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29445 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29446 trouble, such as being unable to write to its log files, this ACL is not run,
29447 because it might try to do things (such as write to log files) that make the
29448 situation even worse.
29449
29450 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29451 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29452 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29453 and &%warn%&.
29454
29455 .vindex &$smtp_notquit_reason$&
29456 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29457 to a string that indicates the reason for the termination of the SMTP
29458 connection. The possible values are:
29459 .table2
29460 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29461 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29462 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29463 .irow &`connection-lost`&          "The SMTP connection has been lost"
29464 .irow &`data-timeout`&             "Timeout while reading message data"
29465 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29466 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29467 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29468 .irow &`synchronization-error`&    "SMTP synchronization error"
29469 .irow &`tls-failed`&               "TLS failed to start"
29470 .endtable
29471 In most cases when an SMTP connection is closed without having received QUIT,
29472 Exim sends an SMTP response message before actually closing the connection.
29473 With the exception of the &`acl-drop`& case, the default message can be
29474 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29475 &%drop%& verb in another ACL, it is the message from the other ACL that is
29476 used.
29477
29478
29479 .section "Finding an ACL to use" "SECID195"
29480 .cindex "&ACL;" "finding which to use"
29481 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29482 you can use different ACLs in different circumstances. For example,
29483 .code
29484 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29485                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29486 .endd
29487 In the default configuration file there are some example settings for
29488 providing an RFC 4409 message &"submission"& service on port 587 and
29489 an RFC 8314 &"submissions"& service on port 465. You can use a string
29490 expansion like this to choose an ACL for MUAs on these ports which is
29491 more appropriate for this purpose than the default ACL on port 25.
29492
29493 The expanded string does not have to be the name of an ACL in the
29494 configuration file; there are other possibilities. Having expanded the
29495 string, Exim searches for an ACL as follows:
29496
29497 .ilist
29498 If the string begins with a slash, Exim uses it as a filename, and reads its
29499 contents as an ACL. The lines are processed in the same way as lines in the
29500 Exim configuration file. In particular, continuation lines are supported, blank
29501 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29502 If the file does not exist or cannot be read, an error occurs (typically
29503 causing a temporary failure of whatever caused the ACL to be run). For example:
29504 .code
29505 acl_smtp_data = /etc/acls/\
29506   ${lookup{$sender_host_address}lsearch\
29507   {/etc/acllist}{$value}{default}}
29508 .endd
29509 This looks up an ACL file to use on the basis of the host's IP address, falling
29510 back to a default if the lookup fails. If an ACL is successfully read from a
29511 file, it is retained in memory for the duration of the Exim process, so that it
29512 can be re-used without having to re-read the file.
29513 .next
29514 If the string does not start with a slash, and does not contain any spaces,
29515 Exim searches the ACL section of the configuration for an ACL whose name
29516 matches the string.
29517 .next
29518 If no named ACL is found, or if the string contains spaces, Exim parses
29519 the string as an inline ACL. This can save typing in cases where you just
29520 want to have something like
29521 .code
29522 acl_smtp_vrfy = accept
29523 .endd
29524 in order to allow free use of the VRFY command. Such a string may contain
29525 newlines; it is processed in the same way as an ACL that is read from a file.
29526 .endlist
29527
29528
29529
29530
29531 .section "ACL return codes" "SECID196"
29532 .cindex "&ACL;" "return codes"
29533 Except for the QUIT ACL, which does not affect the SMTP return code (see
29534 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29535 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29536 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29537 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29538 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29539 This also causes a 4&'xx'& return code.
29540
29541 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29542 &"deny"&, because there is no mechanism for passing temporary errors to the
29543 submitters of non-SMTP messages.
29544
29545
29546 ACLs that are relevant to message reception may also return &"discard"&. This
29547 has the effect of &"accept"&, but causes either the entire message or an
29548 individual recipient address to be discarded. In other words, it is a
29549 blackholing facility. Use it with care.
29550
29551 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29552 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29553 RCPT ACL is to discard just the one recipient address. If there are no
29554 recipients left when the message's data is received, the DATA ACL is not
29555 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29556 remaining recipients. The &"discard"& return is not permitted for the
29557 &%acl_smtp_predata%& ACL.
29558
29559 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29560 is done on the address and the result determines the SMTP response.
29561
29562
29563 .cindex "&[local_scan()]& function" "when all recipients discarded"
29564 The &[local_scan()]& function is always run, even if there are no remaining
29565 recipients; it may create new recipients.
29566
29567
29568
29569 .section "Unset ACL options" "SECID197"
29570 .cindex "&ACL;" "unset options"
29571 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29572 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29573 not defined at all. For any defined ACL, the default action when control
29574 reaches the end of the ACL statements is &"deny"&.
29575
29576 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29577 these two are ACLs that are used only for their side effects. They cannot be
29578 used to accept or reject anything.
29579
29580 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29581 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29582 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29583 when the ACL is not defined is &"accept"&.
29584
29585 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29586 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29587 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29588 messages over an SMTP connection. For an example, see the ACL in the default
29589 configuration file.
29590
29591
29592
29593
29594 .section "Data for message ACLs" "SECID198"
29595 .cindex "&ACL;" "data for message ACL"
29596 .vindex &$domain$&
29597 .vindex &$local_part$&
29598 .vindex &$sender_address$&
29599 .vindex &$sender_host_address$&
29600 .vindex &$smtp_command$&
29601 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29602 that contain information about the host and the message's sender (for example,
29603 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29604 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29605 &$local_part$& are set from the argument address. The entire SMTP command
29606 is available in &$smtp_command$&.
29607
29608 When an ACL for the AUTH parameter of MAIL is running, the variables that
29609 contain information about the host are set, but &$sender_address$& is not yet
29610 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29611 how it is used.
29612
29613 .vindex "&$message_size$&"
29614 The &$message_size$& variable is set to the value of the SIZE parameter on
29615 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29616 that parameter is not given. The value is updated to the true message size by
29617 the time the final DATA ACL is run (after the message data has been
29618 received).
29619
29620 .vindex "&$rcpt_count$&"
29621 .vindex "&$recipients_count$&"
29622 The &$rcpt_count$& variable increases by one for each RCPT command received.
29623 The &$recipients_count$& variable increases by one each time a RCPT command is
29624 accepted, so while an ACL for RCPT is being processed, it contains the number
29625 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29626 &$rcpt_count$& contains the total number of RCPT commands, and
29627 &$recipients_count$& contains the total number of accepted recipients.
29628
29629
29630
29631
29632
29633 .section "Data for non-message ACLs" "SECTdatfornon"
29634 .cindex "&ACL;" "data for non-message ACL"
29635 .vindex &$smtp_command_argument$&
29636 .vindex &$smtp_command$&
29637 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29638 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29639 and the entire SMTP command is available in &$smtp_command$&.
29640 These variables can be tested using a &%condition%& condition. For example,
29641 here is an ACL for use with AUTH, which insists that either the session is
29642 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29643 does not permit authentication methods that use cleartext passwords on
29644 unencrypted connections.
29645 .code
29646 acl_check_auth:
29647   accept encrypted = *
29648   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29649                      {CRAM-MD5}}
29650   deny   message   = TLS encryption or CRAM-MD5 required
29651 .endd
29652 (Another way of applying this restriction is to arrange for the authenticators
29653 that use cleartext passwords not to be advertised when the connection is not
29654 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29655 option to do this.)
29656
29657
29658
29659 .section "Format of an ACL" "SECID199"
29660 .cindex "&ACL;" "format of"
29661 .cindex "&ACL;" "verbs, definition of"
29662 An individual ACL consists of a number of statements. Each statement starts
29663 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29664 Modifiers can change the way the verb operates, define error and log messages,
29665 set variables, insert delays, and vary the processing of accepted messages.
29666
29667 If all the conditions are met, the verb is obeyed. The same condition may be
29668 used (with different arguments) more than once in the same statement. This
29669 provides a means of specifying an &"and"& conjunction between conditions. For
29670 example:
29671 .code
29672 deny  dnslists = list1.example
29673       dnslists = list2.example
29674 .endd
29675 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29676 the conditions and modifiers when it reaches a condition that fails. What
29677 happens then depends on the verb (and in one case, on a special modifier). Not
29678 all the conditions make sense at every testing point. For example, you cannot
29679 test a sender address in the ACL that is run for a VRFY command.
29680
29681
29682 .section "ACL verbs" "SECID200"
29683 The ACL verbs are as follows:
29684
29685 .ilist
29686 .cindex "&%accept%& ACL verb"
29687 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29688 of the conditions are not met, what happens depends on whether &%endpass%&
29689 appears among the conditions (for syntax see below). If the failing condition
29690 is before &%endpass%&, control is passed to the next ACL statement; if it is
29691 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29692 check a RCPT command:
29693 .code
29694 accept domains = +local_domains
29695        endpass
29696        verify = recipient
29697 .endd
29698 If the recipient domain does not match the &%domains%& condition, control
29699 passes to the next statement. If it does match, the recipient is verified, and
29700 the command is accepted if verification succeeds. However, if verification
29701 fails, the ACL yields &"deny"&, because the failing condition is after
29702 &%endpass%&.
29703
29704 The &%endpass%& feature has turned out to be confusing to many people, so its
29705 use is not recommended nowadays. It is always possible to rewrite an ACL so
29706 that &%endpass%& is not needed, and it is no longer used in the default
29707 configuration.
29708
29709 .cindex "&%message%& ACL modifier" "with &%accept%&"
29710 If a &%message%& modifier appears on an &%accept%& statement, its action
29711 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29712 (when an &%accept%& verb either accepts or passes control to the next
29713 statement), &%message%& can be used to vary the message that is sent when an
29714 SMTP command is accepted. For example, in a RCPT ACL you could have:
29715 .display
29716 &`accept  `&<&'some conditions'&>
29717 &`        message = OK, I will allow you through today`&
29718 .endd
29719 You can specify an SMTP response code, optionally followed by an &"extended
29720 response code"& at the start of the message, but the first digit must be the
29721 same as would be sent by default, which is 2 for an &%accept%& verb.
29722
29723 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29724 an error message that is used when access is denied. This behaviour is retained
29725 for backward compatibility, but current &"best practice"& is to avoid the use
29726 of &%endpass%&.
29727
29728
29729 .next
29730 .cindex "&%defer%& ACL verb"
29731 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29732 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29733 &%defer%& is the same as &%deny%&, because there is no way of sending a
29734 temporary error. For a RCPT command, &%defer%& is much the same as using a
29735 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29736 be used in any ACL, and even for a recipient it might be a simpler approach.
29737
29738
29739 .next
29740 .cindex "&%deny%& ACL verb"
29741 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29742 the conditions are not met, control is passed to the next ACL statement. For
29743 example,
29744 .code
29745 deny dnslists = blackholes.mail-abuse.org
29746 .endd
29747 rejects commands from hosts that are on a DNS black list.
29748
29749
29750 .next
29751 .cindex "&%discard%& ACL verb"
29752 &%discard%&: This verb behaves like &%accept%&, except that it returns
29753 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29754 that are concerned with receiving messages. When all the conditions are true,
29755 the sending entity receives a &"success"& response. However, &%discard%& causes
29756 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29757 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29758 message's recipients are discarded. Recipients that are discarded before DATA
29759 do not appear in the log line when the &%received_recipients%& log selector is set.
29760
29761 If the &%log_message%& modifier is set when &%discard%& operates,
29762 its contents are added to the line that is automatically written to the log.
29763 The &%message%& modifier operates exactly as it does for &%accept%&.
29764
29765
29766 .next
29767 .cindex "&%drop%& ACL verb"
29768 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29769 forcibly closed after the 5&'xx'& error message has been sent. For example:
29770 .code
29771 drop   message   = I don't take more than 20 RCPTs
29772        condition = ${if > {$rcpt_count}{20}}
29773 .endd
29774 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29775 The connection is always dropped after sending a 550 response.
29776
29777 .next
29778 .cindex "&%require%& ACL verb"
29779 &%require%&: If all the conditions are met, control is passed to the next ACL
29780 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29781 example, when checking a RCPT command,
29782 .code
29783 require message = Sender did not verify
29784         verify  = sender
29785 .endd
29786 passes control to subsequent statements only if the message's sender can be
29787 verified. Otherwise, it rejects the command. Note the positioning of the
29788 &%message%& modifier, before the &%verify%& condition. The reason for this is
29789 discussed in section &<<SECTcondmodproc>>&.
29790
29791 .next
29792 .cindex "&%warn%& ACL verb"
29793 &%warn%&: If all the conditions are true, a line specified by the
29794 &%log_message%& modifier is written to Exim's main log. Control always passes
29795 to the next ACL statement. If any condition is false, the log line is not
29796 written. If an identical log line is requested several times in the same
29797 message, only one copy is actually written to the log. If you want to force
29798 duplicates to be written, use the &%logwrite%& modifier instead.
29799
29800 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29801 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29802 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29803 first failing condition. There is more about adding header lines in section
29804 &<<SECTaddheadacl>>&.
29805
29806 If any condition on a &%warn%& statement cannot be completed (that is, there is
29807 some sort of defer), the log line specified by &%log_message%& is not written.
29808 This does not include the case of a forced failure from a lookup, which
29809 is considered to be a successful completion. After a defer, no further
29810 conditions or modifiers in the &%warn%& statement are processed. The incident
29811 is logged, and the ACL continues to be processed, from the next statement
29812 onwards.
29813
29814
29815 .vindex "&$acl_verify_message$&"
29816 When one of the &%warn%& conditions is an address verification that fails, the
29817 text of the verification failure message is in &$acl_verify_message$&. If you
29818 want this logged, you must set it up explicitly. For example:
29819 .code
29820 warn   !verify = sender
29821        log_message = sender verify failed: $acl_verify_message
29822 .endd
29823 .endlist
29824
29825 At the end of each ACL there is an implicit unconditional &%deny%&.
29826
29827 As you can see from the examples above, the conditions and modifiers are
29828 written one to a line, with the first one on the same line as the verb, and
29829 subsequent ones on following lines. If you have a very long condition, you can
29830 continue it onto several physical lines by the usual backslash continuation
29831 mechanism. It is conventional to align the conditions vertically.
29832
29833
29834
29835 .section "ACL variables" "SECTaclvariables"
29836 .cindex "&ACL;" "variables"
29837 There are some special variables that can be set during ACL processing. They
29838 can be used to pass information between different ACLs, different invocations
29839 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29840 transports, and filters that are used to deliver a message. The names of these
29841 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29842 an underscore, but the remainder of the name can be any sequence of
29843 alphanumeric characters and underscores that you choose. There is no limit on
29844 the number of ACL variables. The two sets act as follows:
29845 .ilist
29846 The values of those variables whose names begin with &$acl_c$& persist
29847 throughout an SMTP connection. They are never reset. Thus, a value that is set
29848 while receiving one message is still available when receiving the next message
29849 on the same SMTP connection.
29850 .next
29851 The values of those variables whose names begin with &$acl_m$& persist only
29852 while a message is being received. They are reset afterwards. They are also
29853 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29854 .endlist
29855
29856 When a message is accepted, the current values of all the ACL variables are
29857 preserved with the message and are subsequently made available at delivery
29858 time. The ACL variables are set by a modifier called &%set%&. For example:
29859 .code
29860 accept hosts = whatever
29861        set acl_m4 = some value
29862 accept authenticated = *
29863        set acl_c_auth = yes
29864 .endd
29865 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29866 be set. If you want to set a variable without taking any action, you can use a
29867 &%warn%& verb without any other modifiers or conditions.
29868
29869 .oindex &%strict_acl_vars%&
29870 What happens if a syntactically valid but undefined ACL variable is
29871 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29872 false (the default), an empty string is substituted; if it is true, an
29873 error is generated.
29874
29875 Versions of Exim before 4.64 have a limited set of numbered variables, but
29876 their names are compatible, so there is no problem with upgrading.
29877
29878
29879 .section "Condition and modifier processing" "SECTcondmodproc"
29880 .cindex "&ACL;" "conditions; processing"
29881 .cindex "&ACL;" "modifiers; processing"
29882 An exclamation mark preceding a condition negates its result. For example:
29883 .code
29884 deny   domains = *.dom.example
29885       !verify  = recipient
29886 .endd
29887 causes the ACL to return &"deny"& if the recipient domain ends in
29888 &'dom.example'& and the recipient address cannot be verified. Sometimes
29889 negation can be used on the right-hand side of a condition. For example, these
29890 two statements are equivalent:
29891 .code
29892 deny  hosts = !192.168.3.4
29893 deny !hosts =  192.168.3.4
29894 .endd
29895 However, for many conditions (&%verify%& being a good example), only left-hand
29896 side negation of the whole condition is possible.
29897
29898 The arguments of conditions and modifiers are expanded. A forced failure
29899 of an expansion causes a condition to be ignored, that is, it behaves as if the
29900 condition is true. Consider these two statements:
29901 .code
29902 accept  senders = ${lookup{$host_name}lsearch\
29903                   {/some/file}{$value}fail}
29904 accept  senders = ${lookup{$host_name}lsearch\
29905                   {/some/file}{$value}{}}
29906 .endd
29907 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29908 the returned list is searched, but if the lookup fails the behaviour is
29909 different in the two cases. The &%fail%& in the first statement causes the
29910 condition to be ignored, leaving no further conditions. The &%accept%& verb
29911 therefore succeeds. The second statement, however, generates an empty list when
29912 the lookup fails. No sender can match an empty list, so the condition fails,
29913 and therefore the &%accept%& also fails.
29914
29915 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29916 specify actions that are taken as the conditions for a statement are checked;
29917 others specify text for messages that are used when access is denied or a
29918 warning is generated. The &%control%& modifier affects the way an incoming
29919 message is handled.
29920
29921 The positioning of the modifiers in an ACL statement is important, because the
29922 processing of a verb ceases as soon as its outcome is known. Only those
29923 modifiers that have already been encountered will take effect. For example,
29924 consider this use of the &%message%& modifier:
29925 .code
29926 require message = Can't verify sender
29927         verify  = sender
29928         message = Can't verify recipient
29929         verify  = recipient
29930         message = This message cannot be used
29931 .endd
29932 If sender verification fails, Exim knows that the result of the statement is
29933 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29934 so its text is used as the error message. If sender verification succeeds, but
29935 recipient verification fails, the second message is used. If recipient
29936 verification succeeds, the third message becomes &"current"&, but is never used
29937 because there are no more conditions to cause failure.
29938
29939 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29940 modifier that is used, because all the conditions must be true for rejection to
29941 happen. Specifying more than one &%message%& modifier does not make sense, and
29942 the message can even be specified after all the conditions. For example:
29943 .code
29944 deny   hosts = ...
29945       !senders = *@my.domain.example
29946        message = Invalid sender from client host
29947 .endd
29948 The &"deny"& result does not happen until the end of the statement is reached,
29949 by which time Exim has set up the message.
29950
29951
29952
29953 .section "ACL modifiers" "SECTACLmodi"
29954 .cindex "&ACL;" "modifiers; list of"
29955 The ACL modifiers are as follows:
29956
29957 .vlist
29958 .vitem &*add_header*&&~=&~<&'text'&>
29959 This modifier specifies one or more header lines that are to be added to an
29960 incoming message, assuming, of course, that the message is ultimately
29961 accepted. For details, see section &<<SECTaddheadacl>>&.
29962
29963 .vitem &*continue*&&~=&~<&'text'&>
29964 .cindex "&%continue%& ACL modifier"
29965 .cindex "database" "updating in ACL"
29966 This modifier does nothing of itself, and processing of the ACL always
29967 continues with the next condition or modifier. The value of &%continue%& is in
29968 the side effects of expanding its argument. Typically this could be used to
29969 update a database. It is really just a syntactic tidiness, to avoid having to
29970 write rather ugly lines like this:
29971 .display
29972 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29973 .endd
29974 Instead, all you need is
29975 .display
29976 &`continue = `&<&'some expansion'&>
29977 .endd
29978
29979 .vitem &*control*&&~=&~<&'text'&>
29980 .cindex "&%control%& ACL modifier"
29981 This modifier affects the subsequent processing of the SMTP connection or of an
29982 incoming message that is accepted. The effect of the first type of control
29983 lasts for the duration of the connection, whereas the effect of the second type
29984 lasts only until the current message has been received. The message-specific
29985 controls always apply to the whole message, not to individual recipients,
29986 even if the &%control%& modifier appears in a RCPT ACL.
29987
29988 As there are now quite a few controls that can be applied, they are described
29989 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29990 in several different ways. For example:
29991
29992 . ==== As this is a nested list, any displays it contains must be indented
29993 . ==== as otherwise they are too far to the left. That comment applies only
29994 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29995 . ==== way.
29996
29997 .ilist
29998 It can be at the end of an &%accept%& statement:
29999 .code
30000     accept  ...some conditions
30001             control = queue_only
30002 .endd
30003 In this case, the control is applied when this statement yields &"accept"&, in
30004 other words, when the conditions are all true.
30005
30006 .next
30007 It can be in the middle of an &%accept%& statement:
30008 .code
30009     accept  ...some conditions...
30010             control = queue_only
30011             ...some more conditions...
30012 .endd
30013 If the first set of conditions are true, the control is applied, even if the
30014 statement does not accept because one of the second set of conditions is false.
30015 In this case, some subsequent statement must yield &"accept"& for the control
30016 to be relevant.
30017
30018 .next
30019 It can be used with &%warn%& to apply the control, leaving the
30020 decision about accepting or denying to a subsequent verb. For
30021 example:
30022 .code
30023     warn    ...some conditions...
30024             control = freeze
30025     accept  ...
30026 .endd
30027 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30028 &%logwrite%&, so it does not add anything to the message and does not write a
30029 log entry.
30030
30031 .next
30032 If you want to apply a control unconditionally, you can use it with a
30033 &%require%& verb. For example:
30034 .code
30035     require  control = no_multiline_responses
30036 .endd
30037 .endlist
30038
30039 .vitem &*delay*&&~=&~<&'time'&>
30040 .cindex "&%delay%& ACL modifier"
30041 .oindex "&%-bh%&"
30042 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30043 the time interval before proceeding. However, when testing Exim using the
30044 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30045 output instead). The time is given in the usual Exim notation, and the delay
30046 happens as soon as the modifier is processed. In an SMTP session, pending
30047 output is flushed before the delay is imposed.
30048
30049 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30050 example:
30051 .code
30052 deny    ...some conditions...
30053         delay = 30s
30054 .endd
30055 The delay happens if all the conditions are true, before the statement returns
30056 &"deny"&. Compare this with:
30057 .code
30058 deny    delay = 30s
30059         ...some conditions...
30060 .endd
30061 which waits for 30s before processing the conditions. The &%delay%& modifier
30062 can also be used with &%warn%& and together with &%control%&:
30063 .code
30064 warn    ...some conditions...
30065         delay = 2m
30066         control = freeze
30067 accept  ...
30068 .endd
30069
30070 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30071 responses to several commands are no longer buffered and sent in one packet (as
30072 they would normally be) because all output is flushed before imposing the
30073 delay. This optimization is disabled so that a number of small delays do not
30074 appear to the client as one large aggregated delay that might provoke an
30075 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30076 using a &%control%& modifier to set &%no_delay_flush%&.
30077
30078
30079 .vitem &*endpass*&
30080 .cindex "&%endpass%& ACL modifier"
30081 This modifier, which has no argument, is recognized only in &%accept%& and
30082 &%discard%& statements. It marks the boundary between the conditions whose
30083 failure causes control to pass to the next statement, and the conditions whose
30084 failure causes the ACL to return &"deny"&. This concept has proved to be
30085 confusing to some people, so the use of &%endpass%& is no longer recommended as
30086 &"best practice"&. See the description of &%accept%& above for more details.
30087
30088
30089 .vitem &*log_message*&&~=&~<&'text'&>
30090 .cindex "&%log_message%& ACL modifier"
30091 This modifier sets up a message that is used as part of the log message if the
30092 ACL denies access or a &%warn%& statement's conditions are true. For example:
30093 .code
30094 require log_message = wrong cipher suite $tls_in_cipher
30095         encrypted   = DES-CBC3-SHA
30096 .endd
30097 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30098 example:
30099 .display
30100 &`discard `&<&'some conditions'&>
30101 &`        log_message = Discarded $local_part@$domain because...`&
30102 .endd
30103 When access is denied, &%log_message%& adds to any underlying error message
30104 that may exist because of a condition failure. For example, while verifying a
30105 recipient address, a &':fail:'& redirection might have already set up a
30106 message.
30107
30108 The message may be defined before the conditions to which it applies, because
30109 the string expansion does not happen until Exim decides that access is to be
30110 denied. This means that any variables that are set by the condition are
30111 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30112 variables are set after a DNS black list lookup succeeds. If the expansion of
30113 &%log_message%& fails, or if the result is an empty string, the modifier is
30114 ignored.
30115
30116 .vindex "&$acl_verify_message$&"
30117 If you want to use a &%warn%& statement to log the result of an address
30118 verification, you can use &$acl_verify_message$& to include the verification
30119 error message.
30120
30121 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30122 the start of the logged message. If the same warning log message is requested
30123 more than once while receiving  a single email message, only one copy is
30124 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30125 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30126 is logged for a successful &%warn%& statement.
30127
30128 If &%log_message%& is not present and there is no underlying error message (for
30129 example, from the failure of address verification), but &%message%& is present,
30130 the &%message%& text is used for logging rejections. However, if any text for
30131 logging contains newlines, only the first line is logged. In the absence of
30132 both &%log_message%& and &%message%&, a default built-in message is used for
30133 logging rejections.
30134
30135
30136 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30137 .cindex "&%log_reject_target%& ACL modifier"
30138 .cindex "logging in ACL" "specifying which log"
30139 This modifier makes it possible to specify which logs are used for messages
30140 about ACL rejections. Its argument is a colon-separated list of words that can
30141 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30142 may be empty, in which case a rejection is not logged at all. For example, this
30143 ACL fragment writes no logging information when access is denied:
30144 .display
30145 &`deny `&<&'some conditions'&>
30146 &`     log_reject_target =`&
30147 .endd
30148 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30149 permanent and temporary rejections. Its effect lasts for the rest of the
30150 current ACL.
30151
30152
30153 .vitem &*logwrite*&&~=&~<&'text'&>
30154 .cindex "&%logwrite%& ACL modifier"
30155 .cindex "logging in ACL" "immediate"
30156 This modifier writes a message to a log file as soon as it is encountered when
30157 processing an ACL. (Compare &%log_message%&, which, except in the case of
30158 &%warn%& and &%discard%&, is used only if the ACL statement denies
30159 access.) The &%logwrite%& modifier can be used to log special incidents in
30160 ACLs. For example:
30161 .display
30162 &`accept `&<&'some special conditions'&>
30163 &`       control  = freeze`&
30164 &`       logwrite = froze message because ...`&
30165 .endd
30166 By default, the message is written to the main log. However, it may begin
30167 with a colon, followed by a comma-separated list of log names, and then
30168 another colon, to specify exactly which logs are to be written. For
30169 example:
30170 .code
30171 logwrite = :main,reject: text for main and reject logs
30172 logwrite = :panic: text for panic log only
30173 .endd
30174
30175
30176 .vitem &*message*&&~=&~<&'text'&>
30177 .cindex "&%message%& ACL modifier"
30178 This modifier sets up a text string that is expanded and used as a response
30179 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30180 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30181 there is some complication if &%endpass%& is involved; see the description of
30182 &%accept%& for details.)
30183
30184 The expansion of the message happens at the time Exim decides that the ACL is
30185 to end, not at the time it processes &%message%&. If the expansion fails, or
30186 generates an empty string, the modifier is ignored. Here is an example where
30187 &%message%& must be specified first, because the ACL ends with a rejection if
30188 the &%hosts%& condition fails:
30189 .code
30190 require  message = Host not recognized
30191          hosts = 10.0.0.0/8
30192 .endd
30193 (Once a condition has failed, no further conditions or modifiers are
30194 processed.)
30195
30196 .cindex "SMTP" "error codes"
30197 .oindex "&%smtp_banner%&
30198 For ACLs that are triggered by SMTP commands, the message is returned as part
30199 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30200 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30201 is accepted. In the case of the connect ACL, accepting with a message modifier
30202 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30203 accept message may not contain more than one line (otherwise it will be
30204 truncated at the first newline and a panic logged), and it cannot affect the
30205 EHLO options.
30206
30207 When SMTP is involved, the message may begin with an overriding response code,
30208 consisting of three digits optionally followed by an &"extended response code"&
30209 of the form &'n.n.n'&, each code being followed by a space. For example:
30210 .code
30211 deny  message = 599 1.2.3 Host not welcome
30212       hosts = 192.168.34.0/24
30213 .endd
30214 The first digit of the supplied response code must be the same as would be sent
30215 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30216 access, but for the predata ACL, note that the default success code is 354, not
30217 2&'xx'&.
30218
30219 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30220 the message modifier cannot override the 221 response code.
30221
30222 The text in a &%message%& modifier is literal; any quotes are taken as
30223 literals, but because the string is expanded, backslash escapes are processed
30224 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30225 response.
30226
30227 .vindex "&$acl_verify_message$&"
30228 For ACLs that are called by an &%acl =%& ACL condition, the message is
30229 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30230
30231 If &%message%& is used on a statement that verifies an address, the message
30232 specified overrides any message that is generated by the verification process.
30233 However, the original message is available in the variable
30234 &$acl_verify_message$&, so you can incorporate it into your message if you
30235 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30236 routers to be passed back as part of the SMTP response, you should either not
30237 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30238
30239 For compatibility with previous releases of Exim, a &%message%& modifier that
30240 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30241 modifier, but this usage is now deprecated. However, &%message%& acts only when
30242 all the conditions are true, wherever it appears in an ACL command, whereas
30243 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30244 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30245 effect.
30246
30247
30248 .vitem &*queue*&&~=&~<&'text'&>
30249 .cindex "&%queue%& ACL modifier"
30250 .cindex "named queues" "selecting in ACL"
30251 This modifier specifies the use of a named queue for spool files
30252 for the message.
30253 It can only be used before the message is received (i.e. not in
30254 the DATA ACL).
30255 This could be used, for example, for known high-volume burst sources
30256 of traffic, or for quarantine of messages.
30257 Separate queue-runner processes will be needed for named queues.
30258 If the text after expansion is empty, the default queue is used.
30259
30260
30261 .vitem &*remove_header*&&~=&~<&'text'&>
30262 This modifier specifies one or more header names in a colon-separated list
30263  that are to be removed from an incoming message, assuming, of course, that
30264 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30265
30266
30267 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30268 .cindex "&%set%& ACL modifier"
30269 This modifier puts a value into one of the ACL variables (see section
30270 &<<SECTaclvariables>>&).
30271
30272
30273 .vitem &*udpsend*&&~=&~<&'parameters'&>
30274 .cindex "UDP communications"
30275 This modifier sends a UDP packet, for purposes such as statistics
30276 collection or behaviour monitoring. The parameters are expanded, and
30277 the result of the expansion must be a colon-separated list consisting
30278 of a destination server, port number, and the packet contents. The
30279 server can be specified as a host name or IPv4 or IPv6 address. The
30280 separator can be changed with the usual angle bracket syntax. For
30281 example, you might want to collect information on which hosts connect
30282 when:
30283 .code
30284 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30285              $tod_zulu $sender_host_address
30286 .endd
30287 .endlist
30288
30289
30290
30291
30292 .section "Use of the control modifier" "SECTcontrols"
30293 .cindex "&%control%& ACL modifier"
30294 The &%control%& modifier supports the following settings:
30295
30296 .vlist
30297 .vitem &*control&~=&~allow_auth_unadvertised*&
30298 This modifier allows a client host to use the SMTP AUTH command even when it
30299 has not been advertised in response to EHLO. Furthermore, because there are
30300 apparently some really broken clients that do this, Exim will accept AUTH after
30301 HELO (rather than EHLO) when this control is set. It should be used only if you
30302 really need it, and you should limit its use to those broken clients that do
30303 not work without it. For example:
30304 .code
30305 warn hosts   = 192.168.34.25
30306      control = allow_auth_unadvertised
30307 .endd
30308 Normally, when an Exim server receives an AUTH command, it checks the name of
30309 the authentication mechanism that is given in the command to ensure that it
30310 matches an advertised mechanism. When this control is set, the check that a
30311 mechanism has been advertised is bypassed. Any configured mechanism can be used
30312 by the client. This control is permitted only in the connection and HELO ACLs.
30313
30314
30315 .vitem &*control&~=&~caseful_local_part*& &&&
30316        &*control&~=&~caselower_local_part*&
30317 .cindex "&ACL;" "case of local part in"
30318 .cindex "case of local parts"
30319 .vindex "&$local_part$&"
30320 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30321 (that is, during RCPT processing). By default, the contents of &$local_part$&
30322 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30323 any uppercase letters in the original local part are restored in &$local_part$&
30324 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30325 is encountered.
30326
30327 These controls affect only the current recipient. Moreover, they apply only to
30328 local part handling that takes place directly in the ACL (for example, as a key
30329 in lookups). If a test to verify the recipient is obeyed, the case-related
30330 handling of the local part during the verification is controlled by the router
30331 configuration (see the &%caseful_local_part%& generic router option).
30332
30333 This facility could be used, for example, to add a spam score to local parts
30334 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30335 spam score:
30336 .code
30337 warn  control = caseful_local_part
30338       set acl_m4 = ${eval:\
30339                      $acl_m4 + \
30340                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30341                     }
30342       control = caselower_local_part
30343 .endd
30344 Notice that we put back the lower cased version afterwards, assuming that
30345 is what is wanted for subsequent tests.
30346
30347
30348 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30349 .cindex "&ACL;" "cutthrough routing"
30350 .cindex "cutthrough" "requesting"
30351 This option requests delivery be attempted while the item is being received.
30352
30353 The option is usable in the RCPT ACL.
30354 If enabled for a message received via smtp and routed to an smtp transport,
30355 and only one transport, interface, destination host and port combination
30356 is used for all recipients of the message,
30357 then the delivery connection is made while the receiving connection is open
30358 and data is copied from one to the other.
30359
30360 An attempt to set this option for any recipient but the first
30361 for a mail will be quietly ignored.
30362 If a recipient-verify callout
30363 (with use_sender)
30364 connection is subsequently
30365 requested in the same ACL it is held open and used for
30366 any subsequent recipients and the data,
30367 otherwise one is made after the initial RCPT ACL completes.
30368
30369 Note that routers are used in verify mode,
30370 and cannot depend on content of received headers.
30371 Note also that headers cannot be
30372 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30373 Headers may be modified by routers (subject to the above) and transports.
30374 The &'Received-By:'& header is generated as soon as the body reception starts,
30375 rather than the traditional time after the full message is received;
30376 this will affect the timestamp.
30377
30378 All the usual ACLs are called; if one results in the message being
30379 rejected, all effort spent in delivery (including the costs on
30380 the ultimate destination) will be wasted.
30381 Note that in the case of data-time ACLs this includes the entire
30382 message body.
30383
30384 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30385 of outgoing messages is done, because it sends data to the ultimate destination
30386 before the entire message has been received from the source.
30387 It is not supported for messages received with the SMTP PRDR
30388 or CHUNKING
30389 options in use.
30390
30391 Should the ultimate destination system positively accept or reject the mail,
30392 a corresponding indication is given to the source system and nothing is queued.
30393 If the item is successfully delivered in cutthrough mode
30394 the delivery log lines are tagged with ">>" rather than "=>" and appear
30395 before the acceptance "<=" line.
30396
30397 If there is a temporary error the item is queued for later delivery in the
30398 usual fashion.
30399 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30400 to the control; the default value is &"spool"& and the alternate value
30401 &"pass"& copies an SMTP defer response from the target back to the initiator
30402 and does not queue the message.
30403 Note that this is independent of any recipient verify conditions in the ACL.
30404
30405 Delivery in this mode avoids the generation of a bounce mail to a
30406 (possibly faked)
30407 sender when the destination system is doing content-scan based rejection.
30408
30409
30410 .vitem &*control&~=&~debug/*&<&'options'&>
30411 .cindex "&ACL;" "enabling debug logging"
30412 .cindex "debugging" "enabling from an ACL"
30413 This control turns on debug logging, almost as though Exim had been invoked
30414 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30415 by default called &'debuglog'&.
30416 The filename can be adjusted with the &'tag'& option, which
30417 may access any variables already defined.  The logging may be adjusted with
30418 the &'opts'& option, which takes the same values as the &`-d`& command-line
30419 option.
30420 Logging started this way may be stopped, and the file removed,
30421 with the &'kill'& option.
30422 Some examples (which depend on variables that don't exist in all
30423 contexts):
30424 .code
30425       control = debug
30426       control = debug/tag=.$sender_host_address
30427       control = debug/opts=+expand+acl
30428       control = debug/tag=.$message_exim_id/opts=+expand
30429       control = debug/kill
30430 .endd
30431
30432
30433 .vitem &*control&~=&~dkim_disable_verify*&
30434 .cindex "disable DKIM verify"
30435 .cindex "DKIM" "disable verify"
30436 This control turns off DKIM verification processing entirely.  For details on
30437 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30438
30439
30440 .vitem &*control&~=&~dscp/*&<&'value'&>
30441 .cindex "&ACL;" "setting DSCP value"
30442 .cindex "DSCP" "inbound"
30443 This option causes the DSCP value associated with the socket for the inbound
30444 connection to be adjusted to a given value, given as one of a number of fixed
30445 strings or to numeric value.
30446 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30447 Common values include &`throughput`&, &`mincost`&, and on newer systems
30448 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30449
30450 The outbound packets from Exim will be marked with this value in the header
30451 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30452 that these values will have any effect, not be stripped by networking
30453 equipment, or do much of anything without cooperation with your Network
30454 Engineer and those of all network operators between the source and destination.
30455
30456
30457 .vitem &*control&~=&~enforce_sync*& &&&
30458        &*control&~=&~no_enforce_sync*&
30459 .cindex "SMTP" "synchronization checking"
30460 .cindex "synchronization checking in SMTP"
30461 These controls make it possible to be selective about when SMTP synchronization
30462 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30463 state of the switch (it is true by default). See the description of this option
30464 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30465
30466 The effect of these two controls lasts for the remainder of the SMTP
30467 connection. They can appear in any ACL except the one for the non-SMTP
30468 messages. The most straightforward place to put them is in the ACL defined by
30469 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30470 before the first synchronization check. The expected use is to turn off the
30471 synchronization checks for badly-behaved hosts that you nevertheless need to
30472 work with.
30473
30474
30475 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30476 .cindex "fake defer"
30477 .cindex "defer, fake"
30478 This control works in exactly the same way as &%fakereject%& (described below)
30479 except that it causes an SMTP 450 response after the message data instead of a
30480 550 response. You must take care when using &%fakedefer%& because it causes the
30481 messages to be duplicated when the sender retries. Therefore, you should not
30482 use &%fakedefer%& if the message is to be delivered normally.
30483
30484 .vitem &*control&~=&~fakereject/*&<&'message'&>
30485 .cindex "fake rejection"
30486 .cindex "rejection, fake"
30487 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30488 words, only when an SMTP message is being received. If Exim accepts the
30489 message, instead the final 250 response, a 550 rejection message is sent.
30490 However, Exim proceeds to deliver the message as normal. The control applies
30491 only to the current message, not to any subsequent ones that may be received in
30492 the same SMTP connection.
30493
30494 The text for the 550 response is taken from the &%control%& modifier. If no
30495 message is supplied, the following is used:
30496 .code
30497 550-Your message has been rejected but is being
30498 550-kept for evaluation.
30499 550-If it was a legitimate message, it may still be
30500 550 delivered to the target recipient(s).
30501 .endd
30502 This facility should be used with extreme caution.
30503
30504 .vitem &*control&~=&~freeze*&
30505 .cindex "frozen messages" "forcing in ACL"
30506 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30507 other words, only when a message is being received. If the message is accepted,
30508 it is placed on Exim's queue and frozen. The control applies only to the
30509 current message, not to any subsequent ones that may be received in the same
30510 SMTP connection.
30511
30512 This modifier can optionally be followed by &`/no_tell`&. If the global option
30513 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30514 is told about the freezing), provided all the &*control=freeze*& modifiers that
30515 are obeyed for the current message have the &`/no_tell`& option.
30516
30517 .vitem &*control&~=&~no_delay_flush*&
30518 .cindex "SMTP" "output flushing, disabling for delay"
30519 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30520 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30521 use. This control, as long as it is encountered before the &%delay%& modifier,
30522 disables such output flushing.
30523
30524 .vitem &*control&~=&~no_callout_flush*&
30525 .cindex "SMTP" "output flushing, disabling for callout"
30526 Exim normally flushes SMTP output before performing a callout in an ACL, to
30527 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30528 use. This control, as long as it is encountered before the &%verify%& condition
30529 that causes the callout, disables such output flushing.
30530
30531 .vitem &*control&~=&~no_mbox_unspool*&
30532 This control is available when Exim is compiled with the content scanning
30533 extension. Content scanning may require a copy of the current message, or parts
30534 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30535 or spam scanner. Normally, such copies are deleted when they are no longer
30536 needed. If this control is set, the copies are not deleted. The control applies
30537 only to the current message, not to any subsequent ones that may be received in
30538 the same SMTP connection. It is provided for debugging purposes and is unlikely
30539 to be useful in production.
30540
30541 .vitem &*control&~=&~no_multiline_responses*&
30542 .cindex "multiline responses, suppressing"
30543 This control is permitted for any ACL except the one for non-SMTP messages.
30544 It seems that there are broken clients in use that cannot handle multiline
30545 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30546
30547 If this control is set, multiline SMTP responses from ACL rejections are
30548 suppressed. One way of doing this would have been to put out these responses as
30549 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30550 (&"use multiline responses for more"& it says &-- ha!), and some of the
30551 responses might get close to that. So this facility, which is after all only a
30552 sop to broken clients, is implemented by doing two very easy things:
30553
30554 .ilist
30555 Extra information that is normally output as part of a rejection caused by
30556 sender verification failure is omitted. Only the final line (typically &"sender
30557 verification failed"&) is sent.
30558 .next
30559 If a &%message%& modifier supplies a multiline response, only the first
30560 line is output.
30561 .endlist
30562
30563 The setting of the switch can, of course, be made conditional on the
30564 calling host. Its effect lasts until the end of the SMTP connection.
30565
30566 .vitem &*control&~=&~no_pipelining*&
30567 .cindex "PIPELINING" "suppressing advertising"
30568 This control turns off the advertising of the PIPELINING extension to SMTP in
30569 the current session. To be useful, it must be obeyed before Exim sends its
30570 response to an EHLO command. Therefore, it should normally appear in an ACL
30571 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30572 &%pipelining_advertise_hosts%&.
30573
30574 .vitem &*control&~=&~queue_only*&
30575 .oindex "&%queue_only%&"
30576 .cindex "queueing incoming messages"
30577 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30578 other words, only when a message is being received. If the message is accepted,
30579 it is placed on Exim's queue and left there for delivery by a subsequent queue
30580 runner. No immediate delivery process is started. In other words, it has the
30581 effect as the &%queue_only%& global option. However, the control applies only
30582 to the current message, not to any subsequent ones that may be received in the
30583 same SMTP connection.
30584
30585 .vitem &*control&~=&~submission/*&<&'options'&>
30586 .cindex "message" "submission"
30587 .cindex "submission mode"
30588 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30589 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30590 the current message is a submission from a local MUA. In this case, Exim
30591 operates in &"submission mode"&, and applies certain fixups to the message if
30592 necessary. For example, it adds a &'Date:'& header line if one is not present.
30593 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30594 late (the message has already been created).
30595
30596 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30597 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30598 submission mode; the available options for this control are described there.
30599 The control applies only to the current message, not to any subsequent ones
30600 that may be received in the same SMTP connection.
30601
30602 .vitem &*control&~=&~suppress_local_fixups*&
30603 .cindex "submission fixups, suppressing"
30604 This control applies to locally submitted (non TCP/IP) messages, and is the
30605 complement of &`control = submission`&. It disables the fixups that are
30606 normally applied to locally-submitted messages. Specifically:
30607
30608 .ilist
30609 Any &'Sender:'& header line is left alone (in this respect, it is a
30610 dynamic version of &%local_sender_retain%&).
30611 .next
30612 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30613 .next
30614 There is no check that &'From:'& corresponds to the actual sender.
30615 .endlist ilist
30616
30617 This control may be useful when a remotely-originated message is accepted,
30618 passed to some scanning program, and then re-submitted for delivery. It can be
30619 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30620 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30621 data is read.
30622
30623 &*Note:*& This control applies only to the current message, not to any others
30624 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30625
30626 .vitem &*control&~=&~utf8_downconvert*&
30627 This control enables conversion of UTF-8 in message addresses
30628 to a-label form.
30629 For details see section &<<SECTi18nMTA>>&.
30630 .endlist vlist
30631
30632
30633 .section "Summary of message fixup control" "SECTsummesfix"
30634 All four possibilities for message fixups can be specified:
30635
30636 .ilist
30637 Locally submitted, fixups applied: the default.
30638 .next
30639 Locally submitted, no fixups applied: use
30640 &`control = suppress_local_fixups`&.
30641 .next
30642 Remotely submitted, no fixups applied: the default.
30643 .next
30644 Remotely submitted, fixups applied: use &`control = submission`&.
30645 .endlist
30646
30647
30648
30649 .section "Adding header lines in ACLs" "SECTaddheadacl"
30650 .cindex "header lines" "adding in an ACL"
30651 .cindex "header lines" "position of added lines"
30652 .cindex "&%add_header%& ACL modifier"
30653 The &%add_header%& modifier can be used to add one or more extra header lines
30654 to an incoming message, as in this example:
30655 .code
30656 warn dnslists = sbl.spamhaus.org : \
30657                 dialup.mail-abuse.org
30658      add_header = X-blacklisted-at: $dnslist_domain
30659 .endd
30660 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30661 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30662 receiving a message). The message must ultimately be accepted for
30663 &%add_header%& to have any significant effect. You can use &%add_header%& with
30664 any ACL verb, including &%deny%& (though this is potentially useful only in a
30665 RCPT ACL).
30666
30667 Headers will not be added to the message if the modifier is used in
30668 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30669
30670 Leading and trailing newlines are removed from
30671 the data for the &%add_header%& modifier; if it then
30672 contains one or more newlines that
30673 are not followed by a space or a tab, it is assumed to contain multiple header
30674 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30675 front of any line that is not a valid header line.
30676
30677 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30678 They are added to the message before processing the DATA and MIME ACLs.
30679 However, if an identical header line is requested more than once, only one copy
30680 is actually added to the message. Further header lines may be accumulated
30681 during the DATA and MIME ACLs, after which they are added to the message, again
30682 with duplicates suppressed. Thus, it is possible to add two identical header
30683 lines to an SMTP message, but only if one is added before DATA and one after.
30684 In the case of non-SMTP messages, new headers are accumulated during the
30685 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30686 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30687 are included in the entry that is written to the reject log.
30688
30689 .cindex "header lines" "added; visibility of"
30690 Header lines are not visible in string expansions
30691 of message headers
30692 until they are added to the
30693 message. It follows that header lines defined in the MAIL, RCPT, and predata
30694 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30695 header lines that are added by the DATA or MIME ACLs are not visible in those
30696 ACLs. Because of this restriction, you cannot use header lines as a way of
30697 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30698 this, you can use ACL variables, as described in section
30699 &<<SECTaclvariables>>&.
30700
30701 The list of headers yet to be added is given by the &%$headers_added%& variable.
30702
30703 The &%add_header%& modifier acts immediately as it is encountered during the
30704 processing of an ACL. Notice the difference between these two cases:
30705 .display
30706 &`accept add_header = ADDED: some text`&
30707 &`       `&<&'some condition'&>
30708
30709 &`accept `&<&'some condition'&>
30710 &`       add_header = ADDED: some text`&
30711 .endd
30712 In the first case, the header line is always added, whether or not the
30713 condition is true. In the second case, the header line is added only if the
30714 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30715 ACL statement. All those that are encountered before a condition fails are
30716 honoured.
30717
30718 .cindex "&%warn%& ACL verb"
30719 For compatibility with previous versions of Exim, a &%message%& modifier for a
30720 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30721 effect only if all the conditions are true, even if it appears before some of
30722 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30723 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30724 are present on a &%warn%& verb, both are processed according to their
30725 specifications.
30726
30727 By default, new header lines are added to a message at the end of the existing
30728 header lines. However, you can specify that any particular header line should
30729 be added right at the start (before all the &'Received:'& lines), immediately
30730 after the first block of &'Received:'& lines, or immediately before any line
30731 that is not a &'Received:'& or &'Resent-something:'& header.
30732
30733 This is done by specifying &":at_start:"&, &":after_received:"&, or
30734 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30735 header line, respectively. (Header text cannot start with a colon, as there has
30736 to be a header name first.) For example:
30737 .code
30738 warn add_header = \
30739        :after_received:X-My-Header: something or other...
30740 .endd
30741 If more than one header line is supplied in a single &%add_header%& modifier,
30742 each one is treated independently and can therefore be placed differently. If
30743 you add more than one line at the start, or after the Received: block, they end
30744 up in reverse order.
30745
30746 &*Warning*&: This facility currently applies only to header lines that are
30747 added in an ACL. It does NOT work for header lines that are added in a
30748 system filter or in a router or transport.
30749
30750
30751
30752 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30753 .cindex "header lines" "removing in an ACL"
30754 .cindex "header lines" "position of removed lines"
30755 .cindex "&%remove_header%& ACL modifier"
30756 The &%remove_header%& modifier can be used to remove one or more header lines
30757 from an incoming message, as in this example:
30758 .code
30759 warn   message        = Remove internal headers
30760        remove_header  = x-route-mail1 : x-route-mail2
30761 .endd
30762 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30763 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30764 receiving a message). The message must ultimately be accepted for
30765 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30766 with any ACL verb, including &%deny%&, though this is really not useful for
30767 any verb that doesn't result in a delivered message.
30768
30769 Headers will not be removed from the message if the modifier is used in
30770 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30771
30772 More than one header can be removed at the same time by using a colon separated
30773 list of header names. The header matching is case insensitive. Wildcards are
30774 not permitted, nor is list expansion performed, so you cannot use hostlists to
30775 create a list of headers, however both connection and message variable expansion
30776 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30777 .code
30778 warn   hosts           = +internal_hosts
30779        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30780 warn   message         = Remove internal headers
30781        remove_header   = $acl_c_ihdrs
30782 .endd
30783 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30784 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30785 If multiple header lines match, all are removed.
30786 There is no harm in attempting to remove the same header twice nor in removing
30787 a non-existent header. Further header lines to be removed may be accumulated
30788 during the DATA and MIME ACLs, after which they are removed from the message,
30789 if present. In the case of non-SMTP messages, headers to be removed are
30790 accumulated during the non-SMTP ACLs, and are removed from the message after
30791 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30792 ACL, there really is no effect because there is no logging of what headers
30793 would have been removed.
30794
30795 .cindex "header lines" "removed; visibility of"
30796 Header lines are not visible in string expansions until the DATA phase when it
30797 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30798 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30799 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30800 this restriction, you cannot use header lines as a way of controlling data
30801 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30802 you should instead use ACL variables, as described in section
30803 &<<SECTaclvariables>>&.
30804
30805 The &%remove_header%& modifier acts immediately as it is encountered during the
30806 processing of an ACL. Notice the difference between these two cases:
30807 .display
30808 &`accept remove_header = X-Internal`&
30809 &`       `&<&'some condition'&>
30810
30811 &`accept `&<&'some condition'&>
30812 &`       remove_header = X-Internal`&
30813 .endd
30814 In the first case, the header line is always removed, whether or not the
30815 condition is true. In the second case, the header line is removed only if the
30816 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30817 same ACL statement. All those that are encountered before a condition fails
30818 are honoured.
30819
30820 &*Warning*&: This facility currently applies only to header lines that are
30821 present during ACL processing. It does NOT remove header lines that are added
30822 in a system filter or in a router or transport.
30823
30824
30825
30826
30827 .section "ACL conditions" "SECTaclconditions"
30828 .cindex "&ACL;" "conditions; list of"
30829 Some of the conditions listed in this section are available only when Exim is
30830 compiled with the content-scanning extension. They are included here briefly
30831 for completeness. More detailed descriptions can be found in the discussion on
30832 content scanning in chapter &<<CHAPexiscan>>&.
30833
30834 Not all conditions are relevant in all circumstances. For example, testing
30835 senders and recipients does not make sense in an ACL that is being run as the
30836 result of the arrival of an ETRN command, and checks on message headers can be
30837 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30838 can use the same condition (with different parameters) more than once in the
30839 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30840 The conditions are as follows:
30841
30842
30843 .vlist
30844 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30845 .cindex "&ACL;" "nested"
30846 .cindex "&ACL;" "indirect"
30847 .cindex "&ACL;" "arguments"
30848 .cindex "&%acl%& ACL condition"
30849 The possible values of the argument are the same as for the
30850 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30851 &"accept"& the condition is true; if it returns &"deny"& the condition is
30852 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30853 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30854 condition false. This means that further processing of the &%warn%& verb
30855 ceases, but processing of the ACL continues.
30856
30857 If the argument is a named ACL, up to nine space-separated optional values
30858 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30859 and $acl_narg is set to the count of values.
30860 Previous values of these variables are restored after the call returns.
30861 The name and values are expanded separately.
30862 Note that spaces in complex expansions which are used as arguments
30863 will act as argument separators.
30864
30865 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30866 the connection is dropped. If it returns &"discard"&, the verb must be
30867 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30868 conditions are tested.
30869
30870 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30871 loops. This condition allows you to use different ACLs in different
30872 circumstances. For example, different ACLs can be used to handle RCPT commands
30873 for different local users or different local domains.
30874
30875 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30876 .cindex "&%authenticated%& ACL condition"
30877 .cindex "authentication" "ACL checking"
30878 .cindex "&ACL;" "testing for authentication"
30879 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30880 the name of the authenticator is tested against the list. To test for
30881 authentication by any authenticator, you can set
30882 .code
30883 authenticated = *
30884 .endd
30885
30886 .vitem &*condition&~=&~*&<&'string'&>
30887 .cindex "&%condition%& ACL condition"
30888 .cindex "customizing" "ACL condition"
30889 .cindex "&ACL;" "customized test"
30890 .cindex "&ACL;" "testing, customized"
30891 This feature allows you to make up custom conditions. If the result of
30892 expanding the string is an empty string, the number zero, or one of the strings
30893 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30894 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30895 any other value, some error is assumed to have occurred, and the ACL returns
30896 &"defer"&. However, if the expansion is forced to fail, the condition is
30897 ignored. The effect is to treat it as true, whether it is positive or
30898 negative.
30899
30900 .vitem &*decode&~=&~*&<&'location'&>
30901 .cindex "&%decode%& ACL condition"
30902 This condition is available only when Exim is compiled with the
30903 content-scanning extension, and it is allowed only in the ACL defined by
30904 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30905 If all goes well, the condition is true. It is false only if there are
30906 problems such as a syntax error or a memory shortage. For more details, see
30907 chapter &<<CHAPexiscan>>&.
30908
30909 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30910 .cindex "&%dnslists%& ACL condition"
30911 .cindex "DNS list" "in ACL"
30912 .cindex "black list (DNS)"
30913 .cindex "&ACL;" "testing a DNS list"
30914 This condition checks for entries in DNS black lists. These are also known as
30915 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30916 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30917 different variants of this condition to describe briefly here. See sections
30918 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30919
30920 .vitem &*domains&~=&~*&<&'domain&~list'&>
30921 .cindex "&%domains%& ACL condition"
30922 .cindex "domain" "ACL checking"
30923 .cindex "&ACL;" "testing a recipient domain"
30924 .vindex "&$domain_data$&"
30925 This condition is relevant only after a RCPT command. It checks that the domain
30926 of the recipient address is in the domain list. If percent-hack processing is
30927 enabled, it is done before this test is done. If the check succeeds with a
30928 lookup, the result of the lookup is placed in &$domain_data$& until the next
30929 &%domains%& test.
30930
30931 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30932 use &%domains%& in a DATA ACL.
30933
30934
30935 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30936 .cindex "&%encrypted%& ACL condition"
30937 .cindex "encryption" "checking in an ACL"
30938 .cindex "&ACL;" "testing for encryption"
30939 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30940 name of the cipher suite in use is tested against the list. To test for
30941 encryption without testing for any specific cipher suite(s), set
30942 .code
30943 encrypted = *
30944 .endd
30945
30946
30947 .vitem &*hosts&~=&~*&<&'host&~list'&>
30948 .cindex "&%hosts%& ACL condition"
30949 .cindex "host" "ACL checking"
30950 .cindex "&ACL;" "testing the client host"
30951 This condition tests that the calling host matches the host list. If you have
30952 name lookups or wildcarded host names and IP addresses in the same host list,
30953 you should normally put the IP addresses first. For example, you could have:
30954 .code
30955 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30956 .endd
30957 The lookup in this example uses the host name for its key. This is implied by
30958 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30959 and it wouldn't matter which way round you had these two items.)
30960
30961 The reason for the problem with host names lies in the left-to-right way that
30962 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30963 but when it reaches an item that requires a host name, it fails if it cannot
30964 find a host name to compare with the pattern. If the above list is given in the
30965 opposite order, the &%accept%& statement fails for a host whose name cannot be
30966 found, even if its IP address is 10.9.8.7.
30967
30968 If you really do want to do the name check first, and still recognize the IP
30969 address even if the name lookup fails, you can rewrite the ACL like this:
30970 .code
30971 accept hosts = dbm;/etc/friendly/hosts
30972 accept hosts = 10.9.8.7
30973 .endd
30974 The default action on failing to find the host name is to assume that the host
30975 is not in the list, so the first &%accept%& statement fails. The second
30976 statement can then check the IP address.
30977
30978 .vindex "&$host_data$&"
30979 If a &%hosts%& condition is satisfied by means of a lookup, the result
30980 of the lookup is made available in the &$host_data$& variable. This
30981 allows you, for example, to set up a statement like this:
30982 .code
30983 deny  hosts = net-lsearch;/some/file
30984 message = $host_data
30985 .endd
30986 which gives a custom error message for each denied host.
30987
30988 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30989 .cindex "&%local_parts%& ACL condition"
30990 .cindex "local part" "ACL checking"
30991 .cindex "&ACL;" "testing a local part"
30992 .vindex "&$local_part_data$&"
30993 This condition is relevant only after a RCPT command. It checks that the local
30994 part of the recipient address is in the list. If percent-hack processing is
30995 enabled, it is done before this test. If the check succeeds with a lookup, the
30996 result of the lookup is placed in &$local_part_data$&, which remains set until
30997 the next &%local_parts%& test.
30998
30999 .vitem &*malware&~=&~*&<&'option'&>
31000 .cindex "&%malware%& ACL condition"
31001 .cindex "&ACL;" "virus scanning"
31002 .cindex "&ACL;" "scanning for viruses"
31003 This condition is available only when Exim is compiled with the
31004 content-scanning extension
31005 and only after a DATA command.
31006 It causes the incoming message to be scanned for
31007 viruses. For details, see chapter &<<CHAPexiscan>>&.
31008
31009 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31010 .cindex "&%mime_regex%& ACL condition"
31011 .cindex "&ACL;" "testing by regex matching"
31012 This condition is available only when Exim is compiled with the
31013 content-scanning extension, and it is allowed only in the ACL defined by
31014 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31015 with any of the regular expressions. For details, see chapter
31016 &<<CHAPexiscan>>&.
31017
31018 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31019 .cindex "rate limiting"
31020 This condition can be used to limit the rate at which a user or host submits
31021 messages. Details are given in section &<<SECTratelimiting>>&.
31022
31023 .vitem &*recipients&~=&~*&<&'address&~list'&>
31024 .cindex "&%recipients%& ACL condition"
31025 .cindex "recipient" "ACL checking"
31026 .cindex "&ACL;" "testing a recipient"
31027 This condition is relevant only after a RCPT command. It checks the entire
31028 recipient address against a list of recipients.
31029
31030 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31031 .cindex "&%regex%& ACL condition"
31032 .cindex "&ACL;" "testing by regex matching"
31033 This condition is available only when Exim is compiled with the
31034 content-scanning extension, and is available only in the DATA, MIME, and
31035 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31036 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31037
31038 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31039 .cindex "&%sender_domains%& ACL condition"
31040 .cindex "sender" "ACL checking"
31041 .cindex "&ACL;" "testing a sender domain"
31042 .vindex "&$domain$&"
31043 .vindex "&$sender_address_domain$&"
31044 This condition tests the domain of the sender of the message against the given
31045 domain list. &*Note*&: The domain of the sender address is in
31046 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31047 of this condition. This is an exception to the general rule for testing domain
31048 lists. It is done this way so that, if this condition is used in an ACL for a
31049 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31050 influence the sender checking.
31051
31052 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31053 relaying, because sender addresses are easily, and commonly, forged.
31054
31055 .vitem &*senders&~=&~*&<&'address&~list'&>
31056 .cindex "&%senders%& ACL condition"
31057 .cindex "sender" "ACL checking"
31058 .cindex "&ACL;" "testing a sender"
31059 This condition tests the sender of the message against the given list. To test
31060 for a bounce message, which has an empty sender, set
31061 .code
31062 senders = :
31063 .endd
31064 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31065 relaying, because sender addresses are easily, and commonly, forged.
31066
31067 .vitem &*spam&~=&~*&<&'username'&>
31068 .cindex "&%spam%& ACL condition"
31069 .cindex "&ACL;" "scanning for spam"
31070 This condition is available only when Exim is compiled with the
31071 content-scanning extension. It causes the incoming message to be scanned by
31072 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31073
31074 .vitem &*verify&~=&~certificate*&
31075 .cindex "&%verify%& ACL condition"
31076 .cindex "TLS" "client certificate verification"
31077 .cindex "certificate" "verification of client"
31078 .cindex "&ACL;" "certificate verification"
31079 .cindex "&ACL;" "testing a TLS certificate"
31080 This condition is true in an SMTP session if the session is encrypted, and a
31081 certificate was received from the client, and the certificate was verified. The
31082 server requests a certificate only if the client matches &%tls_verify_hosts%&
31083 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31084
31085 .vitem &*verify&~=&~csa*&
31086 .cindex "CSA verification"
31087 This condition checks whether the sending host (the client) is authorized to
31088 send email. Details of how this works are given in section
31089 &<<SECTverifyCSA>>&.
31090
31091 .vitem &*verify&~=&~header_names_ascii*&
31092 .cindex "&%verify%& ACL condition"
31093 .cindex "&ACL;" "verifying header names only ASCII"
31094 .cindex "header lines" "verifying header names only ASCII"
31095 .cindex "verifying" "header names only ASCII"
31096 This condition is relevant only in an ACL that is run after a message has been
31097 received, that is, in an ACL specified by &%acl_smtp_data%& or
31098 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31099 there are no non-ASCII characters, also excluding control characters.  The
31100 allowable characters are decimal ASCII values 33 through 126.
31101
31102 Exim itself will handle headers with non-ASCII characters, but it can cause
31103 problems for downstream applications, so this option will allow their
31104 detection and rejection in the DATA ACL's.
31105
31106 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31107 .cindex "&%verify%& ACL condition"
31108 .cindex "&ACL;" "verifying sender in the header"
31109 .cindex "header lines" "verifying the sender in"
31110 .cindex "sender" "verifying in header"
31111 .cindex "verifying" "sender in header"
31112 This condition is relevant only in an ACL that is run after a message has been
31113 received, that is, in an ACL specified by &%acl_smtp_data%& or
31114 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31115 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31116 is loosely thought of as a &"sender"& address (hence the name of the test).
31117 However, an address that appears in one of these headers need not be an address
31118 that accepts bounce messages; only sender addresses in envelopes are required
31119 to accept bounces. Therefore, if you use the callout option on this check, you
31120 might want to arrange for a non-empty address in the MAIL command.
31121
31122 Details of address verification and the options are given later, starting at
31123 section &<<SECTaddressverification>>& (callouts are described in section
31124 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31125 condition to restrict it to bounce messages only:
31126 .code
31127 deny    senders = :
31128         message = A valid sender header is required for bounces
31129        !verify  = header_sender
31130 .endd
31131
31132 .vitem &*verify&~=&~header_syntax*&
31133 .cindex "&%verify%& ACL condition"
31134 .cindex "&ACL;" "verifying header syntax"
31135 .cindex "header lines" "verifying syntax"
31136 .cindex "verifying" "header syntax"
31137 This condition is relevant only in an ACL that is run after a message has been
31138 received, that is, in an ACL specified by &%acl_smtp_data%& or
31139 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31140 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31141 and &'Bcc:'&), returning true if there are no problems.
31142 Unqualified addresses (local parts without domains) are
31143 permitted only in locally generated messages and from hosts that match
31144 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31145 appropriate.
31146
31147 Note that this condition is a syntax check only. However, a common spamming
31148 ploy used to be to send syntactically invalid headers such as
31149 .code
31150 To: @
31151 .endd
31152 and this condition can be used to reject such messages, though they are not as
31153 common as they used to be.
31154
31155 .vitem &*verify&~=&~helo*&
31156 .cindex "&%verify%& ACL condition"
31157 .cindex "&ACL;" "verifying HELO/EHLO"
31158 .cindex "HELO" "verifying"
31159 .cindex "EHLO" "verifying"
31160 .cindex "verifying" "EHLO"
31161 .cindex "verifying" "HELO"
31162 This condition is true if a HELO or EHLO command has been received from the
31163 client host, and its contents have been verified. If there has been no previous
31164 attempt to verify the HELO/EHLO contents, it is carried out when this
31165 condition is encountered. See the description of the &%helo_verify_hosts%& and
31166 &%helo_try_verify_hosts%& options for details of how to request verification
31167 independently of this condition, and for detail of the verification.
31168
31169 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31170 option), this condition is always true.
31171
31172
31173 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31174 .cindex "verifying" "not blind"
31175 .cindex "bcc recipients, verifying none"
31176 This condition checks that there are no blind (bcc) recipients in the message.
31177 Every envelope recipient must appear either in a &'To:'& header line or in a
31178 &'Cc:'& header line for this condition to be true. Local parts are checked
31179 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31180 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31181 used only in a DATA or non-SMTP ACL.
31182
31183 .new
31184 There is one possible option, &`case_insensitive`&.  If this is present then
31185 local parts are checked case-insensitively.
31186 .wen
31187
31188 There are, of course, many legitimate messages that make use of blind (bcc)
31189 recipients. This check should not be used on its own for blocking messages.
31190
31191
31192 .vitem &*verify&~=&~recipient/*&<&'options'&>
31193 .cindex "&%verify%& ACL condition"
31194 .cindex "&ACL;" "verifying recipient"
31195 .cindex "recipient" "verifying"
31196 .cindex "verifying" "recipient"
31197 .vindex "&$address_data$&"
31198 This condition is relevant only after a RCPT command. It verifies the current
31199 recipient. Details of address verification are given later, starting at section
31200 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31201 of &$address_data$& is the last value that was set while routing the address.
31202 This applies even if the verification fails. When an address that is being
31203 verified is redirected to a single address, verification continues with the new
31204 address, and in that case, the subsequent value of &$address_data$& is the
31205 value for the child address.
31206
31207 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31208 .cindex "&%verify%& ACL condition"
31209 .cindex "&ACL;" "verifying host reverse lookup"
31210 .cindex "host" "verifying reverse lookup"
31211 This condition ensures that a verified host name has been looked up from the IP
31212 address of the client host. (This may have happened already if the host name
31213 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31214 Verification ensures that the host name obtained from a reverse DNS lookup, or
31215 one of its aliases, does, when it is itself looked up in the DNS, yield the
31216 original IP address.
31217
31218 There is one possible option, &`defer_ok`&.  If this is present and a
31219 DNS operation returns a temporary error, the verify condition succeeds.
31220
31221 If this condition is used for a locally generated message (that is, when there
31222 is no client host involved), it always succeeds.
31223
31224 .vitem &*verify&~=&~sender/*&<&'options'&>
31225 .cindex "&%verify%& ACL condition"
31226 .cindex "&ACL;" "verifying sender"
31227 .cindex "sender" "verifying"
31228 .cindex "verifying" "sender"
31229 This condition is relevant only after a MAIL or RCPT command, or after a
31230 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31231 the message's sender is empty (that is, this is a bounce message), the
31232 condition is true. Otherwise, the sender address is verified.
31233
31234 .vindex "&$address_data$&"
31235 .vindex "&$sender_address_data$&"
31236 If there is data in the &$address_data$& variable at the end of routing, its
31237 value is placed in &$sender_address_data$& at the end of verification. This
31238 value can be used in subsequent conditions and modifiers in the same ACL
31239 statement. It does not persist after the end of the current statement. If you
31240 want to preserve the value for longer, you can save it in an ACL variable.
31241
31242 Details of verification are given later, starting at section
31243 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31244 to avoid doing it more than once per message.
31245
31246 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31247 .cindex "&%verify%& ACL condition"
31248 This is a variation of the previous option, in which a modified address is
31249 verified as a sender.
31250
31251 Note that '/' is legal in local-parts; if the address may have such
31252 (eg. is generated from the received message)
31253 they must be protected from the options parsing by doubling:
31254 .code
31255 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31256 .endd
31257 .endlist
31258
31259
31260
31261 .section "Using DNS lists" "SECTmorednslists"
31262 .cindex "DNS list" "in ACL"
31263 .cindex "black list (DNS)"
31264 .cindex "&ACL;" "testing a DNS list"
31265 In its simplest form, the &%dnslists%& condition tests whether the calling host
31266 is on at least one of a number of DNS lists by looking up the inverted IP
31267 address in one or more DNS domains. (Note that DNS list domains are not mail
31268 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31269 special options instead.) For example, if the calling host's IP
31270 address is 192.168.62.43, and the ACL statement is
31271 .code
31272 deny dnslists = blackholes.mail-abuse.org : \
31273                 dialups.mail-abuse.org
31274 .endd
31275 the following records are looked up:
31276 .code
31277 43.62.168.192.blackholes.mail-abuse.org
31278 43.62.168.192.dialups.mail-abuse.org
31279 .endd
31280 As soon as Exim finds an existing DNS record, processing of the list stops.
31281 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31282 to test that a host is on more than one list (an &"and"& conjunction), you can
31283 use two separate conditions:
31284 .code
31285 deny dnslists = blackholes.mail-abuse.org
31286      dnslists = dialups.mail-abuse.org
31287 .endd
31288 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31289 behaves as if the host does not match the list item, that is, as if the DNS
31290 record does not exist. If there are further items in the DNS list, they are
31291 processed.
31292
31293 This is usually the required action when &%dnslists%& is used with &%deny%&
31294 (which is the most common usage), because it prevents a DNS failure from
31295 blocking mail. However, you can change this behaviour by putting one of the
31296 following special items in the list:
31297 .display
31298 &`+include_unknown `&   behave as if the item is on the list
31299 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31300 &`+defer_unknown   `&   give a temporary error
31301 .endd
31302 .cindex "&`+include_unknown`&"
31303 .cindex "&`+exclude_unknown`&"
31304 .cindex "&`+defer_unknown`&"
31305 Each of these applies to any subsequent items on the list. For example:
31306 .code
31307 deny dnslists = +defer_unknown : foo.bar.example
31308 .endd
31309 Testing the list of domains stops as soon as a match is found. If you want to
31310 warn for one list and block for another, you can use two different statements:
31311 .code
31312 deny  dnslists = blackholes.mail-abuse.org
31313 warn  message  = X-Warn: sending host is on dialups list
31314       dnslists = dialups.mail-abuse.org
31315 .endd
31316 .cindex caching "of dns lookup"
31317 .cindex DNS TTL
31318 DNS list lookups are cached by Exim for the duration of the SMTP session
31319 (but limited by the DNS return TTL value),
31320 so a lookup based on the IP address is done at most once for any incoming
31321 connection (assuming long-enough TTL).
31322 Exim does not share information between multiple incoming
31323 connections (but your local name server cache should be active).
31324
31325 There are a number of DNS lists to choose from, some commercial, some free,
31326 or free for small deployments.  An overview can be found at
31327 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31328
31329
31330
31331 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31332 .cindex "DNS list" "keyed by explicit IP address"
31333 By default, the IP address that is used in a DNS list lookup is the IP address
31334 of the calling host. However, you can specify another IP address by listing it
31335 after the domain name, introduced by a slash. For example:
31336 .code
31337 deny dnslists = black.list.tld/192.168.1.2
31338 .endd
31339 This feature is not very helpful with explicit IP addresses; it is intended for
31340 use with IP addresses that are looked up, for example, the IP addresses of the
31341 MX hosts or nameservers of an email sender address. For an example, see section
31342 &<<SECTmulkeyfor>>& below.
31343
31344
31345
31346
31347 .section "DNS lists keyed on domain names" "SECID202"
31348 .cindex "DNS list" "keyed by domain name"
31349 There are some lists that are keyed on domain names rather than inverted IP
31350 addresses (see, e.g., the &'domain based zones'& link at
31351 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31352 with these lists. You can change the name that is looked up in a DNS list by
31353 listing it after the domain name, introduced by a slash. For example,
31354 .code
31355 deny  message  = Sender's domain is listed at $dnslist_domain
31356       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31357 .endd
31358 This particular example is useful only in ACLs that are obeyed after the
31359 RCPT or DATA commands, when a sender address is available. If (for
31360 example) the message's sender is &'user@tld.example'& the name that is looked
31361 up by this example is
31362 .code
31363 tld.example.dsn.rfc-ignorant.org
31364 .endd
31365 A single &%dnslists%& condition can contain entries for both names and IP
31366 addresses. For example:
31367 .code
31368 deny dnslists = sbl.spamhaus.org : \
31369                 dsn.rfc-ignorant.org/$sender_address_domain
31370 .endd
31371 The first item checks the sending host's IP address; the second checks a domain
31372 name. The whole condition is true if either of the DNS lookups succeeds.
31373
31374
31375
31376
31377 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31378 .cindex "DNS list" "multiple keys for"
31379 The syntax described above for looking up explicitly-defined values (either
31380 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31381 name for the DNS list, what follows the slash can in fact be a list of items.
31382 As with all lists in Exim, the default separator is a colon. However, because
31383 this is a sublist within the list of DNS blacklist domains, it is necessary
31384 either to double the separators like this:
31385 .code
31386 dnslists = black.list.tld/name.1::name.2
31387 .endd
31388 or to change the separator character, like this:
31389 .code
31390 dnslists = black.list.tld/<;name.1;name.2
31391 .endd
31392 If an item in the list is an IP address, it is inverted before the DNS
31393 blacklist domain is appended. If it is not an IP address, no inversion
31394 occurs. Consider this condition:
31395 .code
31396 dnslists = black.list.tld/<;192.168.1.2;a.domain
31397 .endd
31398 The DNS lookups that occur are:
31399 .code
31400 2.1.168.192.black.list.tld
31401 a.domain.black.list.tld
31402 .endd
31403 Once a DNS record has been found (that matches a specific IP return
31404 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31405 are done. If there is a temporary DNS error, the rest of the sublist of domains
31406 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31407 only if no other DNS lookup in this sublist succeeds. In other words, a
31408 successful lookup for any of the items in the sublist overrides a temporary
31409 error for a previous item.
31410
31411 The ability to supply a list of items after the slash is in some sense just a
31412 syntactic convenience. These two examples have the same effect:
31413 .code
31414 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31415 dnslists = black.list.tld/a.domain::b.domain
31416 .endd
31417 However, when the data for the list is obtained from a lookup, the second form
31418 is usually much more convenient. Consider this example:
31419 .code
31420 deny message  = The mail servers for the domain \
31421                 $sender_address_domain \
31422                 are listed at $dnslist_domain ($dnslist_value); \
31423                 see $dnslist_text.
31424      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31425                                    ${lookup dnsdb {>|mxh=\
31426                                    $sender_address_domain} }} }
31427 .endd
31428 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31429 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31430 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31431 of expanding the condition might be something like this:
31432 .code
31433 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31434 .endd
31435 Thus, this example checks whether or not the IP addresses of the sender
31436 domain's mail servers are on the Spamhaus black list.
31437
31438 The key that was used for a successful DNS list lookup is put into the variable
31439 &$dnslist_matched$& (see section &<<SECID204>>&).
31440
31441
31442
31443
31444 .section "Data returned by DNS lists" "SECID203"
31445 .cindex "DNS list" "data returned from"
31446 DNS lists are constructed using address records in the DNS. The original RBL
31447 just used the address 127.0.0.1 on the right hand side of each record, but the
31448 RBL+ list and some other lists use a number of values with different meanings.
31449 The values used on the RBL+ list are:
31450 .display
31451 127.1.0.1  RBL
31452 127.1.0.2  DUL
31453 127.1.0.3  DUL and RBL
31454 127.1.0.4  RSS
31455 127.1.0.5  RSS and RBL
31456 127.1.0.6  RSS and DUL
31457 127.1.0.7  RSS and DUL and RBL
31458 .endd
31459 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31460 different values. Some DNS lists may return more than one address record;
31461 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31462
31463
31464 .section "Variables set from DNS lists" "SECID204"
31465 .cindex "expansion" "variables, set from DNS list"
31466 .cindex "DNS list" "variables set from"
31467 .vindex "&$dnslist_domain$&"
31468 .vindex "&$dnslist_matched$&"
31469 .vindex "&$dnslist_text$&"
31470 .vindex "&$dnslist_value$&"
31471 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31472 the name of the overall domain that matched (for example,
31473 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31474 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31475 the DNS record. When the key is an IP address, it is not reversed in
31476 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31477 cases, for example:
31478 .code
31479 deny dnslists = spamhaus.example
31480 .endd
31481 the key is also available in another variable (in this case,
31482 &$sender_host_address$&). In more complicated cases, however, this is not true.
31483 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31484 might generate a dnslists lookup like this:
31485 .code
31486 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31487 .endd
31488 If this condition succeeds, the value in &$dnslist_matched$& might be
31489 &`192.168.6.7`& (for example).
31490
31491 If more than one address record is returned by the DNS lookup, all the IP
31492 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31493 The variable &$dnslist_text$& contains the contents of any associated TXT
31494 record. For lists such as RBL+ the TXT record for a merged entry is often not
31495 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31496 information.
31497
31498 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31499 &-- although these appear before the condition in the ACL, they are not
31500 expanded until after it has failed. For example:
31501 .code
31502 deny    hosts = !+local_networks
31503         message = $sender_host_address is listed \
31504                   at $dnslist_domain
31505         dnslists = rbl-plus.mail-abuse.example
31506 .endd
31507
31508
31509
31510 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31511 .cindex "DNS list" "matching specific returned data"
31512 You can add an equals sign and an IP address after a &%dnslists%& domain name
31513 in order to restrict its action to DNS records with a matching right hand side.
31514 For example,
31515 .code
31516 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31517 .endd
31518 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31519 any address record is considered to be a match. For the moment, we assume
31520 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31521 describes how multiple records are handled.
31522
31523 More than one IP address may be given for checking, using a comma as a
31524 separator. These are alternatives &-- if any one of them matches, the
31525 &%dnslists%& condition is true. For example:
31526 .code
31527 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31528 .endd
31529 If you want to specify a constraining address list and also specify names or IP
31530 addresses to be looked up, the constraining address list must be specified
31531 first. For example:
31532 .code
31533 deny dnslists = dsn.rfc-ignorant.org\
31534                 =127.0.0.2/$sender_address_domain
31535 .endd
31536
31537 If the character &`&&`& is used instead of &`=`&, the comparison for each
31538 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31539 In other words, the listed addresses are used as bit masks. The comparison is
31540 true if all the bits in the mask are present in the address that is being
31541 tested. For example:
31542 .code
31543 dnslists = a.b.c&0.0.0.3
31544 .endd
31545 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31546 want to test whether one bit or another bit is present (as opposed to both
31547 being present), you must use multiple values. For example:
31548 .code
31549 dnslists = a.b.c&0.0.0.1,0.0.0.2
31550 .endd
31551 matches if the final component of the address is an odd number or two times
31552 an odd number.
31553
31554
31555
31556 .section "Negated DNS matching conditions" "SECID205"
31557 You can supply a negative list of IP addresses as part of a &%dnslists%&
31558 condition. Whereas
31559 .code
31560 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31561 .endd
31562 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31563 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31564 .code
31565 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31566 .endd
31567 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31568 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31569 words, the result of the test is inverted if an exclamation mark appears before
31570 the &`=`& (or the &`&&`&) sign.
31571
31572 &*Note*&: This kind of negation is not the same as negation in a domain,
31573 host, or address list (which is why the syntax is different).
31574
31575 If you are using just one list, the negation syntax does not gain you much. The
31576 previous example is precisely equivalent to
31577 .code
31578 deny  dnslists = a.b.c
31579      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31580 .endd
31581 However, if you are using multiple lists, the negation syntax is clearer.
31582 Consider this example:
31583 .code
31584 deny  dnslists = sbl.spamhaus.org : \
31585                  list.dsbl.org : \
31586                  dnsbl.njabl.org!=127.0.0.3 : \
31587                  relays.ordb.org
31588 .endd
31589 Using only positive lists, this would have to be:
31590 .code
31591 deny  dnslists = sbl.spamhaus.org : \
31592                  list.dsbl.org
31593 deny  dnslists = dnsbl.njabl.org
31594      !dnslists = dnsbl.njabl.org=127.0.0.3
31595 deny  dnslists = relays.ordb.org
31596 .endd
31597 which is less clear, and harder to maintain.
31598
31599
31600
31601
31602 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31603 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31604 thereby providing more than one IP address. When an item in a &%dnslists%& list
31605 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31606 the match to specific results from the DNS lookup, there are two ways in which
31607 the checking can be handled. For example, consider the condition:
31608 .code
31609 dnslists = a.b.c=127.0.0.1
31610 .endd
31611 What happens if the DNS lookup for the incoming IP address yields both
31612 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31613 condition true because at least one given value was found, or is it false
31614 because at least one of the found values was not listed? And how does this
31615 affect negated conditions? Both possibilities are provided for with the help of
31616 additional separators &`==`& and &`=&&`&.
31617
31618 .ilist
31619 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31620 IP addresses matches one of the listed addresses. For the example above, the
31621 condition is true because 127.0.0.1 matches.
31622 .next
31623 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31624 looked up IP addresses matches one of the listed addresses. If the condition is
31625 changed to:
31626 .code
31627 dnslists = a.b.c==127.0.0.1
31628 .endd
31629 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31630 false because 127.0.0.2 is not listed. You would need to have:
31631 .code
31632 dnslists = a.b.c==127.0.0.1,127.0.0.2
31633 .endd
31634 for the condition to be true.
31635 .endlist
31636
31637 When &`!`& is used to negate IP address matching, it inverts the result, giving
31638 the precise opposite of the behaviour above. Thus:
31639 .ilist
31640 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31641 addresses matches one of the listed addresses. Consider:
31642 .code
31643 dnslists = a.b.c!&0.0.0.1
31644 .endd
31645 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31646 false because 127.0.0.1 matches.
31647 .next
31648 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31649 looked up IP address that does not match. Consider:
31650 .code
31651 dnslists = a.b.c!=&0.0.0.1
31652 .endd
31653 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31654 true, because 127.0.0.2 does not match. You would need to have:
31655 .code
31656 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31657 .endd
31658 for the condition to be false.
31659 .endlist
31660 When the DNS lookup yields only a single IP address, there is no difference
31661 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31662
31663
31664
31665
31666 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31667 .cindex "DNS list" "information from merged"
31668 When the facility for restricting the matching IP values in a DNS list is used,
31669 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31670 the true reason for rejection. This happens when lists are merged and the IP
31671 address in the A record is used to distinguish them; unfortunately there is
31672 only one TXT record. One way round this is not to use merged lists, but that
31673 can be inefficient because it requires multiple DNS lookups where one would do
31674 in the vast majority of cases when the host of interest is not on any of the
31675 lists.
31676
31677 A less inefficient way of solving this problem is available. If
31678 two domain names, comma-separated, are given, the second is used first to
31679 do an initial check, making use of any IP value restrictions that are set.
31680 If there is a match, the first domain is used, without any IP value
31681 restrictions, to get the TXT record. As a byproduct of this, there is also
31682 a check that the IP being tested is indeed on the first list. The first
31683 domain is the one that is put in &$dnslist_domain$&. For example:
31684 .code
31685 deny message  = \
31686          rejected because $sender_host_address is blacklisted \
31687          at $dnslist_domain\n$dnslist_text
31688        dnslists = \
31689          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31690          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31691 .endd
31692 For the first blacklist item, this starts by doing a lookup in
31693 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31694 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31695 value, and as long as something is found, it looks for the corresponding TXT
31696 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31697 The second blacklist item is processed similarly.
31698
31699 If you are interested in more than one merged list, the same list must be
31700 given several times, but because the results of the DNS lookups are cached,
31701 the DNS calls themselves are not repeated. For example:
31702 .code
31703 deny dnslists = \
31704          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31705          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31706          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31707          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31708 .endd
31709 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31710 values matches (or if no record is found), this is the only lookup that is
31711 done. Only if there is a match is one of the more specific lists consulted.
31712
31713
31714
31715 .section "DNS lists and IPv6" "SECTmorednslistslast"
31716 .cindex "IPv6" "DNS black lists"
31717 .cindex "DNS list" "IPv6 usage"
31718 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31719 nibble by nibble. For example, if the calling host's IP address is
31720 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31721 .code
31722 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31723   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31724 .endd
31725 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31726 lists contain wildcard records, intended for IPv4, that interact badly with
31727 IPv6. For example, the DNS entry
31728 .code
31729 *.3.some.list.example.    A    127.0.0.1
31730 .endd
31731 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31732 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31733
31734 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31735 &%condition%& condition, as in this example:
31736 .code
31737 deny   condition = ${if isip4{$sender_host_address}}
31738        dnslists  = some.list.example
31739 .endd
31740
31741 If an explicit key is being used for a DNS lookup and it may be an IPv6
31742 address you should specify alternate list separators for both the outer
31743 (DNS list name) list and inner (lookup keys) list:
31744 .code
31745        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31746 .endd
31747
31748 .section "Rate limiting incoming messages" "SECTratelimiting"
31749 .cindex "rate limiting" "client sending"
31750 .cindex "limiting client sending rates"
31751 .oindex "&%smtp_ratelimit_*%&"
31752 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31753 which clients can send email. This is more powerful than the
31754 &%smtp_ratelimit_*%& options, because those options control the rate of
31755 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31756 works across all connections (concurrent and sequential) from the same client
31757 host. The syntax of the &%ratelimit%& condition is:
31758 .display
31759 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31760 .endd
31761 If the average client sending rate is less than &'m'& messages per time
31762 period &'p'& then the condition is false; otherwise it is true.
31763
31764 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31765 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31766 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31767 of &'p'&.
31768
31769 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31770 time interval, for example, &`8h`& for eight hours. A larger time constant
31771 means that it takes Exim longer to forget a client's past behaviour. The
31772 parameter &'m'& is the maximum number of messages that a client is permitted to
31773 send in each time interval. It also specifies the number of messages permitted
31774 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31775 constant, you can allow a client to send more messages in a burst without
31776 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31777 both small, messages must be sent at an even rate.
31778
31779 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31780 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31781 when deploying the &%ratelimit%& ACL condition. The script prints usage
31782 instructions when it is run with no arguments.
31783
31784 The key is used to look up the data for calculating the client's average
31785 sending rate. This data is stored in Exim's spool directory, alongside the
31786 retry and other hints databases. The default key is &$sender_host_address$&,
31787 which means Exim computes the sending rate of each client host IP address.
31788 By changing the key you can change how Exim identifies clients for the purpose
31789 of ratelimiting. For example, to limit the sending rate of each authenticated
31790 user, independent of the computer they are sending from, set the key to
31791 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31792 example, &$authenticated_id$& is only meaningful if the client has
31793 authenticated (which you can check with the &%authenticated%& ACL condition).
31794
31795 The lookup key does not have to identify clients: If you want to limit the
31796 rate at which a recipient receives messages, you can use the key
31797 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31798 ACL.
31799
31800 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31801 specifies what Exim measures the rate of, for example, messages or recipients
31802 or bytes. You can adjust the measurement using the &%unique=%& and/or
31803 &%count=%& options. You can also control when Exim updates the recorded rate
31804 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31805 separated by a slash, like the other parameters. They may appear in any order.
31806
31807 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31808 any options that alter the meaning of the stored data. The limit &'m'& is not
31809 stored, so you can alter the configured maximum rate and Exim will still
31810 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31811 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31812 behaviour. The lookup key is not affected by changes to the update mode and
31813 the &%count=%& option.
31814
31815
31816 .section "Ratelimit options for what is being measured" "ratoptmea"
31817 .cindex "rate limiting" "per_* options"
31818 The &%per_conn%& option limits the client's connection rate. It is not
31819 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31820 &%acl_not_smtp_start%& ACLs.
31821
31822 The &%per_mail%& option limits the client's rate of sending messages. This is
31823 the default if none of the &%per_*%& options is specified. It can be used in
31824 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31825 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31826
31827 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31828 the same ACLs as the &%per_mail%& option, though it is best to use this option
31829 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31830 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31831 in its MAIL command, which may be inaccurate or completely missing. You can
31832 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31833 in kilobytes, megabytes, or gigabytes, respectively.
31834
31835 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31836 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31837 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31838 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31839 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31840 in either case the rate limiting engine will see a message with many
31841 recipients as a large high-speed burst.
31842
31843 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31844 number of different recipients that the client has sent messages to in the
31845 last time period. That is, if the client repeatedly sends messages to the same
31846 recipient, its measured rate is not increased. This option can only be used in
31847 &%acl_smtp_rcpt%&.
31848
31849 The &%per_cmd%& option causes Exim to recompute the rate every time the
31850 condition is processed. This can be used to limit the rate of any SMTP
31851 command. If it is used in multiple ACLs it can limit the aggregate rate of
31852 multiple different commands.
31853
31854 The &%count=%& option can be used to alter how much Exim adds to the client's
31855 measured rate. For example, the &%per_byte%& option is equivalent to
31856 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31857 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31858 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31859
31860 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31861
31862
31863 .section "Ratelimit update modes" "ratoptupd"
31864 .cindex "rate limiting" "reading data without updating"
31865 You can specify one of three options with the &%ratelimit%& condition to
31866 control when its database is updated. This section describes the &%readonly%&
31867 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31868
31869 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31870 previously-computed rate to check against the limit.
31871
31872 For example, you can test the client's sending rate and deny it access (when
31873 it is too fast) in the connect ACL. If the client passes this check then it
31874 can go on to send a message, in which case its recorded rate will be updated
31875 in the MAIL ACL. Subsequent connections from the same client will check this
31876 new rate.
31877 .code
31878 acl_check_connect:
31879  deny ratelimit = 100 / 5m / readonly
31880     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31881                   (max $sender_rate_limit)
31882 # ...
31883 acl_check_mail:
31884  warn ratelimit = 100 / 5m / strict
31885     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31886                   (max $sender_rate_limit)
31887 .endd
31888
31889 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31890 processing a message then it may increase the client's measured rate more than
31891 it should. For example, this will happen if you check the &%per_rcpt%& option
31892 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31893 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31894 multiple update problems by using the &%readonly%& option on later ratelimit
31895 checks.
31896
31897 The &%per_*%& options described above do not make sense in some ACLs. If you
31898 use a &%per_*%& option in an ACL where it is not normally permitted then the
31899 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31900 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31901 next section) so you must specify the &%readonly%& option explicitly.
31902
31903
31904 .section "Ratelimit options for handling fast clients" "ratoptfast"
31905 .cindex "rate limiting" "strict and leaky modes"
31906 If a client's average rate is greater than the maximum, the rate limiting
31907 engine can react in two possible ways, depending on the presence of the
31908 &%strict%& or &%leaky%& update modes. This is independent of the other
31909 counter-measures (such as rejecting the message) that may be specified by the
31910 rest of the ACL.
31911
31912 The &%leaky%& (default) option means that the client's recorded rate is not
31913 updated if it is above the limit. The effect of this is that Exim measures the
31914 client's average rate of successfully sent email,
31915 up to the given limit.
31916 This is appropriate if the countermeasure when the condition is true
31917 consists of refusing the message, and
31918 is generally the better choice if you have clients that retry automatically.
31919 If the action when true is anything more complex then this option is
31920 likely not what is wanted.
31921
31922 The &%strict%& option means that the client's recorded rate is always
31923 updated. The effect of this is that Exim measures the client's average rate
31924 of attempts to send email, which can be much higher than the maximum it is
31925 actually allowed. If the client is over the limit it may be subjected to
31926 counter-measures by the ACL. It must slow down and allow sufficient time to
31927 pass that its computed rate falls below the maximum before it can send email
31928 again. The time (the number of smoothing periods) it must wait and not
31929 attempt to send mail can be calculated with this formula:
31930 .code
31931         ln(peakrate/maxrate)
31932 .endd
31933
31934
31935 .section "Limiting the rate of different events" "ratoptuniq"
31936 .cindex "rate limiting" "counting unique events"
31937 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31938 rate of different events. For example, the &%per_addr%& option uses this
31939 mechanism to count the number of different recipients that the client has
31940 sent messages to in the last time period; it is equivalent to
31941 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31942 measure the rate that a client uses different sender addresses with the
31943 options &`per_mail/unique=$sender_address`&.
31944
31945 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31946 has seen for that key. The whole set is thrown away when it is older than the
31947 rate smoothing period &'p'&, so each different event is counted at most once
31948 per period. In the &%leaky%& update mode, an event that causes the client to
31949 go over the limit is not added to the set, in the same way that the client's
31950 recorded rate is not updated in the same situation.
31951
31952 When you combine the &%unique=%& and &%readonly%& options, the specific
31953 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31954 rate.
31955
31956 The &%unique=%& mechanism needs more space in the ratelimit database than the
31957 other &%ratelimit%& options in order to store the event set. The number of
31958 unique values is potentially as large as the rate limit, so the extra space
31959 required increases with larger limits.
31960
31961 The uniqueification is not perfect: there is a small probability that Exim
31962 will think a new event has happened before. If the sender's rate is less than
31963 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31964 the measured rate can go above the limit, in which case Exim may under-count
31965 events by a significant margin. Fortunately, if the rate is high enough (2.7
31966 times the limit) that the false positive rate goes above 9%, then Exim will
31967 throw away the over-full event set before the measured rate falls below the
31968 limit. Therefore the only harm should be that exceptionally high sending rates
31969 are logged incorrectly; any countermeasures you configure will be as effective
31970 as intended.
31971
31972
31973 .section "Using rate limiting" "useratlim"
31974 Exim's other ACL facilities are used to define what counter-measures are taken
31975 when the rate limit is exceeded. This might be anything from logging a warning
31976 (for example, while measuring existing sending rates in order to define
31977 policy), through time delays to slow down fast senders, up to rejecting the
31978 message. For example:
31979 .code
31980 # Log all senders' rates
31981 warn ratelimit = 0 / 1h / strict
31982      log_message = Sender rate $sender_rate / $sender_rate_period
31983
31984 # Slow down fast senders; note the need to truncate $sender_rate
31985 # at the decimal point.
31986 warn ratelimit = 100 / 1h / per_rcpt / strict
31987      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31988                    $sender_rate_limit }s
31989
31990 # Keep authenticated users under control
31991 deny authenticated = *
31992      ratelimit = 100 / 1d / strict / $authenticated_id
31993
31994 # System-wide rate limit
31995 defer message = Sorry, too busy. Try again later.
31996      ratelimit = 10 / 1s / $primary_hostname
31997
31998 # Restrict incoming rate from each host, with a default
31999 # set using a macro and special cases looked up in a table.
32000 defer message = Sender rate exceeds $sender_rate_limit \
32001                messages per $sender_rate_period
32002      ratelimit = ${lookup {$sender_host_address} \
32003                    cdb {DB/ratelimits.cdb} \
32004                    {$value} {RATELIMIT} }
32005 .endd
32006 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32007 especially with the &%per_rcpt%& option, you may suffer from a performance
32008 bottleneck caused by locking on the ratelimit hints database. Apart from
32009 making your ACLs less complicated, you can reduce the problem by using a
32010 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32011 this means that Exim will lose its hints data after a reboot (including retry
32012 hints, the callout cache, and ratelimit data).
32013
32014
32015
32016 .section "Address verification" "SECTaddressverification"
32017 .cindex "verifying address" "options for"
32018 .cindex "policy control" "address verification"
32019 Several of the &%verify%& conditions described in section
32020 &<<SECTaclconditions>>& cause addresses to be verified. Section
32021 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32022 The verification conditions can be followed by options that modify the
32023 verification process. The options are separated from the keyword and from each
32024 other by slashes, and some of them contain parameters. For example:
32025 .code
32026 verify = sender/callout
32027 verify = recipient/defer_ok/callout=10s,defer_ok
32028 .endd
32029 The first stage of address verification, which always happens, is to run the
32030 address through the routers, in &"verify mode"&. Routers can detect the
32031 difference between verification and routing for delivery, and their actions can
32032 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32033 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32034 The available options are as follows:
32035
32036 .ilist
32037 If the &%callout%& option is specified, successful routing to one or more
32038 remote hosts is followed by a &"callout"& to those hosts as an additional
32039 check. Callouts and their sub-options are discussed in the next section.
32040 .next
32041 If there is a defer error while doing verification routing, the ACL
32042 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32043 options, the condition is forced to be true instead. Note that this is a main
32044 verification option as well as a suboption for callouts.
32045 .next
32046 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32047 discusses the reporting of sender address verification failures.
32048 .next
32049 The &%success_on_redirect%& option causes verification always to succeed
32050 immediately after a successful redirection. By default, if a redirection
32051 generates just one address, that address is also verified. See further
32052 discussion in section &<<SECTredirwhilveri>>&.
32053 .endlist
32054
32055 .cindex "verifying address" "differentiating failures"
32056 .vindex "&$recipient_verify_failure$&"
32057 .vindex "&$sender_verify_failure$&"
32058 .vindex "&$acl_verify_message$&"
32059 After an address verification failure, &$acl_verify_message$& contains the
32060 error message that is associated with the failure. It can be preserved by
32061 coding like this:
32062 .code
32063 warn  !verify = sender
32064        set acl_m0 = $acl_verify_message
32065 .endd
32066 If you are writing your own custom rejection message or log message when
32067 denying access, you can use this variable to include information about the
32068 verification failure.
32069
32070 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32071 appropriate) contains one of the following words:
32072
32073 .ilist
32074 &%qualify%&: The address was unqualified (no domain), and the message
32075 was neither local nor came from an exempted host.
32076 .next
32077 &%route%&: Routing failed.
32078 .next
32079 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32080 occurred at or before the MAIL command (that is, on initial
32081 connection, HELO, or MAIL).
32082 .next
32083 &%recipient%&: The RCPT command in a callout was rejected.
32084 .next
32085 &%postmaster%&: The postmaster check in a callout was rejected.
32086 .endlist
32087
32088 The main use of these variables is expected to be to distinguish between
32089 rejections of MAIL and rejections of RCPT in callouts.
32090
32091 The above variables may also be set after a &*successful*&
32092 address verification to:
32093
32094 .ilist
32095 &%random%&: A random local-part callout succeeded
32096 .endlist
32097
32098
32099
32100
32101 .section "Callout verification" "SECTcallver"
32102 .cindex "verifying address" "by callout"
32103 .cindex "callout" "verification"
32104 .cindex "SMTP" "callout verification"
32105 For non-local addresses, routing verifies the domain, but is unable to do any
32106 checking of the local part. There are situations where some means of verifying
32107 the local part is desirable. One way this can be done is to make an SMTP
32108 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32109 a subsequent host for a recipient address, to see if the host accepts the
32110 address. We use the term &'callout'& to cover both cases. Note that for a
32111 sender address, the callback is not to the client host that is trying to
32112 deliver the message, but to one of the hosts that accepts incoming mail for the
32113 sender's domain.
32114
32115 Exim does not do callouts by default. If you want them to happen, you must
32116 request them by setting appropriate options on the &%verify%& condition, as
32117 described below. This facility should be used with care, because it can add a
32118 lot of resource usage to the cost of verifying an address. However, Exim does
32119 cache the results of callouts, which helps to reduce the cost. Details of
32120 caching are in section &<<SECTcallvercache>>&.
32121
32122 Recipient callouts are usually used only between hosts that are controlled by
32123 the same administration. For example, a corporate gateway host could use
32124 callouts to check for valid recipients on an internal mailserver. A successful
32125 callout does not guarantee that a real delivery to the address would succeed;
32126 on the other hand, a failing callout does guarantee that a delivery would fail.
32127
32128 If the &%callout%& option is present on a condition that verifies an address, a
32129 second stage of verification occurs if the address is successfully routed to
32130 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32131 &(manualroute)& router, where the router specifies the hosts. However, if a
32132 router that does not set up hosts routes to an &(smtp)& transport with a
32133 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32134 &%hosts_override%& set, its hosts are always used, whether or not the router
32135 supplies a host list.
32136 Callouts are only supported on &(smtp)& transports.
32137
32138 The port that is used is taken from the transport, if it is specified and is a
32139 remote transport. (For routers that do verification only, no transport need be
32140 specified.) Otherwise, the default SMTP port is used. If a remote transport
32141 specifies an outgoing interface, this is used; otherwise the interface is not
32142 specified. Likewise, the text that is used for the HELO command is taken from
32143 the transport's &%helo_data%& option; if there is no transport, the value of
32144 &$smtp_active_hostname$& is used.
32145
32146 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32147 test whether a bounce message could be delivered to the sender address. The
32148 following SMTP commands are sent:
32149 .display
32150 &`HELO `&<&'local host name'&>
32151 &`MAIL FROM:<>`&
32152 &`RCPT TO:`&<&'the address to be tested'&>
32153 &`QUIT`&
32154 .endd
32155 LHLO is used instead of HELO if the transport's &%protocol%& option is
32156 set to &"lmtp"&.
32157
32158 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32159 settings.
32160
32161 A recipient callout check is similar. By default, it also uses an empty address
32162 for the sender. This default is chosen because most hosts do not make use of
32163 the sender address when verifying a recipient. Using the same address means
32164 that a single cache entry can be used for each recipient. Some sites, however,
32165 do make use of the sender address when verifying. These are catered for by the
32166 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32167
32168 If the response to the RCPT command is a 2&'xx'& code, the verification
32169 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32170 Exim tries the next host, if any. If there is a problem with all the remote
32171 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32172 &%callout%& option is given, in which case the condition is forced to succeed.
32173
32174 .cindex "SMTP" "output flushing, disabling for callout"
32175 A callout may take a little time. For this reason, Exim normally flushes SMTP
32176 output before performing a callout in an ACL, to avoid unexpected timeouts in
32177 clients when the SMTP PIPELINING extension is in use. The flushing can be
32178 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32179
32180
32181
32182
32183 .section "Additional parameters for callouts" "CALLaddparcall"
32184 .cindex "callout" "additional parameters for"
32185 The &%callout%& option can be followed by an equals sign and a number of
32186 optional parameters, separated by commas. For example:
32187 .code
32188 verify = recipient/callout=10s,defer_ok
32189 .endd
32190 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32191 separate verify options, is retained for backwards compatibility, but is now
32192 deprecated. The additional parameters for &%callout%& are as follows:
32193
32194
32195 .vlist
32196 .vitem <&'a&~time&~interval'&>
32197 .cindex "callout" "timeout, specifying"
32198 This specifies the timeout that applies for the callout attempt to each host.
32199 For example:
32200 .code
32201 verify = sender/callout=5s
32202 .endd
32203 The default is 30 seconds. The timeout is used for each response from the
32204 remote host. It is also used for the initial connection, unless overridden by
32205 the &%connect%& parameter.
32206
32207
32208 .vitem &*connect&~=&~*&<&'time&~interval'&>
32209 .cindex "callout" "connection timeout, specifying"
32210 This parameter makes it possible to set a different (usually smaller) timeout
32211 for making the SMTP connection. For example:
32212 .code
32213 verify = sender/callout=5s,connect=1s
32214 .endd
32215 If not specified, this timeout defaults to the general timeout value.
32216
32217 .vitem &*defer_ok*&
32218 .cindex "callout" "defer, action on"
32219 When this parameter is present, failure to contact any host, or any other kind
32220 of temporary error, is treated as success by the ACL. However, the cache is not
32221 updated in this circumstance.
32222
32223 .vitem &*fullpostmaster*&
32224 .cindex "callout" "full postmaster check"
32225 This operates like the &%postmaster%& option (see below), but if the check for
32226 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32227 accordance with the specification in RFC 2821. The RFC states that the
32228 unqualified address &'postmaster'& should be accepted.
32229
32230
32231 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32232 .cindex "callout" "sender when verifying header"
32233 When verifying addresses in header lines using the &%header_sender%&
32234 verification option, Exim behaves by default as if the addresses are envelope
32235 sender addresses from a message. Callout verification therefore tests to see
32236 whether a bounce message could be delivered, by using an empty address in the
32237 MAIL command. However, it is arguable that these addresses might never be used
32238 as envelope senders, and could therefore justifiably reject bounce messages
32239 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32240 address to use in the MAIL command. For example:
32241 .code
32242 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32243 .endd
32244 This parameter is available only for the &%header_sender%& verification option.
32245
32246
32247 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32248 .cindex "callout" "overall timeout, specifying"
32249 This parameter sets an overall timeout for performing a callout verification.
32250 For example:
32251 .code
32252 verify = sender/callout=5s,maxwait=30s
32253 .endd
32254 This timeout defaults to four times the callout timeout for individual SMTP
32255 commands. The overall timeout applies when there is more than one host that can
32256 be tried. The timeout is checked before trying the next host. This prevents
32257 very long delays if there are a large number of hosts and all are timing out
32258 (for example, when network connections are timing out).
32259
32260
32261 .vitem &*no_cache*&
32262 .cindex "callout" "cache, suppressing"
32263 .cindex "caching callout, suppressing"
32264 When this parameter is given, the callout cache is neither read nor updated.
32265
32266 .vitem &*postmaster*&
32267 .cindex "callout" "postmaster; checking"
32268 When this parameter is set, a successful callout check is followed by a similar
32269 check for the local part &'postmaster'& at the same domain. If this address is
32270 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32271 the postmaster check is recorded in a cache record; if it is a failure, this is
32272 used to fail subsequent callouts for the domain without a connection being
32273 made, until the cache record expires.
32274
32275 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32276 The postmaster check uses an empty sender in the MAIL command by default.
32277 You can use this parameter to do a postmaster check using a different address.
32278 For example:
32279 .code
32280 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32281 .endd
32282 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32283 one overrides. The &%postmaster%& parameter is equivalent to this example:
32284 .code
32285 require  verify = sender/callout=postmaster_mailfrom=
32286 .endd
32287 &*Warning*&: The caching arrangements for postmaster checking do not take
32288 account of the sender address. It is assumed that either the empty address or
32289 a fixed non-empty address will be used. All that Exim remembers is that the
32290 postmaster check for the domain succeeded or failed.
32291
32292
32293 .vitem &*random*&
32294 .cindex "callout" "&""random""& check"
32295 When this parameter is set, before doing the normal callout check, Exim does a
32296 check for a &"random"& local part at the same domain. The local part is not
32297 really random &-- it is defined by the expansion of the option
32298 &%callout_random_local_part%&, which defaults to
32299 .code
32300 $primary_hostname-$tod_epoch-testing
32301 .endd
32302 The idea here is to try to determine whether the remote host accepts all local
32303 parts without checking. If it does, there is no point in doing callouts for
32304 specific local parts. If the &"random"& check succeeds, the result is saved in
32305 a cache record, and used to force the current and subsequent callout checks to
32306 succeed without a connection being made, until the cache record expires.
32307
32308 .vitem &*use_postmaster*&
32309 .cindex "callout" "sender for recipient check"
32310 This parameter applies to recipient callouts only. For example:
32311 .code
32312 deny  !verify = recipient/callout=use_postmaster
32313 .endd
32314 .vindex "&$qualify_domain$&"
32315 It causes a non-empty postmaster address to be used in the MAIL command when
32316 performing the callout for the recipient, and also for a &"random"& check if
32317 that is configured. The local part of the address is &`postmaster`& and the
32318 domain is the contents of &$qualify_domain$&.
32319
32320 .vitem &*use_sender*&
32321 This option applies to recipient callouts only. For example:
32322 .code
32323 require  verify = recipient/callout=use_sender
32324 .endd
32325 It causes the message's actual sender address to be used in the MAIL
32326 command when performing the callout, instead of an empty address. There is no
32327 need to use this option unless you know that the called hosts make use of the
32328 sender when checking recipients. If used indiscriminately, it reduces the
32329 usefulness of callout caching.
32330
32331 .vitem &*hold*&
32332 This option applies to recipient callouts only. For example:
32333 .code
32334 require  verify = recipient/callout=use_sender,hold
32335 .endd
32336 It causes the connection to be held open and used for any further recipients
32337 and for eventual delivery (should that be done quickly).
32338 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32339 when that is used for the connections.
32340 The advantage is only gained if there are no callout cache hits
32341 (which could be enforced by the no_cache option),
32342 if the use_sender option is used,
32343 if neither the random nor the use_postmaster option is used,
32344 and if no other callouts intervene.
32345 .endlist
32346
32347 If you use any of the parameters that set a non-empty sender for the MAIL
32348 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32349 &%use_sender%&), you should think about possible loops. Recipient checking is
32350 usually done between two hosts that are under the same management, and the host
32351 that receives the callouts is not normally configured to do callouts itself.
32352 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32353 these circumstances.
32354
32355 However, if you use a non-empty sender address for a callout to an arbitrary
32356 host, there is the likelihood that the remote host will itself initiate a
32357 callout check back to your host. As it is checking what appears to be a message
32358 sender, it is likely to use an empty address in MAIL, thus avoiding a
32359 callout loop. However, to be on the safe side it would be best to set up your
32360 own ACLs so that they do not do sender verification checks when the recipient
32361 is the address you use for header sender or postmaster callout checking.
32362
32363 Another issue to think about when using non-empty senders for callouts is
32364 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32365 by the sender/recipient combination; thus, for any given recipient, many more
32366 actual callouts are performed than when an empty sender or postmaster is used.
32367
32368
32369
32370
32371 .section "Callout caching" "SECTcallvercache"
32372 .cindex "hints database" "callout cache"
32373 .cindex "callout" "cache, description of"
32374 .cindex "caching" "callout"
32375 Exim caches the results of callouts in order to reduce the amount of resources
32376 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32377 option. A hints database called &"callout"& is used for the cache. Two
32378 different record types are used: one records the result of a callout check for
32379 a specific address, and the other records information that applies to the
32380 entire domain (for example, that it accepts the local part &'postmaster'&).
32381
32382 When an original callout fails, a detailed SMTP error message is given about
32383 the failure. However, for subsequent failures use the cache data, this message
32384 is not available.
32385
32386 The expiry times for negative and positive address cache records are
32387 independent, and can be set by the global options &%callout_negative_expire%&
32388 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32389
32390 If a host gives a negative response to an SMTP connection, or rejects any
32391 commands up to and including
32392 .code
32393 MAIL FROM:<>
32394 .endd
32395 (but not including the MAIL command with a non-empty address),
32396 any callout attempt is bound to fail. Exim remembers such failures in a
32397 domain cache record, which it uses to fail callouts for the domain without
32398 making new connections, until the domain record times out. There are two
32399 separate expiry times for domain cache records:
32400 &%callout_domain_negative_expire%& (default 3h) and
32401 &%callout_domain_positive_expire%& (default 7d).
32402
32403 Domain records expire when the negative expiry time is reached if callouts
32404 cannot be made for the domain, or if the postmaster check failed.
32405 Otherwise, they expire when the positive expiry time is reached. This
32406 ensures that, for example, a host that stops accepting &"random"& local parts
32407 will eventually be noticed.
32408
32409 The callout caching mechanism is based on the domain of the address that is
32410 being tested. If the domain routes to several hosts, it is assumed that their
32411 behaviour will be the same.
32412
32413
32414
32415 .section "Sender address verification reporting" "SECTsenaddver"
32416 .cindex "verifying" "suppressing error details"
32417 See section &<<SECTaddressverification>>& for a general discussion of
32418 verification. When sender verification fails in an ACL, the details of the
32419 failure are given as additional output lines before the 550 response to the
32420 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32421 you might see:
32422 .code
32423 MAIL FROM:<xyz@abc.example>
32424 250 OK
32425 RCPT TO:<pqr@def.example>
32426 550-Verification failed for <xyz@abc.example>
32427 550-Called:   192.168.34.43
32428 550-Sent:     RCPT TO:<xyz@abc.example>
32429 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32430 550 Sender verification failed
32431 .endd
32432 If more than one RCPT command fails in the same way, the details are given
32433 only for the first of them. However, some administrators do not want to send
32434 out this much information. You can suppress the details by adding
32435 &`/no_details`& to the ACL statement that requests sender verification. For
32436 example:
32437 .code
32438 verify = sender/no_details
32439 .endd
32440
32441 .section "Redirection while verifying" "SECTredirwhilveri"
32442 .cindex "verifying" "redirection while"
32443 .cindex "address redirection" "while verifying"
32444 A dilemma arises when a local address is redirected by aliasing or forwarding
32445 during verification: should the generated addresses themselves be verified,
32446 or should the successful expansion of the original address be enough to verify
32447 it? By default, Exim takes the following pragmatic approach:
32448
32449 .ilist
32450 When an incoming address is redirected to just one child address, verification
32451 continues with the child address, and if that fails to verify, the original
32452 verification also fails.
32453 .next
32454 When an incoming address is redirected to more than one child address,
32455 verification does not continue. A success result is returned.
32456 .endlist
32457
32458 This seems the most reasonable behaviour for the common use of aliasing as a
32459 way of redirecting different local parts to the same mailbox. It means, for
32460 example, that a pair of alias entries of the form
32461 .code
32462 A.Wol:   aw123
32463 aw123:   :fail: Gone away, no forwarding address
32464 .endd
32465 work as expected, with both local parts causing verification failure. When a
32466 redirection generates more than one address, the behaviour is more like a
32467 mailing list, where the existence of the alias itself is sufficient for
32468 verification to succeed.
32469
32470 It is possible, however, to change the default behaviour so that all successful
32471 redirections count as successful verifications, however many new addresses are
32472 generated. This is specified by the &%success_on_redirect%& verification
32473 option. For example:
32474 .code
32475 require verify = recipient/success_on_redirect/callout=10s
32476 .endd
32477 In this example, verification succeeds if a router generates a new address, and
32478 the callout does not occur, because no address was routed to a remote host.
32479
32480 When verification is being tested via the &%-bv%& option, the treatment of
32481 redirections is as just described, unless the &%-v%& or any debugging option is
32482 also specified. In that case, full verification is done for every generated
32483 address and a report is output for each of them.
32484
32485
32486
32487 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32488 .cindex "CSA" "verifying"
32489 Client SMTP Authorization is a system that allows a site to advertise
32490 which machines are and are not permitted to send email. This is done by placing
32491 special SRV records in the DNS; these are looked up using the client's HELO
32492 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32493 Authorization checks in Exim are performed by the ACL condition:
32494 .code
32495 verify = csa
32496 .endd
32497 This fails if the client is not authorized. If there is a DNS problem, or if no
32498 valid CSA SRV record is found, or if the client is authorized, the condition
32499 succeeds. These three cases can be distinguished using the expansion variable
32500 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32501 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32502 be likely to cause problems for legitimate email.
32503
32504 The error messages produced by the CSA code include slightly more
32505 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32506 looking up the CSA SRV record, or problems looking up the CSA target
32507 address record. There are four reasons for &$csa_status$& being &"fail"&:
32508
32509 .ilist
32510 The client's host name is explicitly not authorized.
32511 .next
32512 The client's IP address does not match any of the CSA target IP addresses.
32513 .next
32514 The client's host name is authorized but it has no valid target IP addresses
32515 (for example, the target's addresses are IPv6 and the client is using IPv4).
32516 .next
32517 The client's host name has no CSA SRV record but a parent domain has asserted
32518 that all subdomains must be explicitly authorized.
32519 .endlist
32520
32521 The &%csa%& verification condition can take an argument which is the domain to
32522 use for the DNS query. The default is:
32523 .code
32524 verify = csa/$sender_helo_name
32525 .endd
32526 This implementation includes an extension to CSA. If the query domain
32527 is an address literal such as [192.0.2.95], or if it is a bare IP
32528 address, Exim searches for CSA SRV records in the reverse DNS as if
32529 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32530 meaningful to say:
32531 .code
32532 verify = csa/$sender_host_address
32533 .endd
32534 In fact, this is the check that Exim performs if the client does not say HELO.
32535 This extension can be turned off by setting the main configuration option
32536 &%dns_csa_use_reverse%& to be false.
32537
32538 If a CSA SRV record is not found for the domain itself, a search
32539 is performed through its parent domains for a record which might be
32540 making assertions about subdomains. The maximum depth of this search is limited
32541 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32542 default. Exim does not look for CSA SRV records in a top level domain, so the
32543 default settings handle HELO domains as long as seven
32544 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32545 of legitimate HELO domains.
32546
32547 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32548 direct SRV lookups, this is not sufficient because of the extra parent domain
32549 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32550 addresses into lookups in the reverse DNS space. The result of a successful
32551 lookup such as:
32552 .code
32553 ${lookup dnsdb {csa=$sender_helo_name}}
32554 .endd
32555 has two space-separated fields: an authorization code and a target host name.
32556 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32557 authorization required but absent, or &"?"& for unknown.
32558
32559
32560
32561
32562 .section "Bounce address tag validation" "SECTverifyPRVS"
32563 .cindex "BATV, verifying"
32564 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32565 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32566 Genuine incoming bounce messages should therefore always be addressed to
32567 recipients that have a valid tag. This scheme is a way of detecting unwanted
32568 bounce messages caused by sender address forgeries (often called &"collateral
32569 spam"&), because the recipients of such messages do not include valid tags.
32570
32571 There are two expansion items to help with the implementation of the BATV
32572 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32573 the original envelope sender address by using a simple key to add a hash of the
32574 address and some time-based randomizing information. The &%prvs%& expansion
32575 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32576 The syntax of these expansion items is described in section
32577 &<<SECTexpansionitems>>&.
32578 The validity period on signed addresses is seven days.
32579
32580 As an example, suppose the secret per-address keys are stored in an MySQL
32581 database. A query to look up the key for an address could be defined as a macro
32582 like this:
32583 .code
32584 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32585                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32586                 }{$value}}
32587 .endd
32588 Suppose also that the senders who make use of BATV are defined by an address
32589 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32590 use this:
32591 .code
32592 # Bounces: drop unsigned addresses for BATV senders
32593 deny message = This address does not send an unsigned reverse path
32594      senders = :
32595      recipients = +batv_senders
32596
32597 # Bounces: In case of prvs-signed address, check signature.
32598 deny message = Invalid reverse path signature.
32599      senders = :
32600      condition  = ${prvscheck {$local_part@$domain}\
32601                   {PRVSCHECK_SQL}{1}}
32602      !condition = $prvscheck_result
32603 .endd
32604 The first statement rejects recipients for bounce messages that are addressed
32605 to plain BATV sender addresses, because it is known that BATV senders do not
32606 send out messages with plain sender addresses. The second statement rejects
32607 recipients that are prvs-signed, but with invalid signatures (either because
32608 the key is wrong, or the signature has timed out).
32609
32610 A non-prvs-signed address is not rejected by the second statement, because the
32611 &%prvscheck%& expansion yields an empty string if its first argument is not a
32612 prvs-signed address, thus causing the &%condition%& condition to be false. If
32613 the first argument is a syntactically valid prvs-signed address, the yield is
32614 the third string (in this case &"1"&), whether or not the cryptographic and
32615 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32616 of the checks (empty for failure, &"1"& for success).
32617
32618 There is one more issue you must consider when implementing prvs-signing:
32619 you have to ensure that the routers accept prvs-signed addresses and
32620 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32621 router to remove the signature with a configuration along these lines:
32622 .code
32623 batv_redirect:
32624   driver = redirect
32625   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32626 .endd
32627 This works because, if the third argument of &%prvscheck%& is empty, the result
32628 of the expansion of a prvs-signed address is the decoded value of the original
32629 address. This router should probably be the first of your routers that handles
32630 local addresses.
32631
32632 To create BATV-signed addresses in the first place, a transport of this form
32633 can be used:
32634 .code
32635 external_smtp_batv:
32636   driver = smtp
32637   return_path = ${prvs {$return_path} \
32638                        {${lookup mysql{SELECT \
32639                        secret FROM batv_prvs WHERE \
32640                        sender='${quote_mysql:$sender_address}'} \
32641                        {$value}fail}}}
32642 .endd
32643 If no key can be found for the existing return path, no signing takes place.
32644
32645
32646
32647 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32648 .cindex "&ACL;" "relay control"
32649 .cindex "relaying" "control by ACL"
32650 .cindex "policy control" "relay control"
32651 An MTA is said to &'relay'& a message if it receives it from some host and
32652 delivers it directly to another host as a result of a remote address contained
32653 within it. Redirecting a local address via an alias or forward file and then
32654 passing the message on to another host is not relaying,
32655 .cindex "&""percent hack""&"
32656 but a redirection as a result of the &"percent hack"& is.
32657
32658 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32659 A host which is acting as a gateway or an MX backup is concerned with incoming
32660 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32661 a host which is acting as a smart host for a number of clients is concerned
32662 with outgoing relaying from those clients to the Internet at large. Often the
32663 same host is fulfilling both functions,
32664 . ///
32665 . as illustrated in the diagram below,
32666 . ///
32667 but in principle these two kinds of relaying are entirely independent. What is
32668 not wanted is the transmission of mail from arbitrary remote hosts through your
32669 system to arbitrary domains.
32670
32671
32672 You can implement relay control by means of suitable statements in the ACL that
32673 runs for each RCPT command. For convenience, it is often easiest to use
32674 Exim's named list facility to define the domains and hosts involved. For
32675 example, suppose you want to do the following:
32676
32677 .ilist
32678 Deliver a number of domains to mailboxes on the local host (or process them
32679 locally in some other way). Let's say these are &'my.dom1.example'& and
32680 &'my.dom2.example'&.
32681 .next
32682 Relay mail for a number of other domains for which you are the secondary MX.
32683 These might be &'friend1.example'& and &'friend2.example'&.
32684 .next
32685 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32686 Suppose your LAN is 192.168.45.0/24.
32687 .endlist
32688
32689
32690 In the main part of the configuration, you put the following definitions:
32691 .code
32692 domainlist local_domains    = my.dom1.example : my.dom2.example
32693 domainlist relay_to_domains = friend1.example : friend2.example
32694 hostlist   relay_from_hosts = 192.168.45.0/24
32695 .endd
32696 Now you can use these definitions in the ACL that is run for every RCPT
32697 command:
32698 .code
32699 acl_check_rcpt:
32700   accept domains = +local_domains : +relay_to_domains
32701   accept hosts   = +relay_from_hosts
32702 .endd
32703 The first statement accepts any RCPT command that contains an address in
32704 the local or relay domains. For any other domain, control passes to the second
32705 statement, which accepts the command only if it comes from one of the relay
32706 hosts. In practice, you will probably want to make your ACL more sophisticated
32707 than this, for example, by including sender and recipient verification. The
32708 default configuration includes a more comprehensive example, which is described
32709 in chapter &<<CHAPdefconfil>>&.
32710
32711
32712
32713 .section "Checking a relay configuration" "SECTcheralcon"
32714 .cindex "relaying" "checking control of"
32715 You can check the relay characteristics of your configuration in the same way
32716 that you can test any ACL behaviour for an incoming SMTP connection, by using
32717 the &%-bh%& option to run a fake SMTP session with which you interact.
32718 .ecindex IIDacl
32719
32720
32721
32722 . ////////////////////////////////////////////////////////////////////////////
32723 . ////////////////////////////////////////////////////////////////////////////
32724
32725 .chapter "Content scanning at ACL time" "CHAPexiscan"
32726 .scindex IIDcosca "content scanning" "at ACL time"
32727 The extension of Exim to include content scanning at ACL time, formerly known
32728 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32729 was integrated into the main source for Exim release 4.50, and Tom continues to
32730 maintain it. Most of the wording of this chapter is taken from Tom's
32731 specification.
32732
32733 It is also possible to scan the content of messages at other times. The
32734 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32735 scanning after all the ACLs have run. A transport filter can be used to scan
32736 messages at delivery time (see the &%transport_filter%& option, described in
32737 chapter &<<CHAPtransportgeneric>>&).
32738
32739 If you want to include the ACL-time content-scanning features when you compile
32740 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32741 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32742
32743 .ilist
32744 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32745 for all MIME parts for SMTP and non-SMTP messages, respectively.
32746 .next
32747 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32748 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32749 run at the end of message reception (the &%acl_smtp_data%& ACL).
32750 .next
32751 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32752 of messages, or parts of messages, for debugging purposes.
32753 .next
32754 Additional expansion variables that are set in the new ACL and by the new
32755 conditions.
32756 .next
32757 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32758 .endlist
32759
32760 Content-scanning is continually evolving, and new features are still being
32761 added. While such features are still unstable and liable to incompatible
32762 changes, they are made available in Exim by setting options whose names begin
32763 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32764 this manual. You can find out about them by reading the file called
32765 &_doc/experimental.txt_&.
32766
32767 All the content-scanning facilities work on a MBOX copy of the message that is
32768 temporarily created in a file called:
32769 .display
32770 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32771 .endd
32772 The &_.eml_& extension is a friendly hint to virus scanners that they can
32773 expect an MBOX-like structure inside that file. The file is created when the
32774 first content scanning facility is called. Subsequent calls to content
32775 scanning conditions open the same file again. The directory is recursively
32776 removed when the &%acl_smtp_data%& ACL has finished running, unless
32777 .code
32778 control = no_mbox_unspool
32779 .endd
32780 has been encountered. When the MIME ACL decodes files, they are put into the
32781 same directory by default.
32782
32783
32784
32785 .section "Scanning for viruses" "SECTscanvirus"
32786 .cindex "virus scanning"
32787 .cindex "content scanning" "for viruses"
32788 .cindex "content scanning" "the &%malware%& condition"
32789 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32790 It supports a &"generic"& interface to scanners called via the shell, and
32791 specialized interfaces for &"daemon"& type virus scanners, which are resident
32792 in memory and thus are much faster.
32793
32794 .new
32795 Since message data needs to have arrived,
32796 the condition may be only called in ACL defined by
32797 &%acl_smtp_data%&,
32798 &%acl_smtp_data_prdr%&,
32799 &%acl_smtp_mime%& or
32800 &%acl_smtp_dkim%&
32801 .wen
32802
32803 A timeout of 2 minutes is applied to a scanner call (by default);
32804 if it expires then a defer action is taken.
32805
32806 .oindex "&%av_scanner%&"
32807 You can set the &%av_scanner%& option in the main part of the configuration
32808 to specify which scanner to use, together with any additional options that
32809 are needed. The basic syntax is as follows:
32810 .display
32811 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32812 .endd
32813 If you do not set &%av_scanner%&, it defaults to
32814 .code
32815 av_scanner = sophie:/var/run/sophie
32816 .endd
32817 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32818 before use.
32819 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32820 The following scanner types are supported in this release,
32821 though individual ones can be included or not at build time:
32822
32823 .vlist
32824 .vitem &%avast%&
32825 .cindex "virus scanners" "avast"
32826 This is the scanner daemon of Avast. It has been tested with Avast Core
32827 Security (currently at version 2.2.0).
32828 You can get a trial version at &url(https://www.avast.com) or for Linux
32829 at &url(https://www.avast.com/linux-server-antivirus).
32830 This scanner type takes one option,
32831 which can be either a full path to a UNIX socket,
32832 or host and port specifiers separated by white space.
32833 The host may be a name or an IP address; the port is either a
32834 single number or a pair of numbers with a dash between.
32835 A list of options may follow. These options are interpreted on the
32836 Exim's side of the malware scanner, or are given on separate lines to
32837 the daemon as options before the main scan command.
32838
32839 .cindex &`pass_unscanned`& "avast"
32840 If &`pass_unscanned`&
32841 is set, any files the Avast scanner can't scan (e.g.
32842 decompression bombs, or invalid archives) are considered clean. Use with
32843 care.
32844
32845 For example:
32846 .code
32847 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32848 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32849 av_scanner = avast:192.168.2.22 5036
32850 .endd
32851 If you omit the argument, the default path
32852 &_/var/run/avast/scan.sock_&
32853 is used.
32854 If you use a remote host,
32855 you need to make Exim's spool directory available to it,
32856 as the scanner is passed a file path, not file contents.
32857 For information about available commands and their options you may use
32858 .code
32859 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32860     FLAGS
32861     SENSITIVITY
32862     PACK
32863 .endd
32864
32865 If the scanner returns a temporary failure (e.g. license issues, or
32866 permission problems), the message is deferred and a paniclog entry is
32867 written.  The usual &`defer_ok`& option is available.
32868
32869 .vitem &%aveserver%&
32870 .cindex "virus scanners" "Kaspersky"
32871 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32872 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32873 which is the path to the daemon's UNIX socket. The default is shown in this
32874 example:
32875 .code
32876 av_scanner = aveserver:/var/run/aveserver
32877 .endd
32878
32879
32880 .vitem &%clamd%&
32881 .cindex "virus scanners" "clamd"
32882 This daemon-type scanner is GPL and free. You can get it at
32883 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32884 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32885 in the MIME ACL. This is no longer believed to be necessary.
32886
32887 The options are a list of server specifiers, which may be
32888 a UNIX socket specification,
32889 a TCP socket specification,
32890 or a (global) option.
32891
32892 A socket specification consists of a space-separated list.
32893 For a Unix socket the first element is a full path for the socket,
32894 for a TCP socket the first element is the IP address
32895 and the second a port number,
32896 Any further elements are per-server (non-global) options.
32897 These per-server options are supported:
32898 .code
32899 retry=<timespec>        Retry on connect fail
32900 .endd
32901
32902 The &`retry`& option specifies a time after which a single retry for
32903 a failed connect is made.  The default is to not retry.
32904
32905 If a Unix socket file is specified, only one server is supported.
32906
32907 Examples:
32908 .code
32909 av_scanner = clamd:/opt/clamd/socket
32910 av_scanner = clamd:192.0.2.3 1234
32911 av_scanner = clamd:192.0.2.3 1234:local
32912 av_scanner = clamd:192.0.2.3 1234 retry=10s
32913 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32914 .endd
32915 If the value of av_scanner points to a UNIX socket file or contains the
32916 &`local`&
32917 option, then the ClamAV interface will pass a filename containing the data
32918 to be scanned, which should normally result in less I/O happening and be
32919 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32920 Exim does not assume that there is a common filesystem with the remote host.
32921
32922 The final example shows that multiple TCP targets can be specified.  Exim will
32923 randomly use one for each incoming email (i.e. it load balances them).  Note
32924 that only TCP targets may be used if specifying a list of scanners; a UNIX
32925 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32926 unavailable, Exim will try the remaining one(s) until it finds one that works.
32927 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32928 not keep track of scanner state between multiple messages, and the scanner
32929 selection is random, so the message will get logged in the mainlog for each
32930 email that the down scanner gets chosen first (message wrapped to be readable):
32931 .code
32932 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32933    clamd: connection to localhost, port 3310 failed
32934    (Connection refused)
32935 .endd
32936
32937 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32938 contributing the code for this scanner.
32939
32940 .vitem &%cmdline%&
32941 .cindex "virus scanners" "command line interface"
32942 This is the keyword for the generic command line scanner interface. It can be
32943 used to attach virus scanners that are invoked from the shell. This scanner
32944 type takes 3 mandatory options:
32945
32946 .olist
32947 The full path and name of the scanner binary, with all command line options,
32948 and a placeholder (&`%s`&) for the directory to scan.
32949
32950 .next
32951 A regular expression to match against the STDOUT and STDERR output of the
32952 virus scanner. If the expression matches, a virus was found. You must make
32953 absolutely sure that this expression matches on &"virus found"&. This is called
32954 the &"trigger"& expression.
32955
32956 .next
32957 Another regular expression, containing exactly one pair of parentheses, to
32958 match the name of the virus found in the scanners output. This is called the
32959 &"name"& expression.
32960 .endlist olist
32961
32962 For example, Sophos Sweep reports a virus on a line like this:
32963 .code
32964 Virus 'W32/Magistr-B' found in file ./those.bat
32965 .endd
32966 For the trigger expression, we can match the phrase &"found in file"&. For the
32967 name expression, we want to extract the W32/Magistr-B string, so we can match
32968 for the single quotes left and right of it. Altogether, this makes the
32969 configuration setting:
32970 .code
32971 av_scanner = cmdline:\
32972              /path/to/sweep -ss -all -rec -archive %s:\
32973              found in file:'(.+)'
32974 .endd
32975 .vitem &%drweb%&
32976 .cindex "virus scanners" "DrWeb"
32977 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32978 takes one option,
32979 either a full path to a UNIX socket,
32980 or host and port specifiers separated by white space.
32981 The host may be a name or an IP address; the port is either a
32982 single number or a pair of numbers with a dash between.
32983 For example:
32984 .code
32985 av_scanner = drweb:/var/run/drwebd.sock
32986 av_scanner = drweb:192.168.2.20 31337
32987 .endd
32988 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32989 is used. Thanks to Alex Miller for contributing the code for this scanner.
32990
32991 .vitem &%f-protd%&
32992 .cindex "virus scanners" "f-protd"
32993 The f-protd scanner is accessed via HTTP over TCP.
32994 One argument is taken, being a space-separated hostname and port number
32995 (or port-range).
32996 For example:
32997 .code
32998 av_scanner = f-protd:localhost 10200-10204
32999 .endd
33000 If you omit the argument, the default values shown above are used.
33001
33002 .vitem &%f-prot6d%&
33003 .cindex "virus scanners" "f-prot6d"
33004 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33005 One argument is taken, being a space-separated hostname and port number.
33006 For example:
33007 .code
33008 av_scanner = f-prot6d:localhost 10200
33009 .endd
33010 If you omit the argument, the default values show above are used.
33011
33012 .vitem &%fsecure%&
33013 .cindex "virus scanners" "F-Secure"
33014 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33015 argument which is the path to a UNIX socket. For example:
33016 .code
33017 av_scanner = fsecure:/path/to/.fsav
33018 .endd
33019 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33020 Thelmen for contributing the code for this scanner.
33021
33022 .vitem &%kavdaemon%&
33023 .cindex "virus scanners" "Kaspersky"
33024 This is the scanner daemon of Kaspersky Version 4. This version of the
33025 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33026 scanner type takes one option, which is the path to the daemon's UNIX socket.
33027 For example:
33028 .code
33029 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33030 .endd
33031 The default path is &_/var/run/AvpCtl_&.
33032
33033 .vitem &%mksd%&
33034 .cindex "virus scanners" "mksd"
33035 This was a daemon type scanner that is aimed mainly at Polish users,
33036 though some documentation was available in English.
33037 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33038 and this appears to be a candidate for removal from Exim, unless
33039 we are informed of other virus scanners which use the same protocol
33040 to integrate.
33041 The only option for this scanner type is
33042 the maximum number of processes used simultaneously to scan the attachments,
33043 provided that mksd has
33044 been run with at least the same number of child processes. For example:
33045 .code
33046 av_scanner = mksd:2
33047 .endd
33048 You can safely omit this option (the default value is 1).
33049
33050 .vitem &%sock%&
33051 .cindex "virus scanners" "simple socket-connected"
33052 This is a general-purpose way of talking to simple scanner daemons
33053 running on the local machine.
33054 There are four options:
33055 an address (which may be an IP address and port, or the path of a Unix socket),
33056 a commandline to send (may include a single %s which will be replaced with
33057 the path to the mail file to be scanned),
33058 an RE to trigger on from the returned data,
33059 and an RE to extract malware_name from the returned data.
33060 For example:
33061 .code
33062 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33063 .endd
33064 Note that surrounding whitespace is stripped from each option, meaning
33065 there is no way to specify a trailing newline.
33066 The socket specifier and both regular-expressions are required.
33067 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33068 specify an empty element to get this.
33069
33070 .vitem &%sophie%&
33071 .cindex "virus scanners" "Sophos and Sophie"
33072 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33073 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33074 for this scanner type is the path to the UNIX socket that Sophie uses for
33075 client communication. For example:
33076 .code
33077 av_scanner = sophie:/tmp/sophie
33078 .endd
33079 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33080 the option.
33081 .endlist
33082
33083 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33084 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33085 ACL.
33086
33087 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33088 makes it possible to use different scanners. See further below for an example.
33089 The &%malware%& condition caches its results, so when you use it multiple times
33090 for the same message, the actual scanning process is only carried out once.
33091 However, using expandable items in &%av_scanner%& disables this caching, in
33092 which case each use of the &%malware%& condition causes a new scan of the
33093 message.
33094
33095 The &%malware%& condition takes a right-hand argument that is expanded before
33096 use and taken as a list, slash-separated by default.
33097 The first element can then be one of
33098
33099 .ilist
33100 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33101 The condition succeeds if a virus was found, and fail otherwise. This is the
33102 recommended usage.
33103 .next
33104 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33105 the condition fails immediately.
33106 .next
33107 A regular expression, in which case the message is scanned for viruses. The
33108 condition succeeds if a virus is found and its name matches the regular
33109 expression. This allows you to take special actions on certain types of virus.
33110 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33111 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33112 .endlist
33113
33114 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33115 messages even if there is a problem with the virus scanner.
33116 Otherwise, such a problem causes the ACL to defer.
33117
33118 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33119 specify a non-default timeout.  The default is two minutes.
33120 For example:
33121 .code
33122 malware = * / defer_ok / tmo=10s
33123 .endd
33124 A timeout causes the ACL to defer.
33125
33126 .vindex "&$callout_address$&"
33127 When a connection is made to the scanner the expansion variable &$callout_address$&
33128 is set to record the actual address used.
33129
33130 .vindex "&$malware_name$&"
33131 When a virus is found, the condition sets up an expansion variable called
33132 &$malware_name$& that contains the name of the virus. You can use it in a
33133 &%message%& modifier that specifies the error returned to the sender, and/or in
33134 logging data.
33135
33136 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33137 imposed by your anti-virus scanner.
33138
33139 Here is a very simple scanning example:
33140 .code
33141 deny message = This message contains malware ($malware_name)
33142      malware = *
33143 .endd
33144 The next example accepts messages when there is a problem with the scanner:
33145 .code
33146 deny message = This message contains malware ($malware_name)
33147      malware = */defer_ok
33148 .endd
33149 The next example shows how to use an ACL variable to scan with both sophie and
33150 aveserver. It assumes you have set:
33151 .code
33152 av_scanner = $acl_m0
33153 .endd
33154 in the main Exim configuration.
33155 .code
33156 deny message = This message contains malware ($malware_name)
33157      set acl_m0 = sophie
33158      malware = *
33159
33160 deny message = This message contains malware ($malware_name)
33161      set acl_m0 = aveserver
33162      malware = *
33163 .endd
33164
33165
33166 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33167 .cindex "content scanning" "for spam"
33168 .cindex "spam scanning"
33169 .cindex "SpamAssassin"
33170 .cindex "Rspamd"
33171 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33172 score and a report for the message.
33173 Support is also provided for Rspamd.
33174
33175 For more information about installation and configuration of SpamAssassin or
33176 Rspamd refer to their respective websites at
33177 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33178
33179 SpamAssassin can be installed with CPAN by running:
33180 .code
33181 perl -MCPAN -e 'install Mail::SpamAssassin'
33182 .endd
33183 SpamAssassin has its own set of configuration files. Please review its
33184 documentation to see how you can tweak it. The default installation should work
33185 nicely, however.
33186
33187 .oindex "&%spamd_address%&"
33188 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33189 intend to use an instance running on the local host you do not need to set
33190 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33191 you must set the &%spamd_address%& option in the global part of the Exim
33192 configuration as follows (example):
33193 .code
33194 spamd_address = 192.168.99.45 783
33195 .endd
33196 The SpamAssassin protocol relies on a TCP half-close from the client.
33197 If your SpamAssassin client side is running a Linux system with an
33198 iptables firewall, consider setting
33199 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33200 timeout, Exim uses when waiting for a response from the SpamAssassin
33201 server (currently defaulting to 120s).  With a lower value the Linux
33202 connection tracking may consider your half-closed connection as dead too
33203 soon.
33204
33205
33206 To use Rspamd (which by default listens on all local addresses
33207 on TCP port 11333)
33208 you should add &%variant=rspamd%& after the address/port pair, for example:
33209 .code
33210 spamd_address = 127.0.0.1 11333 variant=rspamd
33211 .endd
33212
33213 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33214 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33215 filename instead of an address/port pair:
33216 .code
33217 spamd_address = /var/run/spamd_socket
33218 .endd
33219 You can have multiple &%spamd%& servers to improve scalability. These can
33220 reside on other hardware reachable over the network. To specify multiple
33221 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33222 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33223 .code
33224 spamd_address = 192.168.2.10 783 : \
33225                 192.168.2.11 783 : \
33226                 192.168.2.12 783
33227 .endd
33228 Up to 32 &%spamd%& servers are supported.
33229 When a server fails to respond to the connection attempt, all other
33230 servers are tried until one succeeds. If no server responds, the &%spam%&
33231 condition defers.
33232
33233 Unix and TCP socket specifications may be mixed in any order.
33234 Each element of the list is a list itself, space-separated by default
33235 and changeable in the usual way (&<<SECTlistsepchange>>&);
33236 take care to not double the separator.
33237
33238 For TCP socket specifications a host name or IP (v4 or v6, but
33239 subject to list-separator quoting rules) address can be used,
33240 and the port can be one or a dash-separated pair.
33241 In the latter case, the range is tried in strict order.
33242
33243 Elements after the first for Unix sockets, or second for TCP socket,
33244 are options.
33245 The supported options are:
33246 .code
33247 pri=<priority>      Selection priority
33248 weight=<value>      Selection bias
33249 time=<start>-<end>  Use only between these times of day
33250 retry=<timespec>    Retry on connect fail
33251 tmo=<timespec>      Connection time limit
33252 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33253 .endd
33254
33255 The &`pri`& option specifies a priority for the server within the list,
33256 higher values being tried first.
33257 The default priority is 1.
33258
33259 The &`weight`& option specifies a selection bias.
33260 Within a priority set
33261 servers are queried in a random fashion, weighted by this value.
33262 The default value for selection bias is 1.
33263
33264 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33265 in the local time zone; each element being one or more digits.
33266 Either the seconds or both minutes and seconds, plus the leading &`.`&
33267 characters, may be omitted and will be taken as zero.
33268
33269 Timeout specifications for the &`retry`& and &`tmo`& options
33270 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33271
33272 The &`tmo`& option specifies an overall timeout for communication.
33273 The default value is two minutes.
33274
33275 The &`retry`& option specifies a time after which a single retry for
33276 a failed connect is made.
33277 The default is to not retry.
33278
33279 The &%spamd_address%& variable is expanded before use if it starts with
33280 a dollar sign. In this case, the expansion may return a string that is
33281 used as the list so that multiple spamd servers can be the result of an
33282 expansion.
33283
33284 .vindex "&$callout_address$&"
33285 When a connection is made to the server the expansion variable &$callout_address$&
33286 is set to record the actual address used.
33287
33288 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33289 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33290 .code
33291 deny message = This message was classified as SPAM
33292      spam = joe
33293 .endd
33294 The right-hand side of the &%spam%& condition specifies a name. This is
33295 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33296 to scan using a specific profile, but rather use the SpamAssassin system-wide
33297 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33298 Rspamd does not use this setting. However, you must put something on the
33299 right-hand side.
33300
33301 The name allows you to use per-domain or per-user antispam profiles in
33302 principle, but this is not straightforward in practice, because a message may
33303 have multiple recipients, not necessarily all in the same domain. Because the
33304 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33305 read the contents of the message, the variables &$local_part$& and &$domain$&
33306 are not set.
33307 Careful enforcement of single-recipient messages
33308 (e.g. by responding with defer in the recipient ACL for all recipients
33309 after the first),
33310 or the use of PRDR,
33311 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33312 are needed to use this feature.
33313
33314 The right-hand side of the &%spam%& condition is expanded before being used, so
33315 you can put lookups or conditions there. When the right-hand side evaluates to
33316 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33317
33318
33319 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33320 large ones may cause significant performance degradation. As most spam messages
33321 are quite small, it is recommended that you do not scan the big ones. For
33322 example:
33323 .code
33324 deny message = This message was classified as SPAM
33325      condition = ${if < {$message_size}{10K}}
33326      spam = nobody
33327 .endd
33328
33329 The &%spam%& condition returns true if the threshold specified in the user's
33330 SpamAssassin profile has been matched or exceeded. If you want to use the
33331 &%spam%& condition for its side effects (see the variables below), you can make
33332 it always return &"true"& by appending &`:true`& to the username.
33333
33334 .cindex "spam scanning" "returned variables"
33335 When the &%spam%& condition is run, it sets up a number of expansion
33336 variables.
33337 Except for &$spam_report$&,
33338 these variables are saved with the received message so are
33339 available for use at delivery time.
33340
33341 .vlist
33342 .vitem &$spam_score$&
33343 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33344 for inclusion in log or reject messages.
33345
33346 .vitem &$spam_score_int$&
33347 The spam score of the message, multiplied by ten, as an integer value. For
33348 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33349 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33350 The integer value is useful for numeric comparisons in conditions.
33351
33352 .vitem &$spam_bar$&
33353 A string consisting of a number of &"+"& or &"-"& characters, representing the
33354 integer part of the spam score value. A spam score of 4.4 would have a
33355 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33356 headers, since MUAs can match on such strings. The maximum length of the
33357 spam bar is 50 characters.
33358
33359 .vitem &$spam_report$&
33360 A multiline text table, containing the full SpamAssassin report for the
33361 message. Useful for inclusion in headers or reject messages.
33362 This variable is only usable in a DATA-time ACL.
33363 Beware that SpamAssassin may return non-ASCII characters, especially
33364 when running in country-specific locales, which are not legal
33365 unencoded in headers.
33366
33367 .vitem &$spam_action$&
33368 For SpamAssassin either 'reject' or 'no action' depending on the
33369 spam score versus threshold.
33370 For Rspamd, the recommended action.
33371
33372 .endlist
33373
33374 The &%spam%& condition caches its results unless expansion in
33375 spamd_address was used. If you call it again with the same user name, it
33376 does not scan again, but rather returns the same values as before.
33377
33378 The &%spam%& condition returns DEFER if there is any error while running
33379 the message through SpamAssassin or if the expansion of spamd_address
33380 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33381 statement block), append &`/defer_ok`& to the right-hand side of the
33382 spam condition, like this:
33383 .code
33384 deny message = This message was classified as SPAM
33385      spam    = joe/defer_ok
33386 .endd
33387 This causes messages to be accepted even if there is a problem with &%spamd%&.
33388
33389 Here is a longer, commented example of the use of the &%spam%&
33390 condition:
33391 .code
33392 # put headers in all messages (no matter if spam or not)
33393 warn  spam = nobody:true
33394       add_header = X-Spam-Score: $spam_score ($spam_bar)
33395       add_header = X-Spam-Report: $spam_report
33396
33397 # add second subject line with *SPAM* marker when message
33398 # is over threshold
33399 warn  spam = nobody
33400       add_header = Subject: *SPAM* $h_Subject:
33401
33402 # reject spam at high scores (> 12)
33403 deny  message = This message scored $spam_score spam points.
33404       spam = nobody:true
33405       condition = ${if >{$spam_score_int}{120}{1}{0}}
33406 .endd
33407
33408
33409
33410 .section "Scanning MIME parts" "SECTscanmimepart"
33411 .cindex "content scanning" "MIME parts"
33412 .cindex "MIME content scanning"
33413 .oindex "&%acl_smtp_mime%&"
33414 .oindex "&%acl_not_smtp_mime%&"
33415 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33416 each MIME part of an SMTP message, including multipart types, in the sequence
33417 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33418 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33419 options may both refer to the same ACL if you want the same processing in both
33420 cases.
33421
33422 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33423 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33424 the case of a non-SMTP message. However, a MIME ACL is called only if the
33425 message contains a &'Content-Type:'& header line. When a call to a MIME
33426 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33427 result code is sent to the client. In the case of an SMTP message, the
33428 &%acl_smtp_data%& ACL is not called when this happens.
33429
33430 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33431 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33432 condition to match against the raw MIME part. You can also use the
33433 &%mime_regex%& condition to match against the decoded MIME part (see section
33434 &<<SECTscanregex>>&).
33435
33436 At the start of a MIME ACL, a number of variables are set from the header
33437 information for the relevant MIME part. These are described below. The contents
33438 of the MIME part are not by default decoded into a disk file except for MIME
33439 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33440 part into a disk file, you can use the &%decode%& condition. The general
33441 syntax is:
33442 .display
33443 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33444 .endd
33445 The right hand side is expanded before use. After expansion,
33446 the value can be:
33447
33448 .olist
33449 &"0"& or &"false"&, in which case no decoding is done.
33450 .next
33451 The string &"default"&. In that case, the file is put in the temporary
33452 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33453 a sequential filename consisting of the message id and a sequence number. The
33454 full path and name is available in &$mime_decoded_filename$& after decoding.
33455 .next
33456 A full path name starting with a slash. If the full name is an existing
33457 directory, it is used as a replacement for the default directory. The filename
33458 is then sequentially assigned. If the path does not exist, it is used as
33459 the full path and filename.
33460 .next
33461 If the string does not start with a slash, it is used as the
33462 filename, and the default path is then used.
33463 .endlist
33464 The &%decode%& condition normally succeeds. It is only false for syntax
33465 errors or unusual circumstances such as memory shortages. You can easily decode
33466 a file with its original, proposed filename using
33467 .code
33468 decode = $mime_filename
33469 .endd
33470 However, you should keep in mind that &$mime_filename$& might contain
33471 anything. If you place files outside of the default path, they are not
33472 automatically unlinked.
33473
33474 For RFC822 attachments (these are messages attached to messages, with a
33475 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33476 as for the primary message, only that the &$mime_is_rfc822$& expansion
33477 variable is set (see below). Attached messages are always decoded to disk
33478 before being checked, and the files are unlinked once the check is done.
33479
33480 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33481 used to match regular expressions against raw and decoded MIME parts,
33482 respectively. They are described in section &<<SECTscanregex>>&.
33483
33484 .cindex "MIME content scanning" "returned variables"
33485 The following list describes all expansion variables that are
33486 available in the MIME ACL:
33487
33488 .vlist
33489 .vitem &$mime_boundary$&
33490 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33491 have a boundary string, which is stored in this variable. If the current part
33492 has no boundary parameter in the &'Content-Type:'& header, this variable
33493 contains the empty string.
33494
33495 .vitem &$mime_charset$&
33496 This variable contains the character set identifier, if one was found in the
33497 &'Content-Type:'& header. Examples for charset identifiers are:
33498 .code
33499 us-ascii
33500 gb2312 (Chinese)
33501 iso-8859-1
33502 .endd
33503 Please note that this value is not normalized, so you should do matches
33504 case-insensitively.
33505
33506 .vitem &$mime_content_description$&
33507 This variable contains the normalized content of the &'Content-Description:'&
33508 header. It can contain a human-readable description of the parts content. Some
33509 implementations repeat the filename for attachments here, but they are usually
33510 only used for display purposes.
33511
33512 .vitem &$mime_content_disposition$&
33513 This variable contains the normalized content of the &'Content-Disposition:'&
33514 header. You can expect strings like &"attachment"& or &"inline"& here.
33515
33516 .vitem &$mime_content_id$&
33517 This variable contains the normalized content of the &'Content-ID:'& header.
33518 This is a unique ID that can be used to reference a part from another part.
33519
33520 .vitem &$mime_content_size$&
33521 This variable is set only after the &%decode%& modifier (see above) has been
33522 successfully run. It contains the size of the decoded part in kilobytes. The
33523 size is always rounded up to full kilobytes, so only a completely empty part
33524 has a &$mime_content_size$& of zero.
33525
33526 .vitem &$mime_content_transfer_encoding$&
33527 This variable contains the normalized content of the
33528 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33529 type. Typical values are &"base64"& and &"quoted-printable"&.
33530
33531 .vitem &$mime_content_type$&
33532 If the MIME part has a &'Content-Type:'& header, this variable contains its
33533 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33534 are some examples of popular MIME types, as they may appear in this variable:
33535 .code
33536 text/plain
33537 text/html
33538 application/octet-stream
33539 image/jpeg
33540 audio/midi
33541 .endd
33542 If the MIME part has no &'Content-Type:'& header, this variable contains the
33543 empty string.
33544
33545 .vitem &$mime_decoded_filename$&
33546 This variable is set only after the &%decode%& modifier (see above) has been
33547 successfully run. It contains the full path and filename of the file
33548 containing the decoded data.
33549 .endlist
33550
33551 .cindex "RFC 2047"
33552 .vlist
33553 .vitem &$mime_filename$&
33554 This is perhaps the most important of the MIME variables. It contains a
33555 proposed filename for an attachment, if one was found in either the
33556 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33557 RFC2047
33558 or RFC2231
33559 decoded, but no additional sanity checks are done.
33560  If no filename was
33561 found, this variable contains the empty string.
33562
33563 .vitem &$mime_is_coverletter$&
33564 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33565 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33566 content in the cover letter, while not restricting attachments at all.
33567
33568 The variable contains 1 (true) for a MIME part believed to be part of the
33569 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33570 follows:
33571
33572 .olist
33573 The outermost MIME part of a message is always a cover letter.
33574
33575 .next
33576 If a multipart/alternative or multipart/related MIME part is a cover letter,
33577 so are all MIME subparts within that multipart.
33578
33579 .next
33580 If any other multipart is a cover letter, the first subpart is a cover letter,
33581 and the rest are attachments.
33582
33583 .next
33584 All parts contained within an attachment multipart are attachments.
33585 .endlist olist
33586
33587 As an example, the following will ban &"HTML mail"& (including that sent with
33588 alternative plain text), while allowing HTML files to be attached. HTML
33589 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33590 .code
33591 deny message = HTML mail is not accepted here
33592 !condition = $mime_is_rfc822
33593 condition = $mime_is_coverletter
33594 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33595 .endd
33596 .vitem &$mime_is_multipart$&
33597 This variable has the value 1 (true) when the current part has the main type
33598 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33599 Since multipart entities only serve as containers for other parts, you may not
33600 want to carry out specific actions on them.
33601
33602 .vitem &$mime_is_rfc822$&
33603 This variable has the value 1 (true) if the current part is not a part of the
33604 checked message itself, but part of an attached message. Attached message
33605 decoding is fully recursive.
33606
33607 .vitem &$mime_part_count$&
33608 This variable is a counter that is raised for each processed MIME part. It
33609 starts at zero for the very first part (which is usually a multipart). The
33610 counter is per-message, so it is reset when processing RFC822 attachments (see
33611 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33612 complete, so you can use it in the DATA ACL to determine the number of MIME
33613 parts of a message. For non-MIME messages, this variable contains the value -1.
33614 .endlist
33615
33616
33617
33618 .section "Scanning with regular expressions" "SECTscanregex"
33619 .cindex "content scanning" "with regular expressions"
33620 .cindex "regular expressions" "content scanning with"
33621 You can specify your own custom regular expression matches on the full body of
33622 the message, or on individual MIME parts.
33623
33624 The &%regex%& condition takes one or more regular expressions as arguments and
33625 matches them against the full message (when called in the DATA ACL) or a raw
33626 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33627 linewise, with a maximum line length of 32K characters. That means you cannot
33628 have multiline matches with the &%regex%& condition.
33629
33630 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33631 to 32K of decoded content (the whole content at once, not linewise). If the
33632 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33633 is decoded automatically when &%mime_regex%& is executed (using default path
33634 and filename values). If the decoded data is larger than  32K, only the first
33635 32K characters are checked.
33636
33637 The regular expressions are passed as a colon-separated list. To include a
33638 literal colon, you must double it. Since the whole right-hand side string is
33639 expanded before being used, you must also escape dollar signs and backslashes
33640 with more backslashes, or use the &`\N`& facility to disable expansion.
33641 Here is a simple example that contains two regular expressions:
33642 .code
33643 deny message = contains blacklisted regex ($regex_match_string)
33644      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33645 .endd
33646 The conditions returns true if any one of the regular expressions matches. The
33647 &$regex_match_string$& expansion variable is then set up and contains the
33648 matching regular expression.
33649 The expansion variables &$regex1$& &$regex2$& etc
33650 are set to any substrings captured by the regular expression.
33651
33652 &*Warning*&: With large messages, these conditions can be fairly
33653 CPU-intensive.
33654
33655 .ecindex IIDcosca
33656
33657
33658
33659
33660 . ////////////////////////////////////////////////////////////////////////////
33661 . ////////////////////////////////////////////////////////////////////////////
33662
33663 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33664          "Local scan function"
33665 .scindex IIDlosca "&[local_scan()]& function" "description of"
33666 .cindex "customizing" "input scan using C function"
33667 .cindex "policy control" "by local scan function"
33668 In these days of email worms, viruses, and ever-increasing spam, some sites
33669 want to apply a lot of checking to messages before accepting them.
33670
33671 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33672 passing messages to external virus and spam scanning software. You can also do
33673 a certain amount in Exim itself through string expansions and the &%condition%&
33674 condition in the ACL that runs after the SMTP DATA command or the ACL for
33675 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33676
33677 To allow for further customization to a site's own requirements, there is the
33678 possibility of linking Exim with a private message scanning function, written
33679 in C. If you want to run code that is written in something other than C, you
33680 can of course use a little C stub to call it.
33681
33682 The local scan function is run once for every incoming message, at the point
33683 when Exim is just about to accept the message.
33684 It can therefore be used to control non-SMTP messages from local processes as
33685 well as messages arriving via SMTP.
33686
33687 Exim applies a timeout to calls of the local scan function, and there is an
33688 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33689 Zero means &"no timeout"&.
33690 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33691 before calling the local scan function, so that the most common types of crash
33692 are caught. If the timeout is exceeded or one of those signals is caught, the
33693 incoming message is rejected with a temporary error if it is an SMTP message.
33694 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33695 code. The incident is logged on the main and reject logs.
33696
33697
33698
33699 .section "Building Exim to use a local scan function" "SECID207"
33700 .cindex "&[local_scan()]& function" "building Exim to use"
33701 To make use of the local scan function feature, you must tell Exim where your
33702 function is before building Exim, by setting
33703 both HAVE_LOCAL_SCAN and
33704 LOCAL_SCAN_SOURCE in your
33705 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33706 directory, so you might set
33707 .code
33708 HAVE_LOCAL_SCAN=yes
33709 LOCAL_SCAN_SOURCE=Local/local_scan.c
33710 .endd
33711 for example. The function must be called &[local_scan()]&. It is called by
33712 Exim after it has received a message, when the success return code is about to
33713 be sent. This is after all the ACLs have been run. The return code from your
33714 function controls whether the message is actually accepted or not. There is a
33715 commented template function (that just accepts the message) in the file
33716 _src/local_scan.c_.
33717
33718 If you want to make use of Exim's runtime configuration file to set options
33719 for your &[local_scan()]& function, you must also set
33720 .code
33721 LOCAL_SCAN_HAS_OPTIONS=yes
33722 .endd
33723 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33724
33725
33726
33727
33728 .section "API for local_scan()" "SECTapiforloc"
33729 .cindex "&[local_scan()]& function" "API description"
33730 .cindex &%dlfunc%& "API description"
33731 You must include this line near the start of your code:
33732 .code
33733 #include "local_scan.h"
33734 .endd
33735 This header file defines a number of variables and other values, and the
33736 prototype for the function itself. Exim is coded to use unsigned char values
33737 almost exclusively, and one of the things this header defines is a shorthand
33738 for &`unsigned char`& called &`uschar`&.
33739 It also contains the following macro definitions, to simplify casting character
33740 strings and pointers to character strings:
33741 .code
33742 #define CS   (char *)
33743 #define CCS  (const char *)
33744 #define CSS  (char **)
33745 #define US   (unsigned char *)
33746 #define CUS  (const unsigned char *)
33747 #define USS  (unsigned char **)
33748 .endd
33749 The function prototype for &[local_scan()]& is:
33750 .code
33751 extern int local_scan(int fd, uschar **return_text);
33752 .endd
33753 The arguments are as follows:
33754
33755 .ilist
33756 &%fd%& is a file descriptor for the file that contains the body of the message
33757 (the -D file). The file is open for reading and writing, but updating it is not
33758 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33759
33760 The descriptor is positioned at character 19 of the file, which is the first
33761 character of the body itself, because the first 19 characters are the message
33762 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33763 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33764 case this changes in some future version.
33765 .next
33766 &%return_text%& is an address which you can use to return a pointer to a text
33767 string at the end of the function. The value it points to on entry is NULL.
33768 .endlist
33769
33770 The function must return an &%int%& value which is one of the following macros:
33771
33772 .vlist
33773 .vitem &`LOCAL_SCAN_ACCEPT`&
33774 .vindex "&$local_scan_data$&"
33775 The message is accepted. If you pass back a string of text, it is saved with
33776 the message, and made available in the variable &$local_scan_data$&. No
33777 newlines are permitted (if there are any, they are turned into spaces) and the
33778 maximum length of text is 1000 characters.
33779
33780 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33781 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33782 queued without immediate delivery, and is frozen.
33783
33784 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33785 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33786 queued without immediate delivery.
33787
33788 .vitem &`LOCAL_SCAN_REJECT`&
33789 The message is rejected; the returned text is used as an error message which is
33790 passed back to the sender and which is also logged. Newlines are permitted &--
33791 they cause a multiline response for SMTP rejections, but are converted to
33792 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33793 used.
33794
33795 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33796 The message is temporarily rejected; the returned text is used as an error
33797 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33798 problem"& is used.
33799
33800 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33801 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33802 message is not written to the reject log. It has the effect of unsetting the
33803 &%rejected_header%& log selector for just this rejection. If
33804 &%rejected_header%& is already unset (see the discussion of the
33805 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33806 same as LOCAL_SCAN_REJECT.
33807
33808 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33809 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33810 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33811 .endlist
33812
33813 If the message is not being received by interactive SMTP, rejections are
33814 reported by writing to &%stderr%& or by sending an email, as configured by the
33815 &%-oe%& command line options.
33816
33817
33818
33819 .section "Configuration options for local_scan()" "SECTconoptloc"
33820 .cindex "&[local_scan()]& function" "configuration options"
33821 It is possible to have option settings in the main configuration file
33822 that set values in static variables in the &[local_scan()]& module. If you
33823 want to do this, you must have the line
33824 .code
33825 LOCAL_SCAN_HAS_OPTIONS=yes
33826 .endd
33827 in your &_Local/Makefile_& when you build Exim. (This line is in
33828 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33829 file, you must define static variables to hold the option values, and a table
33830 to define them.
33831
33832 The table must be a vector called &%local_scan_options%&, of type
33833 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33834 and a pointer to the variable that holds the value. The entries must appear in
33835 alphabetical order. Following &%local_scan_options%& you must also define a
33836 variable called &%local_scan_options_count%& that contains the number of
33837 entries in the table. Here is a short example, showing two kinds of option:
33838 .code
33839 static int my_integer_option = 42;
33840 static uschar *my_string_option = US"a default string";
33841
33842 optionlist local_scan_options[] = {
33843   { "my_integer", opt_int,       &my_integer_option },
33844   { "my_string",  opt_stringptr, &my_string_option }
33845 };
33846
33847 int local_scan_options_count =
33848   sizeof(local_scan_options)/sizeof(optionlist);
33849 .endd
33850 The values of the variables can now be changed from Exim's runtime
33851 configuration file by including a local scan section as in this example:
33852 .code
33853 begin local_scan
33854 my_integer = 99
33855 my_string = some string of text...
33856 .endd
33857 The available types of option data are as follows:
33858
33859 .vlist
33860 .vitem &*opt_bool*&
33861 This specifies a boolean (true/false) option. The address should point to a
33862 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33863 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33864 whether such a variable has been set at all, you can initialize it to
33865 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33866 values.)
33867
33868 .vitem &*opt_fixed*&
33869 This specifies a fixed point number, such as is used for load averages.
33870 The address should point to a variable of type &`int`&. The value is stored
33871 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33872
33873 .vitem &*opt_int*&
33874 This specifies an integer; the address should point to a variable of type
33875 &`int`&. The value may be specified in any of the integer formats accepted by
33876 Exim.
33877
33878 .vitem &*opt_mkint*&
33879 This is the same as &%opt_int%&, except that when such a value is output in a
33880 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33881 printed with the suffix K or M.
33882
33883 .vitem &*opt_octint*&
33884 This also specifies an integer, but the value is always interpreted as an
33885 octal integer, whether or not it starts with the digit zero, and it is
33886 always output in octal.
33887
33888 .vitem &*opt_stringptr*&
33889 This specifies a string value; the address must be a pointer to a
33890 variable that points to a string (for example, of type &`uschar *`&).
33891
33892 .vitem &*opt_time*&
33893 This specifies a time interval value. The address must point to a variable of
33894 type &`int`&. The value that is placed there is a number of seconds.
33895 .endlist
33896
33897 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33898 out the values of all the &[local_scan()]& options.
33899
33900
33901
33902 .section "Available Exim variables" "SECID208"
33903 .cindex "&[local_scan()]& function" "available Exim variables"
33904 The header &_local_scan.h_& gives you access to a number of C variables. These
33905 are the only ones that are guaranteed to be maintained from release to release.
33906 Note, however, that you can obtain the value of any Exim expansion variable,
33907 including &$recipients$&, by calling &'expand_string()'&. The exported
33908 C variables are as follows:
33909
33910 .vlist
33911 .vitem &*int&~body_linecount*&
33912 This variable contains the number of lines in the message's body.
33913 It is not valid if the &%spool_files_wireformat%& option is used.
33914
33915 .vitem &*int&~body_zerocount*&
33916 This variable contains the number of binary zero bytes in the message's body.
33917 It is not valid if the &%spool_files_wireformat%& option is used.
33918
33919 .vitem &*unsigned&~int&~debug_selector*&
33920 This variable is set to zero when no debugging is taking place. Otherwise, it
33921 is a bitmap of debugging selectors. Two bits are identified for use in
33922 &[local_scan()]&; they are defined as macros:
33923
33924 .ilist
33925 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33926 testing option that is not privileged &-- any caller may set it. All the
33927 other selector bits can be set only by admin users.
33928
33929 .next
33930 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33931 by the &`+local_scan`& debug selector. It is not included in the default set
33932 of debugging bits.
33933 .endlist ilist
33934
33935 Thus, to write to the debugging output only when &`+local_scan`& has been
33936 selected, you should use code like this:
33937 .code
33938 if ((debug_selector & D_local_scan) != 0)
33939   debug_printf("xxx", ...);
33940 .endd
33941 .vitem &*uschar&~*expand_string_message*&
33942 After a failing call to &'expand_string()'& (returned value NULL), the
33943 variable &%expand_string_message%& contains the error message, zero-terminated.
33944
33945 .vitem &*header_line&~*header_list*&
33946 A pointer to a chain of header lines. The &%header_line%& structure is
33947 discussed below.
33948
33949 .vitem &*header_line&~*header_last*&
33950 A pointer to the last of the header lines.
33951
33952 .vitem &*uschar&~*headers_charset*&
33953 The value of the &%headers_charset%& configuration option.
33954
33955 .vitem &*BOOL&~host_checking*&
33956 This variable is TRUE during a host checking session that is initiated by the
33957 &%-bh%& command line option.
33958
33959 .vitem &*uschar&~*interface_address*&
33960 The IP address of the interface that received the message, as a string. This
33961 is NULL for locally submitted messages.
33962
33963 .vitem &*int&~interface_port*&
33964 The port on which this message was received. When testing with the &%-bh%&
33965 command line option, the value of this variable is -1 unless a port has been
33966 specified via the &%-oMi%& option.
33967
33968 .vitem &*uschar&~*message_id*&
33969 This variable contains Exim's message id for the incoming message (the value of
33970 &$message_exim_id$&) as a zero-terminated string.
33971
33972 .vitem &*uschar&~*received_protocol*&
33973 The name of the protocol by which the message was received.
33974
33975 .vitem &*int&~recipients_count*&
33976 The number of accepted recipients.
33977
33978 .vitem &*recipient_item&~*recipients_list*&
33979 .cindex "recipient" "adding in local scan"
33980 .cindex "recipient" "removing in local scan"
33981 The list of accepted recipients, held in a vector of length
33982 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33983 can add additional recipients by calling &'receive_add_recipient()'& (see
33984 below). You can delete recipients by removing them from the vector and
33985 adjusting the value in &%recipients_count%&. In particular, by setting
33986 &%recipients_count%& to zero you remove all recipients. If you then return the
33987 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33988 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33989 and then call &'receive_add_recipient()'& as often as needed.
33990
33991 .vitem &*uschar&~*sender_address*&
33992 The envelope sender address. For bounce messages this is the empty string.
33993
33994 .vitem &*uschar&~*sender_host_address*&
33995 The IP address of the sending host, as a string. This is NULL for
33996 locally-submitted messages.
33997
33998 .vitem &*uschar&~*sender_host_authenticated*&
33999 The name of the authentication mechanism that was used, or NULL if the message
34000 was not received over an authenticated SMTP connection.
34001
34002 .vitem &*uschar&~*sender_host_name*&
34003 The name of the sending host, if known.
34004
34005 .vitem &*int&~sender_host_port*&
34006 The port on the sending host.
34007
34008 .vitem &*BOOL&~smtp_input*&
34009 This variable is TRUE for all SMTP input, including BSMTP.
34010
34011 .vitem &*BOOL&~smtp_batched_input*&
34012 This variable is TRUE for BSMTP input.
34013
34014 .vitem &*int&~store_pool*&
34015 The contents of this variable control which pool of memory is used for new
34016 requests. See section &<<SECTmemhanloc>>& for details.
34017 .endlist
34018
34019
34020 .section "Structure of header lines" "SECID209"
34021 The &%header_line%& structure contains the members listed below.
34022 You can add additional header lines by calling the &'header_add()'& function
34023 (see below). You can cause header lines to be ignored (deleted) by setting
34024 their type to *.
34025
34026
34027 .vlist
34028 .vitem &*struct&~header_line&~*next*&
34029 A pointer to the next header line, or NULL for the last line.
34030
34031 .vitem &*int&~type*&
34032 A code identifying certain headers that Exim recognizes. The codes are printing
34033 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34034 Notice in particular that any header line whose type is * is not transmitted
34035 with the message. This flagging is used for header lines that have been
34036 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34037 lines.) Effectively, * means &"deleted"&.
34038
34039 .vitem &*int&~slen*&
34040 The number of characters in the header line, including the terminating and any
34041 internal newlines.
34042
34043 .vitem &*uschar&~*text*&
34044 A pointer to the text of the header. It always ends with a newline, followed by
34045 a zero byte. Internal newlines are preserved.
34046 .endlist
34047
34048
34049
34050 .section "Structure of recipient items" "SECID210"
34051 The &%recipient_item%& structure contains these members:
34052
34053 .vlist
34054 .vitem &*uschar&~*address*&
34055 This is a pointer to the recipient address as it was received.
34056
34057 .vitem &*int&~pno*&
34058 This is used in later Exim processing when top level addresses are created by
34059 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34060 and must always contain -1 at this stage.
34061
34062 .vitem &*uschar&~*errors_to*&
34063 If this value is not NULL, bounce messages caused by failing to deliver to the
34064 recipient are sent to the address it contains. In other words, it overrides the
34065 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34066 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34067 an unqualified address, Exim qualifies it using the domain from
34068 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34069 is NULL for all recipients.
34070 .endlist
34071
34072
34073
34074 .section "Available Exim functions" "SECID211"
34075 .cindex "&[local_scan()]& function" "available Exim functions"
34076 The header &_local_scan.h_& gives you access to a number of Exim functions.
34077 These are the only ones that are guaranteed to be maintained from release to
34078 release:
34079
34080 .vlist
34081 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34082        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34083
34084 This function creates a child process that runs the command specified by
34085 &%argv%&. The environment for the process is specified by &%envp%&, which can
34086 be NULL if no environment variables are to be passed. A new umask is supplied
34087 for the process in &%newumask%&.
34088
34089 Pipes to the standard input and output of the new process are set up
34090 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34091 standard error is cloned to the standard output. If there are any file
34092 descriptors &"in the way"& in the new process, they are closed. If the final
34093 argument is TRUE, the new process is made into a process group leader.
34094
34095 The function returns the pid of the new process, or -1 if things go wrong.
34096
34097 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34098 This function waits for a child process to terminate, or for a timeout (in
34099 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34100 return value is as follows:
34101
34102 .ilist
34103 >= 0
34104
34105 The process terminated by a normal exit and the value is the process
34106 ending status.
34107
34108 .next
34109 < 0 and > &--256
34110
34111 The process was terminated by a signal and the value is the negation of the
34112 signal number.
34113
34114 .next
34115 &--256
34116
34117 The process timed out.
34118 .next
34119 &--257
34120
34121 The was some other error in wait(); &%errno%& is still set.
34122 .endlist
34123
34124 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34125 This function provide you with a means of submitting a new message to
34126 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34127 want, but this packages it all up for you.) The function creates a pipe,
34128 forks a subprocess that is running
34129 .code
34130 exim -t -oem -oi -f <>
34131 .endd
34132 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34133 that is connected to the standard input. The yield of the function is the PID
34134 of the subprocess. You can then write a message to the file descriptor, with
34135 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34136
34137 When you have finished, call &'child_close()'& to wait for the process to
34138 finish and to collect its ending status. A timeout value of zero is usually
34139 fine in this circumstance. Unless you have made a mistake with the recipient
34140 addresses, you should get a return code of zero.
34141
34142
34143 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34144        *sender_authentication)*&
34145 This function is a more sophisticated version of &'child_open()'&. The command
34146 that it runs is:
34147 .display
34148 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34149 .endd
34150 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34151
34152
34153 .vitem &*void&~debug_printf(char&~*,&~...)*&
34154 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34155 output is written to the standard error stream. If no debugging is selected,
34156 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34157 conditional on the &`local_scan`& debug selector by coding like this:
34158 .code
34159 if ((debug_selector & D_local_scan) != 0)
34160   debug_printf("xxx", ...);
34161 .endd
34162
34163 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34164 This is an interface to Exim's string expansion code. The return value is the
34165 expanded string, or NULL if there was an expansion failure.
34166 The C variable &%expand_string_message%& contains an error message after an
34167 expansion failure. If expansion does not change the string, the return value is
34168 the pointer to the input string. Otherwise, the return value points to a new
34169 block of memory that was obtained by a call to &'store_get()'&. See section
34170 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34171
34172 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34173 This function allows you to an add additional header line at the end of the
34174 existing ones. The first argument is the type, and should normally be a space
34175 character. The second argument is a format string and any number of
34176 substitution arguments as for &[sprintf()]&. You may include internal newlines
34177 if you want, and you must ensure that the string ends with a newline.
34178
34179 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34180         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34181 This function adds a new header line at a specified point in the header
34182 chain. The header itself is specified as for &'header_add()'&.
34183
34184 If &%name%& is NULL, the new header is added at the end of the chain if
34185 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34186 NULL, the header lines are searched for the first non-deleted header that
34187 matches the name. If one is found, the new header is added before it if
34188 &%after%& is false. If &%after%& is true, the new header is added after the
34189 found header and any adjacent subsequent ones with the same name (even if
34190 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34191 option controls where the header is added. If it is true, addition is at the
34192 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34193 headers, or at the top if there are no &'Received:'& headers, you could use
34194 .code
34195 header_add_at_position(TRUE, US"Received", TRUE,
34196   ' ', "X-xxx: ...");
34197 .endd
34198 Normally, there is always at least one non-deleted &'Received:'& header, but
34199 there may not be if &%received_header_text%& expands to an empty string.
34200
34201
34202 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34203 This function removes header lines. If &%occurrence%& is zero or negative, all
34204 occurrences of the header are removed. If occurrence is greater than zero, that
34205 particular instance of the header is removed. If no header(s) can be found that
34206 match the specification, the function does nothing.
34207
34208
34209 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34210         int&~length,&~BOOL&~notdel)*&"
34211 This function tests whether the given header has the given name. It is not just
34212 a string comparison, because white space is permitted between the name and the
34213 colon. If the &%notdel%& argument is true, a false return is forced for all
34214 &"deleted"& headers; otherwise they are not treated specially. For example:
34215 .code
34216 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34217 .endd
34218 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34219 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34220 This function base64-encodes a string, which is passed by address and length.
34221 The text may contain bytes of any value, including zero. The result is passed
34222 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34223 zero-terminated.
34224
34225 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34226 This function decodes a base64-encoded string. Its arguments are a
34227 zero-terminated base64-encoded string and the address of a variable that is set
34228 to point to the result, which is in dynamic memory. The length of the decoded
34229 string is the yield of the function. If the input is invalid base64 data, the
34230 yield is -1. A zero byte is added to the end of the output string to make it
34231 easy to interpret as a C string (assuming it contains no zeros of its own). The
34232 added zero byte is not included in the returned count.
34233
34234 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34235 This function checks for a match in a domain list. Domains are always
34236 matched caselessly. The return value is one of the following:
34237 .display
34238 &`OK     `& match succeeded
34239 &`FAIL   `& match failed
34240 &`DEFER  `& match deferred
34241 .endd
34242 DEFER is usually caused by some kind of lookup defer, such as the
34243 inability to contact a database.
34244
34245 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34246         BOOL&~caseless)*&"
34247 This function checks for a match in a local part list. The third argument
34248 controls case-sensitivity. The return values are as for
34249 &'lss_match_domain()'&.
34250
34251 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34252         BOOL&~caseless)*&"
34253 This function checks for a match in an address list. The third argument
34254 controls the case-sensitivity of the local part match. The domain is always
34255 matched caselessly. The return values are as for &'lss_match_domain()'&.
34256
34257 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34258         uschar&~*list)*&"
34259 This function checks for a match in a host list. The most common usage is
34260 expected to be
34261 .code
34262 lss_match_host(sender_host_name, sender_host_address, ...)
34263 .endd
34264 .vindex "&$sender_host_address$&"
34265 An empty address field matches an empty item in the host list. If the host name
34266 is NULL, the name corresponding to &$sender_host_address$& is automatically
34267 looked up if a host name is required to match an item in the list. The return
34268 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34269 returns ERROR in the case when it had to look up a host name, but the lookup
34270 failed.
34271
34272 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34273         *format,&~...)*&"
34274 This function writes to Exim's log files. The first argument should be zero (it
34275 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34276 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34277 them. It specifies to which log or logs the message is written. The remaining
34278 arguments are a format and relevant insertion arguments. The string should not
34279 contain any newlines, not even at the end.
34280
34281
34282 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34283 This function adds an additional recipient to the message. The first argument
34284 is the recipient address. If it is unqualified (has no domain), it is qualified
34285 with the &%qualify_recipient%& domain. The second argument must always be -1.
34286
34287 This function does not allow you to specify a private &%errors_to%& address (as
34288 described with the structure of &%recipient_item%& above), because it pre-dates
34289 the addition of that field to the structure. However, it is easy to add such a
34290 value afterwards. For example:
34291 .code
34292  receive_add_recipient(US"monitor@mydom.example", -1);
34293  recipients_list[recipients_count-1].errors_to =
34294    US"postmaster@mydom.example";
34295 .endd
34296
34297 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34298 This is a convenience function to remove a named recipient from the list of
34299 recipients. It returns true if a recipient was removed, and false if no
34300 matching recipient could be found. The argument must be a complete email
34301 address.
34302 .endlist
34303
34304
34305 .cindex "RFC 2047"
34306 .vlist
34307 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34308   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34309 This function decodes strings that are encoded according to RFC 2047. Typically
34310 these are the contents of header lines. First, each &"encoded word"& is decoded
34311 from the Q or B encoding into a byte-string. Then, if provided with the name of
34312 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34313 made  to translate the result to the named character set. If this fails, the
34314 binary string is returned with an error message.
34315
34316 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34317 maximum MIME word length is enforced. The third argument is the target
34318 encoding, or NULL if no translation is wanted.
34319
34320 .cindex "binary zero" "in RFC 2047 decoding"
34321 .cindex "RFC 2047" "binary zero in"
34322 If a binary zero is encountered in the decoded string, it is replaced by the
34323 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34324 not be 0 because header lines are handled as zero-terminated strings.
34325
34326 The function returns the result of processing the string, zero-terminated; if
34327 &%lenptr%& is not NULL, the length of the result is set in the variable to
34328 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34329
34330 If an error is encountered, the function returns NULL and uses the &%error%&
34331 argument to return an error message. The variable pointed to by &%error%& is
34332 set to NULL if there is no error; it may be set non-NULL even when the function
34333 returns a non-NULL value if decoding was successful, but there was a problem
34334 with translation.
34335
34336
34337 .vitem &*int&~smtp_fflush(void)*&
34338 This function is used in conjunction with &'smtp_printf()'&, as described
34339 below.
34340
34341 .new
34342 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34343 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34344 .wen
34345 output stream. You should use this function only when there is an SMTP output
34346 stream, that is, when the incoming message is being received via interactive
34347 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34348 is FALSE. If you want to test for an incoming message from another host (as
34349 opposed to a local process that used the &%-bs%& command line option), you can
34350 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34351 is involved.
34352
34353 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34354 output function, so it can be used for all forms of SMTP connection.
34355
34356 .new
34357 The second argument is used to request that the data be buffered
34358 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34359 This is advisory only, but likely to save on system-calls and packets
34360 sent when a sequence of calls to the function are made.
34361
34362 The argument was added in Exim version 4.90 - changing the API/ABI.
34363 Nobody noticed until 4.93 was imminent, at which point the
34364 ABI version number was incremented.
34365 .wen
34366
34367 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34368 must start with an appropriate response code: 550 if you are going to return
34369 LOCAL_SCAN_REJECT, 451 if you are going to return
34370 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34371 initial lines of a multi-line response, the code must be followed by a hyphen
34372 to indicate that the line is not the final response line. You must also ensure
34373 that the lines you write terminate with CRLF. For example:
34374 .code
34375 smtp_printf("550-this is some extra info\r\n");
34376 return LOCAL_SCAN_REJECT;
34377 .endd
34378 Note that you can also create multi-line responses by including newlines in
34379 the data returned via the &%return_text%& argument. The added value of using
34380 &'smtp_printf()'& is that, for instance, you could introduce delays between
34381 multiple output lines.
34382
34383 The &'smtp_printf()'& function does not return any error indication, because it
34384 does not
34385 .new
34386 guarantee a flush of
34387 .wen
34388 pending output, and therefore does not test
34389 the state of the stream. (In the main code of Exim, flushing and error
34390 detection is done when Exim is ready for the next SMTP input command.) If
34391 you want to flush the output and check for an error (for example, the
34392 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34393 arguments. It flushes the output stream, and returns a non-zero value if there
34394 is an error.
34395
34396 .vitem &*void&~*store_get(int)*&
34397 This function accesses Exim's internal store (memory) manager. It gets a new
34398 chunk of memory whose size is given by the argument. Exim bombs out if it ever
34399 runs out of memory. See the next section for a discussion of memory handling.
34400
34401 .vitem &*void&~*store_get_perm(int)*&
34402 This function is like &'store_get()'&, but it always gets memory from the
34403 permanent pool. See the next section for a discussion of memory handling.
34404
34405 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34406 See below.
34407
34408 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34409 See below.
34410
34411 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34412 These three functions create strings using Exim's dynamic memory facilities.
34413 The first makes a copy of an entire string. The second copies up to a maximum
34414 number of characters, indicated by the second argument. The third uses a format
34415 and insertion arguments to create a new string. In each case, the result is a
34416 pointer to a new string in the current memory pool. See the next section for
34417 more discussion.
34418 .endlist
34419
34420
34421
34422 .section "More about Exim's memory handling" "SECTmemhanloc"
34423 .cindex "&[local_scan()]& function" "memory handling"
34424 No function is provided for freeing memory, because that is never needed.
34425 The dynamic memory that Exim uses when receiving a message is automatically
34426 recycled if another message is received by the same process (this applies only
34427 to incoming SMTP connections &-- other input methods can supply only one
34428 message at a time). After receiving the last message, a reception process
34429 terminates.
34430
34431 Because it is recycled, the normal dynamic memory cannot be used for holding
34432 data that must be preserved over a number of incoming messages on the same SMTP
34433 connection. However, Exim in fact uses two pools of dynamic memory; the second
34434 one is not recycled, and can be used for this purpose.
34435
34436 If you want to allocate memory that remains available for subsequent messages
34437 in the same SMTP connection, you should set
34438 .code
34439 store_pool = POOL_PERM
34440 .endd
34441 before calling the function that does the allocation. There is no need to
34442 restore the value if you do not need to; however, if you do want to revert to
34443 the normal pool, you can either restore the previous value of &%store_pool%& or
34444 set it explicitly to POOL_MAIN.
34445
34446 The pool setting applies to all functions that get dynamic memory, including
34447 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34448 There is also a convenience function called &'store_get_perm()'& that gets a
34449 block of memory from the permanent pool while preserving the value of
34450 &%store_pool%&.
34451 .ecindex IIDlosca
34452
34453
34454
34455
34456 . ////////////////////////////////////////////////////////////////////////////
34457 . ////////////////////////////////////////////////////////////////////////////
34458
34459 .chapter "System-wide message filtering" "CHAPsystemfilter"
34460 .scindex IIDsysfil1 "filter" "system filter"
34461 .scindex IIDsysfil2 "filtering all mail"
34462 .scindex IIDsysfil3 "system filter"
34463 The previous chapters (on ACLs and the local scan function) describe checks
34464 that can be applied to messages before they are accepted by a host. There is
34465 also a mechanism for checking messages once they have been received, but before
34466 they are delivered. This is called the &'system filter'&.
34467
34468 The system filter operates in a similar manner to users' filter files, but it
34469 is run just once per message (however many recipients the message has).
34470 It should not normally be used as a substitute for routing, because &%deliver%&
34471 commands in a system router provide new envelope recipient addresses.
34472 The system filter must be an Exim filter. It cannot be a Sieve filter.
34473
34474 The system filter is run at the start of a delivery attempt, before any routing
34475 is done. If a message fails to be completely delivered at the first attempt,
34476 the system filter is run again at the start of every retry.
34477 If you want your filter to do something only once per message, you can make use
34478 of the &%first_delivery%& condition in an &%if%& command in the filter to
34479 prevent it happening on retries.
34480
34481 .vindex "&$domain$&"
34482 .vindex "&$local_part$&"
34483 &*Warning*&: Because the system filter runs just once, variables that are
34484 specific to individual recipient addresses, such as &$local_part$& and
34485 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34486 you want to run a centrally-specified filter for each recipient address
34487 independently, you can do so by setting up a suitable &(redirect)& router, as
34488 described in section &<<SECTperaddfil>>& below.
34489
34490
34491 .section "Specifying a system filter" "SECID212"
34492 .cindex "uid (user id)" "system filter"
34493 .cindex "gid (group id)" "system filter"
34494 The name of the file that contains the system filter must be specified by
34495 setting &%system_filter%&. If you want the filter to run under a uid and gid
34496 other than root, you must also set &%system_filter_user%& and
34497 &%system_filter_group%& as appropriate. For example:
34498 .code
34499 system_filter = /etc/mail/exim.filter
34500 system_filter_user = exim
34501 .endd
34502 If a system filter generates any deliveries directly to files or pipes (via the
34503 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34504 specified by setting &%system_filter_file_transport%& and
34505 &%system_filter_pipe_transport%&, respectively. Similarly,
34506 &%system_filter_reply_transport%& must be set to handle any messages generated
34507 by the &%reply%& command.
34508
34509
34510 .section "Testing a system filter" "SECID213"
34511 You can run simple tests of a system filter in the same way as for a user
34512 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34513 are permitted only in system filters are recognized.
34514
34515 If you want to test the combined effect of a system filter and a user filter,
34516 you can use both &%-bF%& and &%-bf%& on the same command line.
34517
34518
34519
34520 .section "Contents of a system filter" "SECID214"
34521 The language used to specify system filters is the same as for users' filter
34522 files. It is described in the separate end-user document &'Exim's interface to
34523 mail filtering'&. However, there are some additional features that are
34524 available only in system filters; these are described in subsequent sections.
34525 If they are encountered in a user's filter file or when testing with &%-bf%&,
34526 they cause errors.
34527
34528 .cindex "frozen messages" "manual thaw; testing in filter"
34529 There are two special conditions which, though available in users' filter
34530 files, are designed for use in system filters. The condition &%first_delivery%&
34531 is true only for the first attempt at delivering a message, and
34532 &%manually_thawed%& is true only if the message has been frozen, and
34533 subsequently thawed by an admin user. An explicit forced delivery counts as a
34534 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34535
34536 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34537 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34538 succeed, it will not be tried again.
34539 If you want Exim to retry an unseen delivery until it succeeds, you should
34540 arrange to set it up every time the filter runs.
34541
34542 When a system filter finishes running, the values of the variables &$n0$& &--
34543 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34544 users' filter files. Thus a system filter can, for example, set up &"scores"&
34545 to which users' filter files can refer.
34546
34547
34548
34549 .section "Additional variable for system filters" "SECID215"
34550 .vindex "&$recipients$&"
34551 The expansion variable &$recipients$&, containing a list of all the recipients
34552 of the message (separated by commas and white space), is available in system
34553 filters. It is not available in users' filters for privacy reasons.
34554
34555
34556
34557 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34558 .cindex "freezing messages"
34559 .cindex "message" "freezing"
34560 .cindex "message" "forced failure"
34561 .cindex "&%fail%&" "in system filter"
34562 .cindex "&%freeze%& in system filter"
34563 .cindex "&%defer%& in system filter"
34564 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34565 always available in system filters, but are not normally enabled in users'
34566 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34567 for the &(redirect)& router.) These commands can optionally be followed by the
34568 word &%text%& and a string containing an error message, for example:
34569 .code
34570 fail text "this message looks like spam to me"
34571 .endd
34572 The keyword &%text%& is optional if the next character is a double quote.
34573
34574 The &%defer%& command defers delivery of the original recipients of the
34575 message. The &%fail%& command causes all the original recipients to be failed,
34576 and a bounce message to be created. The &%freeze%& command suspends all
34577 delivery attempts for the original recipients. In all cases, any new deliveries
34578 that are specified by the filter are attempted as normal after the filter has
34579 run.
34580
34581 The &%freeze%& command is ignored if the message has been manually unfrozen and
34582 not manually frozen since. This means that automatic freezing by a system
34583 filter can be used as a way of checking out suspicious messages. If a message
34584 is found to be all right, manually unfreezing it allows it to be delivered.
34585
34586 .cindex "log" "&%fail%& command log line"
34587 .cindex "&%fail%&" "log line; reducing"
34588 The text given with a fail command is used as part of the bounce message as
34589 well as being written to the log. If the message is quite long, this can fill
34590 up a lot of log space when such failures are common. To reduce the size of the
34591 log message, Exim interprets the text in a special way if it starts with the
34592 two characters &`<<`& and contains &`>>`& later. The text between these two
34593 strings is written to the log, and the rest of the text is used in the bounce
34594 message. For example:
34595 .code
34596 fail "<<filter test 1>>Your message is rejected \
34597      because it contains attachments that we are \
34598      not prepared to receive."
34599 .endd
34600
34601 .cindex "loop" "caused by &%fail%&"
34602 Take great care with the &%fail%& command when basing the decision to fail on
34603 the contents of the message, because the bounce message will of course include
34604 the contents of the original message and will therefore trigger the &%fail%&
34605 command again (causing a mail loop) unless steps are taken to prevent this.
34606 Testing the &%error_message%& condition is one way to prevent this. You could
34607 use, for example
34608 .code
34609 if $message_body contains "this is spam" and not error_message
34610 then fail text "spam is not wanted here" endif
34611 .endd
34612 though of course that might let through unwanted bounce messages. The
34613 alternative is clever checking of the body and/or headers to detect bounces
34614 generated by the filter.
34615
34616 The interpretation of a system filter file ceases after a
34617 &%defer%&,
34618 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34619 set up earlier in the filter file are honoured, so you can use a sequence such
34620 as
34621 .code
34622 mail ...
34623 freeze
34624 .endd
34625 to send a specified message when the system filter is freezing (or deferring or
34626 failing) a message. The normal deliveries for the message do not, of course,
34627 take place.
34628
34629
34630
34631 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34632 .cindex "header lines" "adding; in system filter"
34633 .cindex "header lines" "removing; in system filter"
34634 .cindex "filter" "header lines; adding/removing"
34635 Two filter commands that are available only in system filters are:
34636 .code
34637 headers add <string>
34638 headers remove <string>
34639 .endd
34640 The argument for the &%headers add%& is a string that is expanded and then
34641 added to the end of the message's headers. It is the responsibility of the
34642 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34643 space is ignored, and if the string is otherwise empty, or if the expansion is
34644 forced to fail, the command has no effect.
34645
34646 You can use &"\n"& within the string, followed by white space, to specify
34647 continued header lines. More than one header may be added in one command by
34648 including &"\n"& within the string without any following white space. For
34649 example:
34650 .code
34651 headers add "X-header-1: ....\n  \
34652              continuation of X-header-1 ...\n\
34653              X-header-2: ...."
34654 .endd
34655 Note that the header line continuation white space after the first newline must
34656 be placed before the backslash that continues the input string, because white
34657 space after input continuations is ignored.
34658
34659 The argument for &%headers remove%& is a colon-separated list of header names.
34660 This command applies only to those headers that are stored with the message;
34661 those that are added at delivery time (such as &'Envelope-To:'& and
34662 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34663 header with the same name, they are all removed.
34664
34665 The &%headers%& command in a system filter makes an immediate change to the set
34666 of header lines that was received with the message (with possible additions
34667 from ACL processing). Subsequent commands in the system filter operate on the
34668 modified set, which also forms the basis for subsequent message delivery.
34669 Unless further modified during routing or transporting, this set of headers is
34670 used for all recipients of the message.
34671
34672 During routing and transporting, the variables that refer to the contents of
34673 header lines refer only to those lines that are in this set. Thus, header lines
34674 that are added by a system filter are visible to users' filter files and to all
34675 routers and transports. This contrasts with the manipulation of header lines by
34676 routers and transports, which is not immediate, but which instead is saved up
34677 until the message is actually being written (see section
34678 &<<SECTheadersaddrem>>&).
34679
34680 If the message is not delivered at the first attempt, header lines that were
34681 added by the system filter are stored with the message, and so are still
34682 present at the next delivery attempt. Header lines that were removed are still
34683 present, but marked &"deleted"& so that they are not transported with the
34684 message. For this reason, it is usual to make the &%headers%& command
34685 conditional on &%first_delivery%& so that the set of header lines is not
34686 modified more than once.
34687
34688 Because header modification in a system filter acts immediately, you have to
34689 use an indirect approach if you want to modify the contents of a header line.
34690 For example:
34691 .code
34692 headers add "Old-Subject: $h_subject:"
34693 headers remove "Subject"
34694 headers add "Subject: new subject (was: $h_old-subject:)"
34695 headers remove "Old-Subject"
34696 .endd
34697
34698
34699
34700 .section "Setting an errors address in a system filter" "SECID217"
34701 .cindex "envelope from"
34702 .cindex "envelope sender"
34703 In a system filter, if a &%deliver%& command is followed by
34704 .code
34705 errors_to <some address>
34706 .endd
34707 in order to change the envelope sender (and hence the error reporting) for that
34708 delivery, any address may be specified. (In a user filter, only the current
34709 user's address can be set.) For example, if some mail is being monitored, you
34710 might use
34711 .code
34712 unseen deliver monitor@spying.example errors_to root@local.example
34713 .endd
34714 to take a copy which would not be sent back to the normal error reporting
34715 address if its delivery failed.
34716
34717
34718
34719 .section "Per-address filtering" "SECTperaddfil"
34720 .vindex "&$domain$&"
34721 .vindex "&$local_part$&"
34722 In contrast to the system filter, which is run just once per message for each
34723 delivery attempt, it is also possible to set up a system-wide filtering
34724 operation that runs once for each recipient address. In this case, variables
34725 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34726 filter file could be made dependent on them. This is an example of a router
34727 which implements such a filter:
34728 .code
34729 central_filter:
34730   check_local_user
34731   driver = redirect
34732   domains = +local_domains
34733   file = /central/filters/$local_part
34734   no_verify
34735   allow_filter
34736   allow_freeze
34737 .endd
34738 The filter is run in a separate process under its own uid. Therefore, either
34739 &%check_local_user%& must be set (as above), in which case the filter is run as
34740 the local user, or the &%user%& option must be used to specify which user to
34741 use. If both are set, &%user%& overrides.
34742
34743 Care should be taken to ensure that none of the commands in the filter file
34744 specify a significant delivery if the message is to go on to be delivered to
34745 its intended recipient. The router will not then claim to have dealt with the
34746 address, so it will be passed on to subsequent routers to be delivered in the
34747 normal way.
34748 .ecindex IIDsysfil1
34749 .ecindex IIDsysfil2
34750 .ecindex IIDsysfil3
34751
34752
34753
34754
34755
34756
34757 . ////////////////////////////////////////////////////////////////////////////
34758 . ////////////////////////////////////////////////////////////////////////////
34759
34760 .chapter "Message processing" "CHAPmsgproc"
34761 .scindex IIDmesproc "message" "general processing"
34762 Exim performs various transformations on the sender and recipient addresses of
34763 all messages that it handles, and also on the messages' header lines. Some of
34764 these are optional and configurable, while others always take place. All of
34765 this processing, except rewriting as a result of routing, and the addition or
34766 removal of header lines while delivering, happens when a message is received,
34767 before it is placed on Exim's queue.
34768
34769 Some of the automatic processing takes place by default only for
34770 &"locally-originated"& messages. This adjective is used to describe messages
34771 that are not received over TCP/IP, but instead are passed to an Exim process on
34772 its standard input. This includes the interactive &"local SMTP"& case that is
34773 set up by the &%-bs%& command line option.
34774
34775 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34776 or ::1) are not considered to be locally-originated. Exim does not treat the
34777 loopback interface specially in any way.
34778
34779 If you want the loopback interface to be treated specially, you must ensure
34780 that there are appropriate entries in your ACLs.
34781
34782
34783
34784
34785 .section "Submission mode for non-local messages" "SECTsubmodnon"
34786 .cindex "message" "submission"
34787 .cindex "submission mode"
34788 Processing that happens automatically for locally-originated messages (unless
34789 &%suppress_local_fixups%& is set) can also be requested for messages that are
34790 received over TCP/IP. The term &"submission mode"& is used to describe this
34791 state. Submission mode is set by the modifier
34792 .code
34793 control = submission
34794 .endd
34795 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34796 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34797 a local submission, and is normally used when the source of the message is
34798 known to be an MUA running on a client host (as opposed to an MTA). For
34799 example, to set submission mode for messages originating on the IPv4 loopback
34800 interface, you could include the following in the MAIL ACL:
34801 .code
34802 warn  hosts = 127.0.0.1
34803       control = submission
34804 .endd
34805 .cindex "&%sender_retain%& submission option"
34806 There are some options that can be used when setting submission mode. A slash
34807 is used to separate options. For example:
34808 .code
34809 control = submission/sender_retain
34810 .endd
34811 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34812 true and &%local_from_check%& false for the current incoming message. The first
34813 of these allows an existing &'Sender:'& header in the message to remain, and
34814 the second suppresses the check to ensure that &'From:'& matches the
34815 authenticated sender. With this setting, Exim still fixes up messages by adding
34816 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34817 attempt to check sender authenticity in header lines.
34818
34819 When &%sender_retain%& is not set, a submission mode setting may specify a
34820 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34821 example:
34822 .code
34823 control = submission/domain=some.domain
34824 .endd
34825 The domain may be empty. How this value is used is described in sections
34826 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34827 that allows you to specify the user's full name for inclusion in a created
34828 &'Sender:'& or &'From:'& header line. For example:
34829 .code
34830 accept authenticated = *
34831        control = submission/domain=wonderland.example/\
34832                             name=${lookup {$authenticated_id} \
34833                                    lsearch {/etc/exim/namelist}}
34834 .endd
34835 Because the name may contain any characters, including slashes, the &%name%&
34836 option must be given last. The remainder of the string is used as the name. For
34837 the example above, if &_/etc/exim/namelist_& contains:
34838 .code
34839 bigegg:  Humpty Dumpty
34840 .endd
34841 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34842 line would be:
34843 .code
34844 Sender: Humpty Dumpty <bigegg@wonderland.example>
34845 .endd
34846 .cindex "return path" "in submission mode"
34847 By default, submission mode forces the return path to the same address as is
34848 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34849 specified, the return path is also left unchanged.
34850
34851 &*Note*&: The changes caused by submission mode take effect after the predata
34852 ACL. This means that any sender checks performed before the fix-ups use the
34853 untrusted sender address specified by the user, not the trusted sender address
34854 specified by submission mode. Although this might be slightly unexpected, it
34855 does mean that you can configure ACL checks to spot that a user is trying to
34856 spoof another's address.
34857
34858 .section "Line endings" "SECTlineendings"
34859 .cindex "line endings"
34860 .cindex "carriage return"
34861 .cindex "linefeed"
34862 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34863 linefeed) is the line ending for messages transmitted over the Internet using
34864 SMTP over TCP/IP. However, within individual operating systems, different
34865 conventions are used. For example, Unix-like systems use just LF, but others
34866 use CRLF or just CR.
34867
34868 Exim was designed for Unix-like systems, and internally, it stores messages
34869 using the system's convention of a single LF as a line terminator. When
34870 receiving a message, all line endings are translated to this standard format.
34871 Originally, it was thought that programs that passed messages directly to an
34872 MTA within an operating system would use that system's convention. Experience
34873 has shown that this is not the case; for example, there are Unix applications
34874 that use CRLF in this circumstance. For this reason, and for compatibility with
34875 other MTAs, the way Exim handles line endings for all messages is now as
34876 follows:
34877
34878 .ilist
34879 LF not preceded by CR is treated as a line ending.
34880 .next
34881 CR is treated as a line ending; if it is immediately followed by LF, the LF
34882 is ignored.
34883 .next
34884 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34885 nor a local message in the state where a line containing only a dot is a
34886 terminator.
34887 .next
34888 If a bare CR is encountered within a header line, an extra space is added after
34889 the line terminator so as not to end the header line. The reasoning behind this
34890 is that bare CRs in header lines are most likely either to be mistakes, or
34891 people trying to play silly games.
34892 .next
34893 If the first header line received in a message ends with CRLF, a subsequent
34894 bare LF in a header line is treated in the same way as a bare CR in a header
34895 line.
34896 .endlist
34897
34898
34899
34900
34901
34902 .section "Unqualified addresses" "SECID218"
34903 .cindex "unqualified addresses"
34904 .cindex "address" "qualification"
34905 By default, Exim expects every envelope address it receives from an external
34906 host to be fully qualified. Unqualified addresses cause negative responses to
34907 SMTP commands. However, because SMTP is used as a means of transporting
34908 messages from MUAs running on personal workstations, there is sometimes a
34909 requirement to accept unqualified addresses from specific hosts or IP networks.
34910
34911 Exim has two options that separately control which hosts may send unqualified
34912 sender or recipient addresses in SMTP commands, namely
34913 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34914 cases, if an unqualified address is accepted, it is qualified by adding the
34915 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34916
34917 .oindex "&%qualify_domain%&"
34918 .oindex "&%qualify_recipient%&"
34919 Unqualified addresses in header lines are automatically qualified for messages
34920 that are locally originated, unless the &%-bnq%& option is given on the command
34921 line. For messages received over SMTP, unqualified addresses in header lines
34922 are qualified only if unqualified addresses are permitted in SMTP commands. In
34923 other words, such qualification is also controlled by
34924 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34925
34926
34927
34928
34929 .section "The UUCP From line" "SECID219"
34930 .cindex "&""From""& line"
34931 .cindex "UUCP" "&""From""& line"
34932 .cindex "sender" "address"
34933 .oindex "&%uucp_from_pattern%&"
34934 .oindex "&%uucp_from_sender%&"
34935 .cindex "envelope from"
34936 .cindex "envelope sender"
34937 .cindex "Sendmail compatibility" "&""From""& line"
34938 Messages that have come from UUCP (and some other applications) often begin
34939 with a line containing the envelope sender and a timestamp, following the word
34940 &"From"&. Examples of two common formats are:
34941 .code
34942 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34943 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34944 .endd
34945 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34946 Exim recognizes such lines at the start of messages that are submitted to it
34947 via the command line (that is, on the standard input). It does not recognize
34948 such lines in incoming SMTP messages, unless the sending host matches
34949 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34950 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34951 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34952 default value matches the two common cases shown above and puts the address
34953 that follows &"From"& into &$1$&.
34954
34955 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34956 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34957 a trusted user, the message's sender address is constructed by expanding the
34958 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34959 then parsed as an RFC 2822 address. If there is no domain, the local part is
34960 qualified with &%qualify_domain%& unless it is the empty string. However, if
34961 the command line &%-f%& option is used, it overrides the &"From"& line.
34962
34963 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34964 sender address is not changed. This is also the case for incoming SMTP messages
34965 that are permitted to contain &"From"& lines.
34966
34967 Only one &"From"& line is recognized. If there is more than one, the second is
34968 treated as a data line that starts the body of the message, as it is not valid
34969 as a header line. This also happens if a &"From"& line is present in an
34970 incoming SMTP message from a source that is not permitted to send them.
34971
34972
34973
34974 .section "Resent- header lines" "SECID220"
34975 .cindex "&%Resent-%& header lines"
34976 .cindex "header lines" "Resent-"
34977 RFC 2822 makes provision for sets of header lines starting with the string
34978 &`Resent-`& to be added to a message when it is resent by the original
34979 recipient to somebody else. These headers are &'Resent-Date:'&,
34980 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34981 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34982
34983 .blockquote
34984 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34985 processing of replies or other such automatic actions on messages.'&
34986 .endblockquote
34987
34988 This leaves things a bit vague as far as other processing actions such as
34989 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34990 follows:
34991
34992 .ilist
34993 A &'Resent-From:'& line that just contains the login id of the submitting user
34994 is automatically rewritten in the same way as &'From:'& (see below).
34995 .next
34996 If there's a rewriting rule for a particular header line, it is also applied to
34997 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34998 &'From:'& also rewrites &'Resent-From:'&.
34999 .next
35000 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35001 also removed.
35002 .next
35003 For a locally-submitted message,
35004 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35005 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35006 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35007 included in log lines in this case.
35008 .next
35009 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35010 &%Resent-%& header lines are present.
35011 .endlist
35012
35013
35014
35015
35016 .section "The Auto-Submitted: header line" "SECID221"
35017 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35018 includes the header line:
35019 .code
35020 Auto-Submitted: auto-replied
35021 .endd
35022
35023 .section "The Bcc: header line" "SECID222"
35024 .cindex "&'Bcc:'& header line"
35025 If Exim is called with the &%-t%& option, to take recipient addresses from a
35026 message's header, it removes any &'Bcc:'& header line that may exist (after
35027 extracting its addresses). If &%-t%& is not present on the command line, any
35028 existing &'Bcc:'& is not removed.
35029
35030
35031 .section "The Date: header line" "SECID223"
35032 .cindex "&'Date:'& header line"
35033 .cindex "header lines" "Date:"
35034 If a locally-generated or submission-mode message has no &'Date:'& header line,
35035 Exim adds one, using the current date and time, unless the
35036 &%suppress_local_fixups%& control has been specified.
35037
35038 .section "The Delivery-date: header line" "SECID224"
35039 .cindex "&'Delivery-date:'& header line"
35040 .oindex "&%delivery_date_remove%&"
35041 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35042 set. Exim can be configured to add them to the final delivery of messages. (See
35043 the generic &%delivery_date_add%& transport option.) They should not be present
35044 in messages in transit. If the &%delivery_date_remove%& configuration option is
35045 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35046 messages.
35047
35048
35049 .section "The Envelope-to: header line" "SECID225"
35050 .cindex "&'Envelope-to:'& header line"
35051 .cindex "header lines" "Envelope-to:"
35052 .oindex "&%envelope_to_remove%&"
35053 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35054 Exim can be configured to add them to the final delivery of messages. (See the
35055 generic &%envelope_to_add%& transport option.) They should not be present in
35056 messages in transit. If the &%envelope_to_remove%& configuration option is set
35057 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35058 messages.
35059
35060
35061 .section "The From: header line" "SECTthefrohea"
35062 .cindex "&'From:'& header line"
35063 .cindex "header lines" "From:"
35064 .cindex "Sendmail compatibility" "&""From""& line"
35065 .cindex "message" "submission"
35066 .cindex "submission mode"
35067 If a submission-mode message does not contain a &'From:'& header line, Exim
35068 adds one if either of the following conditions is true:
35069
35070 .ilist
35071 The envelope sender address is not empty (that is, this is not a bounce
35072 message). The added header line copies the envelope sender address.
35073 .next
35074 .vindex "&$authenticated_id$&"
35075 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35076 .olist
35077 .vindex "&$qualify_domain$&"
35078 If no domain is specified by the submission control, the local part is
35079 &$authenticated_id$& and the domain is &$qualify_domain$&.
35080 .next
35081 If a non-empty domain is specified by the submission control, the local
35082 part is &$authenticated_id$&, and the domain is the specified domain.
35083 .next
35084 If an empty domain is specified by the submission control,
35085 &$authenticated_id$& is assumed to be the complete address.
35086 .endlist
35087 .endlist
35088
35089 A non-empty envelope sender takes precedence.
35090
35091 If a locally-generated incoming message does not contain a &'From:'& header
35092 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35093 containing the sender's address. The calling user's login name and full name
35094 are used to construct the address, as described in section &<<SECTconstr>>&.
35095 They are obtained from the password data by calling &[getpwuid()]& (but see the
35096 &%unknown_login%& configuration option). The address is qualified with
35097 &%qualify_domain%&.
35098
35099 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35100 &'From:'& header line containing just the unqualified login name of the calling
35101 user, this is replaced by an address containing the user's login name and full
35102 name as described in section &<<SECTconstr>>&.
35103
35104
35105 .section "The Message-ID: header line" "SECID226"
35106 .cindex "&'Message-ID:'& header line"
35107 .cindex "header lines" "Message-ID:"
35108 .cindex "message" "submission"
35109 .oindex "&%message_id_header_text%&"
35110 If a locally-generated or submission-mode incoming message does not contain a
35111 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35112 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35113 to the message. If there are any &'Resent-:'& headers in the message, it
35114 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35115 message id, preceded by the letter E to ensure it starts with a letter, and
35116 followed by @ and the primary host name. Additional information can be included
35117 in this header line by setting the &%message_id_header_text%& and/or
35118 &%message_id_header_domain%& options.
35119
35120
35121 .section "The Received: header line" "SECID227"
35122 .cindex "&'Received:'& header line"
35123 .cindex "header lines" "Received:"
35124 A &'Received:'& header line is added at the start of every message. The
35125 contents are defined by the &%received_header_text%& configuration option, and
35126 Exim automatically adds a semicolon and a timestamp to the configured string.
35127
35128 The &'Received:'& header is generated as soon as the message's header lines
35129 have been received. At this stage, the timestamp in the &'Received:'& header
35130 line is the time that the message started to be received. This is the value
35131 that is seen by the DATA ACL and by the &[local_scan()]& function.
35132
35133 Once a message is accepted, the timestamp in the &'Received:'& header line is
35134 changed to the time of acceptance, which is (apart from a small delay while the
35135 -H spool file is written) the earliest time at which delivery could start.
35136
35137
35138 .section "The References: header line" "SECID228"
35139 .cindex "&'References:'& header line"
35140 .cindex "header lines" "References:"
35141 Messages created by the &(autoreply)& transport include a &'References:'&
35142 header line. This is constructed according to the rules that are described in
35143 section 3.64 of RFC 2822 (which states that replies should contain such a
35144 header line), and section 3.14 of RFC 3834 (which states that automatic
35145 responses are not different in this respect). However, because some mail
35146 processing software does not cope well with very long header lines, no more
35147 than 12 message IDs are copied from the &'References:'& header line in the
35148 incoming message. If there are more than 12, the first one and then the final
35149 11 are copied, before adding the message ID of the incoming message.
35150
35151
35152
35153 .section "The Return-path: header line" "SECID229"
35154 .cindex "&'Return-path:'& header line"
35155 .cindex "header lines" "Return-path:"
35156 .oindex "&%return_path_remove%&"
35157 &'Return-path:'& header lines are defined as something an MTA may insert when
35158 it does the final delivery of messages. (See the generic &%return_path_add%&
35159 transport option.) Therefore, they should not be present in messages in
35160 transit. If the &%return_path_remove%& configuration option is set (the
35161 default), Exim removes &'Return-path:'& header lines from incoming messages.
35162
35163
35164
35165 .section "The Sender: header line" "SECTthesenhea"
35166 .cindex "&'Sender:'& header line"
35167 .cindex "message" "submission"
35168 .cindex "header lines" "Sender:"
35169 For a locally-originated message from an untrusted user, Exim may remove an
35170 existing &'Sender:'& header line, and it may add a new one. You can modify
35171 these actions by setting the &%local_sender_retain%& option true, the
35172 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35173 control setting.
35174
35175 When a local message is received from an untrusted user and
35176 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35177 control has not been set, a check is made to see if the address given in the
35178 &'From:'& header line is the correct (local) sender of the message. The address
35179 that is expected has the login name as the local part and the value of
35180 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35181 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35182 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35183 line is added to the message.
35184
35185 If you set &%local_from_check%& false, this checking does not occur. However,
35186 the removal of an existing &'Sender:'& line still happens, unless you also set
35187 &%local_sender_retain%& to be true. It is not possible to set both of these
35188 options true at the same time.
35189
35190 .cindex "submission mode"
35191 By default, no processing of &'Sender:'& header lines is done for messages
35192 received over TCP/IP or for messages submitted by trusted users. However, when
35193 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35194 not specified on the submission control, the following processing takes place:
35195
35196 .vindex "&$authenticated_id$&"
35197 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35198 authenticated, and &$authenticated_id$& is not empty, a sender address is
35199 created as follows:
35200
35201 .ilist
35202 .vindex "&$qualify_domain$&"
35203 If no domain is specified by the submission control, the local part is
35204 &$authenticated_id$& and the domain is &$qualify_domain$&.
35205 .next
35206 If a non-empty domain is specified by the submission control, the local part
35207 is &$authenticated_id$&, and the domain is the specified domain.
35208 .next
35209 If an empty domain is specified by the submission control,
35210 &$authenticated_id$& is assumed to be the complete address.
35211 .endlist
35212
35213 This address is compared with the address in the &'From:'& header line. If they
35214 are different, a &'Sender:'& header line containing the created address is
35215 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35216 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35217
35218 .cindex "return path" "created from &'Sender:'&"
35219 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35220 the message (the envelope sender address) is changed to be the same address,
35221 except in the case of submission mode when &%sender_retain%& is specified.
35222
35223
35224
35225 .section "Adding and removing header lines in routers and transports" &&&
35226          "SECTheadersaddrem"
35227 .cindex "header lines" "adding; in router or transport"
35228 .cindex "header lines" "removing; in router or transport"
35229 When a message is delivered, the addition and removal of header lines can be
35230 specified in a system filter, or on any of the routers and transports that
35231 process the message. Section &<<SECTaddremheasys>>& contains details about
35232 modifying headers in a system filter. Header lines can also be added in an ACL
35233 as a message is received (see section &<<SECTaddheadacl>>&).
35234
35235 In contrast to what happens in a system filter, header modifications that are
35236 specified on routers and transports apply only to the particular recipient
35237 addresses that are being processed by those routers and transports. These
35238 changes do not actually take place until a copy of the message is being
35239 transported. Therefore, they do not affect the basic set of header lines, and
35240 they do not affect the values of the variables that refer to header lines.
35241
35242 &*Note*&: In particular, this means that any expansions in the configuration of
35243 the transport cannot refer to the modified header lines, because such
35244 expansions all occur before the message is actually transported.
35245
35246 For both routers and transports, the argument of a &%headers_add%&
35247 option must be in the form of one or more RFC 2822 header lines, separated by
35248 newlines (coded as &"\n"&). For example:
35249 .code
35250 headers_add = X-added-header: added by $primary_hostname\n\
35251               X-added-second: another added header line
35252 .endd
35253 Exim does not check the syntax of these added header lines.
35254
35255 Multiple &%headers_add%& options for a single router or transport can be
35256 specified; the values will append to a single list of header lines.
35257 Each header-line is separately expanded.
35258
35259 The argument of a &%headers_remove%& option must consist of a colon-separated
35260 list of header names. This is confusing, because header names themselves are
35261 often terminated by colons. In this case, the colons are the list separators,
35262 not part of the names. For example:
35263 .code
35264 headers_remove = return-receipt-to:acknowledge-to
35265 .endd
35266
35267 Multiple &%headers_remove%& options for a single router or transport can be
35268 specified; the arguments will append to a single header-names list.
35269 Each item is separately expanded.
35270 Note that colons in complex expansions which are used to
35271 form all or part of a &%headers_remove%& list
35272 will act as list separators.
35273
35274 When &%headers_add%& or &%headers_remove%& is specified on a router,
35275 items are expanded at routing time,
35276 and then associated with all addresses that are
35277 accepted by that router, and also with any new addresses that it generates. If
35278 an address passes through several routers as a result of aliasing or
35279 forwarding, the changes are cumulative.
35280
35281 .oindex "&%unseen%&"
35282 However, this does not apply to multiple routers that result from the use of
35283 the &%unseen%& option. Any header modifications that were specified by the
35284 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35285
35286 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35287 settings cannot be delivered together in a batch, so a transport is always
35288 dealing with a set of addresses that have the same header-processing
35289 requirements.
35290
35291 The transport starts by writing the original set of header lines that arrived
35292 with the message, possibly modified by the system filter. As it writes out
35293 these lines, it consults the list of header names that were attached to the
35294 recipient address(es) by &%headers_remove%& options in routers, and it also
35295 consults the transport's own &%headers_remove%& option. Header lines whose
35296 names are on either of these lists are not written out. If there are multiple
35297 instances of any listed header, they are all skipped.
35298
35299 After the remaining original header lines have been written, new header
35300 lines that were specified by routers' &%headers_add%& options are written, in
35301 the order in which they were attached to the address. These are followed by any
35302 header lines specified by the transport's &%headers_add%& option.
35303
35304 This way of handling header line modifications in routers and transports has
35305 the following consequences:
35306
35307 .ilist
35308 The original set of header lines, possibly modified by the system filter,
35309 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35310 to it, at all times.
35311 .next
35312 Header lines that are added by a router's
35313 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35314 expansion syntax in subsequent routers or the transport.
35315 .next
35316 Conversely, header lines that are specified for removal by &%headers_remove%&
35317 in a router remain visible to subsequent routers and the transport.
35318 .next
35319 Headers added to an address by &%headers_add%& in a router cannot be removed by
35320 a later router or by a transport.
35321 .next
35322 An added header can refer to the contents of an original header that is to be
35323 removed, even it has the same name as the added header. For example:
35324 .code
35325 headers_remove = subject
35326 headers_add = Subject: new subject (was: $h_subject:)
35327 .endd
35328 .endlist
35329
35330 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35331 for a &(redirect)& router that has the &%one_time%& option set.
35332
35333
35334
35335
35336
35337 .section "Constructed addresses" "SECTconstr"
35338 .cindex "address" "constructed"
35339 .cindex "constructed address"
35340 When Exim constructs a sender address for a locally-generated message, it uses
35341 the form
35342 .display
35343 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35344 .endd
35345 For example:
35346 .code
35347 Zaphod Beeblebrox <zaphod@end.univ.example>
35348 .endd
35349 The user name is obtained from the &%-F%& command line option if set, or
35350 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35351 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35352 ampersand character, this is replaced by the login name with the first letter
35353 upper cased, as is conventional in a number of operating systems. See the
35354 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35355 The &%unknown_username%& option can be used to specify user names in cases when
35356 there is no password file entry.
35357
35358 .cindex "RFC 2047"
35359 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35360 parts of it if necessary. In addition, if it contains any non-printing
35361 characters, it is encoded as described in RFC 2047, which defines a way of
35362 including non-ASCII characters in header lines. The value of the
35363 &%headers_charset%& option specifies the name of the encoding that is used (the
35364 characters are assumed to be in this encoding). The setting of
35365 &%print_topbitchars%& controls whether characters with the top bit set (that
35366 is, with codes greater than 127) count as printing characters or not.
35367
35368
35369
35370 .section "Case of local parts" "SECID230"
35371 .cindex "case of local parts"
35372 .cindex "local part" "case of"
35373 RFC 2822 states that the case of letters in the local parts of addresses cannot
35374 be assumed to be non-significant. Exim preserves the case of local parts of
35375 addresses, but by default it uses a lower-cased form when it is routing,
35376 because on most Unix systems, usernames are in lower case and case-insensitive
35377 routing is required. However, any particular router can be made to use the
35378 original case for local parts by setting the &%caseful_local_part%& generic
35379 router option.
35380
35381 .cindex "mixed-case login names"
35382 If you must have mixed-case user names on your system, the best way to proceed,
35383 assuming you want case-independent handling of incoming email, is to set up
35384 your first router to convert incoming local parts in your domains to the
35385 correct case by means of a file lookup. For example:
35386 .code
35387 correct_case:
35388   driver = redirect
35389   domains = +local_domains
35390   data = ${lookup{$local_part}cdb\
35391               {/etc/usercased.cdb}{$value}fail}\
35392               @$domain
35393 .endd
35394 For this router, the local part is forced to lower case by the default action
35395 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35396 up a new local part in the correct case. If you then set &%caseful_local_part%&
35397 on any subsequent routers which process your domains, they will operate on
35398 local parts with the correct case in a case-sensitive manner.
35399
35400
35401
35402 .section "Dots in local parts" "SECID231"
35403 .cindex "dot" "in local part"
35404 .cindex "local part" "dots in"
35405 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35406 part may not begin or end with a dot, nor have two consecutive dots in the
35407 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35408 empty components for compatibility.
35409
35410
35411
35412 .section "Rewriting addresses" "SECID232"
35413 .cindex "rewriting" "addresses"
35414 Rewriting of sender and recipient addresses, and addresses in headers, can
35415 happen automatically, or as the result of configuration options, as described
35416 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35417 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35418
35419 Automatic rewriting includes qualification, as mentioned above. The other case
35420 in which it can happen is when an incomplete non-local domain is given. The
35421 routing process may cause this to be expanded into the full domain name. For
35422 example, a header such as
35423 .code
35424 To: hare@teaparty
35425 .endd
35426 might get rewritten as
35427 .code
35428 To: hare@teaparty.wonderland.fict.example
35429 .endd
35430 Rewriting as a result of routing is the one kind of message processing that
35431 does not happen at input time, as it cannot be done until the address has
35432 been routed.
35433
35434 Strictly, one should not do &'any'& deliveries of a message until all its
35435 addresses have been routed, in case any of the headers get changed as a
35436 result of routing. However, doing this in practice would hold up many
35437 deliveries for unreasonable amounts of time, just because one address could not
35438 immediately be routed. Exim therefore does not delay other deliveries when
35439 routing of one or more addresses is deferred.
35440 .ecindex IIDmesproc
35441
35442
35443
35444 . ////////////////////////////////////////////////////////////////////////////
35445 . ////////////////////////////////////////////////////////////////////////////
35446
35447 .chapter "SMTP processing" "CHAPSMTP"
35448 .scindex IIDsmtpproc1 "SMTP" "processing details"
35449 .scindex IIDsmtpproc2 "LMTP" "processing details"
35450 Exim supports a number of different ways of using the SMTP protocol, and its
35451 LMTP variant, which is an interactive protocol for transferring messages into a
35452 closed mail store application. This chapter contains details of how SMTP is
35453 processed. For incoming mail, the following are available:
35454
35455 .ilist
35456 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35457 .next
35458 SMTP over the standard input and output (the &%-bs%& option);
35459 .next
35460 Batched SMTP on the standard input (the &%-bS%& option).
35461 .endlist
35462
35463 For mail delivery, the following are available:
35464
35465 .ilist
35466 SMTP over TCP/IP (the &(smtp)& transport);
35467 .next
35468 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35469 &"lmtp"&);
35470 .next
35471 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35472 transport);
35473 .next
35474 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35475 the &%use_bsmtp%& option set).
35476 .endlist
35477
35478 &'Batched SMTP'& is the name for a process in which batches of messages are
35479 stored in or read from files (or pipes), in a format in which SMTP commands are
35480 used to contain the envelope information.
35481
35482
35483
35484 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35485 .cindex "SMTP" "outgoing over TCP/IP"
35486 .cindex "outgoing SMTP over TCP/IP"
35487 .cindex "LMTP" "over TCP/IP"
35488 .cindex "outgoing LMTP over TCP/IP"
35489 .cindex "EHLO"
35490 .cindex "HELO"
35491 .cindex "SIZE option on MAIL command"
35492 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35493 The &%protocol%& option selects which protocol is to be used, but the actual
35494 processing is the same in both cases.
35495
35496 If, in response to its EHLO command, Exim is told that the SIZE
35497 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35498 command. The value of <&'n'&> is the message size plus the value of the
35499 &%size_addition%& option (default 1024) to allow for additions to the message
35500 such as per-transport header lines, or changes made in a
35501 .cindex "transport" "filter"
35502 .cindex "filter" "transport filter"
35503 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35504 suppressed.
35505
35506 If the remote server advertises support for PIPELINING, Exim uses the
35507 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35508 required for the transaction.
35509
35510 If the remote server advertises support for the STARTTLS command, and Exim
35511 was built to support TLS encryption, it tries to start a TLS session unless the
35512 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35513 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35514 is called for verification.
35515
35516 If the remote server advertises support for the AUTH command, Exim scans
35517 the authenticators configuration for any suitable client settings, as described
35518 in chapter &<<CHAPSMTPAUTH>>&.
35519
35520 .cindex "carriage return"
35521 .cindex "linefeed"
35522 Responses from the remote host are supposed to be terminated by CR followed by
35523 LF. However, there are known to be hosts that do not send CR characters, so in
35524 order to be able to interwork with such hosts, Exim treats LF on its own as a
35525 line terminator.
35526
35527 If a message contains a number of different addresses, all those with the same
35528 characteristics (for example, the same envelope sender) that resolve to the
35529 same set of hosts, in the same order, are sent in a single SMTP transaction,
35530 even if they are for different domains, unless there are more than the setting
35531 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35532 they are split into groups containing no more than &%max_rcpt%&s addresses
35533 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35534 in parallel sessions. The order of hosts with identical MX values is not
35535 significant when checking whether addresses can be batched in this way.
35536
35537 When the &(smtp)& transport suffers a temporary failure that is not
35538 message-related, Exim updates its transport-specific database, which contains
35539 records indexed by host name that remember which messages are waiting for each
35540 particular host. It also updates the retry database with new retry times.
35541
35542 .cindex "hints database" "retry keys"
35543 Exim's retry hints are based on host name plus IP address, so if one address of
35544 a multi-homed host is broken, it will soon be skipped most of the time.
35545 See the next section for more detail about error handling.
35546
35547 .cindex "SMTP" "passed connection"
35548 .cindex "SMTP" "batching over TCP/IP"
35549 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35550 looks in the hints database for the transport to see if there are any queued
35551 messages waiting for the host to which it is connected. If it finds one, it
35552 creates a new Exim process using the &%-MC%& option (which can only be used by
35553 a process running as root or the Exim user) and passes the TCP/IP socket to it
35554 so that it can deliver another message using the same socket. The new process
35555 does only those deliveries that are routed to the connected host, and may in
35556 turn pass the socket on to a third process, and so on.
35557
35558 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35559 limit the number of messages sent down a single TCP/IP connection.
35560
35561 .cindex "asterisk" "after IP address"
35562 The second and subsequent messages delivered down an existing connection are
35563 identified in the main log by the addition of an asterisk after the closing
35564 square bracket of the IP address.
35565
35566
35567
35568
35569 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35570 .cindex "error" "in outgoing SMTP"
35571 .cindex "SMTP" "errors in outgoing"
35572 .cindex "host" "error"
35573 Three different kinds of error are recognized for outgoing SMTP: host errors,
35574 message errors, and recipient errors.
35575
35576 .vlist
35577 .vitem "&*Host errors*&"
35578 A host error is not associated with a particular message or with a
35579 particular recipient of a message. The host errors are:
35580
35581 .ilist
35582 Connection refused or timed out,
35583 .next
35584 Any error response code on connection,
35585 .next
35586 Any error response code to EHLO or HELO,
35587 .next
35588 Loss of connection at any time, except after &"."&,
35589 .next
35590 I/O errors at any time,
35591 .next
35592 Timeouts during the session, other than in response to MAIL, RCPT or
35593 the &"."& at the end of the data.
35594 .endlist ilist
35595
35596 For a host error, a permanent error response on connection, or in response to
35597 EHLO, causes all addresses routed to the host to be failed. Any other host
35598 error causes all addresses to be deferred, and retry data to be created for the
35599 host. It is not tried again, for any message, until its retry time arrives. If
35600 the current set of addresses are not all delivered in this run (to some
35601 alternative host), the message is added to the list of those waiting for this
35602 host, so if it is still undelivered when a subsequent successful delivery is
35603 made to the host, it will be sent down the same SMTP connection.
35604
35605 .vitem "&*Message errors*&"
35606 .cindex "message" "error"
35607 A message error is associated with a particular message when sent to a
35608 particular host, but not with a particular recipient of the message. The
35609 message errors are:
35610
35611 .ilist
35612 Any error response code to MAIL, DATA, or the &"."& that terminates
35613 the data,
35614 .next
35615 Timeout after MAIL,
35616 .next
35617 Timeout or loss of connection after the &"."& that terminates the data. A
35618 timeout after the DATA command itself is treated as a host error, as is loss of
35619 connection at any other time.
35620 .endlist ilist
35621
35622 For a message error, a permanent error response (5&'xx'&) causes all addresses
35623 to be failed, and a delivery error report to be returned to the sender. A
35624 temporary error response (4&'xx'&), or one of the timeouts, causes all
35625 addresses to be deferred. Retry data is not created for the host, but instead,
35626 a retry record for the combination of host plus message id is created. The
35627 message is not added to the list of those waiting for this host. This ensures
35628 that the failing message will not be sent to this host again until the retry
35629 time arrives. However, other messages that are routed to the host are not
35630 affected, so if it is some property of the message that is causing the error,
35631 it will not stop the delivery of other mail.
35632
35633 If the remote host specified support for the SIZE parameter in its response
35634 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35635 over-large message will cause a message error because the error arrives as a
35636 response to MAIL.
35637
35638 .vitem "&*Recipient errors*&"
35639 .cindex "recipient" "error"
35640 A recipient error is associated with a particular recipient of a message. The
35641 recipient errors are:
35642
35643 .ilist
35644 Any error response to RCPT,
35645 .next
35646 Timeout after RCPT.
35647 .endlist
35648
35649 For a recipient error, a permanent error response (5&'xx'&) causes the
35650 recipient address to be failed, and a bounce message to be returned to the
35651 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35652 address to be deferred, and routing retry data to be created for it. This is
35653 used to delay processing of the address in subsequent queue runs, until its
35654 routing retry time arrives. This applies to all messages, but because it
35655 operates only in queue runs, one attempt will be made to deliver a new message
35656 to the failing address before the delay starts to operate. This ensures that,
35657 if the failure is really related to the message rather than the recipient
35658 (&"message too big for this recipient"& is a possible example), other messages
35659 have a chance of getting delivered. If a delivery to the address does succeed,
35660 the retry information gets cleared, so all stuck messages get tried again, and
35661 the retry clock is reset.
35662
35663 The message is not added to the list of those waiting for this host. Use of the
35664 host for other messages is unaffected, and except in the case of a timeout,
35665 other recipients are processed independently, and may be successfully delivered
35666 in the current SMTP session. After a timeout it is of course impossible to
35667 proceed with the session, so all addresses get deferred. However, those other
35668 than the one that failed do not suffer any subsequent retry delays. Therefore,
35669 if one recipient is causing trouble, the others have a chance of getting
35670 through when a subsequent delivery attempt occurs before the failing
35671 recipient's retry time.
35672 .endlist
35673
35674 In all cases, if there are other hosts (or IP addresses) available for the
35675 current set of addresses (for example, from multiple MX records), they are
35676 tried in this run for any undelivered addresses, subject of course to their
35677 own retry data. In other words, recipient error retry data does not take effect
35678 until the next delivery attempt.
35679
35680 Some hosts have been observed to give temporary error responses to every
35681 MAIL command at certain times (&"insufficient space"& has been seen). It
35682 would be nice if such circumstances could be recognized, and defer data for the
35683 host itself created, but this is not possible within the current Exim design.
35684 What actually happens is that retry data for every (host, message) combination
35685 is created.
35686
35687 The reason that timeouts after MAIL and RCPT are treated specially is that
35688 these can sometimes arise as a result of the remote host's verification
35689 procedures. Exim makes this assumption, and treats them as if a temporary error
35690 response had been received. A timeout after &"."& is treated specially because
35691 it is known that some broken implementations fail to recognize the end of the
35692 message if the last character of the last line is a binary zero. Thus, it is
35693 helpful to treat this case as a message error.
35694
35695 Timeouts at other times are treated as host errors, assuming a problem with the
35696 host, or the connection to it. If a timeout after MAIL, RCPT,
35697 or &"."& is really a connection problem, the assumption is that at the next try
35698 the timeout is likely to occur at some other point in the dialogue, causing it
35699 then to be treated as a host error.
35700
35701 There is experimental evidence that some MTAs drop the connection after the
35702 terminating &"."& if they do not like the contents of the message for some
35703 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35704 should be given. That is why Exim treats this case as a message rather than a
35705 host error, in order not to delay other messages to the same host.
35706
35707
35708
35709
35710 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35711 .cindex "SMTP" "incoming over TCP/IP"
35712 .cindex "incoming SMTP over TCP/IP"
35713 .cindex "inetd"
35714 .cindex "daemon"
35715 Incoming SMTP messages can be accepted in one of two ways: by running a
35716 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35717 &_/etc/inetd.conf_& should be like this:
35718 .code
35719 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35720 .endd
35721 Exim distinguishes between this case and the case of a locally running user
35722 agent using the &%-bs%& option by checking whether or not the standard input is
35723 a socket. When it is, either the port must be privileged (less than 1024), or
35724 the caller must be root or the Exim user. If any other user passes a socket
35725 with an unprivileged port number, Exim prints a message on the standard error
35726 stream and exits with an error code.
35727
35728 By default, Exim does not make a log entry when a remote host connects or
35729 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35730 unexpected. It can be made to write such log entries by setting the
35731 &%smtp_connection%& log selector.
35732
35733 .cindex "carriage return"
35734 .cindex "linefeed"
35735 Commands from the remote host are supposed to be terminated by CR followed by
35736 LF. However, there are known to be hosts that do not send CR characters. In
35737 order to be able to interwork with such hosts, Exim treats LF on its own as a
35738 line terminator.
35739 Furthermore, because common code is used for receiving messages from all
35740 sources, a CR on its own is also interpreted as a line terminator. However, the
35741 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35742
35743 .cindex "EHLO" "invalid data"
35744 .cindex "HELO" "invalid data"
35745 One area that sometimes gives rise to problems concerns the EHLO or
35746 HELO commands. Some clients send syntactically invalid versions of these
35747 commands, which Exim rejects by default. (This is nothing to do with verifying
35748 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35749 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35750 match the broken hosts that send invalid commands.
35751
35752 .cindex "SIZE option on MAIL command"
35753 .cindex "MAIL" "SIZE option"
35754 The amount of disk space available is checked whenever SIZE is received on
35755 a MAIL command, independently of whether &%message_size_limit%& or
35756 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35757 false. A temporary error is given if there is not enough space. If
35758 &%check_spool_space%& is set, the check is for that amount of space plus the
35759 value given with SIZE, that is, it checks that the addition of the incoming
35760 message will not reduce the space below the threshold.
35761
35762 When a message is successfully received, Exim includes the local message id in
35763 its response to the final &"."& that terminates the data. If the remote host
35764 logs this text it can help with tracing what has happened to a message.
35765
35766 The Exim daemon can limit the number of simultaneous incoming connections it is
35767 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35768 number of simultaneous incoming connections from a single remote host (see the
35769 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35770 rejected using the SMTP temporary error code 421.
35771
35772 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35773 subprocess has finished, as this can get lost at busy times. Instead, it looks
35774 for completed subprocesses every time it wakes up. Provided there are other
35775 things happening (new incoming calls, starts of queue runs), completed
35776 processes will be noticed and tidied away. On very quiet systems you may
35777 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35778 it will be noticed when the daemon next wakes up.
35779
35780 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35781 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35782 high system load &-- for details see the &%smtp_accept_reserve%&,
35783 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35784 applies in both the daemon and &'inetd'& cases.
35785
35786 Exim normally starts a delivery process for each message received, though this
35787 can be varied by means of the &%-odq%& command line option and the
35788 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35789 number of simultaneously running delivery processes started in this way from
35790 SMTP input can be limited by the &%smtp_accept_queue%& and
35791 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35792 subsequently received messages are just put on the input queue without starting
35793 a delivery process.
35794
35795 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35796 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35797 started up from the &'inetd'& daemon, because in that case each connection is
35798 handled by an entirely independent Exim process. Control by load average is,
35799 however, available with &'inetd'&.
35800
35801 Exim can be configured to verify addresses in incoming SMTP commands as they
35802 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35803 to rewrite addresses at this time &-- before any syntax checking is done. See
35804 section &<<SECTrewriteS>>&.
35805
35806 Exim can also be configured to limit the rate at which a client host submits
35807 MAIL and RCPT commands in a single SMTP session. See the
35808 &%smtp_ratelimit_hosts%& option.
35809
35810
35811
35812 .section "Unrecognized SMTP commands" "SECID234"
35813 .cindex "SMTP" "unrecognized commands"
35814 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35815 commands during a single SMTP connection, it drops the connection after sending
35816 the error response to the last command. The default value for
35817 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35818 abuse that subvert web servers into making connections to SMTP ports; in these
35819 circumstances, a number of non-SMTP lines are sent first.
35820
35821
35822 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35823 .cindex "SMTP" "syntax errors"
35824 .cindex "SMTP" "protocol errors"
35825 A syntax error is detected if an SMTP command is recognized, but there is
35826 something syntactically wrong with its data, for example, a malformed email
35827 address in a RCPT command. Protocol errors include invalid command
35828 sequencing such as RCPT before MAIL. If Exim receives more than
35829 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35830 drops the connection after sending the error response to the last command. The
35831 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35832 broken clients that loop sending bad commands (yes, it has been seen).
35833
35834
35835
35836 .section "Use of non-mail SMTP commands" "SECID236"
35837 .cindex "SMTP" "non-mail commands"
35838 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35839 DATA. Exim counts such commands, and drops the connection if there are too
35840 many of them in a single SMTP session. This action catches some
35841 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35842 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35843 defines what &"too many"& means. Its default value is 10.
35844
35845 When a new message is expected, one occurrence of RSET is not counted. This
35846 allows a client to send one RSET between messages (this is not necessary,
35847 but some clients do it). Exim also allows one uncounted occurrence of HELO
35848 or EHLO, and one occurrence of STARTTLS between messages. After
35849 starting up a TLS session, another EHLO is expected, and so it too is not
35850 counted.
35851
35852 The first occurrence of AUTH in a connection, or immediately following
35853 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35854 RCPT, DATA, and QUIT are counted.
35855
35856 You can control which hosts are subject to the limit set by
35857 &%smtp_accept_max_nonmail%& by setting
35858 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35859 the limit apply to all hosts. This option means that you can exclude any
35860 specific badly-behaved hosts that you have to live with.
35861
35862
35863
35864
35865 .section "The VRFY and EXPN commands" "SECID237"
35866 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35867 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35868 appropriate) in order to decide whether the command should be accepted or not.
35869
35870 .cindex "VRFY" "processing"
35871 When no ACL is defined for VRFY, or if it rejects without
35872 setting an explicit response code, the command is accepted
35873 (with a 252 SMTP response code)
35874 in order to support awkward clients that do a VRFY before every RCPT.
35875 When VRFY is accepted, it runs exactly the same code as when Exim is
35876 called with the &%-bv%& option, and returns 250/451/550
35877 SMTP response codes.
35878
35879 .cindex "EXPN" "processing"
35880 If no ACL for EXPN is defined, the command is rejected.
35881 When EXPN is accepted, a single-level expansion of the address is done.
35882 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35883 than a verification (the &%-bv%& option). If an unqualified local part is given
35884 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35885 of VRFY and EXPN commands are logged on the main and reject logs, and
35886 VRFY verification failures are logged on the main log for consistency with
35887 RCPT failures.
35888
35889
35890
35891 .section "The ETRN command" "SECTETRN"
35892 .cindex "ETRN" "processing"
35893 RFC 1985 describes an SMTP command called ETRN that is designed to
35894 overcome the security problems of the TURN command (which has fallen into
35895 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35896 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35897 should be accepted or not. If no ACL is defined, the command is rejected.
35898
35899 The ETRN command is concerned with &"releasing"& messages that are awaiting
35900 delivery to certain hosts. As Exim does not organize its message queue by host,
35901 the only form of ETRN that is supported by default is the one where the
35902 text starts with the &"#"& prefix, in which case the remainder of the text is
35903 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35904 the &%-R%& option to happen, with the remainder of the ETRN text as its
35905 argument. For example,
35906 .code
35907 ETRN #brigadoon
35908 .endd
35909 runs the command
35910 .code
35911 exim -R brigadoon
35912 .endd
35913 which causes a delivery attempt on all messages with undelivered addresses
35914 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35915 default), Exim prevents the simultaneous execution of more than one queue run
35916 for the same argument string as a result of an ETRN command. This stops
35917 a misbehaving client from starting more than one queue runner at once.
35918
35919 .cindex "hints database" "ETRN serialization"
35920 Exim implements the serialization by means of a hints database in which a
35921 record is written whenever a process is started by ETRN, and deleted when
35922 the process completes. However, Exim does not keep the SMTP session waiting for
35923 the ETRN process to complete. Once ETRN is accepted, the client is sent
35924 a &"success"& return code. Obviously there is scope for hints records to get
35925 left lying around if there is a system or program crash. To guard against this,
35926 Exim ignores any records that are more than six hours old.
35927
35928 .oindex "&%smtp_etrn_command%&"
35929 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35930 used. This specifies a command that is run whenever ETRN is received,
35931 whatever the form of its argument. For
35932 example:
35933 .code
35934 smtp_etrn_command = /etc/etrn_command $domain \
35935                     $sender_host_address
35936 .endd
35937 .vindex "&$domain$&"
35938 The string is split up into arguments which are independently expanded. The
35939 expansion variable &$domain$& is set to the argument of the ETRN command,
35940 and no syntax checking is done on the contents of this argument. Exim does not
35941 wait for the command to complete, so its status code is not checked. Exim runs
35942 under its own uid and gid when receiving incoming SMTP, so it is not possible
35943 for it to change them before running the command.
35944
35945
35946
35947 .section "Incoming local SMTP" "SECID238"
35948 .cindex "SMTP" "local incoming"
35949 Some user agents use SMTP to pass messages to their local MTA using the
35950 standard input and output, as opposed to passing the envelope on the command
35951 line and writing the message to the standard input. This is supported by the
35952 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35953 messages over TCP/IP (including the use of ACLs), except that the envelope
35954 sender given in a MAIL command is ignored unless the caller is trusted. In
35955 an ACL you can detect this form of SMTP input by testing for an empty host
35956 identification. It is common to have this as the first line in the ACL that
35957 runs for RCPT commands:
35958 .code
35959 accept hosts = :
35960 .endd
35961 This accepts SMTP messages from local processes without doing any other tests.
35962
35963
35964
35965 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35966 .cindex "SMTP" "batched outgoing"
35967 .cindex "batched SMTP output"
35968 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35969 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35970 be output in BSMTP format. No SMTP responses are possible for this form of
35971 delivery. All it is doing is using SMTP commands as a way of transmitting the
35972 envelope along with the message.
35973
35974 The message is written to the file or pipe preceded by the SMTP commands
35975 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35976 the message that start with a dot have an extra dot added. The SMTP command
35977 HELO is not normally used. If it is required, the &%message_prefix%& option
35978 can be used to specify it.
35979
35980 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35981 one recipient address at a time by default. However, you can arrange for them
35982 to handle several addresses at once by setting the &%batch_max%& option. When
35983 this is done for BSMTP, messages may contain multiple RCPT commands. See
35984 chapter &<<CHAPbatching>>& for more details.
35985
35986 .vindex "&$host$&"
35987 When one or more addresses are routed to a BSMTP transport by a router that
35988 sets up a host list, the name of the first host on the list is available to the
35989 transport in the variable &$host$&. Here is an example of such a transport and
35990 router:
35991 .code
35992 begin routers
35993 route_append:
35994   driver = manualroute
35995   transport = smtp_appendfile
35996   route_list = domain.example  batch.host.example
35997
35998 begin transports
35999 smtp_appendfile:
36000   driver = appendfile
36001   directory = /var/bsmtp/$host
36002   batch_max = 1000
36003   use_bsmtp
36004   user = exim
36005 .endd
36006 This causes messages addressed to &'domain.example'& to be written in BSMTP
36007 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36008 message (unless there are more than 1000 recipients).
36009
36010
36011
36012 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36013 .cindex "SMTP" "batched incoming"
36014 .cindex "batched SMTP input"
36015 The &%-bS%& command line option causes Exim to accept one or more messages by
36016 reading SMTP on the standard input, but to generate no responses. If the caller
36017 is trusted, the senders in the MAIL commands are believed; otherwise the
36018 sender is always the caller of Exim. Unqualified senders and receivers are not
36019 rejected (there seems little point) but instead just get qualified. HELO
36020 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36021 as NOOP; QUIT quits.
36022
36023 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36024 ACL is run in the same way as for non-SMTP local input.
36025
36026 If an error is detected while reading a message, including a missing &"."& at
36027 the end, Exim gives up immediately. It writes details of the error to the
36028 standard output in a stylized way that the calling program should be able to
36029 make some use of automatically, for example:
36030 .code
36031 554 Unexpected end of file
36032 Transaction started in line 10
36033 Error detected in line 14
36034 .endd
36035 It writes a more verbose version, for human consumption, to the standard error
36036 file, for example:
36037 .code
36038 An error was detected while processing a file of BSMTP input.
36039 The error message was:
36040
36041 501 '>' missing at end of address
36042
36043 The SMTP transaction started in line 10.
36044 The error was detected in line 12.
36045 The SMTP command at fault was:
36046
36047 rcpt to:<malformed@in.com.plete
36048
36049 1 previous message was successfully processed.
36050 The rest of the batch was abandoned.
36051 .endd
36052 The return code from Exim is zero only if there were no errors. It is 1 if some
36053 messages were accepted before an error was detected, and 2 if no messages were
36054 accepted.
36055 .ecindex IIDsmtpproc1
36056 .ecindex IIDsmtpproc2
36057
36058
36059
36060 . ////////////////////////////////////////////////////////////////////////////
36061 . ////////////////////////////////////////////////////////////////////////////
36062
36063 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36064          "Customizing messages"
36065 When a message fails to be delivered, or remains in the queue for more than a
36066 configured amount of time, Exim sends a message to the original sender, or
36067 to an alternative configured address. The text of these messages is built into
36068 the code of Exim, but it is possible to change it, either by adding a single
36069 string, or by replacing each of the paragraphs by text supplied in a file.
36070
36071 The &'From:'& and &'To:'& header lines are automatically generated; you can
36072 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36073 option. Exim also adds the line
36074 .code
36075 Auto-Submitted: auto-generated
36076 .endd
36077 to all warning and bounce messages,
36078
36079
36080 .section "Customizing bounce messages" "SECID239"
36081 .cindex "customizing" "bounce message"
36082 .cindex "bounce message" "customizing"
36083 If &%bounce_message_text%& is set, its contents are included in the default
36084 message immediately after &"This message was created automatically by mail
36085 delivery software."& The string is not expanded. It is not used if
36086 &%bounce_message_file%& is set.
36087
36088 When &%bounce_message_file%& is set, it must point to a template file for
36089 constructing error messages. The file consists of a series of text items,
36090 separated by lines consisting of exactly four asterisks. If the file cannot be
36091 opened, default text is used and a message is written to the main and panic
36092 logs. If any text item in the file is empty, default text is used for that
36093 item.
36094
36095 .vindex "&$bounce_recipient$&"
36096 .vindex "&$bounce_return_size_limit$&"
36097 Each item of text that is read from the file is expanded, and there are two
36098 expansion variables which can be of use here: &$bounce_recipient$& is set to
36099 the recipient of an error message while it is being created, and
36100 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36101 option, rounded to a whole number.
36102
36103 The items must appear in the file in the following order:
36104
36105 .ilist
36106 The first item is included in the headers, and should include at least a
36107 &'Subject:'& header. Exim does not check the syntax of these headers.
36108 .next
36109 The second item forms the start of the error message. After it, Exim lists the
36110 failing addresses with their error messages.
36111 .next
36112 The third item is used to introduce any text from pipe transports that is to be
36113 returned to the sender. It is omitted if there is no such text.
36114 .next
36115 The fourth, fifth and sixth items will be ignored and may be empty.
36116 The fields exist for back-compatibility
36117 .endlist
36118
36119 The default state (&%bounce_message_file%& unset) is equivalent to the
36120 following file, in which the sixth item is empty. The &'Subject:'& and some
36121 other lines have been split in order to fit them on the page:
36122 .code
36123 Subject: Mail delivery failed
36124   ${if eq{$sender_address}{$bounce_recipient}
36125   {: returning message to sender}}
36126 ****
36127 This message was created automatically by mail delivery software.
36128
36129 A message ${if eq{$sender_address}{$bounce_recipient}
36130   {that you sent }{sent by
36131
36132 <$sender_address>
36133
36134 }}could not be delivered to all of its recipients.
36135 This is a permanent error. The following address(es) failed:
36136 ****
36137 The following text was generated during the delivery attempt(s):
36138 ****
36139 ------ This is a copy of the message, including all the headers.
36140   ------
36141 ****
36142 ------ The body of the message is $message_size characters long;
36143   only the first
36144 ------ $bounce_return_size_limit or so are included here.
36145 ****
36146 .endd
36147 .section "Customizing warning messages" "SECTcustwarn"
36148 .cindex "customizing" "warning message"
36149 .cindex "warning of delay" "customizing the message"
36150 The option &%warn_message_file%& can be pointed at a template file for use when
36151 warnings about message delays are created. In this case there are only three
36152 text sections:
36153
36154 .ilist
36155 The first item is included in the headers, and should include at least a
36156 &'Subject:'& header. Exim does not check the syntax of these headers.
36157 .next
36158 The second item forms the start of the warning message. After it, Exim lists
36159 the delayed addresses.
36160 .next
36161 The third item then ends the message.
36162 .endlist
36163
36164 The default state is equivalent to the following file, except that some lines
36165 have been split here, in order to fit them on the page:
36166 .code
36167 Subject: Warning: message $message_exim_id delayed
36168   $warn_message_delay
36169 ****
36170 This message was created automatically by mail delivery software.
36171
36172 A message ${if eq{$sender_address}{$warn_message_recipients}
36173 {that you sent }{sent by
36174
36175 <$sender_address>
36176
36177 }}has not been delivered to all of its recipients after
36178 more than $warn_message_delay in the queue on $primary_hostname.
36179
36180 The message identifier is:     $message_exim_id
36181 The subject of the message is: $h_subject
36182 The date of the message is:    $h_date
36183
36184 The following address(es) have not yet been delivered:
36185 ****
36186 No action is required on your part. Delivery attempts will
36187 continue for some time, and this warning may be repeated at
36188 intervals if the message remains undelivered. Eventually the
36189 mail delivery software will give up, and when that happens,
36190 the message will be returned to you.
36191 .endd
36192 .vindex "&$warn_message_delay$&"
36193 .vindex "&$warn_message_recipients$&"
36194 However, in the default state the subject and date lines are omitted if no
36195 appropriate headers exist. During the expansion of this file,
36196 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36197 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36198 of recipients for the warning message. There may be more than one if there are
36199 multiple addresses with different &%errors_to%& settings on the routers that
36200 handled them.
36201
36202
36203
36204
36205 . ////////////////////////////////////////////////////////////////////////////
36206 . ////////////////////////////////////////////////////////////////////////////
36207
36208 .chapter "Some common configuration settings" "CHAPcomconreq"
36209 This chapter discusses some configuration settings that seem to be fairly
36210 common. More examples and discussion can be found in the Exim book.
36211
36212
36213
36214 .section "Sending mail to a smart host" "SECID240"
36215 .cindex "smart host" "example router"
36216 If you want to send all mail for non-local domains to a &"smart host"&, you
36217 should replace the default &(dnslookup)& router with a router which does the
36218 routing explicitly:
36219 .code
36220 send_to_smart_host:
36221   driver = manualroute
36222   route_list = !+local_domains smart.host.name
36223   transport = remote_smtp
36224 .endd
36225 You can use the smart host's IP address instead of the name if you wish.
36226 If you are using Exim only to submit messages to a smart host, and not for
36227 receiving incoming messages, you can arrange for it to do the submission
36228 synchronously by setting the &%mua_wrapper%& option (see chapter
36229 &<<CHAPnonqueueing>>&).
36230
36231
36232
36233
36234 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36235 .cindex "mailing lists"
36236 Exim can be used to run simple mailing lists, but for large and/or complicated
36237 requirements, the use of additional specialized mailing list software such as
36238 Majordomo or Mailman is recommended.
36239
36240 The &(redirect)& router can be used to handle mailing lists where each list
36241 is maintained in a separate file, which can therefore be managed by an
36242 independent manager. The &%domains%& router option can be used to run these
36243 lists in a separate domain from normal mail. For example:
36244 .code
36245 lists:
36246   driver = redirect
36247   domains = lists.example
36248   file = /usr/lists/$local_part
36249   forbid_pipe
36250   forbid_file
36251   errors_to = $local_part-request@lists.example
36252   no_more
36253 .endd
36254 This router is skipped for domains other than &'lists.example'&. For addresses
36255 in that domain, it looks for a file that matches the local part. If there is no
36256 such file, the router declines, but because &%no_more%& is set, no subsequent
36257 routers are tried, and so the whole delivery fails.
36258
36259 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36260 expanded into a filename or a pipe delivery, which is usually inappropriate in
36261 a mailing list.
36262
36263 .oindex "&%errors_to%&"
36264 The &%errors_to%& option specifies that any delivery errors caused by addresses
36265 taken from a mailing list are to be sent to the given address rather than the
36266 original sender of the message. However, before acting on this, Exim verifies
36267 the error address, and ignores it if verification fails.
36268
36269 For example, using the configuration above, mail sent to
36270 &'dicts@lists.example'& is passed on to those addresses contained in
36271 &_/usr/lists/dicts_&, with error reports directed to
36272 &'dicts-request@lists.example'&, provided that this address can be verified.
36273 There could be a file called &_/usr/lists/dicts-request_& containing
36274 the address(es) of this particular list's manager(s), but other approaches,
36275 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36276 or &%local_part_suffix%& options) to handle addresses of the form
36277 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36278
36279
36280
36281 .section "Syntax errors in mailing lists" "SECID241"
36282 .cindex "mailing lists" "syntax errors in"
36283 If an entry in redirection data contains a syntax error, Exim normally defers
36284 delivery of the original address. That means that a syntax error in a mailing
36285 list holds up all deliveries to the list. This may not be appropriate when a
36286 list is being maintained automatically from data supplied by users, and the
36287 addresses are not rigorously checked.
36288
36289 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36290 entries that fail to parse, noting the incident in the log. If in addition
36291 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36292 whenever a broken address is skipped. It is usually appropriate to set
36293 &%syntax_errors_to%& to the same address as &%errors_to%&.
36294
36295
36296
36297 .section "Re-expansion of mailing lists" "SECID242"
36298 .cindex "mailing lists" "re-expansion of"
36299 Exim remembers every individual address to which a message has been delivered,
36300 in order to avoid duplication, but it normally stores only the original
36301 recipient addresses with a message. If all the deliveries to a mailing list
36302 cannot be done at the first attempt, the mailing list is re-expanded when the
36303 delivery is next tried. This means that alterations to the list are taken into
36304 account at each delivery attempt, so addresses that have been added to
36305 the list since the message arrived will therefore receive a copy of the
36306 message, even though it pre-dates their subscription.
36307
36308 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36309 on the &(redirect)& router. If this is done, any addresses generated by the
36310 router that fail to deliver at the first attempt are added to the message as
36311 &"top level"& addresses, and the parent address that generated them is marked
36312 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36313 subsequent delivery attempts. The disadvantage of this is that if any of the
36314 failing addresses are incorrect, correcting them in the file has no effect on
36315 pre-existing messages.
36316
36317 The original top-level address is remembered with each of the generated
36318 addresses, and is output in any log messages. However, any intermediate parent
36319 addresses are not recorded. This makes a difference to the log only if the
36320 &%all_parents%& selector is set, but for mailing lists there is normally only
36321 one level of expansion anyway.
36322
36323
36324
36325 .section "Closed mailing lists" "SECID243"
36326 .cindex "mailing lists" "closed"
36327 The examples so far have assumed open mailing lists, to which anybody may
36328 send mail. It is also possible to set up closed lists, where mail is accepted
36329 from specified senders only. This is done by making use of the generic
36330 &%senders%& option to restrict the router that handles the list.
36331
36332 The following example uses the same file as a list of recipients and as a list
36333 of permitted senders. It requires three routers:
36334 .code
36335 lists_request:
36336   driver = redirect
36337   domains = lists.example
36338   local_part_suffix = -request
36339   file = /usr/lists/$local_part$local_part_suffix
36340   no_more
36341
36342 lists_post:
36343   driver = redirect
36344   domains = lists.example
36345   senders = ${if exists {/usr/lists/$local_part}\
36346              {lsearch;/usr/lists/$local_part}{*}}
36347   file = /usr/lists/$local_part
36348   forbid_pipe
36349   forbid_file
36350   errors_to = $local_part-request@lists.example
36351   no_more
36352
36353 lists_closed:
36354   driver = redirect
36355   domains = lists.example
36356   allow_fail
36357   data = :fail: $local_part@lists.example is a closed mailing list
36358 .endd
36359 All three routers have the same &%domains%& setting, so for any other domains,
36360 they are all skipped. The first router runs only if the local part ends in
36361 &%-request%&. It handles messages to the list manager(s) by means of an open
36362 mailing list.
36363
36364 The second router runs only if the &%senders%& precondition is satisfied. It
36365 checks for the existence of a list that corresponds to the local part, and then
36366 checks that the sender is on the list by means of a linear search. It is
36367 necessary to check for the existence of the file before trying to search it,
36368 because otherwise Exim thinks there is a configuration error. If the file does
36369 not exist, the expansion of &%senders%& is *, which matches all senders. This
36370 means that the router runs, but because there is no list, declines, and
36371 &%no_more%& ensures that no further routers are run. The address fails with an
36372 &"unrouteable address"& error.
36373
36374 The third router runs only if the second router is skipped, which happens when
36375 a mailing list exists, but the sender is not on it. This router forcibly fails
36376 the address, giving a suitable error message.
36377
36378
36379
36380
36381 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36382 .cindex "VERP"
36383 .cindex "Variable Envelope Return Paths"
36384 .cindex "envelope from"
36385 .cindex "envelope sender"
36386 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36387 are a way of helping mailing list administrators discover which subscription
36388 address is the cause of a particular delivery failure. The idea is to encode
36389 the original recipient address in the outgoing envelope sender address, so that
36390 if the message is forwarded by another host and then subsequently bounces, the
36391 original recipient can be extracted from the recipient address of the bounce.
36392
36393 .oindex &%errors_to%&
36394 .oindex &%return_path%&
36395 Envelope sender addresses can be modified by Exim using two different
36396 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36397 list examples), or the &%return_path%& option on a transport. The second of
36398 these is effective only if the message is successfully delivered to another
36399 host; it is not used for errors detected on the local host (see the description
36400 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36401 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36402 .code
36403 verp_smtp:
36404   driver = smtp
36405   max_rcpt = 1
36406   return_path = \
36407     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36408       {$1-request+$local_part=$domain@your.dom.example}fail}
36409 .endd
36410 This has the effect of rewriting the return path (envelope sender) on outgoing
36411 SMTP messages, if the local part of the original return path ends in
36412 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36413 local part and domain of the recipient into the return path. Suppose, for
36414 example, that a message whose return path has been set to
36415 &'somelist-request@your.dom.example'& is sent to
36416 &'subscriber@other.dom.example'&. In the transport, the return path is
36417 rewritten as
36418 .code
36419 somelist-request+subscriber=other.dom.example@your.dom.example
36420 .endd
36421 .vindex "&$local_part$&"
36422 For this to work, you must tell Exim to send multiple copies of messages that
36423 have more than one recipient, so that each copy has just one recipient. This is
36424 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36425 might be sent to several different recipients in the same domain, in which case
36426 &$local_part$& is not available in the transport, because it is not unique.
36427
36428 Unless your host is doing nothing but mailing list deliveries, you should
36429 probably use a separate transport for the VERP deliveries, so as not to use
36430 extra resources in making one-per-recipient copies for other deliveries. This
36431 can easily be done by expanding the &%transport%& option in the router:
36432 .code
36433 dnslookup:
36434   driver = dnslookup
36435   domains = ! +local_domains
36436   transport = \
36437     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36438       {verp_smtp}{remote_smtp}}
36439   no_more
36440 .endd
36441 If you want to change the return path using &%errors_to%& in a router instead
36442 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36443 routers that handle mailing list addresses. This will ensure that all delivery
36444 errors, including those detected on the local host, are sent to the VERP
36445 address.
36446
36447 On a host that does no local deliveries and has no manual routing, only the
36448 &(dnslookup)& router needs to be changed. A special transport is not needed for
36449 SMTP deliveries. Every mailing list recipient has its own return path value,
36450 and so Exim must hand them to the transport one at a time. Here is an example
36451 of a &(dnslookup)& router that implements VERP:
36452 .code
36453 verp_dnslookup:
36454   driver = dnslookup
36455   domains = ! +local_domains
36456   transport = remote_smtp
36457   errors_to = \
36458     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36459      {$1-request+$local_part=$domain@your.dom.example}fail}
36460   no_more
36461 .endd
36462 Before you start sending out messages with VERPed return paths, you must also
36463 configure Exim to accept the bounce messages that come back to those paths.
36464 Typically this is done by setting a &%local_part_suffix%& option for a
36465 router, and using this to route the messages to wherever you want to handle
36466 them.
36467
36468 The overhead incurred in using VERP depends very much on the size of the
36469 message, the number of recipient addresses that resolve to the same remote
36470 host, and the speed of the connection over which the message is being sent. If
36471 a lot of addresses resolve to the same host and the connection is slow, sending
36472 a separate copy of the message for each address may take substantially longer
36473 than sending a single copy with many recipients (for which VERP cannot be
36474 used).
36475
36476
36477
36478
36479
36480
36481 .section "Virtual domains" "SECTvirtualdomains"
36482 .cindex "virtual domains"
36483 .cindex "domain" "virtual"
36484 The phrase &'virtual domain'& is unfortunately used with two rather different
36485 meanings:
36486
36487 .ilist
36488 A domain for which there are no real mailboxes; all valid local parts are
36489 aliases for other email addresses. Common examples are organizational
36490 top-level domains and &"vanity"& domains.
36491 .next
36492 One of a number of independent domains that are all handled by the same host,
36493 with mailboxes on that host, but where the mailbox owners do not necessarily
36494 have login accounts on that host.
36495 .endlist
36496
36497 The first usage is probably more common, and does seem more &"virtual"& than
36498 the second. This kind of domain can be handled in Exim with a straightforward
36499 aliasing router. One approach is to create a separate alias file for each
36500 virtual domain. Exim can test for the existence of the alias file to determine
36501 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36502 to a router of this form:
36503 .code
36504 virtual:
36505   driver = redirect
36506   domains = dsearch;/etc/mail/virtual
36507   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36508   no_more
36509 .endd
36510 The &%domains%& option specifies that the router is to be skipped, unless there
36511 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36512 domain that is being processed. When the router runs, it looks up the local
36513 part in the file to find a new address (or list of addresses). The &%no_more%&
36514 setting ensures that if the lookup fails (leading to &%data%& being an empty
36515 string), Exim gives up on the address without trying any subsequent routers.
36516
36517 This one router can handle all the virtual domains because the alias filenames
36518 follow a fixed pattern. Permissions can be arranged so that appropriate people
36519 can edit the different alias files. A successful aliasing operation results in
36520 a new envelope recipient address, which is then routed from scratch.
36521
36522 The other kind of &"virtual"& domain can also be handled in a straightforward
36523 way. One approach is to create a file for each domain containing a list of
36524 valid local parts, and use it in a router like this:
36525 .code
36526 my_domains:
36527   driver = accept
36528   domains = dsearch;/etc/mail/domains
36529   local_parts = lsearch;/etc/mail/domains/$domain
36530   transport = my_mailboxes
36531 .endd
36532 The address is accepted if there is a file for the domain, and the local part
36533 can be found in the file. The &%domains%& option is used to check for the
36534 file's existence because &%domains%& is tested before the &%local_parts%&
36535 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36536 because that option is tested after &%local_parts%&. The transport is as
36537 follows:
36538 .code
36539 my_mailboxes:
36540   driver = appendfile
36541   file = /var/mail/$domain/$local_part
36542   user = mail
36543 .endd
36544 This uses a directory of mailboxes for each domain. The &%user%& setting is
36545 required, to specify which uid is to be used for writing to the mailboxes.
36546
36547 The configuration shown here is just one example of how you might support this
36548 requirement. There are many other ways this kind of configuration can be set
36549 up, for example, by using a database instead of separate files to hold all the
36550 information about the domains.
36551
36552
36553
36554 .section "Multiple user mailboxes" "SECTmulbox"
36555 .cindex "multiple mailboxes"
36556 .cindex "mailbox" "multiple"
36557 .cindex "local part" "prefix"
36558 .cindex "local part" "suffix"
36559 Heavy email users often want to operate with multiple mailboxes, into which
36560 incoming mail is automatically sorted. A popular way of handling this is to
36561 allow users to use multiple sender addresses, so that replies can easily be
36562 identified. Users are permitted to add prefixes or suffixes to their local
36563 parts for this purpose. The wildcard facility of the generic router options
36564 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36565 example, consider this router:
36566 .code
36567 userforward:
36568   driver = redirect
36569   check_local_user
36570   file = $home/.forward
36571   local_part_suffix = -*
36572   local_part_suffix_optional
36573   allow_filter
36574 .endd
36575 .vindex "&$local_part_suffix$&"
36576 It runs a user's &_.forward_& file for all local parts of the form
36577 &'username-*'&. Within the filter file the user can distinguish different
36578 cases by testing the variable &$local_part_suffix$&. For example:
36579 .code
36580 if $local_part_suffix contains -special then
36581 save /home/$local_part/Mail/special
36582 endif
36583 .endd
36584 If the filter file does not exist, or does not deal with such addresses, they
36585 fall through to subsequent routers, and, assuming no subsequent use of the
36586 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36587 control over which suffixes are valid.
36588
36589 Alternatively, a suffix can be used to trigger the use of a different
36590 &_.forward_& file &-- which is the way a similar facility is implemented in
36591 another MTA:
36592 .code
36593 userforward:
36594   driver = redirect
36595   check_local_user
36596   file = $home/.forward$local_part_suffix
36597   local_part_suffix = -*
36598   local_part_suffix_optional
36599   allow_filter
36600 .endd
36601 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36602 example, &_.forward-special_& is used. Once again, if the appropriate file
36603 does not exist, or does not deal with the address, it is passed on to
36604 subsequent routers, which could, if required, look for an unqualified
36605 &_.forward_& file to use as a default.
36606
36607
36608
36609 .section "Simplified vacation processing" "SECID244"
36610 .cindex "vacation processing"
36611 The traditional way of running the &'vacation'& program is for a user to set up
36612 a pipe command in a &_.forward_& file
36613 (see section &<<SECTspecitredli>>& for syntax details).
36614 This is prone to error by inexperienced users. There are two features of Exim
36615 that can be used to make this process simpler for users:
36616
36617 .ilist
36618 A local part prefix such as &"vacation-"& can be specified on a router which
36619 can cause the message to be delivered directly to the &'vacation'& program, or
36620 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36621 &_.forward_& file are then much simpler. For example:
36622 .code
36623 spqr, vacation-spqr
36624 .endd
36625 .next
36626 The &%require_files%& generic router option can be used to trigger a
36627 vacation delivery by checking for the existence of a certain file in the
36628 user's home directory. The &%unseen%& generic option should also be used, to
36629 ensure that the original delivery also proceeds. In this case, all the user has
36630 to do is to create a file called, say, &_.vacation_&, containing a vacation
36631 message.
36632 .endlist
36633
36634 Another advantage of both these methods is that they both work even when the
36635 use of arbitrary pipes by users is locked out.
36636
36637
36638
36639 .section "Taking copies of mail" "SECID245"
36640 .cindex "message" "copying every"
36641 Some installations have policies that require archive copies of all messages to
36642 be made. A single copy of each message can easily be taken by an appropriate
36643 command in a system filter, which could, for example, use a different file for
36644 each day's messages.
36645
36646 There is also a shadow transport mechanism that can be used to take copies of
36647 messages that are successfully delivered by local transports, one copy per
36648 delivery. This could be used, &'inter alia'&, to implement automatic
36649 notification of delivery by sites that insist on doing such things.
36650
36651
36652
36653 .section "Intermittently connected hosts" "SECID246"
36654 .cindex "intermittently connected hosts"
36655 It has become quite common (because it is cheaper) for hosts to connect to the
36656 Internet periodically rather than remain connected all the time. The normal
36657 arrangement is that mail for such hosts accumulates on a system that is
36658 permanently connected.
36659
36660 Exim was designed for use on permanently connected hosts, and so it is not
36661 particularly well-suited to use in an intermittently connected environment.
36662 Nevertheless there are some features that can be used.
36663
36664
36665 .section "Exim on the upstream server host" "SECID247"
36666 It is tempting to arrange for incoming mail for the intermittently connected
36667 host to remain in Exim's queue until the client connects. However, this
36668 approach does not scale very well. Two different kinds of waiting message are
36669 being mixed up in the same queue &-- those that cannot be delivered because of
36670 some temporary problem, and those that are waiting for their destination host
36671 to connect. This makes it hard to manage the queue, as well as wasting
36672 resources, because each queue runner scans the entire queue.
36673
36674 A better approach is to separate off those messages that are waiting for an
36675 intermittently connected host. This can be done by delivering these messages
36676 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36677 format, from where they are transmitted by other software when their
36678 destination connects. This makes it easy to collect all the mail for one host
36679 in a single directory, and to apply local timeout rules on a per-message basis
36680 if required.
36681
36682 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36683 you are doing this, you should configure Exim with a long retry period for the
36684 intermittent host. For example:
36685 .code
36686 cheshire.wonderland.fict.example    *   F,5d,24h
36687 .endd
36688 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36689 which messages it has queued up for that host. Once the intermittent host comes
36690 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36691 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36692 causes all the queued up messages to be delivered, often down a single SMTP
36693 connection. While the host remains connected, any new messages get delivered
36694 immediately.
36695
36696 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36697 issued with a different IP address each time it connects, Exim's retry
36698 mechanisms on the holding host get confused, because the IP address is normally
36699 used as part of the key string for holding retry information. This can be
36700 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36701 Since this has disadvantages for permanently connected hosts, it is best to
36702 arrange a separate transport for the intermittently connected ones.
36703
36704
36705
36706 .section "Exim on the intermittently connected client host" "SECID248"
36707 The value of &%smtp_accept_queue_per_connection%& should probably be
36708 increased, or even set to zero (that is, disabled) on the intermittently
36709 connected host, so that all incoming messages down a single connection get
36710 delivered immediately.
36711
36712 .cindex "SMTP" "passed connection"
36713 .cindex "SMTP" "multiple deliveries"
36714 .cindex "multiple SMTP deliveries"
36715 Mail waiting to be sent from an intermittently connected host will probably
36716 not have been routed, because without a connection DNS lookups are not
36717 possible. This means that if a normal queue run is done at connection time,
36718 each message is likely to be sent in a separate SMTP session. This can be
36719 avoided by starting the queue run with a command line option beginning with
36720 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36721 first pass, routing is done but no deliveries take place. The second pass is a
36722 normal queue run; since all the messages have been previously routed, those
36723 destined for the same host are likely to get sent as multiple deliveries in a
36724 single SMTP connection.
36725
36726
36727
36728 . ////////////////////////////////////////////////////////////////////////////
36729 . ////////////////////////////////////////////////////////////////////////////
36730
36731 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36732          "Exim as a non-queueing client"
36733 .cindex "client, non-queueing"
36734 .cindex "smart host" "suppressing queueing"
36735 On a personal computer, it is a common requirement for all
36736 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36737 configured to operate that way, for all the popular operating systems.
36738 However, there are some MUAs for Unix-like systems that cannot be so
36739 configured: they submit messages using the command line interface of
36740 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36741 messages this way.
36742
36743 If the personal computer runs continuously, there is no problem, because it can
36744 run a conventional MTA that handles delivery to the smart host, and deal with
36745 any delays via its queueing mechanism. However, if the computer does not run
36746 continuously or runs different operating systems at different times, queueing
36747 email is not desirable.
36748
36749 There is therefore a requirement for something that can provide the
36750 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36751 any queueing or retrying facilities. Furthermore, the delivery to the smart
36752 host should be synchronous, so that if it fails, the sending MUA is immediately
36753 informed. In other words, we want something that extends an MUA that submits
36754 to a local MTA via the command line so that it behaves like one that submits
36755 to a remote smart host using TCP/SMTP.
36756
36757 There are a number of applications (for example, there is one called &'ssmtp'&)
36758 that do this job. However, people have found them to be lacking in various
36759 ways. For instance, you might want to allow aliasing and forwarding to be done
36760 before sending a message to the smart host.
36761
36762 Exim already had the necessary infrastructure for doing this job. Just a few
36763 tweaks were needed to make it behave as required, though it is somewhat of an
36764 overkill to use a fully-featured MTA for this purpose.
36765
36766 .oindex "&%mua_wrapper%&"
36767 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36768 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36769 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36770 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36771 compatible router and transport configuration. Typically there will be just one
36772 router and one transport, sending everything to a smart host.
36773
36774 When run in MUA wrapping mode, the behaviour of Exim changes in the
36775 following ways:
36776
36777 .ilist
36778 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36779 In other words, the only way to submit messages is via the command line.
36780 .next
36781 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36782 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36783 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36784 does not finish until the delivery attempt is complete. If the delivery is
36785 successful, a zero return code is given.
36786 .next
36787 Address redirection is permitted, but the final routing for all addresses must
36788 be to the same remote transport, and to the same list of hosts. Furthermore,
36789 the return address (envelope sender) must be the same for all recipients, as
36790 must any added or deleted header lines. In other words, it must be possible to
36791 deliver the message in a single SMTP transaction, however many recipients there
36792 are.
36793 .next
36794 If these conditions are not met, or if routing any address results in a
36795 failure or defer status, or if Exim is unable to deliver all the recipients
36796 successfully to one of the smart hosts, delivery of the entire message fails.
36797 .next
36798 Because no queueing is allowed, all failures are treated as permanent; there
36799 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36800 smart host. Furthermore, because only a single yes/no response can be given to
36801 the caller, it is not possible to deliver to some recipients and not others. If
36802 there is an error (temporary or permanent) for any recipient, all are failed.
36803 .next
36804 If more than one smart host is listed, Exim will try another host after a
36805 connection failure or a timeout, in the normal way. However, if this kind of
36806 failure happens for all the hosts, the delivery fails.
36807 .next
36808 When delivery fails, an error message is written to the standard error stream
36809 (as well as to Exim's log), and Exim exits to the caller with a return code
36810 value 1. The message is expunged from Exim's spool files. No bounce messages
36811 are ever generated.
36812 .next
36813 No retry data is maintained, and any retry rules are ignored.
36814 .next
36815 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36816 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36817 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36818 .endlist
36819
36820 The overall effect is that Exim makes a single synchronous attempt to deliver
36821 the message, failing if there is any kind of problem. Because no local
36822 deliveries are done and no daemon can be run, Exim does not need root
36823 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36824 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36825 the advantages and disadvantages of running without root privilege.
36826
36827
36828
36829
36830 . ////////////////////////////////////////////////////////////////////////////
36831 . ////////////////////////////////////////////////////////////////////////////
36832
36833 .chapter "Log files" "CHAPlog"
36834 .scindex IIDloggen "log" "general description"
36835 .cindex "log" "types of"
36836 Exim writes three different logs, referred to as the main log, the reject log,
36837 and the panic log:
36838
36839 .ilist
36840 .cindex "main log"
36841 The main log records the arrival of each message and each delivery in a single
36842 line in each case. The format is as compact as possible, in an attempt to keep
36843 down the size of log files. Two-character flag sequences make it easy to pick
36844 out these lines. A number of other events are recorded in the main log. Some of
36845 them are optional, in which case the &%log_selector%& option controls whether
36846 they are included or not. A Perl script called &'eximstats'&, which does simple
36847 analysis of main log files, is provided in the Exim distribution (see section
36848 &<<SECTmailstat>>&).
36849 .next
36850 .cindex "reject log"
36851 The reject log records information from messages that are rejected as a result
36852 of a configuration option (that is, for policy reasons).
36853 The first line of each rejection is a copy of the line that is also written to
36854 the main log. Then, if the message's header has been read at the time the log
36855 is written, its contents are written to this log. Only the original header
36856 lines are available; header lines added by ACLs are not logged. You can use the
36857 reject log to check that your policy controls are working correctly; on a busy
36858 host this may be easier than scanning the main log for rejection messages. You
36859 can suppress the writing of the reject log by setting &%write_rejectlog%&
36860 false.
36861 .next
36862 .cindex "panic log"
36863 .cindex "system log"
36864 When certain serious errors occur, Exim writes entries to its panic log. If the
36865 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36866 are usually written to the main log as well, but can get lost amid the mass of
36867 other entries. The panic log should be empty under normal circumstances. It is
36868 therefore a good idea to check it (or to have a &'cron'& script check it)
36869 regularly, in order to become aware of any problems. When Exim cannot open its
36870 panic log, it tries as a last resort to write to the system log (syslog). This
36871 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36872 message itself is written at priority LOG_CRIT.
36873 .endlist
36874
36875 Every log line starts with a timestamp, in the format shown in the following
36876 example. Note that many of the examples shown in this chapter are line-wrapped.
36877 In the log file, this would be all on one line:
36878 .code
36879 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36880   by QUIT
36881 .endd
36882 By default, the timestamps are in the local timezone. There are two
36883 ways of changing this:
36884
36885 .ilist
36886 You can set the &%timezone%& option to a different time zone; in particular, if
36887 you set
36888 .code
36889 timezone = UTC
36890 .endd
36891 the timestamps will be in UTC (aka GMT).
36892 .next
36893 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36894 example:
36895 .code
36896 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36897 .endd
36898 .endlist
36899
36900 .cindex "log" "process ids in"
36901 .cindex "pid (process id)" "in log lines"
36902 Exim does not include its process id in log lines by default, but you can
36903 request that it does so by specifying the &`pid`& log selector (see section
36904 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36905 brackets, immediately after the time and date.
36906
36907
36908
36909
36910 .section "Where the logs are written" "SECTwhelogwri"
36911 .cindex "log" "destination"
36912 .cindex "log" "to file"
36913 .cindex "log" "to syslog"
36914 .cindex "syslog"
36915 The logs may be written to local files, or to syslog, or both. However, it
36916 should be noted that many syslog implementations use UDP as a transport, and
36917 are therefore unreliable in the sense that messages are not guaranteed to
36918 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36919 It has also been reported that on large log files (tens of megabytes) you may
36920 need to tweak syslog to prevent it syncing the file with each write &-- on
36921 Linux this has been seen to make syslog take 90% plus of CPU time.
36922
36923 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36924 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36925 configuration. This latter string is expanded, so it can contain, for example,
36926 references to the host name:
36927 .code
36928 log_file_path = /var/log/$primary_hostname/exim_%slog
36929 .endd
36930 It is generally advisable, however, to set the string in &_Local/Makefile_&
36931 rather than at runtime, because then the setting is available right from the
36932 start of Exim's execution. Otherwise, if there's something it wants to log
36933 before it has read the configuration file (for example, an error in the
36934 configuration file) it will not use the path you want, and may not be able to
36935 log at all.
36936
36937 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36938 list, currently limited to at most two items. This is one option where the
36939 facility for changing a list separator may not be used. The list must always be
36940 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36941 otherwise the item must either be an absolute path, containing &`%s`& at the
36942 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36943 implying the use of a default path.
36944
36945 When Exim encounters an empty item in the list, it searches the list defined by
36946 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36947 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36948 mean &"use the path specified at build time"&. It no such item exists, log
36949 files are written in the &_log_& subdirectory of the spool directory. This is
36950 equivalent to the setting:
36951 .code
36952 log_file_path = $spool_directory/log/%slog
36953 .endd
36954 If you do not specify anything at build time or runtime,
36955 or if you unset the option at runtime (i.e. &`log_file_path = `&),
36956 that is where the logs are written.
36957
36958 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
36959 are in use &-- see section &<<SECTdatlogfil>>& below.
36960
36961 Here are some examples of possible settings:
36962 .display
36963 &`LOG_FILE_PATH=syslog                    `& syslog only
36964 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36965 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36966 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36967 .endd
36968 If there are more than two paths in the list, the first is used and a panic
36969 error is logged.
36970
36971
36972
36973 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36974 .cindex "log" "cycling local files"
36975 .cindex "cycling logs"
36976 .cindex "&'exicyclog'&"
36977 .cindex "log" "local files; writing to"
36978 Some operating systems provide centralized and standardized methods for cycling
36979 log files. For those that do not, a utility script called &'exicyclog'& is
36980 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36981 main and reject logs each time it is called. The maximum number of old logs to
36982 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36983
36984 An Exim delivery process opens the main log when it first needs to write to it,
36985 and it keeps the file open in case subsequent entries are required &-- for
36986 example, if a number of different deliveries are being done for the same
36987 message. However, remote SMTP deliveries can take a long time, and this means
36988 that the file may be kept open long after it is renamed if &'exicyclog'& or
36989 something similar is being used to rename log files on a regular basis. To
36990 ensure that a switch of log files is noticed as soon as possible, Exim calls
36991 &[stat()]& on the main log's name before reusing an open file, and if the file
36992 does not exist, or its inode has changed, the old file is closed and Exim
36993 tries to open the main log from scratch. Thus, an old log file may remain open
36994 for quite some time, but no Exim processes should write to it once it has been
36995 renamed.
36996
36997
36998
36999 .section "Datestamped log files" "SECTdatlogfil"
37000 .cindex "log" "datestamped files"
37001 Instead of cycling the main and reject log files by renaming them
37002 periodically, some sites like to use files whose names contain a datestamp,
37003 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37004 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37005 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37006 point where the datestamp is required. For example:
37007 .code
37008 log_file_path = /var/spool/exim/log/%slog-%D
37009 log_file_path = /var/log/exim-%s-%D.log
37010 log_file_path = /var/spool/exim/log/%D-%slog
37011 log_file_path = /var/log/exim/%s.%M
37012 .endd
37013 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37014 examples of names generated by the above examples:
37015 .code
37016 /var/spool/exim/log/mainlog-20021225
37017 /var/log/exim-reject-20021225.log
37018 /var/spool/exim/log/20021225-mainlog
37019 /var/log/exim/main.200212
37020 .endd
37021 When this form of log file is specified, Exim automatically switches to new
37022 files at midnight. It does not make any attempt to compress old logs; you
37023 will need to write your own script if you require this. You should not
37024 run &'exicyclog'& with this form of logging.
37025
37026 The location of the panic log is also determined by &%log_file_path%&, but it
37027 is not datestamped, because rotation of the panic log does not make sense.
37028 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37029 the string. In addition, if it immediately follows a slash, a following
37030 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37031 character is removed. Thus, the four examples above would give these panic
37032 log names:
37033 .code
37034 /var/spool/exim/log/paniclog
37035 /var/log/exim-panic.log
37036 /var/spool/exim/log/paniclog
37037 /var/log/exim/panic
37038 .endd
37039
37040
37041 .section "Logging to syslog" "SECID249"
37042 .cindex "log" "syslog; writing to"
37043 The use of syslog does not change what Exim logs or the format of its messages,
37044 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37045 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37046 that, the same strings are written to syslog as to log files. The syslog
37047 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37048 by default, but you can change these by setting the &%syslog_facility%& and
37049 &%syslog_processname%& options, respectively. If Exim was compiled with
37050 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37051 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37052 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37053 the time and host name to each line.
37054 The three log streams are mapped onto syslog priorities as follows:
37055
37056 .ilist
37057 &'mainlog'& is mapped to LOG_INFO
37058 .next
37059 &'rejectlog'& is mapped to LOG_NOTICE
37060 .next
37061 &'paniclog'& is mapped to LOG_ALERT
37062 .endlist
37063
37064 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37065 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37066 these are routed by syslog to the same place. You can suppress this duplication
37067 by setting &%syslog_duplication%& false.
37068
37069 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37070 entries contain multiple lines when headers are included. To cope with both
37071 these cases, entries written to syslog are split into separate &[syslog()]&
37072 calls at each internal newline, and also after a maximum of
37073 870 data characters. (This allows for a total syslog line length of 1024, when
37074 additions such as timestamps are added.) If you are running a syslog
37075 replacement that can handle lines longer than the 1024 characters allowed by
37076 RFC 3164, you should set
37077 .code
37078 SYSLOG_LONG_LINES=yes
37079 .endd
37080 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37081 lines, but it still splits at internal newlines in &'reject'& log entries.
37082
37083 To make it easy to re-assemble split lines later, each component of a split
37084 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37085 where <&'n'&> is the component number and <&'m'&> is the total number of
37086 components in the entry. The / delimiter is used when the line was split
37087 because it was too long; if it was split because of an internal newline, the \
37088 delimiter is used. For example, supposing the length limit to be 50 instead of
37089 870, the following would be the result of a typical rejection message to
37090 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37091 name, and pid as added by syslog:
37092 .code
37093 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37094 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37095 [3/5]  when scanning for sender: missing or malformed lo
37096 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37097 [5/5] mple>)
37098 .endd
37099 The same error might cause the following lines to be written to &"rejectlog"&
37100 (LOG_NOTICE):
37101 .code
37102 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37103 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37104 [3/18] er when scanning for sender: missing or malformed
37105 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37106 [5\18] .example>)
37107 [6\18] Recipients: ph10@some.domain.cam.example
37108 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37109 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37110 [9\18]        id 16RdAL-0006pc-00
37111 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37112 [11\18] 09:43 +0100
37113 [12\18] F From: <>
37114 [13\18]   Subject: this is a test header
37115 [18\18]   X-something: this is another header
37116 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37117 [16\18] le>
37118 [17\18] B Bcc:
37119 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37120 .endd
37121 Log lines that are neither too long nor contain newlines are written to syslog
37122 without modification.
37123
37124 If only syslog is being used, the Exim monitor is unable to provide a log tail
37125 display, unless syslog is routing &'mainlog'& to a file on the local host and
37126 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37127 where it is.
37128
37129
37130
37131 .section "Log line flags" "SECID250"
37132 One line is written to the main log for each message received, and for each
37133 successful, unsuccessful, and delayed delivery. These lines can readily be
37134 picked out by the distinctive two-character flags that immediately follow the
37135 timestamp. The flags are:
37136 .display
37137 &`<=`&     message arrival
37138 &`(=`&     message fakereject
37139 &`=>`&     normal message delivery
37140 &`->`&     additional address in same delivery
37141 &`>>`&     cutthrough message delivery
37142 &`*>`&     delivery suppressed by &%-N%&
37143 &`**`&     delivery failed; address bounced
37144 &`==`&     delivery deferred; temporary problem
37145 .endd
37146
37147
37148 .section "Logging message reception" "SECID251"
37149 .cindex "log" "reception line"
37150 The format of the single-line entry in the main log that is written for every
37151 message received is shown in the basic example below, which is split over
37152 several lines in order to fit it on the page:
37153 .code
37154 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37155   H=mailer.fict.example [192.168.123.123] U=exim
37156   P=smtp S=5678 id=<incoming message id>
37157 .endd
37158 The address immediately following &"<="& is the envelope sender address. A
37159 bounce message is shown with the sender address &"<>"&, and if it is locally
37160 generated, this is followed by an item of the form
37161 .code
37162 R=<message id>
37163 .endd
37164 which is a reference to the message that caused the bounce to be sent.
37165
37166 .cindex "HELO"
37167 .cindex "EHLO"
37168 For messages from other hosts, the H and U fields identify the remote host and
37169 record the RFC 1413 identity of the user that sent the message, if one was
37170 received. The number given in square brackets is the IP address of the sending
37171 host. If there is a single, unparenthesized  host name in the H field, as
37172 above, it has been verified to correspond to the IP address (see the
37173 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37174 by the remote host in the SMTP HELO or EHLO command, and has not been
37175 verified. If verification yields a different name to that given for HELO or
37176 EHLO, the verified name appears first, followed by the HELO or EHLO
37177 name in parentheses.
37178
37179 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37180 without brackets, in the HELO or EHLO command, leading to entries in
37181 the log containing text like these examples:
37182 .code
37183 H=(10.21.32.43) [192.168.8.34]
37184 H=([10.21.32.43]) [192.168.8.34]
37185 .endd
37186 This can be confusing. Only the final address in square brackets can be relied
37187 on.
37188
37189 For locally generated messages (that is, messages not received over TCP/IP),
37190 the H field is omitted, and the U field contains the login name of the caller
37191 of Exim.
37192
37193 .cindex "authentication" "logging"
37194 .cindex "AUTH" "logging"
37195 For all messages, the P field specifies the protocol used to receive the
37196 message. This is the value that is stored in &$received_protocol$&. In the case
37197 of incoming SMTP messages, the value indicates whether or not any SMTP
37198 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37199 session was encrypted, there is an additional X field that records the cipher
37200 suite that was used.
37201
37202 .cindex log protocol
37203 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37204 hosts that have authenticated themselves using the SMTP AUTH command. The first
37205 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37206 there is an additional item A= followed by the name of the authenticator that
37207 was used. If an authenticated identification was set up by the authenticator's
37208 &%server_set_id%& option, this is logged too, separated by a colon from the
37209 authenticator name.
37210
37211 .cindex "size" "of message"
37212 The id field records the existing message id, if present. The size of the
37213 received message is given by the S field. When the message is delivered,
37214 headers may be removed or added, so that the size of delivered copies of the
37215 message may not correspond with this value (and indeed may be different to each
37216 other).
37217
37218 The &%log_selector%& option can be used to request the logging of additional
37219 data when a message is received. See section &<<SECTlogselector>>& below.
37220
37221
37222
37223 .section "Logging deliveries" "SECID252"
37224 .cindex "log" "delivery line"
37225 The format of the single-line entry in the main log that is written for every
37226 delivery is shown in one of the examples below, for local and remote
37227 deliveries, respectively. Each example has been split into multiple lines in order
37228 to fit it on the page:
37229 .code
37230 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37231   <marv@hitch.fict.example> R=localuser T=local_delivery
37232 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37233   monk@holistic.fict.example R=dnslookup T=remote_smtp
37234   H=holistic.fict.example [192.168.234.234]
37235 .endd
37236 For ordinary local deliveries, the original address is given in angle brackets
37237 after the final delivery address, which might be a pipe or a file. If
37238 intermediate address(es) exist between the original and the final address, the
37239 last of these is given in parentheses after the final address. The R and T
37240 fields record the router and transport that were used to process the address.
37241
37242 If SMTP AUTH was used for the delivery there is an additional item A=
37243 followed by the name of the authenticator that was used.
37244 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37245 option, this is logged too, separated by a colon from the authenticator name.
37246
37247 If a shadow transport was run after a successful local delivery, the log line
37248 for the successful delivery has an item added on the end, of the form
37249 .display
37250 &`ST=<`&&'shadow transport name'&&`>`&
37251 .endd
37252 If the shadow transport did not succeed, the error message is put in
37253 parentheses afterwards.
37254
37255 .cindex "asterisk" "after IP address"
37256 When more than one address is included in a single delivery (for example, two
37257 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37258 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37259 down a single SMTP connection, an asterisk follows the IP address in the log
37260 lines for the second and subsequent messages.
37261 When two or more messages are delivered down a single TLS connection, the
37262 DNS and some TLS-related information logged for the first message delivered
37263 will not be present in the log lines for the second and subsequent messages.
37264 TLS cipher information is still available.
37265
37266 .cindex "delivery" "cutthrough; logging"
37267 .cindex "cutthrough" "logging"
37268 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37269 line precedes the reception line, since cutthrough waits for a possible
37270 rejection from the destination in case it can reject the sourced item.
37271
37272 The generation of a reply message by a filter file gets logged as a
37273 &"delivery"& to the addressee, preceded by &">"&.
37274
37275 The &%log_selector%& option can be used to request the logging of additional
37276 data when a message is delivered. See section &<<SECTlogselector>>& below.
37277
37278
37279 .section "Discarded deliveries" "SECID253"
37280 .cindex "discarded messages"
37281 .cindex "message" "discarded"
37282 .cindex "delivery" "discarded; logging"
37283 When a message is discarded as a result of the command &"seen finish"& being
37284 obeyed in a filter file which generates no deliveries, a log entry of the form
37285 .code
37286 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37287   <low.club@bridge.example> R=userforward
37288 .endd
37289 is written, to record why no deliveries are logged. When a message is discarded
37290 because it is aliased to &":blackhole:"& the log line is like this:
37291 .code
37292 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37293   <hole@nowhere.example> R=blackhole_router
37294 .endd
37295
37296
37297 .section "Deferred deliveries" "SECID254"
37298 When a delivery is deferred, a line of the following form is logged:
37299 .code
37300 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37301   R=dnslookup T=smtp defer (146): Connection refused
37302 .endd
37303 In the case of remote deliveries, the error is the one that was given for the
37304 last IP address that was tried. Details of individual SMTP failures are also
37305 written to the log, so the above line would be preceded by something like
37306 .code
37307 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37308   mail1.endrest.example [192.168.239.239]: Connection refused
37309 .endd
37310 When a deferred address is skipped because its retry time has not been reached,
37311 a message is written to the log, but this can be suppressed by setting an
37312 appropriate value in &%log_selector%&.
37313
37314
37315
37316 .section "Delivery failures" "SECID255"
37317 .cindex "delivery" "failure; logging"
37318 If a delivery fails because an address cannot be routed, a line of the
37319 following form is logged:
37320 .code
37321 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37322   <jim@trek99.example>: unknown mail domain
37323 .endd
37324 If a delivery fails at transport time, the router and transport are shown, and
37325 the response from the remote host is included, as in this example:
37326 .code
37327 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37328   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37329   after pipelined RCPT TO:<ace400@pb.example>: host
37330   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37331   <ace400@pb.example>...Addressee unknown
37332 .endd
37333 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37334 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37335 disabling PIPELINING. The log lines for all forms of delivery failure are
37336 flagged with &`**`&.
37337
37338
37339
37340 .section "Fake deliveries" "SECID256"
37341 .cindex "delivery" "fake; logging"
37342 If a delivery does not actually take place because the &%-N%& option has been
37343 used to suppress it, a normal delivery line is written to the log, except that
37344 &"=>"& is replaced by &"*>"&.
37345
37346
37347
37348 .section "Completion" "SECID257"
37349 A line of the form
37350 .code
37351 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37352 .endd
37353 is written to the main log when a message is about to be removed from the spool
37354 at the end of its processing.
37355
37356
37357
37358
37359 .section "Summary of Fields in Log Lines" "SECID258"
37360 .cindex "log" "summary of fields"
37361 A summary of the field identifiers that are used in log lines is shown in
37362 the following table:
37363 .display
37364 &`A   `&        authenticator name (and optional id and sender)
37365 &`C   `&        SMTP confirmation on delivery
37366 &`    `&        command list for &"no mail in SMTP session"&
37367 &`CV  `&        certificate verification status
37368 &`D   `&        duration of &"no mail in SMTP session"&
37369 &`DKIM`&        domain verified in incoming message
37370 &`DN  `&        distinguished name from peer certificate
37371 &`DS  `&        DNSSEC secured lookups
37372 &`DT  `&        on &`=>`& lines: time taken for a delivery
37373 &`F   `&        sender address (on delivery lines)
37374 &`H   `&        host name and IP address
37375 &`I   `&        local interface used
37376 &`id  `&        message id (from header) for incoming message
37377 &`K   `&        CHUNKING extension used
37378 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37379 &`M8S `&        8BITMIME status for incoming message
37380 &`P   `&        on &`<=`& lines: protocol used
37381 &`    `&        on &`=>`& and &`**`& lines: return path
37382 &`PRDR`&        PRDR extension used
37383 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37384 &`Q   `&        alternate queue name
37385 &`QT  `&        on &`=>`& lines: time spent on queue so far
37386 &`    `&        on &"Completed"& lines: time spent on queue
37387 &`R   `&        on &`<=`& lines: reference for local bounce
37388 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37389 &`RT  `&        on &`<=`& lines: time taken for reception
37390 &`S   `&        size of message in bytes
37391 &`SNI `&        server name indication from TLS client hello
37392 &`ST  `&        shadow transport name
37393 &`T   `&        on &`<=`& lines: message subject (topic)
37394 &`TFO `&        connection took advantage of TCP Fast Open
37395 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37396 &`U   `&        local user or RFC 1413 identity
37397 &`X   `&        TLS cipher suite
37398 .endd
37399
37400
37401 .section "Other log entries" "SECID259"
37402 Various other types of log entry are written from time to time. Most should be
37403 self-explanatory. Among the more common are:
37404
37405 .ilist
37406 .cindex "retry" "time not reached"
37407 &'retry time not reached'&&~&~An address previously suffered a temporary error
37408 during routing or local delivery, and the time to retry has not yet arrived.
37409 This message is not written to an individual message log file unless it happens
37410 during the first delivery attempt.
37411 .next
37412 &'retry time not reached for any host'&&~&~An address previously suffered
37413 temporary errors during remote delivery, and the retry time has not yet arrived
37414 for any of the hosts to which it is routed.
37415 .next
37416 .cindex "spool directory" "file locked"
37417 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37418 some other Exim process is already working on the message. This can be quite
37419 common if queue running processes are started at frequent intervals. The
37420 &'exiwhat'& utility script can be used to find out what Exim processes are
37421 doing.
37422 .next
37423 .cindex "error" "ignored"
37424 &'error ignored'&&~&~There are several circumstances that give rise to this
37425 message:
37426 .olist
37427 Exim failed to deliver a bounce message whose age was greater than
37428 &%ignore_bounce_errors_after%&. The bounce was discarded.
37429 .next
37430 A filter file set up a delivery using the &"noerror"& option, and the delivery
37431 failed. The delivery was discarded.
37432 .next
37433 A delivery set up by a router configured with
37434 . ==== As this is a nested list, any displays it contains must be indented
37435 . ==== as otherwise they are too far to the left.
37436 .code
37437     errors_to = <>
37438 .endd
37439 failed. The delivery was discarded.
37440 .endlist olist
37441 .next
37442 .cindex DKIM "log line"
37443 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37444 logging and the message has a DKIM signature header.
37445 .endlist ilist
37446
37447
37448
37449
37450
37451 .section "Reducing or increasing what is logged" "SECTlogselector"
37452 .cindex "log" "selectors"
37453 By setting the &%log_selector%& global option, you can disable some of Exim's
37454 default logging, or you can request additional logging. The value of
37455 &%log_selector%& is made up of names preceded by plus or minus characters. For
37456 example:
37457 .code
37458 log_selector = +arguments -retry_defer
37459 .endd
37460 The list of optional log items is in the following table, with the default
37461 selection marked by asterisks:
37462 .display
37463 &` 8bitmime                   `&  received 8BITMIME status
37464 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37465 &` address_rewrite            `&  address rewriting
37466 &` all_parents                `&  all parents in => lines
37467 &` arguments                  `&  command line arguments
37468 &`*connection_reject          `&  connection rejections
37469 &`*delay_delivery             `&  immediate delivery delayed
37470 &` deliver_time               `&  time taken to perform delivery
37471 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37472 &`*dkim                       `&  DKIM verified domain on <= lines
37473 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37474 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37475 &` dnssec                     `&  DNSSEC secured lookups
37476 &`*etrn                       `&  ETRN commands
37477 &`*host_lookup_failed         `&  as it says
37478 &` ident_timeout              `&  timeout for ident connection
37479 &` incoming_interface         `&  local interface on <= and => lines
37480 &` incoming_port              `&  remote port on <= lines
37481 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37482 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37483 &`*msg_id                     `&  on <= lines, Message-ID: header value
37484 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37485 &` outgoing_interface         `&  local interface on => lines
37486 &` outgoing_port              `&  add remote port to => lines
37487 &`*queue_run                  `&  start and end queue runs
37488 &` queue_time                 `&  time on queue for one recipient
37489 &` queue_time_overall         `&  time on queue for whole message
37490 &` pid                        `&  Exim process id
37491 &` pipelining                 `&  PIPELINING use, on <= and => lines
37492 &` proxy                      `&  proxy address on <= and => lines
37493 &` receive_time               `&  time taken to receive message
37494 &` received_recipients        `&  recipients on <= lines
37495 &` received_sender            `&  sender on <= lines
37496 &`*rejected_header            `&  header contents on reject log
37497 &`*retry_defer                `&  &"retry time not reached"&
37498 &` return_path_on_delivery    `&  put return path on => and ** lines
37499 &` sender_on_delivery         `&  add sender to => lines
37500 &`*sender_verify_fail         `&  sender verification failures
37501 &`*size_reject                `&  rejection because too big
37502 &`*skip_delivery              `&  delivery skipped in a queue run
37503 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37504 &` smtp_connection            `&  incoming SMTP connections
37505 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37506 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37507 &` smtp_no_mail               `&  session with no MAIL commands
37508 &` smtp_protocol_error        `&  SMTP protocol errors
37509 &` smtp_syntax_error          `&  SMTP syntax errors
37510 &` subject                    `&  contents of &'Subject:'& on <= lines
37511 &`*tls_certificate_verified   `&  certificate verification status
37512 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37513 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37514 &` tls_sni                    `&  TLS SNI on <= lines
37515 &` unknown_in_list            `&  DNS lookup failed in list match
37516
37517 &` all                        `&  all of the above
37518 .endd
37519 See also the &%slow_lookup_log%& main configuration option,
37520 section &<<SECID99>>&
37521
37522 More details on each of these items follows:
37523
37524 .ilist
37525 .cindex "8BITMIME"
37526 .cindex "log" "8BITMIME"
37527 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37528 which may help in tracking down interoperability issues with ancient MTAs
37529 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37530 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37531 &`7BIT`& and &`8BITMIME`& respectively.
37532 .next
37533 .cindex "&%warn%& ACL verb" "log when skipping"
37534 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37535 its conditions cannot be evaluated, a log line to this effect is written if
37536 this log selector is set.
37537 .next
37538 .cindex "log" "rewriting"
37539 .cindex "rewriting" "logging"
37540 &%address_rewrite%&: This applies both to global rewrites and per-transport
37541 rewrites, but not to rewrites in filters run as an unprivileged user (because
37542 such users cannot access the log).
37543 .next
37544 .cindex "log" "full parentage"
37545 &%all_parents%&: Normally only the original and final addresses are logged on
37546 delivery lines; with this selector, intermediate parents are given in
37547 parentheses between them.
37548 .next
37549 .cindex "log" "Exim arguments"
37550 .cindex "Exim arguments, logging"
37551 &%arguments%&: This causes Exim to write the arguments with which it was called
37552 to the main log, preceded by the current working directory. This is a debugging
37553 feature, added to make it easier to find out how certain MUAs call
37554 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37555 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37556 that are empty or that contain white space are quoted. Non-printing characters
37557 are shown as escape sequences. This facility cannot log unrecognized arguments,
37558 because the arguments are checked before the configuration file is read. The
37559 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37560 between the caller and Exim.
37561 .next
37562 .cindex "log" "connection rejections"
37563 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37564 connection is rejected, for whatever reason.
37565 .next
37566 .cindex "log" "delayed delivery"
37567 .cindex "delayed delivery, logging"
37568 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37569 started for an incoming message because the load is too high or too many
37570 messages were received on one connection. Logging does not occur if no delivery
37571 process is started because &%queue_only%& is set or &%-odq%& was used.
37572 .next
37573 .cindex "log" "delivery duration"
37574 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37575 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37576 If millisecond logging is enabled, short times will be shown with greater
37577 precision, eg. &`DT=0.304s`&.
37578 .next
37579 .cindex "log" "message size on delivery"
37580 .cindex "size" "of message"
37581 &%delivery_size%&: For each delivery, the size of message delivered is added to
37582 the &"=>"& line, tagged with S=.
37583 .next
37584 .cindex log "DKIM verification"
37585 .cindex DKIM "verification logging"
37586 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37587 verifies successfully a tag of DKIM is added, with one of the verified domains.
37588 .next
37589 .cindex log "DKIM verification"
37590 .cindex DKIM "verification logging"
37591 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37592 .next
37593 .cindex "log" "dnslist defer"
37594 .cindex "DNS list" "logging defer"
37595 .cindex "black list (DNS)"
37596 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37597 DNS black list suffers a temporary error.
37598 .next
37599 .cindex log dnssec
37600 .cindex dnssec logging
37601 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37602 dns lookups gave secure results a tag of DS is added.
37603 For acceptance this covers the reverse and forward lookups for host name verification.
37604 It does not cover helo-name verification.
37605 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37606 .next
37607 .cindex "log" "ETRN commands"
37608 .cindex "ETRN" "logging"
37609 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37610 is run to determine whether or not it is actually accepted. An invalid ETRN
37611 command, or one received within a message transaction is not logged by this
37612 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37613 .next
37614 .cindex "log" "host lookup failure"
37615 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37616 any addresses, or when a lookup of an IP address fails to find a host name, a
37617 log line is written. This logging does not apply to direct DNS lookups when
37618 routing email addresses, but it does apply to &"byname"& lookups.
37619 .next
37620 .cindex "log" "ident timeout"
37621 .cindex "RFC 1413" "logging timeout"
37622 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37623 client's ident port times out.
37624 .next
37625 .cindex "log" "incoming interface"
37626 .cindex "log" "local interface"
37627 .cindex "log" "local address and port"
37628 .cindex "TCP/IP" "logging local address and port"
37629 .cindex "interface" "logging"
37630 &%incoming_interface%&: The interface on which a message was received is added
37631 to the &"<="& line as an IP address in square brackets, tagged by I= and
37632 followed by a colon and the port number. The local interface and port are also
37633 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37634 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37635 The latter can be disabled by turning off the &%outgoing_interface%& option.
37636 .next
37637 .cindex log "incoming proxy address"
37638 .cindex proxy "logging proxy address"
37639 .cindex "TCP/IP" "logging proxy address"
37640 &%proxy%&: The internal (closest to the system running Exim) IP address
37641 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37642 on a proxied connection
37643 or the &"=>"& line for a message delivered on a proxied connection.
37644 See &<<SECTproxyInbound>>& for more information.
37645 .next
37646 .cindex "log" "incoming remote port"
37647 .cindex "port" "logging remote"
37648 .cindex "TCP/IP" "logging incoming remote port"
37649 .vindex "&$sender_fullhost$&"
37650 .vindex "&$sender_rcvhost$&"
37651 &%incoming_port%&: The remote port number from which a message was received is
37652 added to log entries and &'Received:'& header lines, following the IP address
37653 in square brackets, and separated from it by a colon. This is implemented by
37654 changing the value that is put in the &$sender_fullhost$& and
37655 &$sender_rcvhost$& variables. Recording the remote port number has become more
37656 important with the widening use of NAT (see RFC 2505).
37657 .next
37658 .cindex "log" "dropped connection"
37659 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37660 connection is unexpectedly dropped.
37661 .next
37662 .cindex "log" "millisecond timestamps"
37663 .cindex millisecond logging
37664 .cindex timestamps "millisecond, in logs"
37665 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37666 appended to the seconds value.
37667 .next
37668 .new
37669 .cindex "log" "message id"
37670 &%msg_id%&: The value of the Message-ID: header.
37671 .next
37672 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37673 This will be either because the message is a bounce, or was submitted locally
37674 (submission mode) without one.
37675 The field identifier will have an asterix appended: &"id*="&.
37676 .wen
37677 .next
37678 .cindex "log" "outgoing interface"
37679 .cindex "log" "local interface"
37680 .cindex "log" "local address and port"
37681 .cindex "TCP/IP" "logging local address and port"
37682 .cindex "interface" "logging"
37683 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37684 interface on which a message was sent is added to delivery lines as an I= tag
37685 followed by IP address in square brackets. You can disable this by turning
37686 off the &%outgoing_interface%& option.
37687 .next
37688 .cindex "log" "outgoing remote port"
37689 .cindex "port" "logging outgoing remote"
37690 .cindex "TCP/IP" "logging outgoing remote port"
37691 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37692 containing => tags) following the IP address.
37693 The local port is also added if &%incoming_interface%& and
37694 &%outgoing_interface%& are both enabled.
37695 This option is not included in the default setting, because for most ordinary
37696 configurations, the remote port number is always 25 (the SMTP port), and the
37697 local port is a random ephemeral port.
37698 .next
37699 .cindex "log" "process ids in"
37700 .cindex "pid (process id)" "in log lines"
37701 &%pid%&: The current process id is added to every log line, in square brackets,
37702 immediately after the time and date.
37703 .next
37704 .cindex log pipelining
37705 .cindex pipelining "logging outgoing"
37706 &%pipelining%&: A field is added to delivery and accept
37707 log lines when the ESMTP PIPELINING extension was used.
37708 The field is a single "L".
37709
37710 On accept lines, where PIPELINING was offered but not used by the client,
37711 the field has a minus appended.
37712
37713 .new
37714 .cindex "pipelining" "early connection"
37715 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37716 accept "L" fields have a period appended if the feature was
37717 offered but not used, or an asterisk appended if used.
37718 Delivery "L" fields have an asterisk appended if used.
37719 .wen
37720
37721 .next
37722 .cindex "log" "queue run"
37723 .cindex "queue runner" "logging"
37724 &%queue_run%&: The start and end of every queue run are logged.
37725 .next
37726 .cindex "log" "queue time"
37727 &%queue_time%&: The amount of time the message has been in the queue on the
37728 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37729 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37730 includes reception time as well as the delivery time for the current address.
37731 This means that it may be longer than the difference between the arrival and
37732 delivery log line times, because the arrival log line is not written until the
37733 message has been successfully received.
37734 If millisecond logging is enabled, short times will be shown with greater
37735 precision, eg. &`QT=1.578s`&.
37736 .next
37737 &%queue_time_overall%&: The amount of time the message has been in the queue on
37738 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37739 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37740 message, so it includes reception time as well as the total delivery time.
37741 .next
37742 .cindex "log" "receive duration"
37743 &%receive_time%&: For each message, the amount of real time it has taken to
37744 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37745 If millisecond logging is enabled, short times will be shown with greater
37746 precision, eg. &`RT=0.204s`&.
37747 .next
37748 .cindex "log" "recipients"
37749 &%received_recipients%&: The recipients of a message are listed in the main log
37750 as soon as the message is received. The list appears at the end of the log line
37751 that is written when a message is received, preceded by the word &"for"&. The
37752 addresses are listed after they have been qualified, but before any rewriting
37753 has taken place.
37754 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37755 in the list.
37756 .next
37757 .cindex "log" "sender reception"
37758 &%received_sender%&: The unrewritten original sender of a message is added to
37759 the end of the log line that records the message's arrival, after the word
37760 &"from"& (before the recipients if &%received_recipients%& is also set).
37761 .next
37762 .cindex "log" "header lines for rejection"
37763 &%rejected_header%&: If a message's header has been received at the time a
37764 rejection is written to the reject log, the complete header is added to the
37765 log. Header logging can be turned off individually for messages that are
37766 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37767 .next
37768 .cindex "log" "retry defer"
37769 &%retry_defer%&: A log line is written if a delivery is deferred because a
37770 retry time has not yet been reached. However, this &"retry time not reached"&
37771 message is always omitted from individual message logs after the first delivery
37772 attempt.
37773 .next
37774 .cindex "log" "return path"
37775 &%return_path_on_delivery%&: The return path that is being transmitted with
37776 the message is included in delivery and bounce lines, using the tag P=.
37777 This is omitted if no delivery actually happens, for example, if routing fails,
37778 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37779 .next
37780 .cindex "log" "sender on delivery"
37781 &%sender_on_delivery%&: The message's sender address is added to every delivery
37782 and bounce line, tagged by F= (for &"from"&).
37783 This is the original sender that was received with the message; it is not
37784 necessarily the same as the outgoing return path.
37785 .next
37786 .cindex "log" "sender verify failure"
37787 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37788 gives details of a sender verification failure is not written. Log lines for
37789 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37790 detail is lost.
37791 .next
37792 .cindex "log" "size rejection"
37793 &%size_reject%&: A log line is written whenever a message is rejected because
37794 it is too big.
37795 .next
37796 .cindex "log" "frozen messages; skipped"
37797 .cindex "frozen messages" "logging skipping"
37798 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37799 queue run because it is frozen or because another process is already delivering
37800 it.
37801 .cindex "&""spool file is locked""&"
37802 The message that is written is &"spool file is locked"&.
37803 .next
37804 .cindex "log" "smtp confirmation"
37805 .cindex "SMTP" "logging confirmation"
37806 .cindex "LMTP" "logging confirmation"
37807 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37808 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37809 A number of MTAs (including Exim) return an identifying string in this
37810 response.
37811 .next
37812 .cindex "log" "SMTP connections"
37813 .cindex "SMTP" "logging connections"
37814 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37815 established or closed, unless the connection is from a host that matches
37816 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37817 only when the closure is unexpected.) This applies to connections from local
37818 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37819 dropped in the middle of a message, a log line is always written, whether or
37820 not this selector is set, but otherwise nothing is written at the start and end
37821 of connections unless this selector is enabled.
37822
37823 For TCP/IP connections to an Exim daemon, the current number of connections is
37824 included in the log message for each new connection, but note that the count is
37825 reset if the daemon is restarted.
37826 Also, because connections are closed (and the closure is logged) in
37827 subprocesses, the count may not include connections that have been closed but
37828 whose termination the daemon has not yet noticed. Thus, while it is possible to
37829 match up the opening and closing of connections in the log, the value of the
37830 logged counts may not be entirely accurate.
37831 .next
37832 .cindex "log" "SMTP transaction; incomplete"
37833 .cindex "SMTP" "logging incomplete transactions"
37834 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37835 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37836 and the message sender plus any accepted recipients are included in the log
37837 line. This can provide evidence of dictionary attacks.
37838 .next
37839 .cindex "log" "non-MAIL SMTP sessions"
37840 .cindex "MAIL" "logging session without"
37841 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37842 connection terminates without having issued a MAIL command. This includes both
37843 the case when the connection is dropped, and the case when QUIT is used. It
37844 does not include cases where the connection is rejected right at the start (by
37845 an ACL, or because there are too many connections, or whatever). These cases
37846 already have their own log lines.
37847
37848 The log line that is written contains the identity of the client in the usual
37849 way, followed by D= and a time, which records the duration of the connection.
37850 If the connection was authenticated, this fact is logged exactly as it is for
37851 an incoming message, with an A= item. If the connection was encrypted, CV=,
37852 DN=, and X= items may appear as they do for an incoming message, controlled by
37853 the same logging options.
37854
37855 Finally, if any SMTP commands were issued during the connection, a C= item
37856 is added to the line, listing the commands that were used. For example,
37857 .code
37858 C=EHLO,QUIT
37859 .endd
37860 shows that the client issued QUIT straight after EHLO. If there were fewer
37861 than 20 commands, they are all listed. If there were more than 20 commands,
37862 the last 20 are listed, preceded by &"..."&. However, with the default
37863 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37864 have been aborted before 20 non-mail commands are processed.
37865 .next
37866 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37867 colon-separated, is appended to the A= item for a message arrival or delivery
37868 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37869 was accepted or used.
37870 .next
37871 .cindex "log" "SMTP protocol error"
37872 .cindex "SMTP" "logging protocol error"
37873 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37874 encountered. Exim does not have perfect detection of all protocol errors
37875 because of transmission delays and the use of pipelining. If PIPELINING has
37876 been advertised to a client, an Exim server assumes that the client will use
37877 it, and therefore it does not count &"expected"& errors (for example, RCPT
37878 received after rejecting MAIL) as protocol errors.
37879 .next
37880 .cindex "SMTP" "logging syntax errors"
37881 .cindex "SMTP" "syntax errors; logging"
37882 .cindex "SMTP" "unknown command; logging"
37883 .cindex "log" "unknown SMTP command"
37884 .cindex "log" "SMTP syntax error"
37885 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37886 encountered. An unrecognized command is treated as a syntax error. For an
37887 external connection, the host identity is given; for an internal connection
37888 using &%-bs%& the sender identification (normally the calling user) is given.
37889 .next
37890 .cindex "log" "subject"
37891 .cindex "subject, logging"
37892 &%subject%&: The subject of the message is added to the arrival log line,
37893 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37894 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37895 specifies whether characters with values greater than 127 should be logged
37896 unchanged, or whether they should be rendered as escape sequences.
37897 .next
37898 .cindex "log" "certificate verification"
37899 .cindex log DANE
37900 .cindex DANE logging
37901 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37902 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37903 verified
37904 using a CA trust anchor,
37905 &`CA=dane`& if using a DNS trust anchor,
37906 and &`CV=no`& if not.
37907 .next
37908 .cindex "log" "TLS cipher"
37909 .cindex "TLS" "logging cipher"
37910 &%tls_cipher%&: When a message is sent or received over an encrypted
37911 connection, the cipher suite used is added to the log line, preceded by X=.
37912 .next
37913 .cindex "log" "TLS peer DN"
37914 .cindex "TLS" "logging peer DN"
37915 &%tls_peerdn%&: When a message is sent or received over an encrypted
37916 connection, and a certificate is supplied by the remote host, the peer DN is
37917 added to the log line, preceded by DN=.
37918 .next
37919 .cindex "log" "TLS SNI"
37920 .cindex "TLS" "logging SNI"
37921 &%tls_sni%&: When a message is received over an encrypted connection, and
37922 the remote host provided the Server Name Indication extension, the SNI is
37923 added to the log line, preceded by SNI=.
37924 .next
37925 .cindex "log" "DNS failure in list"
37926 &%unknown_in_list%&: This setting causes a log entry to be written when the
37927 result of a list match is failure because a DNS lookup failed.
37928 .endlist
37929
37930
37931 .section "Message log" "SECID260"
37932 .cindex "message" "log file for"
37933 .cindex "log" "message log; description of"
37934 .cindex "&_msglog_& directory"
37935 .oindex "&%preserve_message_logs%&"
37936 In addition to the general log files, Exim writes a log file for each message
37937 that it handles. The names of these per-message logs are the message ids, and
37938 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37939 message log contains copies of the log lines that apply to the message. This
37940 makes it easier to inspect the status of an individual message without having
37941 to search the main log. A message log is deleted when processing of the message
37942 is complete, unless &%preserve_message_logs%& is set, but this should be used
37943 only with great care because they can fill up your disk very quickly.
37944
37945 On a heavily loaded system, it may be desirable to disable the use of
37946 per-message logs, in order to reduce disk I/O. This can be done by setting the
37947 &%message_logs%& option false.
37948 .ecindex IIDloggen
37949
37950
37951
37952
37953 . ////////////////////////////////////////////////////////////////////////////
37954 . ////////////////////////////////////////////////////////////////////////////
37955
37956 .chapter "Exim utilities" "CHAPutils"
37957 .scindex IIDutils "utilities"
37958 A number of utility scripts and programs are supplied with Exim and are
37959 described in this chapter. There is also the Exim Monitor, which is covered in
37960 the next chapter. The utilities described here are:
37961
37962 .itable none 0 0 3  7* left  15* left  40* left
37963 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37964   "list what Exim processes are doing"
37965 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37966 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37967 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37968 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37969                                                 various criteria"
37970 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37971 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37972   "extract statistics from the log"
37973 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37974   "check address acceptance from given IP"
37975 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37976 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37977 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37978 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37979 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37980 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37981 .endtable
37982
37983 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37984 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37985 &url(https://duncanthrax.net/exilog/) for details.
37986
37987
37988
37989
37990 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37991 .cindex "&'exiwhat'&"
37992 .cindex "process, querying"
37993 .cindex "SIGUSR1"
37994 On operating systems that can restart a system call after receiving a signal
37995 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37996 a line describing what it is doing to the file &_exim-process.info_& in the
37997 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37998 processes it can find, having first emptied the file. It then waits for one
37999 second to allow the Exim processes to react before displaying the results. In
38000 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38001 send the signal to the Exim processes, so it is normally run as root.
38002
38003 &*Warning*&: This is not an efficient process. It is intended for occasional
38004 use by system administrators. It is not sensible, for example, to set up a
38005 script that sends SIGUSR1 signals to Exim processes at short intervals.
38006
38007
38008 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38009 varies in different operating systems. Not only are different options used,
38010 but the format of the output is different. For this reason, there are some
38011 system configuration options that configure exactly how &'exiwhat'& works. If
38012 it doesn't seem to be working for you, check the following compile-time
38013 options:
38014 .display
38015 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38016 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38017 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38018 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38019 .endd
38020 An example of typical output from &'exiwhat'& is
38021 .code
38022 164 daemon: -q1h, listening on port 25
38023 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38024 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38025   [10.19.42.42] (editor@ref.example)
38026 10592 handling incoming call from [192.168.243.242]
38027 10628 accepting a local non-SMTP message
38028 .endd
38029 The first number in the output line is the process number. The third line has
38030 been split here, in order to fit it on the page.
38031
38032
38033
38034 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38035 .cindex "&'exiqgrep'&"
38036 .cindex "queue" "grepping"
38037 This utility is a Perl script contributed by Matt Hubbard. It runs
38038 .code
38039 exim -bpu
38040 .endd
38041 or (in case &*-a*& switch is specified)
38042 .code
38043 exim -bp
38044 .endd
38045 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38046 contain alternate exim configuration the queue management might be using.
38047
38048 to obtain a queue listing, and then greps the output to select messages
38049 that match given criteria. The following selection options are available:
38050
38051 .vlist
38052 .vitem &*-f*&&~<&'regex'&>
38053 Match the sender address using a case-insensitive search. The field that is
38054 tested is enclosed in angle brackets, so you can test for bounce messages with
38055 .code
38056 exiqgrep -f '^<>$'
38057 .endd
38058 .vitem &*-r*&&~<&'regex'&>
38059 Match a recipient address using a case-insensitive search. The field that is
38060 tested is not enclosed in angle brackets.
38061
38062 .vitem &*-s*&&~<&'regex'&>
38063 Match against the size field.
38064
38065 .vitem &*-y*&&~<&'seconds'&>
38066 Match messages that are younger than the given time.
38067
38068 .vitem &*-o*&&~<&'seconds'&>
38069 Match messages that are older than the given time.
38070
38071 .vitem &*-z*&
38072 Match only frozen messages.
38073
38074 .vitem &*-x*&
38075 Match only non-frozen messages.
38076
38077 .new
38078 .vitem &*-G*&&~<&'queuename'&>
38079 Match only messages in the given queue.  Without this, the default queue is searched.
38080 .wen
38081 .endlist
38082
38083 The following options control the format of the output:
38084
38085 .vlist
38086 .vitem &*-c*&
38087 Display only the count of matching messages.
38088
38089 .vitem &*-l*&
38090 Long format &-- display the full message information as output by Exim. This is
38091 the default.
38092
38093 .vitem &*-i*&
38094 Display message ids only.
38095
38096 .vitem &*-b*&
38097 Brief format &-- one line per message.
38098
38099 .vitem &*-R*&
38100 Display messages in reverse order.
38101
38102 .vitem &*-a*&
38103 Include delivered recipients in queue listing.
38104 .endlist
38105
38106 There is one more option, &%-h%&, which outputs a list of options.
38107
38108
38109
38110 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38111 .cindex "&'exiqsumm'&"
38112 .cindex "queue" "summary"
38113 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38114 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38115 running a command such as
38116 .code
38117 exim -bp | exiqsumm
38118 .endd
38119 The output consists of one line for each domain that has messages waiting for
38120 it, as in the following example:
38121 .code
38122 3   2322   74m   66m  msn.com.example
38123 .endd
38124 Each line lists the number of pending deliveries for a domain, their total
38125 volume, and the length of time that the oldest and the newest messages have
38126 been waiting. Note that the number of pending deliveries is greater than the
38127 number of messages when messages have more than one recipient.
38128
38129 A summary line is output at the end. By default the output is sorted on the
38130 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38131 the output to be sorted by oldest message and by count of messages,
38132 respectively. There are also three options that split the messages for each
38133 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38134 separates frozen messages, and &%-s%& separates messages according to their
38135 sender.
38136
38137 The output of &'exim -bp'& contains the original addresses in the message, so
38138 this also applies to the output from &'exiqsumm'&. No domains from addresses
38139 generated by aliasing or forwarding are included (unless the &%one_time%&
38140 option of the &(redirect)& router has been used to convert them into &"top
38141 level"& addresses).
38142
38143
38144
38145
38146 .section "Extracting specific information from the log (exigrep)" &&&
38147          "SECTextspeinf"
38148 .cindex "&'exigrep'&"
38149 .cindex "log" "extracts; grepping for"
38150 The &'exigrep'& utility is a Perl script that searches one or more main log
38151 files for entries that match a given pattern. When it finds a match, it
38152 extracts all the log entries for the relevant message, not just those that
38153 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38154 given message, or all mail for a given user, or for a given host, for example.
38155 The input files can be in Exim log format or syslog format.
38156 If a matching log line is not associated with a specific message, it is
38157 included in &'exigrep'&'s output without any additional lines. The usage is:
38158 .display
38159 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38160 .endd
38161 If no log filenames are given on the command line, the standard input is read.
38162
38163 The &%-t%& argument specifies a number of seconds. It adds an additional
38164 condition for message selection. Messages that are complete are shown only if
38165 they spent more than <&'n'&> seconds in the queue.
38166
38167 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38168 makes it case-sensitive. This may give a performance improvement when searching
38169 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38170 option; with &%-I%& they do not. In both cases it is possible to change the
38171 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38172
38173 The &%-l%& option means &"literal"&, that is, treat all characters in the
38174 pattern as standing for themselves. Otherwise the pattern must be a Perl
38175 regular expression.
38176
38177 The &%-v%& option inverts the matching condition. That is, a line is selected
38178 if it does &'not'& match the pattern.
38179
38180 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38181 that are generated as a result/response to a message that &'exigrep'& matched
38182 normally.
38183
38184 Example of &%-M%&:
38185 user_a sends a message to user_b, which generates a bounce back to user_b. If
38186 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38187 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38188 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38189 when searching for &"user_a"& will show both messages since the bounce is
38190 &"related"& to or a &"result"& of the first message that was found by the
38191 search term.
38192
38193 If the location of a &'zcat'& command is known from the definition of
38194 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38195 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38196 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38197 autodetection of some well known compression extensions.
38198
38199
38200 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38201 .cindex "&'exipick'&"
38202 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38203 lists messages from the queue according to a variety of criteria. For details
38204 of &'exipick'&'s facilities, run &'exipick'& with
38205 the &%--help%& option.
38206
38207
38208 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38209 .cindex "log" "cycling local files"
38210 .cindex "cycling logs"
38211 .cindex "&'exicyclog'&"
38212 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38213 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38214 you are using log files with datestamps in their names (see section
38215 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38216 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38217 There are two command line options for &'exicyclog'&:
38218 .ilist
38219 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38220 default that is set when Exim is built. The default default is 10.
38221 .next
38222 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38223 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38224 overriding the script's default, which is to find the setting from Exim's
38225 configuration.
38226 .endlist
38227
38228 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38229 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38230 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38231 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38232 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38233 logs are handled similarly.
38234
38235 If the limit is greater than 99, the script uses 3-digit numbers such as
38236 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38237 to one that is greater, or &'vice versa'&, you will have to fix the names of
38238 any existing log files.
38239
38240 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38241 the end are deleted. All files with numbers greater than 01 are compressed,
38242 using a compression command which is configured by the COMPRESS_COMMAND
38243 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38244 root &%crontab%& entry of the form
38245 .code
38246 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38247 .endd
38248 assuming you have used the name &"exim"& for the Exim user. You can run
38249 &'exicyclog'& as root if you wish, but there is no need.
38250
38251
38252
38253 .section "Mail statistics (eximstats)" "SECTmailstat"
38254 .cindex "statistics"
38255 .cindex "&'eximstats'&"
38256 A Perl script called &'eximstats'& is provided for extracting statistical
38257 information from log files. The output is either plain text, or HTML.
38258 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38259 . --- 404 error and everything else points to that.
38260
38261 The &'eximstats'& script has been hacked about quite a bit over time. The
38262 latest version is the result of some extensive revision by Steve Campbell. A
38263 lot of information is given by default, but there are options for suppressing
38264 various parts of it. Following any options, the arguments to the script are a
38265 list of files, which should be main log files. For example:
38266 .code
38267 eximstats -nr /var/spool/exim/log/mainlog.01
38268 .endd
38269 By default, &'eximstats'& extracts information about the number and volume of
38270 messages received from or delivered to various hosts. The information is sorted
38271 both by message count and by volume, and the top fifty hosts in each category
38272 are listed on the standard output. Similar information, based on email
38273 addresses or domains instead of hosts can be requested by means of various
38274 options. For messages delivered and received locally, similar statistics are
38275 also produced per user.
38276
38277 The output also includes total counts and statistics about delivery errors, and
38278 histograms showing the number of messages received and deliveries made in each
38279 hour of the day. A delivery with more than one address in its envelope (for
38280 example, an SMTP transaction with more than one RCPT command) is counted
38281 as a single delivery by &'eximstats'&.
38282
38283 Though normally more deliveries than receipts are reported (as messages may
38284 have multiple recipients), it is possible for &'eximstats'& to report more
38285 messages received than delivered, even though the queue is empty at the start
38286 and end of the period in question. If an incoming message contains no valid
38287 recipients, no deliveries are recorded for it. A bounce message is handled as
38288 an entirely separate message.
38289
38290 &'eximstats'& always outputs a grand total summary giving the volume and number
38291 of messages received and deliveries made, and the number of hosts involved in
38292 each case. It also outputs the number of messages that were delayed (that is,
38293 not completely delivered at the first attempt), and the number that had at
38294 least one address that failed.
38295
38296 The remainder of the output is in sections that can be independently disabled
38297 or modified by various options. It consists of a summary of deliveries by
38298 transport, histograms of messages received and delivered per time interval
38299 (default per hour), information about the time messages spent in the queue,
38300 a list of relayed messages, lists of the top fifty sending hosts, local
38301 senders, destination hosts, and destination local users by count and by volume,
38302 and a list of delivery errors that occurred.
38303
38304 The relay information lists messages that were actually relayed, that is, they
38305 came from a remote host and were directly delivered to some other remote host,
38306 without being processed (for example, for aliasing or forwarding) locally.
38307
38308 There are quite a few options for &'eximstats'& to control exactly what it
38309 outputs. These are documented in the Perl script itself, and can be extracted
38310 by running the command &(perldoc)& on the script. For example:
38311 .code
38312 perldoc /usr/exim/bin/eximstats
38313 .endd
38314
38315 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38316 .cindex "&'exim_checkaccess'&"
38317 .cindex "policy control" "checking access"
38318 .cindex "checking access"
38319 The &%-bh%& command line argument allows you to run a fake SMTP session with
38320 debugging output, in order to check what Exim is doing when it is applying
38321 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38322 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38323 sometimes you just want to answer the question &"Does this address have
38324 access?"& without bothering with any further details.
38325
38326 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38327 two arguments, an IP address and an email address:
38328 .code
38329 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38330 .endd
38331 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38332 given email address would be accepted in a RCPT command in a TCP/IP
38333 connection from the host with the given IP address. The output of the utility
38334 is either the word &"accepted"&, or the SMTP error response, for example:
38335 .code
38336 Rejected:
38337 550 Relay not permitted
38338 .endd
38339 When running this test, the utility uses &`<>`& as the envelope sender address
38340 for the MAIL command, but you can change this by providing additional
38341 options. These are passed directly to the Exim command. For example, to specify
38342 that the test is to be run with the sender address &'himself@there.example'&
38343 you can use:
38344 .code
38345 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38346                  -f himself@there.example
38347 .endd
38348 Note that these additional Exim command line items must be given after the two
38349 mandatory arguments.
38350
38351 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38352 while running its checks. You can run checks that include callouts by using
38353 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38354
38355
38356
38357 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38358 .cindex "DBM" "building dbm files"
38359 .cindex "building DBM files"
38360 .cindex "&'exim_dbmbuild'&"
38361 .cindex "lower casing"
38362 .cindex "binary zero" "in lookup key"
38363 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38364 the format used by the &(lsearch)& lookup (see section
38365 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38366 names as keys and the remainder of the information as data. The lower-casing
38367 can be prevented by calling the program with the &%-nolc%& option.
38368
38369 A terminating zero is included as part of the key string. This is expected by
38370 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38371 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38372 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38373 files.
38374
38375 The program requires two arguments: the name of the input file (which can be a
38376 single hyphen to indicate the standard input), and the name of the output file.
38377 It creates the output under a temporary name, and then renames it if all went
38378 well.
38379
38380 .cindex "USE_DB"
38381 If the native DB interface is in use (USE_DB is set in a compile-time
38382 configuration file &-- this is common in free versions of Unix) the two
38383 filenames must be different, because in this mode the Berkeley DB functions
38384 create a single output file using exactly the name given. For example,
38385 .code
38386 exim_dbmbuild /etc/aliases /etc/aliases.db
38387 .endd
38388 reads the system alias file and creates a DBM version of it in
38389 &_/etc/aliases.db_&.
38390
38391 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38392 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38393 environment, the suffixes are added to the second argument of
38394 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38395 when the Berkeley functions are used in compatibility mode (though this is not
38396 recommended), because in that case it adds a &_.db_& suffix to the filename.
38397
38398 If a duplicate key is encountered, the program outputs a warning, and when it
38399 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38400 option is used. By default, only the first of a set of duplicates is used &--
38401 this makes it compatible with &(lsearch)& lookups. There is an option
38402 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38403 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38404 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38405 return code is 2.
38406
38407
38408
38409
38410 .section "Finding individual retry times (exinext)" "SECTfinindret"
38411 .cindex "retry" "times"
38412 .cindex "&'exinext'&"
38413 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38414 fish specific information out of the retry database. Given a mail domain (or a
38415 complete address), it looks up the hosts for that domain, and outputs any retry
38416 information for the hosts or for the domain. At present, the retry information
38417 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38418 output. For example:
38419 .code
38420 $ exinext piglet@milne.fict.example
38421 kanga.milne.example:192.168.8.1 error 146: Connection refused
38422   first failed: 21-Feb-1996 14:57:34
38423   last tried:   21-Feb-1996 14:57:34
38424   next try at:  21-Feb-1996 15:02:34
38425 roo.milne.example:192.168.8.3 error 146: Connection refused
38426   first failed: 20-Jan-1996 13:12:08
38427   last tried:   21-Feb-1996 11:42:03
38428   next try at:  21-Feb-1996 19:42:03
38429   past final cutoff time
38430 .endd
38431 You can also give &'exinext'& a local part, without a domain, and it
38432 will give any retry information for that local part in your default domain.
38433 A message id can be used to obtain retry information pertaining to a specific
38434 message. This exists only when an attempt to deliver a message to a remote host
38435 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38436 &'exinext'& is not particularly efficient, but then it is not expected to be
38437 run very often.
38438
38439 The &'exinext'& utility calls Exim to find out information such as the location
38440 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38441 passed on to the &'exim'& commands. The first specifies an alternate Exim
38442 configuration file, and the second sets macros for use within the configuration
38443 file. These features are mainly to help in testing, but might also be useful in
38444 environments where more than one configuration file is in use.
38445
38446
38447
38448 .section "Hints database maintenance" "SECThindatmai"
38449 .cindex "hints database" "maintenance"
38450 .cindex "maintaining Exim's hints database"
38451 Three utility programs are provided for maintaining the DBM files that Exim
38452 uses to contain its delivery hint information. Each program requires two
38453 arguments. The first specifies the name of Exim's spool directory, and the
38454 second is the name of the database it is to operate on. These are as follows:
38455
38456 .ilist
38457 &'retry'&: the database of retry information
38458 .next
38459 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38460 for remote hosts
38461 .next
38462 &'callout'&: the callout cache
38463 .next
38464 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38465 .next
38466 &'misc'&: other hints data
38467 .endlist
38468
38469 The &'misc'& database is used for
38470
38471 .ilist
38472 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38473 .next
38474 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38475 &(smtp)& transport)
38476 .next
38477 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38478 in a transport)
38479 .endlist
38480
38481
38482
38483 .section "exim_dumpdb" "SECID261"
38484 .cindex "&'exim_dumpdb'&"
38485 The entire contents of a database are written to the standard output by the
38486 &'exim_dumpdb'& program, which has no options or arguments other than the
38487 spool and database names. For example, to dump the retry database:
38488 .code
38489 exim_dumpdb /var/spool/exim retry
38490 .endd
38491 Two lines of output are produced for each entry:
38492 .code
38493 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38494 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38495 .endd
38496 The first item on the first line is the key of the record. It starts with one
38497 of the letters R, or T, depending on whether it refers to a routing or
38498 transport retry. For a local delivery, the next part is the local address; for
38499 a remote delivery it is the name of the remote host, followed by its failing IP
38500 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38501 transport). If the remote port is not the standard one (port 25), it is added
38502 to the IP address. Then there follows an error code, an additional error code,
38503 and a textual description of the error.
38504
38505 The three times on the second line are the time of first failure, the time of
38506 the last delivery attempt, and the computed time for the next attempt. The line
38507 ends with an asterisk if the cutoff time for the last retry rule has been
38508 exceeded.
38509
38510 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38511 consists of a host name followed by a list of ids for messages that are or were
38512 waiting to be delivered to that host. If there are a very large number for any
38513 one host, continuation records, with a sequence number added to the host name,
38514 may be seen. The data in these records is often out of date, because a message
38515 may be routed to several alternative hosts, and Exim makes no effort to keep
38516 cross-references.
38517
38518
38519
38520 .section "exim_tidydb" "SECID262"
38521 .cindex "&'exim_tidydb'&"
38522 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38523 database. If run with no options, it removes all records that are more than 30
38524 days old. The age is calculated from the date and time that the record was last
38525 updated. Note that, in the case of the retry database, it is &'not'& the time
38526 since the first delivery failure. Information about a host that has been down
38527 for more than 30 days will remain in the database, provided that the record is
38528 updated sufficiently often.
38529
38530 The cutoff date can be altered by means of the &%-t%& option, which must be
38531 followed by a time. For example, to remove all records older than a week from
38532 the retry database:
38533 .code
38534 exim_tidydb -t 7d /var/spool/exim retry
38535 .endd
38536 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38537 message ids. In the former these appear as data in records keyed by host &--
38538 they were messages that were waiting for that host &-- and in the latter they
38539 are the keys for retry information for messages that have suffered certain
38540 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38541 message ids in database records are those of messages that are still on the
38542 queue. Message ids for messages that no longer exist are removed from
38543 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38544 For the &'retry'& database, records whose keys are non-existent message ids are
38545 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38546 whenever it removes information from the database.
38547
38548 Certain records are automatically removed by Exim when they are no longer
38549 needed, but others are not. For example, if all the MX hosts for a domain are
38550 down, a retry record is created for each one. If the primary MX host comes back
38551 first, its record is removed when Exim successfully delivers to it, but the
38552 records for the others remain because Exim has not tried to use those hosts.
38553
38554 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38555 hints databases. You should do this at a quiet time of day, because it requires
38556 a database to be locked (and therefore inaccessible to Exim) while it does its
38557 work. Removing records from a DBM file does not normally make the file smaller,
38558 but all the common DBM libraries are able to re-use the space that is released.
38559 After an initial phase of increasing in size, the databases normally reach a
38560 point at which they no longer get any bigger, as long as they are regularly
38561 tidied.
38562
38563 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38564 databases is likely to keep on increasing.
38565
38566
38567
38568
38569 .section "exim_fixdb" "SECID263"
38570 .cindex "&'exim_fixdb'&"
38571 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38572 Its main use is for testing Exim, but it might also be occasionally useful for
38573 getting round problems in a live system. It has no options, and its interface
38574 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38575 key of a database record can then be entered, and the data for that record is
38576 displayed.
38577
38578 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38579 except the &'retry'& database, that is the only operation that can be carried
38580 out. For the &'retry'& database, each field is output preceded by a number, and
38581 data for individual fields can be changed by typing the field number followed
38582 by new data, for example:
38583 .code
38584 > 4 951102:1000
38585 .endd
38586 resets the time of the next delivery attempt. Time values are given as a
38587 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38588 used as optional separators.
38589
38590
38591
38592
38593 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38594 .cindex "mailbox" "maintenance"
38595 .cindex "&'exim_lock'&"
38596 .cindex "locking mailboxes"
38597 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38598 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38599 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38600 a user agent while investigating a problem. The utility requires the name of
38601 the file as its first argument. If the locking is successful, the second
38602 argument is run as a command (using C's &[system()]& function); if there is no
38603 second argument, the value of the SHELL environment variable is used; if this
38604 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38605 is unlocked and the utility ends. The following options are available:
38606
38607 .vlist
38608 .vitem &%-fcntl%&
38609 Use &[fcntl()]& locking on the open mailbox.
38610
38611 .vitem &%-flock%&
38612 Use &[flock()]& locking on the open mailbox, provided the operating system
38613 supports it.
38614
38615 .vitem &%-interval%&
38616 This must be followed by a number, which is a number of seconds; it sets the
38617 interval to sleep between retries (default 3).
38618
38619 .vitem &%-lockfile%&
38620 Create a lock file before opening the mailbox.
38621
38622 .vitem &%-mbx%&
38623 Lock the mailbox using MBX rules.
38624
38625 .vitem &%-q%&
38626 Suppress verification output.
38627
38628 .vitem &%-retries%&
38629 This must be followed by a number; it sets the number of times to try to get
38630 the lock (default 10).
38631
38632 .vitem &%-restore_time%&
38633 This option causes &%exim_lock%& to restore the modified and read times to the
38634 locked file before exiting. This allows you to access a locked mailbox (for
38635 example, to take a backup copy) without disturbing the times that the user
38636 subsequently sees.
38637
38638 .vitem &%-timeout%&
38639 This must be followed by a number, which is a number of seconds; it sets a
38640 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38641 default), a non-blocking call is used.
38642
38643 .vitem &%-v%&
38644 Generate verbose output.
38645 .endlist
38646
38647 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38648 default is to create a lock file and also to use &[fcntl()]& locking on the
38649 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38650 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38651 requires that the directory containing the file be writeable. Locking by lock
38652 file does not last forever; Exim assumes that a lock file is expired if it is
38653 more than 30 minutes old.
38654
38655 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38656 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38657 to be taken out on the open mailbox, and an exclusive lock on the file
38658 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38659 number of the mailbox file. When the locking is released, if an exclusive lock
38660 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38661
38662 The default output contains verification of the locking that takes place. The
38663 &%-v%& option causes some additional information to be given. The &%-q%& option
38664 suppresses all output except error messages.
38665
38666 A command such as
38667 .code
38668 exim_lock /var/spool/mail/spqr
38669 .endd
38670 runs an interactive shell while the file is locked, whereas
38671 .display
38672 &`exim_lock -q /var/spool/mail/spqr <<End`&
38673 <&'some commands'&>
38674 &`End`&
38675 .endd
38676 runs a specific non-interactive sequence of commands while the file is locked,
38677 suppressing all verification output. A single command can be run by a command
38678 such as
38679 .code
38680 exim_lock -q /var/spool/mail/spqr \
38681   "cp /var/spool/mail/spqr /some/where"
38682 .endd
38683 Note that if a command is supplied, it must be entirely contained within the
38684 second argument &-- hence the quotes.
38685 .ecindex IIDutils
38686
38687
38688 . ////////////////////////////////////////////////////////////////////////////
38689 . ////////////////////////////////////////////////////////////////////////////
38690
38691 .chapter "The Exim monitor" "CHAPeximon"
38692 .scindex IIDeximon "Exim monitor" "description"
38693 .cindex "X-windows"
38694 .cindex "&'eximon'&"
38695 .cindex "Local/eximon.conf"
38696 .cindex "&_exim_monitor/EDITME_&"
38697 The Exim monitor is an application which displays in an X window information
38698 about the state of Exim's queue and what Exim is doing. An admin user can
38699 perform certain operations on messages from this GUI interface; however all
38700 such facilities are also available from the command line, and indeed, the
38701 monitor itself makes use of the command line to perform any actions requested.
38702
38703
38704
38705 .section "Running the monitor" "SECID264"
38706 The monitor is started by running the script called &'eximon'&. This is a shell
38707 script that sets up a number of environment variables, and then runs the
38708 binary called &_eximon.bin_&. The default appearance of the monitor window can
38709 be changed by editing the &_Local/eximon.conf_& file created by editing
38710 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38711 parameters are for.
38712
38713 The parameters that get built into the &'eximon'& script can be overridden for
38714 a particular invocation by setting up environment variables of the same names,
38715 preceded by &`EXIMON_`&. For example, a shell command such as
38716 .code
38717 EXIMON_LOG_DEPTH=400 eximon
38718 .endd
38719 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38720 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38721 overrides the Exim log file configuration. This makes it possible to have
38722 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38723 syslog messages are routed to a file on the local host.
38724
38725 X resources can be used to change the appearance of the window in the normal
38726 way. For example, a resource setting of the form
38727 .code
38728 Eximon*background: gray94
38729 .endd
38730 changes the colour of the background to light grey rather than white. The
38731 stripcharts are drawn with both the data lines and the reference lines in
38732 black. This means that the reference lines are not visible when on top of the
38733 data. However, their colour can be changed by setting a resource called
38734 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38735 For example, if your X server is running Unix, you could set up lighter
38736 reference lines in the stripcharts by obeying
38737 .code
38738 xrdb -merge <<End
38739 Eximon*highlight: gray
38740 End
38741 .endd
38742 .cindex "admin user"
38743 In order to see the contents of messages in the queue, and to operate on them,
38744 &'eximon'& must either be run as root or by an admin user.
38745
38746 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38747 contain X11 resource parameters interpreted by the X11 library.  In addition,
38748 if the first parameter starts with the string "gdb" then it is removed and the
38749 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38750 versioned variants of gdb can be invoked).
38751
38752 The monitor's window is divided into three parts. The first contains one or
38753 more stripcharts and two action buttons, the second contains a &"tail"& of the
38754 main log file, and the third is a display of the queue of messages awaiting
38755 delivery, with two more action buttons. The following sections describe these
38756 different parts of the display.
38757
38758
38759
38760
38761 .section "The stripcharts" "SECID265"
38762 .cindex "stripchart"
38763 The first stripchart is always a count of messages in the queue. Its name can
38764 be configured by setting QUEUE_STRIPCHART_NAME in the
38765 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38766 configuration script by regular expression matches on log file entries, making
38767 it possible to display, for example, counts of messages delivered to certain
38768 hosts or using certain transports. The supplied defaults display counts of
38769 received and delivered messages, and of local and SMTP deliveries. The default
38770 period between stripchart updates is one minute; this can be adjusted by a
38771 parameter in the &_Local/eximon.conf_& file.
38772
38773 The stripchart displays rescale themselves automatically as the value they are
38774 displaying changes. There are always 10 horizontal lines in each chart; the
38775 title string indicates the value of each division when it is greater than one.
38776 For example, &"x2"& means that each division represents a value of 2.
38777
38778 It is also possible to have a stripchart which shows the percentage fullness of
38779 a particular disk partition, which is useful when local deliveries are confined
38780 to a single partition.
38781
38782 .cindex "&%statvfs%& function"
38783 This relies on the availability of the &[statvfs()]& function or equivalent in
38784 the operating system. Most, but not all versions of Unix that support Exim have
38785 this. For this particular stripchart, the top of the chart always represents
38786 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38787 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38788 &_Local/eximon.conf_& file.
38789
38790
38791
38792
38793 .section "Main action buttons" "SECID266"
38794 .cindex "size" "of monitor window"
38795 .cindex "Exim monitor" "window size"
38796 .cindex "window size"
38797 Below the stripcharts there is an action button for quitting the monitor. Next
38798 to this is another button marked &"Size"&. They are placed here so that
38799 shrinking the window to its default minimum size leaves just the queue count
38800 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38801 the window to expand to its maximum size, unless it is already at the maximum,
38802 in which case it is reduced to its minimum.
38803
38804 When expanding to the maximum, if the window cannot be fully seen where it
38805 currently is, it is moved back to where it was the last time it was at full
38806 size. When it is expanding from its minimum size, the old position is
38807 remembered, and next time it is reduced to the minimum it is moved back there.
38808
38809 The idea is that you can keep a reduced window just showing one or two
38810 stripcharts at a convenient place on your screen, easily expand it to show
38811 the full window when required, and just as easily put it back to what it was.
38812 The idea is copied from what the &'twm'& window manager does for its
38813 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38814 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38815
38816 Normally, the monitor starts up with the window at its full size, but it can be
38817 built so that it starts up with the window at its smallest size, by setting
38818 START_SMALL=yes in &_Local/eximon.conf_&.
38819
38820
38821
38822 .section "The log display" "SECID267"
38823 .cindex "log" "tail of; in monitor"
38824 The second section of the window is an area in which a display of the tail of
38825 the main log is maintained.
38826 To save space on the screen, the timestamp on each log line is shortened by
38827 removing the date and, if &%log_timezone%& is set, the timezone.
38828 The log tail is not available when the only destination for logging data is
38829 syslog, unless the syslog lines are routed to a local file whose name is passed
38830 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38831
38832 The log sub-window has a scroll bar at its lefthand side which can be used to
38833 move back to look at earlier text, and the up and down arrow keys also have a
38834 scrolling effect. The amount of log that is kept depends on the setting of
38835 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38836 to use. When this is full, the earlier 50% of data is discarded &-- this is
38837 much more efficient than throwing it away line by line. The sub-window also has
38838 a horizontal scroll bar for accessing the ends of long log lines. This is the
38839 only means of horizontal scrolling; the right and left arrow keys are not
38840 available. Text can be cut from this part of the window using the mouse in the
38841 normal way. The size of this subwindow is controlled by parameters in the
38842 configuration file &_Local/eximon.conf_&.
38843
38844 Searches of the text in the log window can be carried out by means of the ^R
38845 and ^S keystrokes, which default to a reverse and a forward search,
38846 respectively. The search covers only the text that is displayed in the window.
38847 It cannot go further back up the log.
38848
38849 The point from which the search starts is indicated by a caret marker. This is
38850 normally at the end of the text in the window, but can be positioned explicitly
38851 by pointing and clicking with the left mouse button, and is moved automatically
38852 by a successful search. If new text arrives in the window when it is scrolled
38853 back, the caret remains where it is, but if the window is not scrolled back,
38854 the caret is moved to the end of the new text.
38855
38856 Pressing ^R or ^S pops up a window into which the search text can be typed.
38857 There are buttons for selecting forward or reverse searching, for carrying out
38858 the search, and for cancelling. If the &"Search"& button is pressed, the search
38859 happens and the window remains so that further searches can be done. If the
38860 &"Return"& key is pressed, a single search is done and the window is closed. If
38861 ^C is typed the search is cancelled.
38862
38863 The searching facility is implemented using the facilities of the Athena text
38864 widget. By default this pops up a window containing both &"search"& and
38865 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38866 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38867 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38868 provided version of &%TextPop%& when the remaining parts of the text widget
38869 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38870 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38871 on these systems, at the expense of having unwanted items in the search popup
38872 window.
38873
38874
38875
38876 .section "The queue display" "SECID268"
38877 .cindex "queue" "display in monitor"
38878 The bottom section of the monitor window contains a list of all messages that
38879 are in the queue, which includes those currently being received or delivered,
38880 as well as those awaiting delivery. The size of this subwindow is controlled by
38881 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38882 at which it is updated is controlled by another parameter in the same file &--
38883 the default is 5 minutes, since queue scans can be quite expensive. However,
38884 there is an &"Update"& action button just above the display which can be used
38885 to force an update of the queue display at any time.
38886
38887 When a host is down for some time, a lot of pending mail can build up for it,
38888 and this can make it hard to deal with other messages in the queue. To help
38889 with this situation there is a button next to &"Update"& called &"Hide"&. If
38890 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38891 type anything in here and press &"Return"&, the text is added to a chain of
38892 such texts, and if every undelivered address in a message matches at least one
38893 of the texts, the message is not displayed.
38894
38895 If there is an address that does not match any of the texts, all the addresses
38896 are displayed as normal. The matching happens on the ends of addresses so, for
38897 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38898 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38899 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38900 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38901 a hide request is automatically cancelled after one hour.
38902
38903 While the dialogue box is displayed, you can't press any buttons or do anything
38904 else to the monitor window. For this reason, if you want to cut text from the
38905 queue display to use in the dialogue box, you have to do the cutting before
38906 pressing the &"Hide"& button.
38907
38908 The queue display contains, for each unhidden queued message, the length of
38909 time it has been in the queue, the size of the message, the message id, the
38910 message sender, and the first undelivered recipient, all on one line. If it is
38911 a bounce message, the sender is shown as &"<>"&. If there is more than one
38912 recipient to which the message has not yet been delivered, subsequent ones are
38913 listed on additional lines, up to a maximum configured number, following which
38914 an ellipsis is displayed. Recipients that have already received the message are
38915 not shown.
38916
38917 .cindex "frozen messages" "display"
38918 If a message is frozen, an asterisk is displayed at the left-hand side.
38919
38920 The queue display has a vertical scroll bar, and can also be scrolled by means
38921 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38922 The text searching facilities, as described above for the log window, are also
38923 available, but the caret is always moved to the end of the text when the queue
38924 display is updated.
38925
38926
38927
38928 .section "The queue menu" "SECID269"
38929 .cindex "queue" "menu in monitor"
38930 If the &%shift%& key is held down and the left button is clicked when the mouse
38931 pointer is over the text for any message, an action menu pops up, and the first
38932 line of the queue display for the message is highlighted. This does not affect
38933 any selected text.
38934
38935 If you want to use some other event for popping up the menu, you can set the
38936 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38937 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38938 value set in this parameter is a standard X event description. For example, to
38939 run eximon using &%ctrl%& rather than &%shift%& you could use
38940 .code
38941 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38942 .endd
38943 The title of the menu is the message id, and it contains entries which act as
38944 follows:
38945
38946 .ilist
38947 &'message log'&: The contents of the message log for the message are displayed
38948 in a new text window.
38949 .next
38950 &'headers'&: Information from the spool file that contains the envelope
38951 information and headers is displayed in a new text window. See chapter
38952 &<<CHAPspool>>& for a description of the format of spool files.
38953 .next
38954 &'body'&: The contents of the spool file containing the body of the message are
38955 displayed in a new text window. There is a default limit of 20,000 bytes to the
38956 amount of data displayed. This can be changed by setting the BODY_MAX
38957 option at compile time, or the EXIMON_BODY_MAX option at runtime.
38958 .next
38959 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38960 delivery of the message. This causes an automatic thaw if the message is
38961 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38962 a new text window. The delivery is run in a separate process, to avoid holding
38963 up the monitor while the delivery proceeds.
38964 .next
38965 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38966 that the message be frozen.
38967 .next
38968 .cindex "thawing messages"
38969 .cindex "unfreezing messages"
38970 .cindex "frozen messages" "thawing"
38971 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38972 that the message be thawed.
38973 .next
38974 .cindex "delivery" "forcing failure"
38975 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38976 that Exim gives up trying to deliver the message. A bounce message is generated
38977 for any remaining undelivered addresses.
38978 .next
38979 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38980 that the message be deleted from the system without generating a bounce
38981 message.
38982 .next
38983 &'add recipient'&: A dialog box is displayed into which a recipient address can
38984 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38985 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38986 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38987 causes a call to Exim to be made using the &%-Mar%& option to request that an
38988 additional recipient be added to the message, unless the entry box is empty, in
38989 which case no action is taken.
38990 .next
38991 &'mark delivered'&: A dialog box is displayed into which a recipient address
38992 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38993 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38994 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38995 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38996 recipient address as already delivered, unless the entry box is empty, in which
38997 case no action is taken.
38998 .next
38999 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39000 mark all recipient addresses as already delivered.
39001 .next
39002 &'edit sender'&: A dialog box is displayed initialized with the current
39003 sender's address. Pressing RETURN causes a call to Exim to be made using the
39004 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39005 in which case no action is taken. If you want to set an empty sender (as in
39006 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39007 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39008 the address is qualified with that domain.
39009 .endlist
39010
39011 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39012 other cases when a call to Exim is made, if there is any output from Exim (in
39013 particular, if the command fails) a window containing the command and the
39014 output is displayed. Otherwise, the results of the action are normally apparent
39015 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39016 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39017 if no output is generated.
39018
39019 The queue display is automatically updated for actions such as freezing and
39020 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39021 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39022 force an update of the display after one of these actions.
39023
39024 In any text window that is displayed as result of a menu action, the normal
39025 cut-and-paste facility is available, and searching can be carried out using ^R
39026 and ^S, as described above for the log tail window.
39027 .ecindex IIDeximon
39028
39029
39030
39031
39032
39033 . ////////////////////////////////////////////////////////////////////////////
39034 . ////////////////////////////////////////////////////////////////////////////
39035
39036 .chapter "Security considerations" "CHAPsecurity"
39037 .scindex IIDsecurcon "security" "discussion of"
39038 This chapter discusses a number of issues concerned with security, some of
39039 which are also covered in other parts of this manual.
39040
39041 For reasons that this author does not understand, some people have promoted
39042 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39043 existence of this chapter in the documentation. However, the intent of the
39044 chapter is simply to describe the way Exim works in relation to certain
39045 security concerns, not to make any specific claims about the effectiveness of
39046 its security as compared with other MTAs.
39047
39048 What follows is a description of the way Exim is supposed to be. Best efforts
39049 have been made to try to ensure that the code agrees with the theory, but an
39050 absence of bugs can never be guaranteed. Any that are reported will get fixed
39051 as soon as possible.
39052
39053
39054 .section "Building a more &""hardened""& Exim" "SECID286"
39055 .cindex "security" "build-time features"
39056 There are a number of build-time options that can be set in &_Local/Makefile_&
39057 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39058 Exim administrator who does not have the root password, or by someone who has
39059 penetrated the Exim (but not the root) account. These options are as follows:
39060
39061 .ilist
39062 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39063 start of any filenames used with the &%-C%& option. When it is set, these
39064 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39065 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39066 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39067 default setting for &%ALT_CONFIG_PREFIX%&.
39068
39069 If the permitted configuration files are confined to a directory to
39070 which only root has access, this guards against someone who has broken
39071 into the Exim account from running a privileged Exim with an arbitrary
39072 configuration file, and using it to break into other accounts.
39073 .next
39074
39075 If a non-trusted configuration file (i.e. not the default configuration file
39076 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39077 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39078 the next item), then root privilege is retained only if the caller of Exim is
39079 root. This locks out the possibility of testing a configuration using &%-C%&
39080 right through message reception and delivery, even if the caller is root. The
39081 reception works, but by that time, Exim is running as the Exim user, so when
39082 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39083 privilege to be lost. However, root can test reception and delivery using two
39084 separate commands.
39085
39086 .next
39087 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39088 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39089 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39090 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39091 the restrictive side.  Requiring build-time selection of safe macros is onerous
39092 but this option is intended solely as a transition mechanism to permit
39093 previously-working configurations to continue to work after release 4.73.
39094 .next
39095 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39096 is disabled.
39097 .next
39098 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39099 never to be used for any deliveries. This is like the &%never_users%& runtime
39100 option, but it cannot be overridden; the runtime option adds additional users
39101 to the list. The default setting is &"root"&; this prevents a non-root user who
39102 is permitted to modify the runtime file from using Exim as a way to get root.
39103 .endlist
39104
39105
39106
39107 .section "Root privilege" "SECID270"
39108 .cindex "setuid"
39109 .cindex "root privilege"
39110 The Exim binary is normally setuid to root, which means that it gains root
39111 privilege (runs as root) when it starts execution. In some special cases (for
39112 example, when the daemon is not in use and there are no local deliveries), it
39113 may be possible to run Exim setuid to some user other than root. This is
39114 discussed in the next section. However, in most installations, root privilege
39115 is required for two things:
39116
39117 .ilist
39118 To set up a socket connected to the standard SMTP port (25) when initialising
39119 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39120 not required.
39121 .next
39122 To be able to change uid and gid in order to read users' &_.forward_& files and
39123 perform local deliveries as the receiving user or as specified in the
39124 configuration.
39125 .endlist
39126
39127 It is not necessary to be root to do any of the other things Exim does, such as
39128 receiving messages and delivering them externally over SMTP, and it is
39129 obviously more secure if Exim does not run as root except when necessary.
39130 For this reason, a user and group for Exim to use must be defined in
39131 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39132 group"&. Their values can be changed by the runtime configuration, though this
39133 is not recommended. Often a user called &'exim'& is used, but some sites use
39134 &'mail'& or another user name altogether.
39135
39136 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39137 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39138 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39139
39140 After a new Exim process has interpreted its command line options, it changes
39141 uid and gid in the following cases:
39142
39143 .ilist
39144 .oindex "&%-C%&"
39145 .oindex "&%-D%&"
39146 If the &%-C%& option is used to specify an alternate configuration file, or if
39147 the &%-D%& option is used to define macro values for the configuration, and the
39148 calling process is not running as root, the uid and gid are changed to those of
39149 the calling process.
39150 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39151 option may not be used at all.
39152 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39153 can be supplied if the calling process is running as root, the Exim run-time
39154 user or CONFIGURE_OWNER, if defined.
39155 .next
39156 .oindex "&%-be%&"
39157 .oindex "&%-bf%&"
39158 .oindex "&%-bF%&"
39159 If the expansion test option (&%-be%&) or one of the filter testing options
39160 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39161 calling process.
39162 .next
39163 If the process is not a daemon process or a queue runner process or a delivery
39164 process or a process for testing address routing (started with &%-bt%&), the
39165 uid and gid are changed to the Exim user and group. This means that Exim always
39166 runs under its own uid and gid when receiving messages. This also applies when
39167 testing address verification
39168 .oindex "&%-bv%&"
39169 .oindex "&%-bh%&"
39170 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39171 option).
39172 .next
39173 For a daemon, queue runner, delivery, or address testing process, the uid
39174 remains as root at this stage, but the gid is changed to the Exim group.
39175 .endlist
39176
39177 The processes that initially retain root privilege behave as follows:
39178
39179 .ilist
39180 A daemon process changes the gid to the Exim group and the uid to the Exim
39181 user after setting up one or more listening sockets. The &[initgroups()]&
39182 function is called, so that if the Exim user is in any additional groups, they
39183 will be used during message reception.
39184 .next
39185 A queue runner process retains root privilege throughout its execution. Its
39186 job is to fork a controlled sequence of delivery processes.
39187 .next
39188 A delivery process retains root privilege throughout most of its execution,
39189 but any actual deliveries (that is, the transports themselves) are run in
39190 subprocesses which always change to a non-root uid and gid. For local
39191 deliveries this is typically the uid and gid of the owner of the mailbox; for
39192 remote deliveries, the Exim uid and gid are used. Once all the delivery
39193 subprocesses have been run, a delivery process changes to the Exim uid and gid
39194 while doing post-delivery tidying up such as updating the retry database and
39195 generating bounce and warning messages.
39196
39197 While the recipient addresses in a message are being routed, the delivery
39198 process runs as root. However, if a user's filter file has to be processed,
39199 this is done in a subprocess that runs under the individual user's uid and
39200 gid. A system filter is run as root unless &%system_filter_user%& is set.
39201 .next
39202 A process that is testing addresses (the &%-bt%& option) runs as root so that
39203 the routing is done in the same environment as a message delivery.
39204 .endlist
39205
39206
39207
39208
39209 .section "Running Exim without privilege" "SECTrunexiwitpri"
39210 .cindex "privilege, running without"
39211 .cindex "unprivileged running"
39212 .cindex "root privilege" "running without"
39213 Some installations like to run Exim in an unprivileged state for more of its
39214 operation, for added security. Support for this mode of operation is provided
39215 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39216 gid are changed to the Exim user and group at the start of a delivery process
39217 (and also queue runner and address testing processes). This means that address
39218 routing is no longer run as root, and the deliveries themselves cannot change
39219 to any other uid.
39220
39221 .cindex SIGHUP
39222 .cindex "daemon" "restarting"
39223 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39224 that the daemon can still be started in the usual way, and it can respond
39225 correctly to SIGHUP because the re-invocation regains root privilege.
39226
39227 An alternative approach is to make Exim setuid to the Exim user and also setgid
39228 to the Exim group. If you do this, the daemon must be started from a root
39229 process. (Calling Exim from a root process makes it behave in the way it does
39230 when it is setuid root.) However, the daemon cannot restart itself after a
39231 SIGHUP signal because it cannot regain privilege.
39232
39233 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39234 stops Exim from trying to re-invoke itself to do a delivery after a message has
39235 been received. Such a re-invocation is a waste of resources because it has no
39236 effect.
39237
39238 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39239 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39240 to the Exim user seems a clean approach, but there is one complication:
39241
39242 In this style of operation, Exim is running with the real uid and gid set to
39243 those of the calling process, and the effective uid/gid set to Exim's values.
39244 Ideally, any association with the calling process' uid/gid should be dropped,
39245 that is, the real uid/gid should be reset to the effective values so as to
39246 discard any privileges that the caller may have. While some operating systems
39247 have a function that permits this action for a non-root effective uid, quite a
39248 number of them do not. Because of this lack of standardization, Exim does not
39249 address this problem at this time.
39250
39251 For this reason, the recommended approach for &"mostly unprivileged"& running
39252 is to keep the Exim binary setuid to root, and to set
39253 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39254 be used in the most straightforward way.
39255
39256 If you configure Exim not to run delivery processes as root, there are a
39257 number of restrictions on what you can do:
39258
39259 .ilist
39260 You can deliver only as the Exim user/group. You should  explicitly use the
39261 &%user%& and &%group%& options to override routers or local transports that
39262 normally deliver as the recipient. This makes sure that configurations that
39263 work in this mode function the same way in normal mode. Any implicit or
39264 explicit specification of another user causes an error.
39265 .next
39266 Use of &_.forward_& files is severely restricted, such that it is usually
39267 not worthwhile to include them in the configuration.
39268 .next
39269 Users who wish to use &_.forward_& would have to make their home directory and
39270 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39271 and their equivalents in Exim filters, cannot be used. While they could be
39272 enabled in the Exim user's name, that would be insecure and not very useful.
39273 .next
39274 Unless the local user mailboxes are all owned by the Exim user (possible in
39275 some POP3 or IMAP-only environments):
39276
39277 .olist
39278 They must be owned by the Exim group and be writeable by that group. This
39279 implies you must set &%mode%& in the appendfile configuration, as well as the
39280 mode of the mailbox files themselves.
39281 .next
39282 You must set &%no_check_owner%&, since most or all of the files will not be
39283 owned by the Exim user.
39284 .next
39285 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39286 on a newly created mailbox when unprivileged. This also implies that new
39287 mailboxes need to be created manually.
39288 .endlist olist
39289 .endlist ilist
39290
39291
39292 These restrictions severely restrict what can be done in local deliveries.
39293 However, there are no restrictions on remote deliveries. If you are running a
39294 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39295 gives more security at essentially no cost.
39296
39297 If you are using the &%mua_wrapper%& facility (see chapter
39298 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39299
39300
39301
39302
39303 .section "Delivering to local files" "SECID271"
39304 Full details of the checks applied by &(appendfile)& before it writes to a file
39305 are given in chapter &<<CHAPappendfile>>&.
39306
39307
39308
39309 .section "Running local commands" "SECTsecconslocalcmds"
39310 .cindex "security" "local commands"
39311 .cindex "security" "command injection attacks"
39312 There are a number of ways in which an administrator can configure Exim to run
39313 commands based upon received, untrustworthy, data. Further, in some
39314 configurations a user who can control a &_.forward_& file can also arrange to
39315 run commands. Configuration to check includes, but is not limited to:
39316
39317 .ilist
39318 Use of &%use_shell%& in the pipe transport: various forms of shell command
39319 injection may be possible with this option present. It is dangerous and should
39320 be used only with considerable caution. Consider constraints which whitelist
39321 allowed characters in a variable which is to be used in a pipe transport that
39322 has &%use_shell%& enabled.
39323 .next
39324 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39325 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39326 &_.forward_& files in a redirect router. If Exim is running on a central mail
39327 hub to which ordinary users do not have shell access, but home directories are
39328 NFS mounted (for instance) then administrators should review the list of these
39329 forbid options available, and should bear in mind that the options that may
39330 need forbidding can change as new features are added between releases.
39331 .next
39332 The &%${run...}%& expansion item does not use a shell by default, but
39333 administrators can configure use of &_/bin/sh_& as part of the command.
39334 Such invocations should be viewed with prejudicial suspicion.
39335 .next
39336 Administrators who use embedded Perl are advised to explore how Perl's
39337 taint checking might apply to their usage.
39338 .next
39339 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39340 administrators are well advised to view its use with suspicion, in case (for
39341 instance) it allows a local-part to contain embedded Exim directives.
39342 .next
39343 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39344 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39345 each can reference arbitrary lists and files, rather than just being a list
39346 of opaque strings.
39347 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39348 real-world security vulnerabilities caused by its use with untrustworthy data
39349 injected in, for SQL injection attacks.
39350 Consider the use of the &%inlisti%& expansion condition instead.
39351 .endlist
39352
39353
39354
39355
39356 .section "Trust in configuration data" "SECTsecconfdata"
39357 .cindex "security" "data sources"
39358 .cindex "security" "regular expressions"
39359 .cindex "regular expressions" "security"
39360 .cindex "PCRE" "security"
39361 If configuration data for Exim can come from untrustworthy sources, there
39362 are some issues to be aware of:
39363
39364 .ilist
39365 Use of &%${expand...}%& may provide a path for shell injection attacks.
39366 .next
39367 Letting untrusted data provide a regular expression is unwise.
39368 .next
39369 Using &%${match...}%& to apply a fixed regular expression against untrusted
39370 data may result in pathological behaviour within PCRE.  Be aware of what
39371 "backtracking" means and consider options for being more strict with a regular
39372 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39373 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39374 possessive quantifiers or just not using regular expressions against untrusted
39375 data.
39376 .next
39377 It can be important to correctly use &%${quote:...}%&,
39378 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39379 items to ensure that data is correctly constructed.
39380 .next
39381 Some lookups might return multiple results, even though normal usage is only
39382 expected to yield one result.
39383 .endlist
39384
39385
39386
39387
39388 .section "IPv4 source routing" "SECID272"
39389 .cindex "source routing" "in IP packets"
39390 .cindex "IP source routing"
39391 Many operating systems suppress IP source-routed packets in the kernel, but
39392 some cannot be made to do this, so Exim does its own check. It logs incoming
39393 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39394 IPv6. No special checking is currently done.
39395
39396
39397
39398 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39399 Support for these SMTP commands is disabled by default. If required, they can
39400 be enabled by defining suitable ACLs.
39401
39402
39403
39404
39405 .section "Privileged users" "SECID274"
39406 .cindex "trusted users"
39407 .cindex "admin user"
39408 .cindex "privileged user"
39409 .cindex "user" "trusted"
39410 .cindex "user" "admin"
39411 Exim recognizes two sets of users with special privileges. Trusted users are
39412 able to submit new messages to Exim locally, but supply their own sender
39413 addresses and information about a sending host. For other users submitting
39414 local messages, Exim sets up the sender address from the uid, and doesn't
39415 permit a remote host to be specified.
39416
39417 .oindex "&%-f%&"
39418 However, an untrusted user is permitted to use the &%-f%& command line option
39419 in the special form &%-f <>%& to indicate that a delivery failure for the
39420 message should not cause an error report. This affects the message's envelope,
39421 but it does not affect the &'Sender:'& header. Untrusted users may also be
39422 permitted to use specific forms of address with the &%-f%& option by setting
39423 the &%untrusted_set_sender%& option.
39424
39425 Trusted users are used to run processes that receive mail messages from some
39426 other mail domain and pass them on to Exim for delivery either locally, or over
39427 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39428 as any user listed in the &%trusted_users%& configuration option, or under any
39429 group listed in the &%trusted_groups%& option.
39430
39431 Admin users are permitted to do things to the messages on Exim's queue. They
39432 can freeze or thaw messages, cause them to be returned to their senders, remove
39433 them entirely, or modify them in various ways. In addition, admin users can run
39434 the Exim monitor and see all the information it is capable of providing, which
39435 includes the contents of files on the spool.
39436
39437 .oindex "&%-M%&"
39438 .oindex "&%-q%&"
39439 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39440 delivery of messages on its queue is restricted to admin users. This
39441 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39442 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39443 queue is also restricted to admin users. This restriction can be relaxed by
39444 setting &%no_queue_list_requires_admin%&.
39445
39446 Exim recognizes an admin user if the calling process is running as root or as
39447 the Exim user or if any of the groups associated with the calling process is
39448 the Exim group. It is not necessary actually to be running under the Exim
39449 group. However, if admin users who are not root or the Exim user are to access
39450 the contents of files on the spool via the Exim monitor (which runs
39451 unprivileged), Exim must be built to allow group read access to its spool
39452 files.
39453
39454 By default, regular users are trusted to perform basic testing and
39455 introspection commands, as themselves.  This setting can be tightened by
39456 setting the &%commandline_checks_require_admin%& option.
39457 This affects most of the checking options,
39458 such as &%-be%& and anything else &%-b*%&.
39459
39460
39461 .section "Spool files" "SECID275"
39462 .cindex "spool directory" "files"
39463 Exim's spool directory and everything it contains is owned by the Exim user and
39464 set to the Exim group. The mode for spool files is defined in the
39465 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39466 any user who is a member of the Exim group can access these files.
39467
39468
39469
39470 .section "Use of argv[0]" "SECID276"
39471 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39472 of specific strings, Exim assumes certain options. For example, calling Exim
39473 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39474 to calling it with the option &%-bS%&. There are no security implications in
39475 this.
39476
39477
39478
39479 .section "Use of %f formatting" "SECID277"
39480 The only use made of &"%f"& by Exim is in formatting load average values. These
39481 are actually stored in integer variables as 1000 times the load average.
39482 Consequently, their range is limited and so therefore is the length of the
39483 converted output.
39484
39485
39486
39487 .section "Embedded Exim path" "SECID278"
39488 Exim uses its own path name, which is embedded in the code, only when it needs
39489 to re-exec in order to regain root privilege. Therefore, it is not root when it
39490 does so. If some bug allowed the path to get overwritten, it would lead to an
39491 arbitrary program's being run as exim, not as root.
39492
39493
39494
39495 .section "Dynamic module directory" "SECTdynmoddir"
39496 Any dynamically loadable modules must be installed into the directory
39497 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39498 loading it.
39499
39500
39501 .section "Use of sprintf()" "SECID279"
39502 .cindex "&[sprintf()]&"
39503 A large number of occurrences of &"sprintf"& in the code are actually calls to
39504 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39505 The intermediate formatting is done into a large fixed buffer by a function
39506 that runs through the format string itself, and checks the length of each
39507 conversion before performing it, thus preventing buffer overruns.
39508
39509 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39510 the output buffer is known to be sufficiently long to contain the converted
39511 string.
39512
39513
39514
39515 .section "Use of debug_printf() and log_write()" "SECID280"
39516 Arbitrary strings are passed to both these functions, but they do their
39517 formatting by calling the function &'string_vformat()'&, which runs through
39518 the format string itself, and checks the length of each conversion.
39519
39520
39521
39522 .section "Use of strcat() and strcpy()" "SECID281"
39523 These are used only in cases where the output buffer is known to be large
39524 enough to hold the result.
39525 .ecindex IIDsecurcon
39526
39527
39528
39529
39530 . ////////////////////////////////////////////////////////////////////////////
39531 . ////////////////////////////////////////////////////////////////////////////
39532
39533 .chapter "Format of spool files" "CHAPspool"
39534 .scindex IIDforspo1 "format" "spool files"
39535 .scindex IIDforspo2 "spool directory" "format of files"
39536 .scindex IIDforspo3 "spool files" "format of"
39537 .cindex "spool files" "editing"
39538 A message on Exim's queue consists of two files, whose names are the message id
39539 followed by -D and -H, respectively. The data portion of the message is kept in
39540 the -D file on its own. The message's envelope, status, and headers are all
39541 kept in the -H file, whose format is described in this chapter. Each of these
39542 two files contains the final component of its own name as its first line. This
39543 is insurance against disk crashes where the directory is lost but the files
39544 themselves are recoverable.
39545
39546 The file formats may be changed, or new formats added, at any release.
39547 Spool files are not intended as an interface to other programs
39548 and should not be used as such.
39549
39550 Some people are tempted into editing -D files in order to modify messages. You
39551 need to be extremely careful if you do this; it is not recommended and you are
39552 on your own if you do it. Here are some of the pitfalls:
39553
39554 .ilist
39555 You must ensure that Exim does not try to deliver the message while you are
39556 fiddling with it. The safest way is to take out a write lock on the -D file,
39557 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39558 place, the lock will be retained. If you write a new file and rename it, the
39559 lock will be lost at the instant of rename.
39560 .next
39561 .vindex "&$body_linecount$&"
39562 If you change the number of lines in the file, the value of
39563 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39564 cause incomplete transmission of messages or undeliverable messages.
39565 .next
39566 If the message is in MIME format, you must take care not to break it.
39567 .next
39568 If the message is cryptographically signed, any change will invalidate the
39569 signature.
39570 .endlist
39571 All in all, modifying -D files is fraught with danger.
39572
39573 Files whose names end with -J may also be seen in the &_input_& directory (or
39574 its subdirectories when &%split_spool_directory%& is set). These are journal
39575 files, used to record addresses to which the message has been delivered during
39576 the course of a delivery attempt. If there are still undelivered recipients at
39577 the end, the -H file is updated, and the -J file is deleted. If, however, there
39578 is some kind of crash (for example, a power outage) before this happens, the -J
39579 file remains in existence. When Exim next processes the message, it notices the
39580 -J file and uses it to update the -H file before starting the next delivery
39581 attempt.
39582
39583 Files whose names end with -K or .eml may also be seen in the spool.
39584 These are temporaries used for DKIM or malware processing, when that is used.
39585 They should be tidied up by normal operations; any old ones are probably
39586 relics of crashes and can be removed.
39587
39588 .section "Format of the -H file" "SECID282"
39589 .cindex "uid (user id)" "in spool file"
39590 .cindex "gid (group id)" "in spool file"
39591 The second line of the -H file contains the login name for the uid of the
39592 process that called Exim to read the message, followed by the numerical uid and
39593 gid. For a locally generated message, this is normally the user who sent the
39594 message. For a message received over TCP/IP via the daemon, it is
39595 normally the Exim user.
39596
39597 The third line of the file contains the address of the message's sender as
39598 transmitted in the envelope, contained in angle brackets. The sender address is
39599 empty for bounce messages. For incoming SMTP mail, the sender address is given
39600 in the MAIL command. For locally generated mail, the sender address is
39601 created by Exim from the login name of the current user and the configured
39602 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39603 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39604 &"<>"& or an address that matches &%untrusted_set_senders%&.
39605
39606 The fourth line contains two numbers. The first is the time that the message
39607 was received, in the conventional Unix form &-- the number of seconds since the
39608 start of the epoch. The second number is a count of the number of messages
39609 warning of delayed delivery that have been sent to the sender.
39610
39611 There follow a number of lines starting with a hyphen. These can appear in any
39612 order, and are omitted when not relevant:
39613
39614 .vlist
39615 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39616 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39617 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39618 recognized, to provide backward compatibility. In the old format, a line of
39619 this form is present for every ACL variable that is not empty. The number
39620 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39621 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39622 the data string for the variable. The string itself starts at the beginning of
39623 the next line, and is followed by a newline character. It may contain internal
39624 newlines.
39625
39626 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39627 A line of this form is present for every ACL connection variable that is
39628 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39629 The length is the length of the data string for the variable. The string itself
39630 starts at the beginning of the next line, and is followed by a newline
39631 character. It may contain internal newlines.
39632
39633 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39634 A line of this form is present for every ACL message variable that is defined.
39635 Note that there is a space between &%-aclm%& and the rest of the name. The
39636 length is the length of the data string for the variable. The string itself
39637 starts at the beginning of the next line, and is followed by a newline
39638 character. It may contain internal newlines.
39639
39640 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39641 This is present if, when the message was received over SMTP, the value of
39642 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39643
39644 .vitem &%-allow_unqualified_recipient%&
39645 This is present if unqualified recipient addresses are permitted in header
39646 lines (to stop such addresses from being qualified if rewriting occurs at
39647 transport time). Local messages that were input using &%-bnq%& and remote
39648 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39649
39650 .vitem &%-allow_unqualified_sender%&
39651 This is present if unqualified sender addresses are permitted in header lines
39652 (to stop such addresses from being qualified if rewriting occurs at transport
39653 time). Local messages that were input using &%-bnq%& and remote messages from
39654 hosts that match &%sender_unqualified_hosts%& set this flag.
39655
39656 .vitem "&%-auth_id%&&~<&'text'&>"
39657 The id information for a message received on an authenticated SMTP connection
39658 &-- the value of the &$authenticated_id$& variable.
39659
39660 .vitem "&%-auth_sender%&&~<&'address'&>"
39661 The address of an authenticated sender &-- the value of the
39662 &$authenticated_sender$& variable.
39663
39664 .vitem "&%-body_linecount%&&~<&'number'&>"
39665 This records the number of lines in the body of the message, and is
39666 present unless &%-spool_file_wireformat%& is.
39667
39668 .vitem "&%-body_zerocount%&&~<&'number'&>"
39669 This records the number of binary zero bytes in the body of the message, and is
39670 present if the number is greater than zero.
39671
39672 .vitem &%-deliver_firsttime%&
39673 This is written when a new message is first added to the spool. When the spool
39674 file is updated after a deferral, it is omitted.
39675
39676 .vitem "&%-frozen%&&~<&'time'&>"
39677 .cindex "frozen messages" "spool data"
39678 The message is frozen, and the freezing happened at <&'time'&>.
39679
39680 .vitem "&%-helo_name%&&~<&'text'&>"
39681 This records the host name as specified by a remote host in a HELO or EHLO
39682 command.
39683
39684 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39685 This records the IP address of the host from which the message was received and
39686 the remote port number that was used. It is omitted for locally generated
39687 messages.
39688
39689 .vitem "&%-host_auth%&&~<&'text'&>"
39690 If the message was received on an authenticated SMTP connection, this records
39691 the name of the authenticator &-- the value of the
39692 &$sender_host_authenticated$& variable.
39693
39694 .vitem &%-host_lookup_failed%&
39695 This is present if an attempt to look up the sending host's name from its IP
39696 address failed. It corresponds to the &$host_lookup_failed$& variable.
39697
39698 .vitem "&%-host_name%&&~<&'text'&>"
39699 .cindex "reverse DNS lookup"
39700 .cindex "DNS" "reverse lookup"
39701 This records the name of the remote host from which the message was received,
39702 if the host name was looked up from the IP address when the message was being
39703 received. It is not present if no reverse lookup was done.
39704
39705 .vitem "&%-ident%&&~<&'text'&>"
39706 For locally submitted messages, this records the login of the originating user,
39707 unless it was a trusted user and the &%-oMt%& option was used to specify an
39708 ident value. For messages received over TCP/IP, this records the ident string
39709 supplied by the remote host, if any.
39710
39711 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39712 This records the IP address of the local interface and the port number through
39713 which a message was received from a remote host. It is omitted for locally
39714 generated messages.
39715
39716 .vitem &%-local%&
39717 The message is from a local sender.
39718
39719 .vitem &%-localerror%&
39720 The message is a locally-generated bounce message.
39721
39722 .vitem "&%-local_scan%&&~<&'string'&>"
39723 This records the data string that was returned by the &[local_scan()]& function
39724 when the message was received &-- the value of the &$local_scan_data$&
39725 variable. It is omitted if no data was returned.
39726
39727 .vitem &%-manual_thaw%&
39728 The message was frozen but has been thawed manually, that is, by an explicit
39729 Exim command rather than via the auto-thaw process.
39730
39731 .vitem &%-N%&
39732 A testing delivery process was started using the &%-N%& option to suppress any
39733 actual deliveries, but delivery was deferred. At any further delivery attempts,
39734 &%-N%& is assumed.
39735
39736 .vitem &%-received_protocol%&
39737 This records the value of the &$received_protocol$& variable, which contains
39738 the name of the protocol by which the message was received.
39739
39740 .vitem &%-sender_set_untrusted%&
39741 The envelope sender of this message was set by an untrusted local caller (used
39742 to ensure that the caller is displayed in queue listings).
39743
39744 .vitem "&%-spam_score_int%&&~<&'number'&>"
39745 If a message was scanned by SpamAssassin, this is present. It records the value
39746 of &$spam_score_int$&.
39747
39748 .vitem &%-spool_file_wireformat%&
39749 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39750 rather than Unix-format.
39751 The line-ending is CRLF rather than newline.
39752 There is still, however, no leading-dot-stuffing.
39753
39754 .vitem &%-tls_certificate_verified%&
39755 A TLS certificate was received from the client that sent this message, and the
39756 certificate was verified by the server.
39757
39758 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39759 When the message was received over an encrypted connection, this records the
39760 name of the cipher suite that was used.
39761
39762 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39763 When the message was received over an encrypted connection, and a certificate
39764 was received from the client, this records the Distinguished Name from that
39765 certificate.
39766 .endlist
39767
39768 .new
39769 Any of the above may have an extra hyphen prepended, to indicate the the
39770 corresponding data is untrusted.
39771 .wen
39772
39773 Following the options there is a list of those addresses to which the message
39774 is not to be delivered. This set of addresses is initialized from the command
39775 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39776 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39777 the address is added to this set. The addresses are kept internally as a
39778 balanced binary tree, and it is a representation of that tree which is written
39779 to the spool file. If an address is expanded via an alias or forward file, the
39780 original address is added to the tree when deliveries to all its child
39781 addresses are complete.
39782
39783 If the tree is empty, there is a single line in the spool file containing just
39784 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39785 Y or N, followed by an address. The address is the value for the node of the
39786 tree, and the letters indicate whether the node has a left branch and/or a
39787 right branch attached to it, respectively. If branches exist, they immediately
39788 follow. Here is an example of a three-node tree:
39789 .code
39790 YY darcy@austen.fict.example
39791 NN alice@wonderland.fict.example
39792 NN editor@thesaurus.ref.example
39793 .endd
39794 After the non-recipients tree, there is a list of the message's recipients.
39795 This is a simple list, preceded by a count. It includes all the original
39796 recipients of the message, including those to whom the message has already been
39797 delivered. In the simplest case, the list contains one address per line. For
39798 example:
39799 .code
39800 4
39801 editor@thesaurus.ref.example
39802 darcy@austen.fict.example
39803 rdo@foundation
39804 alice@wonderland.fict.example
39805 .endd
39806 However, when a child address has been added to the top-level addresses as a
39807 result of the use of the &%one_time%& option on a &(redirect)& router, each
39808 line is of the following form:
39809 .display
39810 <&'top-level address'&> <&'errors_to address'&> &&&
39811   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39812 .endd
39813 The 01 flag bit indicates the presence of the three other fields that follow
39814 the top-level address. Other bits may be used in future to support additional
39815 fields. The <&'parent number'&> is the offset in the recipients list of the
39816 original parent of the &"one time"& address. The first two fields are the
39817 envelope sender that is associated with this address and its length. If the
39818 length is zero, there is no special envelope sender (there are then two space
39819 characters in the line). A non-empty field can arise from a &(redirect)& router
39820 that has an &%errors_to%& setting.
39821
39822
39823 A blank line separates the envelope and status information from the headers
39824 which follow. A header may occupy several lines of the file, and to save effort
39825 when reading it in, each header is preceded by a number and an identifying
39826 character. The number is the number of characters in the header, including any
39827 embedded newlines and the terminating newline. The character is one of the
39828 following:
39829
39830 .table2 50pt
39831 .row <&'blank'&>         "header in which Exim has no special interest"
39832 .row &`B`&               "&'Bcc:'& header"
39833 .row &`C`&               "&'Cc:'& header"
39834 .row &`F`&               "&'From:'& header"
39835 .row &`I`&               "&'Message-id:'& header"
39836 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39837 .row &`R`&               "&'Reply-To:'& header"
39838 .row &`S`&               "&'Sender:'& header"
39839 .row &`T`&               "&'To:'& header"
39840 .row &`*`&               "replaced or deleted header"
39841 .endtable
39842
39843 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39844 purposes. They are not transmitted when the message is delivered. Here is a
39845 typical set of headers:
39846 .code
39847 111P Received: by hobbit.fict.example with local (Exim 4.00)
39848 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39849 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39850 038* X-rewrote-sender: bb@hobbit.fict.example
39851 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39852 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39853 099* To: alice@wonderland.fict.example, rdo@foundation,
39854 darcy@austen.fict.example, editor@thesaurus.ref.example
39855 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39856 darcy@austen.fict.example, editor@thesaurus.ref.example
39857 038  Date: Fri, 11 May 2001 10:28:59 +0100
39858 .endd
39859 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39860 &'To:'& header have been rewritten, the last one because routing expanded the
39861 unqualified domain &'foundation'&.
39862 .ecindex IIDforspo1
39863 .ecindex IIDforspo2
39864 .ecindex IIDforspo3
39865
39866 .section "Format of the -D file" "SECID282a"
39867 The data file is traditionally in Unix-standard format: lines are ended with
39868 an ASCII newline character.
39869 However, when the &%spool_wireformat%& main option is used some -D files
39870 can have an alternate format.
39871 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39872 The -D file lines (not including the first name-component line) are
39873 suitable for direct copying to the wire when transmitting using the
39874 ESMTP CHUNKING option, meaning lower processing overhead.
39875 Lines are terminated with an ASCII CRLF pair.
39876 There is no dot-stuffing (and no dot-termination).
39877
39878 . ////////////////////////////////////////////////////////////////////////////
39879 . ////////////////////////////////////////////////////////////////////////////
39880
39881 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
39882          "DKIM, SPF and DMARC Support"
39883
39884 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39885 .cindex "DKIM"
39886
39887 DKIM is a mechanism by which messages sent by some entity can be provably
39888 linked to a domain which that entity controls.  It permits reputation to
39889 be tracked on a per-domain basis, rather than merely upon source IP address.
39890 DKIM is documented in RFC 6376.
39891
39892 As DKIM relies on the message being unchanged in transit, messages handled
39893 by a mailing-list (which traditionally adds to the message) will not match
39894 any original DKIM signature.
39895
39896 DKIM support is compiled into Exim by default if TLS support is present.
39897 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39898
39899 Exim's DKIM implementation allows for
39900 .olist
39901 Signing outgoing messages: This function is implemented in the SMTP transport.
39902 It can co-exist with all other Exim features
39903 (including transport filters)
39904 except cutthrough delivery.
39905 .next
39906 Verifying signatures in incoming messages: This is implemented by an additional
39907 ACL (acl_smtp_dkim), which can be called several times per message, with
39908 different signature contexts.
39909 .endlist
39910
39911 In typical Exim style, the verification implementation does not include any
39912 default "policy". Instead it enables you to build your own policy using
39913 Exim's standard controls.
39914
39915 Please note that verification of DKIM signatures in incoming mail is turned
39916 on by default for logging (in the <= line) purposes.
39917
39918 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39919 When set, for each signature in incoming email,
39920 exim will log a line displaying the most important signature details, and the
39921 signature status. Here is an example (with line-breaks added for clarity):
39922 .code
39923 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39924     d=facebookmail.com s=q1-2009b
39925     c=relaxed/relaxed a=rsa-sha1
39926     i=@facebookmail.com t=1252484542 [verification succeeded]
39927 .endd
39928
39929 You might want to turn off DKIM verification processing entirely for internal
39930 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39931 control modifier. This should typically be done in the RCPT ACL, at points
39932 where you accept mail from relay sources (internal hosts or authenticated
39933 senders).
39934
39935
39936 .section "Signing outgoing messages" "SECDKIMSIGN"
39937 .cindex "DKIM" "signing"
39938
39939 For signing to be usable you must have published a DKIM record in DNS.
39940 Note that RFC 8301 (which does not cover EC keys) says:
39941 .code
39942 rsa-sha1 MUST NOT be used for signing or verifying.
39943
39944 Signers MUST use RSA keys of at least 1024 bits for all keys.
39945 Signers SHOULD use RSA keys of at least 2048 bits.
39946 .endd
39947
39948 Note also that the key content (the 'p=' field)
39949 in the DNS record is different between RSA and EC keys;
39950 for the former it is the base64 of the ASN.1 for the RSA public key
39951 (equivalent to the private-key .pem with the header/trailer stripped)
39952 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39953
39954 Signing is enabled by setting private options on the SMTP transport.
39955 These options take (expandable) strings as arguments.
39956
39957 .option dkim_domain smtp string list&!! unset
39958 The domain(s) you want to sign with.
39959 After expansion, this can be a list.
39960 Each element in turn,
39961 .new
39962 lowercased,
39963 .wen
39964 is put into the &%$dkim_domain%& expansion variable
39965 while expanding the remaining signing options.
39966 If it is empty after expansion, DKIM signing is not done,
39967 and no error will result even if &%dkim_strict%& is set.
39968
39969 .option dkim_selector smtp string list&!! unset
39970 This sets the key selector string.
39971 After expansion, which can use &$dkim_domain$&, this can be a list.
39972 Each element in turn is put in the expansion
39973 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39974 option along with &%$dkim_domain%&.
39975 If the option is empty after expansion, DKIM signing is not done for this domain,
39976 and no error will result even if &%dkim_strict%& is set.
39977
39978 .option dkim_private_key smtp string&!! unset
39979 This sets the private key to use.
39980 You can use the &%$dkim_domain%& and
39981 &%$dkim_selector%& expansion variables to determine the private key to use.
39982 The result can either
39983 .ilist
39984 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39985 .next
39986 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39987 be a valid Ed25519 private key (same format as above)
39988 .next
39989 start with a slash, in which case it is treated as a file that contains
39990 the private key
39991 .next
39992 be "0", "false" or the empty string, in which case the message will not
39993 be signed. This case will not result in an error, even if &%dkim_strict%&
39994 is set.
39995 .endlist
39996
39997 To generate keys under OpenSSL:
39998 .code
39999 openssl genrsa -out dkim_rsa.private 2048
40000 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40001 .endd
40002 Take the base-64 lines from the output of the second command, concatenated,
40003 for the DNS TXT record.
40004 See section 3.6 of RFC6376 for the record specification.
40005
40006 Under GnuTLS:
40007 .code
40008 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40009 certtool --load-privkey=dkim_rsa.private --pubkey-info
40010 .endd
40011
40012 Note that RFC 8301 says:
40013 .code
40014 Signers MUST use RSA keys of at least 1024 bits for all keys.
40015 Signers SHOULD use RSA keys of at least 2048 bits.
40016 .endd
40017
40018 .new
40019 EC keys for DKIM are defined by RFC 8463.
40020 .wen
40021 They are considerably smaller than RSA keys for equivalent protection.
40022 As they are a recent development, users should consider dual-signing
40023 (by setting a list of selectors, and an expansion for this option)
40024 for some transition period.
40025 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40026 for EC keys.
40027
40028 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40029 .code
40030 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40031 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40032 .endd
40033
40034 To produce the required public key value for a DNS record:
40035 .code
40036 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40037 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40038 .endd
40039
40040 .new
40041 Exim also supports an alternate format
40042 of Ed25519 keys in DNS which was a candidate during development
40043 of the standard, but not adopted.
40044 A future release will probably drop that support.
40045 .wen
40046
40047 .option dkim_hash smtp string&!! sha256
40048 Can be set to any one of the supported hash methods, which are:
40049 .ilist
40050 &`sha1`& &-- should not be used, is old and insecure
40051 .next
40052 &`sha256`& &-- the default
40053 .next
40054 &`sha512`& &-- possibly more secure but less well supported
40055 .endlist
40056
40057 Note that RFC 8301 says:
40058 .code
40059 rsa-sha1 MUST NOT be used for signing or verifying.
40060 .endd
40061
40062 .option dkim_identity smtp string&!! unset
40063 If set after expansion, the value is used to set an "i=" tag in
40064 the signing header.  The DKIM standards restrict the permissible
40065 syntax of this optional tag to a mail address, with possibly-empty
40066 local part, an @, and a domain identical to or subdomain of the "d="
40067 tag value.  Note that Exim does not check the value.
40068
40069 .option dkim_canon smtp string&!! unset
40070 This option sets the canonicalization method used when signing a message.
40071 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40072 The option defaults to "relaxed" when unset. Note: the current implementation
40073 only supports signing with the same canonicalization method for both headers and body.
40074
40075 .option dkim_strict smtp string&!! unset
40076 This  option  defines  how  Exim  behaves  when  signing a message that
40077 should be signed fails for some reason.  When the expansion evaluates to
40078 either "1" or "true", Exim will defer. Otherwise Exim will send the message
40079 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40080 variables here.
40081
40082 .option dkim_sign_headers smtp string&!! "see below"
40083 If set, this option must expand to a colon-separated
40084 list of header names.
40085 Headers with these names, or the absence or such a header, will be included
40086 in the message signature.
40087 When unspecified, the header names listed in RFC4871 will be used,
40088 whether or not each header is present in the message.
40089 The default list is available for the expansion in the macro
40090 "_DKIM_SIGN_HEADERS".
40091
40092 If a name is repeated, multiple headers by that name (or the absence thereof)
40093 will be signed.  The textually later headers in the headers part of the
40094 message are signed first, if there are multiples.
40095
40096 A name can be prefixed with either an '=' or a '+' character.
40097 If an '=' prefix is used, all headers that are present with this name
40098 will be signed.
40099 If a '+' prefix if used, all headers that are present with this name
40100 will be signed, and one signature added for a missing header with the
40101 name will be appended.
40102
40103 .option dkim_timestamps smtp integer&!! unset
40104 This option controls the inclusion of timestamp information in the signature.
40105 If not set, no such information will be included.
40106 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40107 for the expiry tag
40108 (eg. 1209600 for two weeks);
40109 both creation (t=) and expiry (x=) tags will be included.
40110
40111 RFC 6376 lists these tags as RECOMMENDED.
40112
40113
40114 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40115 .cindex "DKIM" "verification"
40116
40117 Verification of DKIM signatures in SMTP incoming email is done for all
40118 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40119 .new
40120 .cindex DKIM "selecting signature algorithms"
40121 Individual classes of signature algorithm can be ignored by changing
40122 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40123 The &%dkim_verify_minimal%& option can be set to cease verification
40124 processing for a message once the first passing signature is found.
40125 .wen
40126
40127 .cindex authentication "expansion item"
40128 Performing verification sets up information used by the
40129 &%authresults%& expansion item.
40130
40131 .new
40132 For most purposes the default option settings suffice and the remainder
40133 of this section can be ignored.
40134 .wen
40135
40136 The results of verification are made available to the
40137 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40138 A missing ACL definition defaults to accept.
40139 By default, the ACL is called once for each
40140 syntactically(!) correct signature in the incoming message.
40141 If any ACL call does not accept, the message is not accepted.
40142 If a cutthrough delivery was in progress for the message, that is
40143 summarily dropped (having wasted the transmission effort).
40144
40145 To evaluate the verification result in the ACL
40146 a large number of expansion variables
40147 containing the signature status and its details are set up during the
40148 runtime of the ACL.
40149
40150 Calling the ACL only for existing signatures is not sufficient to build
40151 more advanced policies. For that reason, the main option
40152 &%dkim_verify_signers%&, and an expansion variable
40153 &%$dkim_signers%& exist.
40154
40155 The main option &%dkim_verify_signers%& can be set to a colon-separated
40156 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40157 called. It is expanded when the message has been received. At this point,
40158 the expansion variable &%$dkim_signers%& already contains a colon-separated
40159 list of signer domains and identities for the message. When
40160 &%dkim_verify_signers%& is not specified in the main configuration,
40161 it defaults as:
40162 .code
40163 dkim_verify_signers = $dkim_signers
40164 .endd
40165 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40166 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40167 call the ACL for known domains or identities. This would be achieved as follows:
40168 .code
40169 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40170 .endd
40171 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40172 and "ebay.com", plus all domains and identities that have signatures in the message.
40173 You can also be more creative in constructing your policy. For example:
40174 .code
40175 dkim_verify_signers = $sender_address_domain:$dkim_signers
40176 .endd
40177
40178 If a domain or identity is listed several times in the (expanded) value of
40179 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40180
40181 .new
40182 Note that if the option is set using untrustworthy data
40183 (such as the From: header)
40184 care should be taken to force lowercase for domains
40185 and for the domain part if identities.
40186 The default setting can be regarded as trustworthy in this respect.
40187 .wen
40188
40189 If multiple signatures match a domain (or identity), the ACL is called once
40190 for each matching signature.
40191
40192
40193 Inside the DKIM ACL, the following expansion variables are
40194 available (from most to least important):
40195
40196
40197 .vlist
40198 .vitem &%$dkim_cur_signer%&
40199 The signer that is being evaluated in this ACL run. This can be a domain or
40200 an identity. This is one of the list items from the expanded main option
40201 &%dkim_verify_signers%& (see above).
40202
40203 .vitem &%$dkim_verify_status%&
40204 Within the DKIM ACL,
40205 a string describing the general status of the signature. One of
40206 .ilist
40207 &%none%&: There is no signature in the message for the current domain or
40208 identity (as reflected by &%$dkim_cur_signer%&).
40209 .next
40210 &%invalid%&: The signature could not be verified due to a processing error.
40211 More detail is available in &%$dkim_verify_reason%&.
40212 .next
40213 &%fail%&: Verification of the signature failed.  More detail is
40214 available in &%$dkim_verify_reason%&.
40215 .next
40216 &%pass%&: The signature passed verification. It is valid.
40217 .endlist
40218
40219 This variable can be overwritten using an ACL 'set' modifier.
40220 This might, for instance, be done to enforce a policy restriction on
40221 hash-method or key-size:
40222 .code
40223   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40224        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40225        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40226                                   {< {$dkim_key_length}{1024}}}}
40227        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40228        set dkim_verify_status = fail
40229        set dkim_verify_reason = hash too weak or key too short
40230 .endd
40231
40232 So long as a DKIM ACL is defined (it need do no more than accept),
40233 after all the DKIM ACL runs have completed, the value becomes a
40234 colon-separated list of the values after each run.
40235 This is maintained for the mime, prdr and data ACLs.
40236
40237 .vitem &%$dkim_verify_reason%&
40238 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40239 "fail" or "invalid". One of
40240 .ilist
40241 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40242 key for the domain could not be retrieved. This may be a temporary problem.
40243 .next
40244 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40245 record for the domain is syntactically invalid.
40246 .next
40247 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40248 body hash does not match the one specified in the signature header. This
40249 means that the message body was modified in transit.
40250 .next
40251 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40252 could not be verified. This may mean that headers were modified,
40253 re-written or otherwise changed in a way which is incompatible with
40254 DKIM verification. It may of course also mean that the signature is forged.
40255 .endlist
40256
40257 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40258
40259 .vitem &%$dkim_domain%&
40260 The signing domain. IMPORTANT: This variable is only populated if there is
40261 an actual signature in the message for the current domain or identity (as
40262 reflected by &%$dkim_cur_signer%&).
40263
40264 .vitem &%$dkim_identity%&
40265 The signing identity, if present. IMPORTANT: This variable is only populated
40266 if there is an actual signature in the message for the current domain or
40267 identity (as reflected by &%$dkim_cur_signer%&).
40268
40269 .vitem &%$dkim_selector%&
40270 The key record selector string.
40271
40272 .vitem &%$dkim_algo%&
40273 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40274 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40275 may also be 'ed25519-sha256'.
40276 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40277 for EC keys.
40278
40279 Note that RFC 8301 says:
40280 .code
40281 rsa-sha1 MUST NOT be used for signing or verifying.
40282
40283 DKIM signatures identified as having been signed with historic
40284 algorithms (currently, rsa-sha1) have permanently failed evaluation
40285 .endd
40286
40287 To enforce this you must either have a DKIM ACL which checks this variable
40288 and overwrites the &$dkim_verify_status$& variable as discussed above,
40289 .new
40290 or have set the main option &%dkim_verify_hashes%& to exclude
40291 processing of such signatures.
40292 .wen
40293
40294 .vitem &%$dkim_canon_body%&
40295 The body canonicalization method. One of 'relaxed' or 'simple'.
40296
40297 .vitem &%$dkim_canon_headers%&
40298 The header canonicalization method. One of 'relaxed' or 'simple'.
40299
40300 .vitem &%$dkim_copiedheaders%&
40301 A transcript of headers and their values which are included in the signature
40302 (copied from the 'z=' tag of the signature).
40303 Note that RFC6376 requires that verification fail if the From: header is
40304 not included in the signature.  Exim does not enforce this; sites wishing
40305 strict enforcement should code the check explicitly.
40306
40307 .vitem &%$dkim_bodylength%&
40308 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40309 limit was set by the signer, "9999999999999" is returned. This makes sure
40310 that this variable always expands to an integer value.
40311 &*Note:*& The presence of the signature tag specifying a signing body length
40312 is one possible route to spoofing of valid DKIM signatures.
40313 A paranoid implementation might wish to regard signature where this variable
40314 shows less than the "no limit" return as being invalid.
40315
40316 .vitem &%$dkim_created%&
40317 UNIX timestamp reflecting the date and time when the signature was created.
40318 When this was not specified by the signer, "0" is returned.
40319
40320 .vitem &%$dkim_expires%&
40321 UNIX timestamp reflecting the date and time when the signer wants the
40322 signature to be treated as "expired". When this was not specified by the
40323 signer, "9999999999999" is returned. This makes it possible to do useful
40324 integer size comparisons against this value.
40325 Note that Exim does not check this value.
40326
40327 .vitem &%$dkim_headernames%&
40328 A colon-separated list of names of headers included in the signature.
40329
40330 .vitem &%$dkim_key_testing%&
40331 "1" if the key record has the "testing" flag set, "0" if not.
40332
40333 .vitem &%$dkim_key_nosubdomains%&
40334 "1" if the key record forbids subdomaining, "0" otherwise.
40335
40336 .vitem &%$dkim_key_srvtype%&
40337 Service type (tag s=) from the key record. Defaults to "*" if not specified
40338 in the key record.
40339
40340 .vitem &%$dkim_key_granularity%&
40341 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40342 in the key record.
40343
40344 .vitem &%$dkim_key_notes%&
40345 Notes from the key record (tag n=).
40346
40347 .vitem &%$dkim_key_length%&
40348 Number of bits in the key.
40349
40350 Note that RFC 8301 says:
40351 .code
40352 Verifiers MUST NOT consider signatures using RSA keys of
40353 less than 1024 bits as valid signatures.
40354 .endd
40355
40356 To enforce this you must have a DKIM ACL which checks this variable
40357 and overwrites the &$dkim_verify_status$& variable as discussed above.
40358 As EC keys are much smaller, the check should only do this for RSA keys.
40359
40360 .endlist
40361
40362 In addition, two ACL conditions are provided:
40363
40364 .vlist
40365 .vitem &%dkim_signers%&
40366 ACL condition that checks a colon-separated list of domains or identities
40367 for a match against the domain or identity that the ACL is currently verifying
40368 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40369 verb to a group of domains or identities. For example:
40370
40371 .code
40372 # Warn when Mail purportedly from GMail has no gmail signature
40373 warn log_message = GMail sender without gmail.com DKIM signature
40374      sender_domains = gmail.com
40375      dkim_signers = gmail.com
40376      dkim_status = none
40377 .endd
40378
40379 Note that the above does not check for a total lack of DKIM signing;
40380 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40381
40382 .vitem &%dkim_status%&
40383 ACL condition that checks a colon-separated list of possible DKIM verification
40384 results against the actual result of verification. This is typically used
40385 to restrict an ACL verb to a list of verification outcomes, for example:
40386
40387 .code
40388 deny message = Mail from Paypal with invalid/missing signature
40389      sender_domains = paypal.com:paypal.de
40390      dkim_signers = paypal.com:paypal.de
40391      dkim_status = none:invalid:fail
40392 .endd
40393
40394 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40395 see the documentation of the &%$dkim_verify_status%& expansion variable above
40396 for more information of what they mean.
40397 .endlist
40398
40399
40400
40401
40402 .section "SPF (Sender Policy Framework)" SECSPF
40403 .cindex SPF verification
40404
40405 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40406 messages with its domain in the envelope from, documented by RFC 7208.
40407 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40408 the &url(http://openspf.org).
40409 . --- 2019-10-28: still not https, open-spf.org is told to be a
40410 . --- web-archive copy of the now dead openspf.org site
40411 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40412 . --- discussion.
40413
40414 Messages sent by a system not authorised will fail checking of such assertions.
40415 This includes retransmissions done by traditional forwarders.
40416
40417 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40418 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40419 &url(https://www.libspf2.org/).
40420 There is no Exim involvement in the transmission of messages;
40421 publishing certain DNS records is all that is required.
40422
40423 For verification, an ACL condition and an expansion lookup are provided.
40424 .cindex authentication "expansion item"
40425 Performing verification sets up information used by the
40426 &%authresults%& expansion item.
40427
40428
40429 .cindex SPF "ACL condition"
40430 .cindex ACL "spf condition"
40431 The ACL condition "spf" can be used at or after the MAIL ACL.
40432 It takes as an argument a list of strings giving the outcome of the SPF check,
40433 and will succeed for any matching outcome.
40434 Valid strings are:
40435 .vlist
40436 .vitem &%pass%&
40437 The SPF check passed, the sending host is positively verified by SPF.
40438
40439 .vitem &%fail%&
40440 The SPF check failed, the sending host is NOT allowed to send mail for the
40441 domain in the envelope-from address.
40442
40443 .vitem &%softfail%&
40444 The SPF check failed, but the queried domain can't absolutely confirm that this
40445 is a forgery.
40446
40447 .vitem &%none%&
40448 The queried domain does not publish SPF records.
40449
40450 .vitem &%neutral%&
40451 The SPF check returned a "neutral" state.  This means the queried domain has
40452 published a SPF record, but wants to allow outside servers to send mail under
40453 its domain as well.  This should be treated like "none".
40454
40455 .vitem &%permerror%&
40456 This indicates a syntax error in the SPF record of the queried domain.
40457 You may deny messages when this occurs.
40458
40459 .vitem &%temperror%&
40460 This indicates a temporary error during all processing, including Exim's
40461 SPF processing.  You may defer messages when this occurs.
40462 .endlist
40463
40464 You can prefix each string with an exclamation mark to  invert
40465 its meaning,  for example  "!fail" will  match all  results but
40466 "fail".  The  string  list is  evaluated  left-to-right,  in a
40467 short-circuit fashion.
40468
40469 Example:
40470 .code
40471 deny spf = fail
40472      message = $sender_host_address is not allowed to send mail from \
40473                ${if def:sender_address_domain \
40474                     {$sender_address_domain}{$sender_helo_name}}.  \
40475                Please see http://www.open-spf.org/Why?scope=\
40476                ${if def:sender_address_domain {mfrom}{helo}};\
40477                identity=${if def:sender_address_domain \
40478                              {$sender_address}{$sender_helo_name}};\
40479                ip=$sender_host_address
40480 .endd
40481
40482 When the spf condition has run, it sets up several expansion
40483 variables:
40484
40485 .cindex SPF "verification variables"
40486 .vlist
40487 .vitem &$spf_header_comment$&
40488 .vindex &$spf_header_comment$&
40489   This contains a human-readable string describing the outcome
40490   of the SPF check. You can add it to a custom header or use
40491   it for logging purposes.
40492
40493 .vitem &$spf_received$&
40494 .vindex &$spf_received$&
40495   This contains a complete Received-SPF: header that can be
40496   added to the message. Please note that according to the SPF
40497   draft, this header must be added at the top of the header
40498   list. Please see section 10 on how you can do this.
40499
40500   Note: in case of "Best-guess" (see below), the convention is
40501   to put this string in a header called X-SPF-Guess: instead.
40502
40503 .vitem &$spf_result$&
40504 .vindex &$spf_result$&
40505   This contains the outcome of the SPF check in string form,
40506   one of pass, fail, softfail, none, neutral, permerror or
40507   temperror.
40508
40509 .vitem &$spf_result_guessed$&
40510 .vindex &$spf_result_guessed$&
40511   This boolean is true only if a best-guess operation was used
40512   and required in order to obtain a result.
40513
40514 .vitem &$spf_smtp_comment$&
40515 .vindex &$spf_smtp_comment$&
40516   This contains a string that can be used in a SMTP response
40517   to the calling party. Useful for "fail".
40518 .endlist
40519
40520
40521 .cindex SPF "ACL condition"
40522 .cindex ACL "spf_guess condition"
40523 .cindex SPF "best guess"
40524 In addition to SPF, you can also perform checks for so-called
40525 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40526 SPF, but it is supported by the same framework that enables SPF
40527 capability.
40528 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
40529 for a description of what it means.
40530 . --- 2019-10-28: still not https:
40531
40532 To access this feature, simply use the spf_guess condition in place
40533 of the spf one.  For example:
40534
40535 .code
40536 deny spf_guess = fail
40537      message = $sender_host_address doesn't look trustworthy to me
40538 .endd
40539
40540 In case you decide to reject messages based on this check, you
40541 should note that although it uses the same framework, "Best-guess"
40542 is not SPF, and therefore you should not mention SPF at all in your
40543 reject message.
40544
40545 When the spf_guess condition has run, it sets up the same expansion
40546 variables as when spf condition is run, described above.
40547
40548 Additionally, since Best-guess is not standardized, you may redefine
40549 what "Best-guess" means to you by redefining the main configuration
40550 &%spf_guess%& option.
40551 For example, the following:
40552
40553 .code
40554 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40555 .endd
40556
40557 would relax host matching rules to a broader network range.
40558
40559
40560 .cindex SPF "lookup expansion"
40561 .cindex lookup spf
40562 A lookup expansion is also available. It takes an email
40563 address as the key and an IP address
40564 .new
40565 (v4 or v6)
40566 .wen
40567 as the database:
40568
40569 .code
40570   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40571 .endd
40572
40573 The lookup will return the same result strings as can appear in
40574 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40575
40576
40577
40578
40579
40580 .new
40581 .section DMARC SECDMARC
40582 .cindex DMARC verification
40583
40584 DMARC combines feedback from SPF, DKIM, and header From: in order
40585 to attempt to provide better indicators of the authenticity of an
40586 email.  This document does not explain the fundamentals; you
40587 should read and understand how it works by visiting the website at
40588 &url(http://www.dmarc.org/).
40589
40590 If Exim is built with DMARC support,
40591 the libopendmarc library is used.
40592
40593 For building Exim yourself, obtain the library from
40594 &url(http://sourceforge.net/projects/opendmarc/)
40595 to obtain a copy, or find it in your favorite package
40596 repository.  You will need to attend to the local/Makefile feature
40597 SUPPORT_DMARC and the associated LDFLAGS addition.
40598 This description assumes
40599 that headers will be in /usr/local/include, and that the libraries
40600 are in /usr/local/lib.
40601
40602 . subsection
40603
40604 There are three main-configuration options:
40605 .cindex DMARC "configuration options"
40606
40607 The &%dmarc_tld_file%& option
40608 .oindex &%dmarc_tld_file%&
40609 defines the location of a text file of valid
40610 top level domains the opendmarc library uses
40611 during domain parsing. Maintained by Mozilla,
40612 the most current version can be downloaded
40613 from a link at &url(https://publicsuffix.org/list/, currently pointing
40614 at https://publicsuffix.org/list/public_suffix_list.dat)
40615 See also util/renew-opendmarc-tlds.sh script.
40616 The default for the option is /etc/exim/opendmarc.tlds.
40617
40618
40619 The &%dmarc_history_file%& option, if set
40620 .oindex &%dmarc_history_file%&
40621 defines the location of a file to log results
40622 of dmarc verification on inbound emails. The
40623 contents are importable by the opendmarc tools
40624 which will manage the data, send out DMARC
40625 reports, and expire the data. Make sure the
40626 directory of this file is writable by the user
40627 exim runs as.
40628 The default is unset.
40629
40630 The &%dmarc_forensic_sender%& option
40631 .oindex &%dmarc_forensic_sender%&
40632 defines an alternate email address to use when sending a
40633 forensic report detailing alignment failures
40634 if a sender domain's dmarc record specifies it
40635 and you have configured Exim to send them.
40636 If set, this is expanded and used for the
40637 From: header line; the address is extracted
40638 from it and used for the envelope from.
40639 If not set (the default), the From: header is expanded from
40640 the dsn_from option, and <> is used for the
40641 envelope from.
40642
40643 . I wish we had subsections...
40644
40645 .cindex DMARC controls
40646 By default, the DMARC processing will run for any remote,
40647 non-authenticated user.  It makes sense to only verify DMARC
40648 status of messages coming from remote, untrusted sources.  You can
40649 use standard conditions such as hosts, senders, etc, to decide that
40650 DMARC verification should *not* be performed for them and disable
40651 DMARC with an ACL control modifier:
40652 .code
40653   control = dmarc_disable_verify
40654 .endd
40655 A DMARC record can also specify a "forensic address", which gives
40656 exim an email address to submit reports about failed alignment.
40657 Exim does not do this by default because in certain conditions it
40658 results in unintended information leakage (what lists a user might
40659 be subscribed to, etc).  You must configure exim to submit forensic
40660 reports to the owner of the domain.  If the DMARC record contains a
40661 forensic address and you specify the control statement below, then
40662 exim will send these forensic emails.  It is also advised that you
40663 configure a &%dmarc_forensic_sender%& because the default sender address
40664 construction might be inadequate.
40665 .code
40666   control = dmarc_enable_forensic
40667 .endd
40668 (AGAIN: You can choose not to send these forensic reports by simply
40669 not putting the dmarc_enable_forensic control line at any point in
40670 your exim config.  If you don't tell exim to send them, it will not
40671 send them.)
40672
40673 There are no options to either control.  Both must appear before
40674 the DATA acl.
40675
40676 . subsection
40677
40678 DMARC checks cam be run on incoming SMTP  messages by using the
40679 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
40680 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
40681 condition.  Putting this condition in the ACLs is required in order
40682 for a DMARC check to actually occur.  All of the variables are set
40683 up before the DATA ACL, but there is no actual DMARC check that
40684 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
40685
40686 The &"dmarc_status"& condition takes a list of strings on its
40687 right-hand side.  These strings describe recommended action based
40688 on the DMARC check.  To understand what the policy recommendations
40689 mean, refer to the DMARC website above.  Valid strings are:
40690 .display
40691 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40692 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40693 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40694 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40695 &'norecord    '& No policy section in the DMARC record for this sender domain.
40696 &'nofrom      '& Unable to determine the domain of the sender.
40697 &'temperror   '& Library error or dns error.
40698 &'off         '& The DMARC check was disabled for this email.
40699 .endd
40700 You can prefix each string with an exclamation mark to invert its
40701 meaning, for example "!accept" will match all results but
40702 "accept".  The string list is evaluated left-to-right in a
40703 short-circuit fashion.  When a string matches the outcome of the
40704 DMARC check, the condition succeeds.  If none of the listed
40705 strings matches the outcome of the DMARC check, the condition
40706 fails.
40707
40708 Of course, you can also use any other lookup method that Exim
40709 supports, including LDAP, Postgres, MySQL, etc, as long as the
40710 result is a list of colon-separated strings.
40711
40712 Performing the check sets up information used by the
40713 &%authresults%& expansion item.
40714
40715 Several expansion variables are set before the DATA ACL is
40716 processed, and you can use them in this ACL.  The following
40717 expansion variables are available:
40718
40719 .vlist
40720 .vitem &$dmarc_status$&
40721 .vindex &$dmarc_status$&
40722 .cindex DMARC result
40723 A one word status indicating what the DMARC library
40724 thinks of the email.  It is a combination of the results of
40725 DMARC record lookup and the SPF/DKIM/DMARC processing results
40726 (if a DMARC record was found).  The actual policy declared
40727 in the DMARC record is in a separate expansion variable.
40728
40729 .vitem &$dmarc_status_text$&
40730 .vindex &$dmarc_status_text$&
40731 Slightly longer, human readable status.
40732
40733 .vitem &$dmarc_used_domain$&
40734 .vindex &$dmarc_used_domain$&
40735 The domain which DMARC used to look up the DMARC policy record.
40736
40737 .vitem &$dmarc_domain_policy$&
40738 .vindex &$dmarc_domain_policy$&
40739 The policy declared in the DMARC record.  Valid values
40740 are "none", "reject" and "quarantine".  It is blank when there
40741 is any error, including no DMARC record.
40742 .endlist
40743
40744 . subsection
40745
40746 By default, Exim's DMARC configuration is intended to be
40747 non-intrusive and conservative.  To facilitate this, Exim will not
40748 create any type of logging files without explicit configuration by
40749 you, the admin.  Nor will Exim send out any emails/reports about
40750 DMARC issues without explicit configuration by you, the admin (other
40751 than typical bounce messages that may come about due to ACL
40752 processing or failure delivery issues).
40753
40754 In order to log statistics suitable to be imported by the opendmarc
40755 tools, you need to:
40756 .ilist
40757 Configure the global option &%dmarc_history_file%&
40758 .next
40759 Configure cron jobs to call the appropriate opendmarc history
40760 import scripts and truncating the dmarc_history_file
40761 .endlist
40762
40763 In order to send forensic reports, you need to:
40764 .ilist
40765 Configure the global option &%dmarc_forensic_sender%&
40766 .next
40767 Configure, somewhere before the DATA ACL, the control option to
40768 enable sending DMARC forensic reports
40769 .endlist
40770
40771 . subsection
40772
40773 Example usage:
40774 .code
40775 (RCPT ACL)
40776   warn    domains        = +local_domains
40777           hosts          = +local_hosts
40778           control        = dmarc_disable_verify
40779
40780   warn    !domains       = +screwed_up_dmarc_records
40781           control        = dmarc_enable_forensic
40782
40783   warn    condition      = (lookup if destined to mailing list)
40784           set acl_m_mailing_list = 1
40785
40786 (DATA ACL)
40787   warn    dmarc_status   = accept : none : off
40788           !authenticated = *
40789           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40790
40791   warn    dmarc_status   = !accept
40792           !authenticated = *
40793           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40794
40795   warn    dmarc_status   = quarantine
40796           !authenticated = *
40797           set $acl_m_quarantine = 1
40798           # Do something in a transport with this flag variable
40799
40800   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40801           condition      = ${if eq{$acl_m_mailing_list}{1}}
40802           message        = Messages from $dmarc_used_domain break mailing lists
40803
40804   deny    dmarc_status   = reject
40805           !authenticated = *
40806           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40807
40808   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40809 .endd
40810
40811 .wen
40812
40813
40814
40815
40816 . ////////////////////////////////////////////////////////////////////////////
40817 . ////////////////////////////////////////////////////////////////////////////
40818
40819 .chapter "Proxies" "CHAPproxies" &&&
40820          "Proxy support"
40821 .cindex "proxy support"
40822 .cindex "proxy" "access via"
40823
40824 A proxy is an intermediate system through which communication is passed.
40825 Proxies may provide a security, availability or load-distribution function.
40826
40827
40828 .section "Inbound proxies" SECTproxyInbound
40829 .cindex proxy inbound
40830 .cindex proxy "server side"
40831 .cindex proxy "Proxy protocol"
40832 .cindex "Proxy protocol" proxy
40833
40834 Exim has support for receiving inbound SMTP connections via a proxy
40835 that uses &"Proxy Protocol"& to speak to it.
40836 To include this support, include &"SUPPORT_PROXY=yes"&
40837 in Local/Makefile.
40838
40839 It was built on the HAProxy specification, found at
40840 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40841
40842 The purpose of this facility is so that an application load balancer,
40843 such as HAProxy, can sit in front of several Exim servers
40844 to distribute load.
40845 Exim uses the local protocol communication with the proxy to obtain
40846 the remote SMTP system IP address and port information.
40847 There is no logging if a host passes or
40848 fails Proxy Protocol negotiation, but it can easily be determined and
40849 recorded in an ACL (example is below).
40850
40851 Use of a proxy is enabled by setting the &%hosts_proxy%&
40852 main configuration option to a hostlist; connections from these
40853 hosts will use Proxy Protocol.
40854 Exim supports both version 1 and version 2 of the Proxy Protocol and
40855 automatically determines which version is in use.
40856
40857 The Proxy Protocol header is the first data received on a TCP connection
40858 and is inserted before any TLS-on-connect handshake from the client; Exim
40859 negotiates TLS between Exim-as-server and the remote client, not between
40860 Exim and the proxy server.
40861
40862 The following expansion variables are usable
40863 (&"internal"& and &"external"& here refer to the interfaces
40864 of the proxy):
40865 .display
40866 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40867 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40868 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40869 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40870 &'proxy_session            '& boolean: SMTP connection via proxy
40871 .endd
40872 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40873 there was a protocol error.
40874 The variables &$sender_host_address$& and &$sender_host_port$&
40875 will have values for the actual client system, not the proxy.
40876
40877 Since the real connections are all coming from the proxy, and the
40878 per host connection tracking is done before Proxy Protocol is
40879 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40880 handle all of the parallel volume you expect per inbound proxy.
40881 With the option set so high, you lose the ability
40882 to protect your server from many connections from one IP.
40883 In order to prevent your server from overload, you
40884 need to add a per connection ratelimit to your connect ACL.
40885 A possible solution is:
40886 .display
40887   # Set max number of connections per host
40888   LIMIT   = 5
40889   # Or do some kind of IP lookup in a flat file or database
40890   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40891
40892   defer   message        = Too many connections from this IP right now
40893           ratelimit      = LIMIT / 5s / per_conn / strict
40894 .endd
40895
40896
40897
40898 .section "Outbound proxies" SECTproxySOCKS
40899 .cindex proxy outbound
40900 .cindex proxy "client side"
40901 .cindex proxy SOCKS
40902 .cindex SOCKS proxy
40903 Exim has support for sending outbound SMTP via a proxy
40904 using a protocol called SOCKS5 (defined by RFC1928).
40905 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40906 Local/Makefile.
40907
40908 Use of a proxy is enabled by setting the &%socks_proxy%& option
40909 on an smtp transport.
40910 The option value is expanded and should then be a list
40911 (colon-separated by default) of proxy specifiers.
40912 Each proxy specifier is a list
40913 (space-separated by default) where the initial element
40914 is an IP address and any subsequent elements are options.
40915
40916 Options are a string <name>=<value>.
40917 The list of options is in the following table:
40918 .display
40919 &'auth   '& authentication method
40920 &'name   '& authentication username
40921 &'pass   '& authentication password
40922 &'port   '& tcp port
40923 &'tmo    '& connection timeout
40924 &'pri    '& priority
40925 &'weight '& selection bias
40926 .endd
40927
40928 More details on each of these options follows:
40929
40930 .ilist
40931 .cindex authentication "to proxy"
40932 .cindex proxy authentication
40933 &%auth%&: Either &"none"& (default) or &"name"&.
40934 Using &"name"& selects username/password authentication per RFC 1929
40935 for access to the proxy.
40936 Default is &"none"&.
40937 .next
40938 &%name%&: sets the username for the &"name"& authentication method.
40939 Default is empty.
40940 .next
40941 &%pass%&: sets the password for the &"name"& authentication method.
40942 Default is empty.
40943 .next
40944 &%port%&: the TCP port number to use for the connection to the proxy.
40945 Default is 1080.
40946 .next
40947 &%tmo%&: sets a connection timeout in seconds for this proxy.
40948 Default is 5.
40949 .next
40950 &%pri%&: specifies a priority for the proxy within the list,
40951 higher values being tried first.
40952 The default priority is 1.
40953 .next
40954 &%weight%&: specifies a selection bias.
40955 Within a priority set servers are queried in a random fashion,
40956 weighted by this value.
40957 The default value for selection bias is 1.
40958 .endlist
40959
40960 Proxies from the list are tried according to their priority
40961 and weight settings until one responds.  The timeout for the
40962 overall connection applies to the set of proxied attempts.
40963
40964 .section Logging SECTproxyLog
40965 To log the (local) IP of a proxy in the incoming or delivery logline,
40966 add &"+proxy"& to the &%log_selector%& option.
40967 This will add a component tagged with &"PRX="& to the line.
40968
40969 . ////////////////////////////////////////////////////////////////////////////
40970 . ////////////////////////////////////////////////////////////////////////////
40971
40972 .chapter "Internationalisation" "CHAPi18n" &&&
40973          "Internationalisation""
40974 .cindex internationalisation "email address"
40975 .cindex EAI
40976 .cindex i18n
40977 .cindex utf8 "mail name handling"
40978
40979 Exim has support for Internationalised mail names.
40980 To include this it must be built with SUPPORT_I18N and the libidn library.
40981 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40982
40983 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40984 instead of it) then IDNA2008 is supported; this adds an extra library
40985 requirement, upon libidn2.
40986
40987 .section "MTA operations" SECTi18nMTA
40988 .cindex SMTPUTF8 "ESMTP option"
40989 The main configuration option &%smtputf8_advertise_hosts%& specifies
40990 a host list.  If this matches the sending host and
40991 accept_8bitmime is true (the default) then the ESMTP option
40992 SMTPUTF8 will be advertised.
40993
40994 If the sender specifies the SMTPUTF8 option on a MAIL command
40995 international handling for the message is enabled and
40996 the expansion variable &$message_smtputf8$& will have value TRUE.
40997
40998 The option &%allow_utf8_domains%& is set to true for this
40999 message. All DNS lookups are converted to a-label form
41000 whatever the setting of &%allow_utf8_domains%&
41001 when Exim is built with SUPPORT_I18N.
41002
41003 Both localparts and domain are maintained as the original
41004 UTF-8 form internally; any comparison or regular-expression use will
41005 require appropriate care.  Filenames created, eg. by
41006 the appendfile transport, will have UTF-8 names.
41007
41008 HELO names sent by the smtp transport will have any UTF-8
41009 components expanded to a-label form,
41010 and any certificate name checks will be done using the a-label
41011 form of the name.
41012
41013 .cindex log protocol
41014 .cindex SMTPUTF8 logging
41015 .cindex i18n logging
41016 Log lines and Received-by: header lines will acquire a "utf8"
41017 prefix on the protocol element, eg. utf8esmtp.
41018
41019 The following expansion operators can be used:
41020 .code
41021 ${utf8_domain_to_alabel:str}
41022 ${utf8_domain_from_alabel:str}
41023 ${utf8_localpart_to_alabel:str}
41024 ${utf8_localpart_from_alabel:str}
41025 .endd
41026
41027 .cindex utf8 "address downconversion"
41028 .cindex i18n "utf8 address downconversion"
41029 The RCPT ACL
41030 may use the following modifier:
41031 .display
41032 control = utf8_downconvert
41033 control = utf8_downconvert/<value>
41034 .endd
41035 This sets a flag requiring that addresses are converted to
41036 a-label form before smtp delivery, for use in a
41037 Message Submission Agent context.
41038 If a value is appended it may be:
41039 .display
41040 &`1  `& (default) mandatory downconversion
41041 &`0  `& no downconversion
41042 &`-1 `& if SMTPUTF8 not supported by destination host
41043 .endd
41044
41045 If mua_wrapper is set, the utf8_downconvert control
41046 is initially set to -1.
41047
41048 The smtp transport has an option &%utf8_downconvert%&.
41049 If set it must expand to one of the three values described above,
41050 and it overrides any previously set value.
41051
41052
41053 There is no explicit support for VRFY and EXPN.
41054 Configurations supporting these should inspect
41055 &$smtp_command_argument$& for an SMTPUTF8 argument.
41056
41057 There is no support for LMTP on Unix sockets.
41058 Using the "lmtp" protocol option on an smtp transport,
41059 for LMTP over TCP, should work as expected.
41060
41061 There is no support for DSN unitext handling,
41062 and no provision for converting logging from or to UTF-8.
41063
41064
41065
41066 .section "MDA operations" SECTi18nMDA
41067 To aid in constructing names suitable for IMAP folders
41068 the following expansion operator can be used:
41069 .code
41070 ${imapfolder {<string>} {<sep>} {<specials>}}
41071 .endd
41072
41073 The string is converted from the charset specified by
41074 the "headers charset" command (in a filter file)
41075 or &%headers_charset%& main configuration option (otherwise),
41076 to the
41077 modified UTF-7 encoding specified by RFC 2060,
41078 with the following exception: All occurrences of <sep>
41079 (which has to be a single character)
41080 are replaced with periods ("."), and all periods and slashes that are not
41081 <sep> and are not in the <specials> string are BASE64 encoded.
41082
41083 The third argument can be omitted, defaulting to an empty string.
41084 The second argument can be omitted, defaulting to "/".
41085
41086 This is the encoding used by Courier for Maildir names on disk, and followed
41087 by many other IMAP servers.
41088
41089 Examples:
41090 .display
41091 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41092 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41093 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41094 .endd
41095
41096 Note that the source charset setting is vital, and also that characters
41097 must be representable in UTF-16.
41098
41099
41100 . ////////////////////////////////////////////////////////////////////////////
41101 . ////////////////////////////////////////////////////////////////////////////
41102
41103 .chapter "Events" "CHAPevents" &&&
41104          "Events"
41105 .cindex events
41106
41107 The events mechanism in Exim can be used to intercept processing at a number
41108 of points.  It was originally invented to give a way to do customised logging
41109 actions (for example, to a database) but can also be used to modify some
41110 processing actions.
41111
41112 Most installations will never need to use Events.
41113 The support can be left out of a build by defining DISABLE_EVENT=yes
41114 in &_Local/Makefile_&.
41115
41116 There are two major classes of events: main and transport.
41117 The main configuration option &%event_action%& controls reception events;
41118 a transport option &%event_action%& controls delivery events.
41119
41120 Both options are a string which is expanded when the event fires.
41121 An example might look like:
41122 .cindex logging custom
41123 .code
41124 event_action = ${if eq {msg:delivery}{$event_name} \
41125 {${lookup pgsql {SELECT * FROM record_Delivery( \
41126     '${quote_pgsql:$sender_address_domain}',\
41127     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41128     '${quote_pgsql:$domain}', \
41129     '${quote_pgsql:${lc:$local_part}}', \
41130     '${quote_pgsql:$host_address}', \
41131     '${quote_pgsql:${lc:$host}}', \
41132     '${quote_pgsql:$message_exim_id}')}} \
41133 } {}}
41134 .endd
41135
41136 Events have names which correspond to the point in process at which they fire.
41137 The name is placed in the variable &$event_name$& and the event action
41138 expansion must check this, as it will be called for every possible event type.
41139
41140 .new
41141 The current list of events is:
41142 .wen
41143 .display
41144 &`dane:fail              after    transport  `& per connection
41145 &`msg:complete           after    main       `& per message
41146 &`msg:delivery           after    transport  `& per recipient
41147 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41148 &`msg:rcpt:defer         after    transport  `& per recipient
41149 &`msg:host:defer         after    transport  `& per attempt
41150 &`msg:fail:delivery      after    transport  `& per recipient
41151 &`msg:fail:internal      after    main       `& per recipient
41152 &`tcp:connect            before   transport  `& per connection
41153 &`tcp:close              after    transport  `& per connection
41154 &`tls:cert               before   both       `& per certificate in verification chain
41155 &`smtp:connect           after    transport  `& per connection
41156 &`smtp:ehlo              after    transport  `& per connection
41157 .endd
41158 New event types may be added in future.
41159
41160 The event name is a colon-separated list, defining the type of
41161 event in a tree of possibilities.  It may be used as a list
41162 or just matched on as a whole.  There will be no spaces in the name.
41163
41164 The second column in the table above describes whether the event fires
41165 before or after the action is associates with.  Those which fire before
41166 can be used to affect that action (more on this below).
41167
41168 The third column in the table above says what section of the configuration
41169 should define the event action.
41170
41171 An additional variable, &$event_data$&, is filled with information varying
41172 with the event type:
41173 .display
41174 &`dane:fail            `& failure reason
41175 &`msg:delivery         `& smtp confirmation message
41176 &`msg:fail:internal    `& failure reason
41177 &`msg:fail:delivery    `& smtp error message
41178 &`msg:rcpt:host:defer  `& error string
41179 &`msg:rcpt:defer       `& error string
41180 &`msg:host:defer       `& error string
41181 &`tls:cert             `& verification chain depth
41182 &`smtp:connect         `& smtp banner
41183 &`smtp:ehlo            `& smtp ehlo response
41184 .endd
41185
41186 The :defer events populate one extra variable: &$event_defer_errno$&.
41187
41188 For complex operations an ACL expansion can be used in &%event_action%&
41189 however due to the multiple contexts that Exim operates in during
41190 the course of its processing:
41191 .ilist
41192 variables set in transport events will not be visible outside that
41193 transport call
41194 .next
41195 acl_m variables in a server context are lost on a new connection,
41196 and after smtp helo/ehlo/mail/starttls/rset commands
41197 .endlist
41198 Using an ACL expansion with the logwrite modifier can be
41199 a useful way of writing to the main log.
41200
41201 The expansion of the event_action option should normally
41202 return an empty string.  Should it return anything else the
41203 following will be forced:
41204 .display
41205 &`tcp:connect      `&  do not connect
41206 &`tls:cert         `&  refuse verification
41207 &`smtp:connect     `&  close connection
41208 .endd
41209 All other message types ignore the result string, and
41210 no other use is made of it.
41211
41212 For a tcp:connect event, if the connection is being made to a proxy
41213 then the address and port variables will be that of the proxy and not
41214 the target system.
41215
41216 For tls:cert events, if GnuTLS is in use this will trigger only per
41217 chain element received on the connection.
41218 For OpenSSL it will trigger for every chain element including those
41219 loaded locally.
41220
41221 . ////////////////////////////////////////////////////////////////////////////
41222 . ////////////////////////////////////////////////////////////////////////////
41223
41224 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41225          "Adding drivers or lookups"
41226 .cindex "adding drivers"
41227 .cindex "new drivers, adding"
41228 .cindex "drivers" "adding new"
41229 The following actions have to be taken in order to add a new router, transport,
41230 authenticator, or lookup type to Exim:
41231
41232 .olist
41233 Choose a name for the driver or lookup type that does not conflict with any
41234 existing name; I will use &"newdriver"& in what follows.
41235 .next
41236 Add to &_src/EDITME_& the line:
41237 .display
41238 <&'type'&>&`_NEWDRIVER=yes`&
41239 .endd
41240 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41241 code is not to be included in the binary by default, comment this line out. You
41242 should also add any relevant comments about the driver or lookup type.
41243 .next
41244 Add to &_src/config.h.defaults_& the line:
41245 .code
41246 #define <type>_NEWDRIVER
41247 .endd
41248 .next
41249 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41250 and create a table entry as is done for all the other drivers and lookup types.
41251 .next
41252 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41253 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41254 Add your &`NEWDRIVER`& to that list.
41255 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41256 simple form that most lookups have.
41257 .next
41258 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41259 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41260 driver or lookup type and add it to the definition of OBJ.
41261 .next
41262 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41263 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41264 .next
41265 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41266 &_src_&.
41267 .next
41268 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41269 as for other drivers and lookups.
41270 .endlist
41271
41272 Then all you need to do is write the code! A good way to start is to make a
41273 proforma by copying an existing module of the same type, globally changing all
41274 occurrences of the name, and cutting out most of the code. Note that any
41275 options you create must be listed in alphabetical order, because the tables are
41276 searched using a binary chop procedure.
41277
41278 There is a &_README_& file in each of the sub-directories of &_src_& describing
41279 the interface that is expected.
41280
41281
41282
41283
41284 . ////////////////////////////////////////////////////////////////////////////
41285 . ////////////////////////////////////////////////////////////////////////////
41286
41287 . /////////////////////////////////////////////////////////////////////////////
41288 . These lines are processing instructions for the Simple DocBook Processor that
41289 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41290 . PDFs than using xmlto and fop. They will be ignored by all other XML
41291 . processors.
41292 . /////////////////////////////////////////////////////////////////////////////
41293
41294 .literal xml
41295 <?sdop
41296   format="newpage"
41297   foot_right_recto="&chaptertitle;"
41298   foot_right_verso="&chaptertitle;"
41299 ?>
41300 .literal off
41301
41302 .makeindex "Options index"   "option"
41303 .makeindex "Variables index" "variable"
41304 .makeindex "Concept index"   "concept"
41305
41306
41307 . /////////////////////////////////////////////////////////////////////////////
41308 . /////////////////////////////////////////////////////////////////////////////