tidying
[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.93"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 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 If you do not want TLS support you should set
1904 .code
1905 DISABLE_TLS=yes
1906 .endd
1907 in &_Local/Makefile_&.
1908
1909 If OpenSSL is installed, you should set
1910 .code
1911 USE_OPENSL=yes
1912 TLS_LIBS=-lssl -lcrypto
1913 .endd
1914 in &_Local/Makefile_&. You may also need to specify the locations of the
1915 OpenSSL library and include files. For example:
1916 .code
1917 USE_OPENSSL=yes
1918 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1919 TLS_INCLUDE=-I/usr/local/openssl/include/
1920 .endd
1921 .cindex "pkg-config" "OpenSSL"
1922 If you have &'pkg-config'& available, then instead you can just use:
1923 .code
1924 USE_OPENSSL=yes
1925 USE_OPENSSL_PC=openssl
1926 .endd
1927 .cindex "USE_GNUTLS"
1928 If GnuTLS is installed, you should set
1929 .code
1930 USE_GNUTLS=yes
1931 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1932 .endd
1933 in &_Local/Makefile_&, and again you may need to specify the locations of the
1934 library and include files. For example:
1935 .code
1936 USE_GNUTLS=yes
1937 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1938 TLS_INCLUDE=-I/usr/gnu/include
1939 .endd
1940 .cindex "pkg-config" "GnuTLS"
1941 If you have &'pkg-config'& available, then instead you can just use:
1942 .code
1943 USE_GNUTLS=yes
1944 USE_GNUTLS_PC=gnutls
1945 .endd
1946
1947 You do not need to set TLS_INCLUDE if the relevant directory is already
1948 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1949 given in chapter &<<CHAPTLS>>&.
1950
1951
1952
1953
1954 .section "Use of tcpwrappers" "SECID27"
1955
1956 .cindex "tcpwrappers, building Exim to support"
1957 .cindex "USE_TCP_WRAPPERS"
1958 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1959 .cindex "tcp_wrappers_daemon_name"
1960 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1961 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1962 alternative to Exim's own checking facilities for installations that are
1963 already making use of &'tcpwrappers'& for other purposes. To do this, you
1964 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1965 &_tcpd.h_& to be available at compile time, and also ensure that the library
1966 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1967 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1968 you might have
1969 .code
1970 USE_TCP_WRAPPERS=yes
1971 CFLAGS=-O -I/usr/local/include
1972 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1973 .endd
1974 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1975 files is &"exim"&. For example, the line
1976 .code
1977 exim : LOCAL  192.168.1.  .friendly.domain.example
1978 .endd
1979 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1980 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1981 All other connections are denied. The daemon name used by &'tcpwrappers'&
1982 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1983 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1984 configure file. Consult the &'tcpwrappers'& documentation for
1985 further details.
1986
1987
1988 .section "Including support for IPv6" "SECID28"
1989 .cindex "IPv6" "including support for"
1990 Exim contains code for use on systems that have IPv6 support. Setting
1991 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1992 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1993 where the IPv6 support is not fully integrated into the normal include and
1994 library files.
1995
1996 Two different types of DNS record for handling IPv6 addresses have been
1997 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1998 currently seen as the mainstream. Another record type called A6 was proposed
1999 as better than AAAA because it had more flexibility. However, it was felt to be
2000 over-complex, and its status was reduced to &"experimental"&.
2001 Exim used to
2002 have a compile option for including A6 record support but this has now been
2003 withdrawn.
2004
2005
2006
2007 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2008 .cindex "lookup modules"
2009 .cindex "dynamic modules"
2010 .cindex ".so building"
2011 On some platforms, Exim supports not compiling all lookup types directly into
2012 the main binary, instead putting some into external modules which can be loaded
2013 on demand.
2014 This permits packagers to build Exim with support for lookups with extensive
2015 library dependencies without requiring all users to install all of those
2016 dependencies.
2017 Most, but not all, lookup types can be built this way.
2018
2019 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2020 installed; Exim will only load modules from that directory, as a security
2021 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2022 for your OS; see &_OS/Makefile-Linux_& for an example.
2023 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2024 see &_src/EDITME_& for details.
2025
2026 Then, for each module to be loaded dynamically, define the relevant
2027 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2028 For example, this will build in lsearch but load sqlite and mysql support
2029 on demand:
2030 .code
2031 LOOKUP_LSEARCH=yes
2032 LOOKUP_SQLITE=2
2033 LOOKUP_MYSQL=2
2034 .endd
2035
2036
2037 .section "The building process" "SECID29"
2038 .cindex "build directory"
2039 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2040 created, run &'make'& at the top level. It determines the architecture and
2041 operating system types, and creates a build directory if one does not exist.
2042 For example, on a Sun system running Solaris 8, the directory
2043 &_build-SunOS5-5.8-sparc_& is created.
2044 .cindex "symbolic link" "to source files"
2045 Symbolic links to relevant source files are installed in the build directory.
2046
2047 If this is the first time &'make'& has been run, it calls a script that builds
2048 a make file inside the build directory, using the configuration files from the
2049 &_Local_& directory. The new make file is then passed to another instance of
2050 &'make'&. This does the real work, building a number of utility scripts, and
2051 then compiling and linking the binaries for the Exim monitor (if configured), a
2052 number of utility programs, and finally Exim itself. The command &`make
2053 makefile`& can be used to force a rebuild of the make file in the build
2054 directory, should this ever be necessary.
2055
2056 If you have problems building Exim, check for any comments there may be in the
2057 &_README_& file concerning your operating system, and also take a look at the
2058 FAQ, where some common problems are covered.
2059
2060
2061
2062 .section 'Output from &"make"&' "SECID283"
2063 The output produced by the &'make'& process for compile lines is often very
2064 unreadable, because these lines can be very long. For this reason, the normal
2065 output is suppressed by default, and instead output similar to that which
2066 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2067 each module that is being compiled or linked. However, it is still possible to
2068 get the full output, by calling &'make'& like this:
2069 .code
2070 FULLECHO='' make -e
2071 .endd
2072 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2073 command reflection in &'make'&. When you ask for the full output, it is
2074 given in addition to the short output.
2075
2076
2077
2078 .section "Overriding build-time options for Exim" "SECToverride"
2079 .cindex "build-time options, overriding"
2080 The main make file that is created at the beginning of the building process
2081 consists of the concatenation of a number of files which set configuration
2082 values, followed by a fixed set of &'make'& instructions. If a value is set
2083 more than once, the last setting overrides any previous ones. This provides a
2084 convenient way of overriding defaults. The files that are concatenated are, in
2085 order:
2086 .display
2087 &_OS/Makefile-Default_&
2088 &_OS/Makefile-_&<&'ostype'&>
2089 &_Local/Makefile_&
2090 &_Local/Makefile-_&<&'ostype'&>
2091 &_Local/Makefile-_&<&'archtype'&>
2092 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2093 &_OS/Makefile-Base_&
2094 .endd
2095 .cindex "&_Local/Makefile_&"
2096 .cindex "building Exim" "operating system type"
2097 .cindex "building Exim" "architecture type"
2098 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2099 architecture type. &_Local/Makefile_& is required to exist, and the building
2100 process fails if it is absent. The other three &_Local_& files are optional,
2101 and are often not needed.
2102
2103 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2104 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2105 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2106 values are used, thereby providing a means of forcing particular settings.
2107 Otherwise, the scripts try to get values from the &%uname%& command. If this
2108 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2109 of &'ad hoc'& transformations are then applied, to produce the standard names
2110 that Exim expects. You can run these scripts directly from the shell in order
2111 to find out what values are being used on your system.
2112
2113
2114 &_OS/Makefile-Default_& contains comments about the variables that are set
2115 therein. Some (but not all) are mentioned below. If there is something that
2116 needs changing, review the contents of this file and the contents of the make
2117 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2118 default values are.
2119
2120
2121 .cindex "building Exim" "overriding default settings"
2122 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2123 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2124 need to change the original files. Instead, you should make the changes by
2125 putting the new values in an appropriate &_Local_& file. For example,
2126 .cindex "Tru64-Unix build-time settings"
2127 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2128 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2129 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2130 called with the option &%-std1%&, to make it recognize some of the features of
2131 Standard C that Exim uses. (Most other compilers recognize Standard C by
2132 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2133 containing the lines
2134 .code
2135 CC=cc
2136 CFLAGS=-std1
2137 .endd
2138 If you are compiling for just one operating system, it may be easier to put
2139 these lines directly into &_Local/Makefile_&.
2140
2141 Keeping all your local configuration settings separate from the distributed
2142 files makes it easy to transfer them to new versions of Exim simply by copying
2143 the contents of the &_Local_& directory.
2144
2145
2146 .cindex "NIS lookup type" "including support for"
2147 .cindex "NIS+ lookup type" "including support for"
2148 .cindex "LDAP" "including support for"
2149 .cindex "lookup" "inclusion in binary"
2150 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2151 lookup, but not all systems have these components installed, so the default is
2152 not to include the relevant code in the binary. All the different kinds of file
2153 and database lookup that Exim supports are implemented as separate code modules
2154 which are included only if the relevant compile-time options are set. In the
2155 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2156 .code
2157 LOOKUP_LDAP=yes
2158 LOOKUP_NIS=yes
2159 LOOKUP_NISPLUS=yes
2160 .endd
2161 and similar settings apply to the other lookup types. They are all listed in
2162 &_src/EDITME_&. In many cases the relevant include files and interface
2163 libraries need to be installed before compiling Exim.
2164 .cindex "cdb" "including support for"
2165 However, there are some optional lookup types (such as cdb) for which
2166 the code is entirely contained within Exim, and no external include
2167 files or libraries are required. When a lookup type is not included in the
2168 binary, attempts to configure Exim to use it cause runtime configuration
2169 errors.
2170
2171 .cindex "pkg-config" "lookups"
2172 .cindex "pkg-config" "authenticators"
2173 Many systems now use a tool called &'pkg-config'& to encapsulate information
2174 about how to compile against a library; Exim has some initial support for
2175 being able to use pkg-config for lookups and authenticators.  For any given
2176 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2177 variable with the &`_PC`& suffix in the name and assign as the value the
2178 name of the package to be queried.  The results of querying via the
2179 &'pkg-config'& command will be added to the appropriate Makefile variables
2180 with &`+=`& directives, so your version of &'make'& will need to support that
2181 syntax.  For instance:
2182 .code
2183 LOOKUP_SQLITE=yes
2184 LOOKUP_SQLITE_PC=sqlite3
2185 AUTH_GSASL=yes
2186 AUTH_GSASL_PC=libgsasl
2187 AUTH_HEIMDAL_GSSAPI=yes
2188 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2189 .endd
2190
2191 .cindex "Perl" "including support for"
2192 Exim can be linked with an embedded Perl interpreter, allowing Perl
2193 subroutines to be called during string expansion. To enable this facility,
2194 .code
2195 EXIM_PERL=perl.o
2196 .endd
2197 must be defined in &_Local/Makefile_&. Details of this facility are given in
2198 chapter &<<CHAPperl>>&.
2199
2200 .cindex "X11 libraries, location of"
2201 The location of the X11 libraries is something that varies a lot between
2202 operating systems, and there may be different versions of X11 to cope
2203 with. Exim itself makes no use of X11, but if you are compiling the Exim
2204 monitor, the X11 libraries must be available.
2205 The following three variables are set in &_OS/Makefile-Default_&:
2206 .code
2207 X11=/usr/X11R6
2208 XINCLUDE=-I$(X11)/include
2209 XLFLAGS=-L$(X11)/lib
2210 .endd
2211 These are overridden in some of the operating-system configuration files. For
2212 example, in &_OS/Makefile-SunOS5_& there is
2213 .code
2214 X11=/usr/openwin
2215 XINCLUDE=-I$(X11)/include
2216 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2217 .endd
2218 If you need to override the default setting for your operating system, place a
2219 definition of all three of these variables into your
2220 &_Local/Makefile-<ostype>_& file.
2221
2222 .cindex "EXTRALIBS"
2223 If you need to add any extra libraries to the link steps, these can be put in a
2224 variable called EXTRALIBS, which appears in all the link commands, but by
2225 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2226 command for linking the main Exim binary, and not for any associated utilities.
2227
2228 .cindex "DBM libraries" "configuration for building"
2229 There is also DBMLIB, which appears in the link commands for binaries that
2230 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2231 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2232 binary, and which can be used, for example, to include additional X11
2233 libraries.
2234
2235 .cindex "configuration file" "editing"
2236 The make file copes with rebuilding Exim correctly if any of the configuration
2237 files are edited. However, if an optional configuration file is deleted, it is
2238 necessary to touch the associated non-optional file (that is,
2239 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2240
2241
2242 .section "OS-specific header files" "SECID30"
2243 .cindex "&_os.h_&"
2244 .cindex "building Exim" "OS-specific C header files"
2245 The &_OS_& directory contains a number of files with names of the form
2246 &_os.h-<ostype>_&. These are system-specific C header files that should not
2247 normally need to be changed. There is a list of macro settings that are
2248 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2249 are porting Exim to a new operating system.
2250
2251
2252
2253 .section "Overriding build-time options for the monitor" "SECID31"
2254 .cindex "building Eximon"
2255 A similar process is used for overriding things when building the Exim monitor,
2256 where the files that are involved are
2257 .display
2258 &_OS/eximon.conf-Default_&
2259 &_OS/eximon.conf-_&<&'ostype'&>
2260 &_Local/eximon.conf_&
2261 &_Local/eximon.conf-_&<&'ostype'&>
2262 &_Local/eximon.conf-_&<&'archtype'&>
2263 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2264 .endd
2265 .cindex "&_Local/eximon.conf_&"
2266 As with Exim itself, the final three files need not exist, and in this case the
2267 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2268 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2269 variables of the same name, preceded by EXIMON_. For example, setting
2270 EXIMON_LOG_DEPTH in the environment overrides the value of
2271 LOG_DEPTH at runtime.
2272 .ecindex IIDbuex
2273
2274
2275 .section "Installing Exim binaries and scripts" "SECID32"
2276 .cindex "installing Exim"
2277 .cindex "BIN_DIRECTORY"
2278 The command &`make install`& runs the &(exim_install)& script with no
2279 arguments. The script copies binaries and utility scripts into the directory
2280 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2281 .cindex "setuid" "installing Exim with"
2282 The install script copies files only if they are newer than the files they are
2283 going to replace. The Exim binary is required to be owned by root and have the
2284 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2285 install`& as root so that it can set up the Exim binary in this way. However, in
2286 some special situations (for example, if a host is doing no local deliveries)
2287 it may be possible to run Exim without making the binary setuid root (see
2288 chapter &<<CHAPsecurity>>& for details).
2289
2290 .cindex "CONFIGURE_FILE"
2291 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2292 in &_Local/Makefile_&. If this names a single file, and the file does not
2293 exist, the default configuration file &_src/configure.default_& is copied there
2294 by the installation script. If a runtime configuration file already exists, it
2295 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2296 alternative files, no default is installed.
2297
2298 .cindex "system aliases file"
2299 .cindex "&_/etc/aliases_&"
2300 One change is made to the default configuration file when it is installed: the
2301 default configuration contains a router that references a system aliases file.
2302 The path to this file is set to the value specified by
2303 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2304 If the system aliases file does not exist, the installation script creates it,
2305 and outputs a comment to the user.
2306
2307 The created file contains no aliases, but it does contain comments about the
2308 aliases a site should normally have. Mail aliases have traditionally been
2309 kept in &_/etc/aliases_&. However, some operating systems are now using
2310 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2311 Exim's configuration if necessary.
2312
2313 The default configuration uses the local host's name as the only local domain,
2314 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2315 running as the local user. System aliases and &_.forward_& files in users' home
2316 directories are supported, but no NIS or NIS+ support is configured. Domains
2317 other than the name of the local host are routed using the DNS, with delivery
2318 over SMTP.
2319
2320 It is possible to install Exim for special purposes (such as building a binary
2321 distribution) in a private part of the file system. You can do this by a
2322 command such as
2323 .code
2324 make DESTDIR=/some/directory/ install
2325 .endd
2326 This has the effect of pre-pending the specified directory to all the file
2327 paths, except the name of the system aliases file that appears in the default
2328 configuration. (If a default alias file is created, its name &'is'& modified.)
2329 For backwards compatibility, ROOT is used if DESTDIR is not set,
2330 but this usage is deprecated.
2331
2332 .cindex "installing Exim" "what is not installed"
2333 Running &'make install'& does not copy the Exim 4 conversion script
2334 &'convert4r4'&. You will probably run this only once if you are
2335 upgrading from Exim 3. None of the documentation files in the &_doc_&
2336 directory are copied, except for the info files when you have set
2337 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2338
2339 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2340 to their names. The Exim binary itself, however, is handled differently. It is
2341 installed under a name that includes the version number and the compile number,
2342 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2343 called &_exim_& to point to the binary. If you are updating a previous version
2344 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2345 from the directory (as seen by other processes).
2346
2347 .cindex "installing Exim" "testing the script"
2348 If you want to see what the &'make install'& will do before running it for
2349 real, you can pass the &%-n%& option to the installation script by this
2350 command:
2351 .code
2352 make INSTALL_ARG=-n install
2353 .endd
2354 The contents of the variable INSTALL_ARG are passed to the installation
2355 script. You do not need to be root to run this test. Alternatively, you can run
2356 the installation script directly, but this must be from within the build
2357 directory. For example, from the top-level Exim directory you could use this
2358 command:
2359 .code
2360 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2361 .endd
2362 .cindex "installing Exim" "install script options"
2363 There are two other options that can be supplied to the installation script.
2364
2365 .ilist
2366 &%-no_chown%& bypasses the call to change the owner of the installed binary
2367 to root, and the call to make it a setuid binary.
2368 .next
2369 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2370 installed binary.
2371 .endlist
2372
2373 INSTALL_ARG can be used to pass these options to the script. For example:
2374 .code
2375 make INSTALL_ARG=-no_symlink install
2376 .endd
2377 The installation script can also be given arguments specifying which files are
2378 to be copied. For example, to install just the Exim binary, and nothing else,
2379 without creating the symbolic link, you could use:
2380 .code
2381 make INSTALL_ARG='-no_symlink exim' install
2382 .endd
2383
2384
2385
2386 .section "Installing info documentation" "SECTinsinfdoc"
2387 .cindex "installing Exim" "&'info'& documentation"
2388 Not all systems use the GNU &'info'& system for documentation, and for this
2389 reason, the Texinfo source of Exim's documentation is not included in the main
2390 distribution. Instead it is available separately from the FTP site (see section
2391 &<<SECTavail>>&).
2392
2393 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2394 source of the documentation is found in the source tree, running &`make
2395 install`& automatically builds the info files and installs them.
2396
2397
2398
2399 .section "Setting up the spool directory" "SECID33"
2400 .cindex "spool directory" "creating"
2401 When it starts up, Exim tries to create its spool directory if it does not
2402 exist. The Exim uid and gid are used for the owner and group of the spool
2403 directory. Sub-directories are automatically created in the spool directory as
2404 necessary.
2405
2406
2407
2408
2409 .section "Testing" "SECID34"
2410 .cindex "testing" "installation"
2411 Having installed Exim, you can check that the runtime configuration file is
2412 syntactically valid by running the following command, which assumes that the
2413 Exim binary directory is within your PATH environment variable:
2414 .code
2415 exim -bV
2416 .endd
2417 If there are any errors in the configuration file, Exim outputs error messages.
2418 Otherwise it outputs the version number and build date,
2419 the DBM library that is being used, and information about which drivers and
2420 other optional code modules are included in the binary.
2421 Some simple routing tests can be done by using the address testing option. For
2422 example,
2423 .display
2424 &`exim -bt`& <&'local username'&>
2425 .endd
2426 should verify that it recognizes a local mailbox, and
2427 .display
2428 &`exim -bt`& <&'remote address'&>
2429 .endd
2430 a remote one. Then try getting it to deliver mail, both locally and remotely.
2431 This can be done by passing messages directly to Exim, without going through a
2432 user agent. For example:
2433 .code
2434 exim -v postmaster@your.domain.example
2435 From: user@your.domain.example
2436 To: postmaster@your.domain.example
2437 Subject: Testing Exim
2438
2439 This is a test message.
2440 ^D
2441 .endd
2442 The &%-v%& option causes Exim to output some verification of what it is doing.
2443 In this case you should see copies of three log lines, one for the message's
2444 arrival, one for its delivery, and one containing &"Completed"&.
2445
2446 .cindex "delivery" "problems with"
2447 If you encounter problems, look at Exim's log files (&'mainlog'& and
2448 &'paniclog'&) to see if there is any relevant information there. Another source
2449 of information is running Exim with debugging turned on, by specifying the
2450 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2451 with debugging turned on by a command of the form
2452 .display
2453 &`exim -d -M`& <&'exim-message-id'&>
2454 .endd
2455 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2456 produces rather a lot of output, but you can cut this down to specific areas.
2457 For example, if you use &%-d-all+route%& only the debugging information
2458 relevant to routing is included. (See the &%-d%& option in chapter
2459 &<<CHAPcommandline>>& for more details.)
2460
2461 .cindex '&"sticky"& bit'
2462 .cindex "lock files"
2463 One specific problem that has shown up on some sites is the inability to do
2464 local deliveries into a shared mailbox directory, because it does not have the
2465 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2466 writing to a mailbox file, and if it cannot create the lock file, the delivery
2467 is deferred. You can get round this either by setting the &"sticky bit"& on the
2468 directory, or by setting a specific group for local deliveries and allowing
2469 that group to create files in the directory (see the comments above the
2470 &(local_delivery)& transport in the default configuration file). Another
2471 approach is to configure Exim not to use lock files, but just to rely on
2472 &[fcntl()]& locking instead. However, you should do this only if all user
2473 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2474 see chapter &<<CHAPappendfile>>&.
2475
2476 One thing that cannot be tested on a system that is already running an MTA is
2477 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2478 &%-oX%& option can be used to run an Exim daemon that listens on some other
2479 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2480 &'exim_checkaccess'& utility can be used to check out policy controls on
2481 incoming SMTP mail.
2482
2483 Testing a new version on a system that is already running Exim can most easily
2484 be done by building a binary with a different CONFIGURE_FILE setting. From
2485 within the runtime configuration, all other file and directory names
2486 that Exim uses can be altered, in order to keep it entirely clear of the
2487 production version.
2488
2489
2490 .section "Replacing another MTA with Exim" "SECID35"
2491 .cindex "replacing another MTA"
2492 Building and installing Exim for the first time does not of itself put it in
2493 general use. The name by which the system's MTA is called by mail user agents
2494 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2495 operating system), and it is necessary to make this name point to the &'exim'&
2496 binary in order to get the user agents to pass messages to Exim. This is
2497 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2498 or &_/usr/lib/sendmail_&
2499 .cindex "symbolic link" "to &'exim'& binary"
2500 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2501 privilege and executable status from the old MTA. It is then necessary to stop
2502 and restart the mailer daemon, if one is running.
2503
2504 .cindex "FreeBSD, MTA indirection"
2505 .cindex "&_/etc/mail/mailer.conf_&"
2506 Some operating systems have introduced alternative ways of switching MTAs. For
2507 example, if you are running FreeBSD, you need to edit the file
2508 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2509 described. A typical example of the contents of this file for running Exim is
2510 as follows:
2511 .code
2512 sendmail            /usr/exim/bin/exim
2513 send-mail           /usr/exim/bin/exim
2514 mailq               /usr/exim/bin/exim -bp
2515 newaliases          /usr/bin/true
2516 .endd
2517 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2518 your Exim installation is &"live"&. Check it by sending a message from your
2519 favourite user agent.
2520
2521 You should consider what to tell your users about the change of MTA. Exim may
2522 have different capabilities to what was previously running, and there are
2523 various operational differences such as the text of messages produced by
2524 command line options and in bounce messages. If you allow your users to make
2525 use of Exim's filtering capabilities, you should make the document entitled
2526 &'Exim's interface to mail filtering'& available to them.
2527
2528
2529
2530 .section "Upgrading Exim" "SECID36"
2531 .cindex "upgrading Exim"
2532 If you are already running Exim on your host, building and installing a new
2533 version automatically makes it available to MUAs, or any other programs that
2534 call the MTA directly. However, if you are running an Exim daemon, you do need
2535 .cindex restart "on HUP signal"
2536 .cindex signal "HUP, to restart"
2537 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2538 new binary. You do not need to stop processing mail in order to install a new
2539 version of Exim. The install script does not modify an existing runtime
2540 configuration file.
2541
2542
2543
2544
2545 .section "Stopping the Exim daemon on Solaris" "SECID37"
2546 .cindex "Solaris" "stopping Exim on"
2547 The standard command for stopping the mailer daemon on Solaris is
2548 .code
2549 /etc/init.d/sendmail stop
2550 .endd
2551 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2552 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2553 for the text &"sendmail"&; this is not present because the actual program name
2554 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2555 solution is to replace the line that finds the process id with something like
2556 .code
2557 pid=`cat /var/spool/exim/exim-daemon.pid`
2558 .endd
2559 to obtain the daemon's pid directly from the file that Exim saves it in.
2560
2561 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2562 still be received from local processes, and if automatic delivery is configured
2563 (the normal case), deliveries will still occur.
2564
2565
2566
2567
2568 . ////////////////////////////////////////////////////////////////////////////
2569 . ////////////////////////////////////////////////////////////////////////////
2570
2571 .chapter "The Exim command line" "CHAPcommandline"
2572 .scindex IIDclo1 "command line" "options"
2573 .scindex IIDclo2 "options" "command line"
2574 Exim's command line takes the standard Unix form of a sequence of options,
2575 each starting with a hyphen character, followed by a number of arguments. The
2576 options are compatible with the main options of Sendmail, and there are also
2577 some additional options, some of which are compatible with Smail 3. Certain
2578 combinations of options do not make sense, and provoke an error if used.
2579 The form of the arguments depends on which options are set.
2580
2581
2582 .section "Setting options by program name" "SECID38"
2583 .cindex "&'mailq'&"
2584 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2585 were present before any other options.
2586 The &%-bp%& option requests a listing of the contents of the mail queue on the
2587 standard output.
2588 This feature is for compatibility with some systems that contain a command of
2589 that name in one of the standard libraries, symbolically linked to
2590 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2591
2592 .cindex "&'rsmtp'&"
2593 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2594 were present before any other options, for compatibility with Smail. The
2595 &%-bS%& option is used for reading in a number of messages in batched SMTP
2596 format.
2597
2598 .cindex "&'rmail'&"
2599 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2600 &%-oee%& options were present before any other options, for compatibility with
2601 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2602
2603 .cindex "&'runq'&"
2604 .cindex "queue runner"
2605 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2606 were present before any other options, for compatibility with Smail. The &%-q%&
2607 option causes a single queue runner process to be started.
2608
2609 .cindex "&'newaliases'&"
2610 .cindex "alias file" "building"
2611 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2612 If Exim is called under the name &'newaliases'& it behaves as if the option
2613 &%-bi%& were present before any other options, for compatibility with Sendmail.
2614 This option is used for rebuilding Sendmail's alias file. Exim does not have
2615 the concept of a single alias file, but can be configured to run a given
2616 command if called with the &%-bi%& option.
2617
2618
2619 .section "Trusted and admin users" "SECTtrustedadmin"
2620 Some Exim options are available only to &'trusted users'& and others are
2621 available only to &'admin users'&. In the description below, the phrases &"Exim
2622 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2623 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2624 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2625
2626 .ilist
2627 .cindex "trusted users" "definition of"
2628 .cindex "user" "trusted definition of"
2629 The trusted users are root, the Exim user, any user listed in the
2630 &%trusted_users%& configuration option, and any user whose current group or any
2631 supplementary group is one of those listed in the &%trusted_groups%&
2632 configuration option. Note that the Exim group is not automatically trusted.
2633
2634 .cindex '&"From"& line'
2635 .cindex "envelope from"
2636 .cindex "envelope sender"
2637 Trusted users are always permitted to use the &%-f%& option or a leading
2638 &"From&~"& line to specify the envelope sender of a message that is passed to
2639 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2640 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2641 users to set envelope senders.
2642
2643 .cindex "&'From:'& header line"
2644 .cindex "&'Sender:'& header line"
2645 .cindex "header lines" "From:"
2646 .cindex "header lines" "Sender:"
2647 For a trusted user, there is never any check on the contents of the &'From:'&
2648 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2649 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2650
2651 Trusted users may also specify a host name, host address, interface address,
2652 protocol name, ident value, and authentication data when submitting a message
2653 locally. Thus, they are able to insert messages into Exim's queue locally that
2654 have the characteristics of messages received from a remote host. Untrusted
2655 users may in some circumstances use &%-f%&, but can never set the other values
2656 that are available to trusted users.
2657 .next
2658 .cindex "user" "admin definition of"
2659 .cindex "admin user" "definition of"
2660 The admin users are root, the Exim user, and any user that is a member of the
2661 Exim group or of any group listed in the &%admin_groups%& configuration option.
2662 The current group does not have to be one of these groups.
2663
2664 Admin users are permitted to list the queue, and to carry out certain
2665 operations on messages, for example, to force delivery failures. It is also
2666 necessary to be an admin user in order to see the full information provided by
2667 the Exim monitor, and full debugging output.
2668
2669 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2670 Exim to attempt delivery of messages on its queue is restricted to admin users.
2671 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2672 option false (that is, specifying &%no_prod_requires_admin%&).
2673
2674 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2675 is restricted to admin users unless &%queue_list_requires_admin%& is set
2676 false.
2677 .endlist
2678
2679
2680 &*Warning*&: If you configure your system so that admin users are able to
2681 edit Exim's configuration file, you are giving those users an easy way of
2682 getting root. There is further discussion of this issue at the start of chapter
2683 &<<CHAPconf>>&.
2684
2685
2686
2687
2688 .section "Command line options" "SECID39"
2689 Exim's command line options are described in alphabetical order below. If none
2690 of the options that specifies a specific action (such as starting the daemon or
2691 a queue runner, or testing an address, or receiving a message in a specific
2692 format, or listing the queue) are present, and there is at least one argument
2693 on the command line, &%-bm%& (accept a local message on the standard input,
2694 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2695 outputs a brief message about itself and exits.
2696
2697 . ////////////////////////////////////////////////////////////////////////////
2698 . Insert a stylized XML comment here, to identify the start of the command line
2699 . options. This is for the benefit of the Perl script that automatically
2700 . creates a man page for the options.
2701 . ////////////////////////////////////////////////////////////////////////////
2702
2703 .literal xml
2704 <!-- === Start of command line options === -->
2705 .literal off
2706
2707
2708 .vlist
2709 .vitem &%--%&
2710 .oindex "--"
2711 .cindex "options" "command line; terminating"
2712 This is a pseudo-option whose only purpose is to terminate the options and
2713 therefore to cause subsequent command line items to be treated as arguments
2714 rather than options, even if they begin with hyphens.
2715
2716 .vitem &%--help%&
2717 .oindex "&%--help%&"
2718 This option causes Exim to output a few sentences stating what it is.
2719 The same output is generated if the Exim binary is called with no options and
2720 no arguments.
2721
2722 .vitem &%--version%&
2723 .oindex "&%--version%&"
2724 This option is an alias for &%-bV%& and causes version information to be
2725 displayed.
2726
2727 .vitem &%-Ac%& &&&
2728        &%-Am%&
2729 .oindex "&%-Ac%&"
2730 .oindex "&%-Am%&"
2731 These options are used by Sendmail for selecting configuration files and are
2732 ignored by Exim.
2733
2734 .vitem &%-B%&<&'type'&>
2735 .oindex "&%-B%&"
2736 .cindex "8-bit characters"
2737 .cindex "Sendmail compatibility" "8-bit characters"
2738 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2739 clean; it ignores this option.
2740
2741 .vitem &%-bd%&
2742 .oindex "&%-bd%&"
2743 .cindex "daemon"
2744 .cindex "SMTP" "listener"
2745 .cindex "queue runner"
2746 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2747 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2748 that the daemon should also initiate periodic queue runs.
2749
2750 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2751 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2752 disconnect from the controlling terminal. When running this way, it can be
2753 stopped by pressing ctrl-C.
2754
2755 By default, Exim listens for incoming connections to the standard SMTP port on
2756 all the host's running interfaces. However, it is possible to listen on other
2757 ports, on multiple ports, and only on specific interfaces. Chapter
2758 &<<CHAPinterfaces>>& contains a description of the options that control this.
2759
2760 When a listening daemon
2761 .cindex "daemon" "process id (pid)"
2762 .cindex "pid (process id)" "of daemon"
2763 is started without the use of &%-oX%& (that is, without overriding the normal
2764 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2765 in Exim's spool directory. This location can be overridden by setting
2766 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2767 running as root.
2768
2769 When &%-oX%& is used on the command line to start a listening daemon, the
2770 process id is not written to the normal pid file path. However, &%-oP%& can be
2771 used to specify a path on the command line if a pid file is required.
2772
2773 The SIGHUP signal
2774 .cindex "SIGHUP"
2775 .cindex restart "on HUP signal"
2776 .cindex signal "HUP, to restart"
2777 .cindex "daemon" "restarting"
2778 .cindex signal "to reload configuration"
2779 .cindex daemon "reload configuration"
2780 .cindex reload configuration
2781 can be used to cause the daemon to re-execute itself. This should be done
2782 whenever Exim's configuration file, or any file that is incorporated into it by
2783 means of the &%.include%& facility, is changed, and also whenever a new version
2784 of Exim is installed. It is not necessary to do this when other files that are
2785 referenced from the configuration (for example, alias files) are changed,
2786 because these are reread each time they are used.
2787
2788 .vitem &%-bdf%&
2789 .oindex "&%-bdf%&"
2790 This option has the same effect as &%-bd%& except that it never disconnects
2791 from the controlling terminal, even when no debugging is specified.
2792
2793 .vitem &%-be%&
2794 .oindex "&%-be%&"
2795 .cindex "testing" "string expansion"
2796 .cindex "expansion" "testing"
2797 Run Exim in expansion testing mode. Exim discards its root privilege, to
2798 prevent ordinary users from using this mode to read otherwise inaccessible
2799 files. If no arguments are given, Exim runs interactively, prompting for lines
2800 of data. Otherwise, it processes each argument in turn.
2801
2802 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2803 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2804 used without command line arguments. If successful, it uses the &[readline()]&
2805 function, which provides extensive line-editing facilities, for reading the
2806 test data. A line history is supported.
2807
2808 Long expansion expressions can be split over several lines by using backslash
2809 continuations. As in Exim's runtime configuration, white space at the start of
2810 continuation lines is ignored. Each argument or data line is passed through the
2811 string expansion mechanism, and the result is output. Variable values from the
2812 configuration file (for example, &$qualify_domain$&) are available, but no
2813 message-specific values (such as &$message_exim_id$&) are set, because no message
2814 is being processed (but see &%-bem%& and &%-Mset%&).
2815
2816 &*Note*&: If you use this mechanism to test lookups, and you change the data
2817 files or databases you are using, you must exit and restart Exim before trying
2818 the same lookup again. Otherwise, because each Exim process caches the results
2819 of lookups, you will just get the same result as before.
2820
2821 Macro processing is done on lines before string-expansion: new macros can be
2822 defined and macros will be expanded.
2823 Because macros in the config file are often used for secrets, those are only
2824 available to admin users.
2825
2826 .vitem &%-bem%&&~<&'filename'&>
2827 .oindex "&%-bem%&"
2828 .cindex "testing" "string expansion"
2829 .cindex "expansion" "testing"
2830 This option operates like &%-be%& except that it must be followed by the name
2831 of a file. For example:
2832 .code
2833 exim -bem /tmp/testmessage
2834 .endd
2835 The file is read as a message (as if receiving a locally-submitted non-SMTP
2836 message) before any of the test expansions are done. Thus, message-specific
2837 variables such as &$message_size$& and &$header_from:$& are available. However,
2838 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2839 recipients are read from the headers in the normal way, and are shown in the
2840 &$recipients$& variable. Note that recipients cannot be given on the command
2841 line, because further arguments are taken as strings to expand (just like
2842 &%-be%&).
2843
2844 .vitem &%-bF%&&~<&'filename'&>
2845 .oindex "&%-bF%&"
2846 .cindex "system filter" "testing"
2847 .cindex "testing" "system filter"
2848 This option is the same as &%-bf%& except that it assumes that the filter being
2849 tested is a system filter. The additional commands that are available only in
2850 system filters are recognized.
2851
2852 .vitem &%-bf%&&~<&'filename'&>
2853 .oindex "&%-bf%&"
2854 .cindex "filter" "testing"
2855 .cindex "testing" "filter file"
2856 .cindex "forward file" "testing"
2857 .cindex "testing" "forward file"
2858 .cindex "Sieve filter" "testing"
2859 This option runs Exim in user filter testing mode; the file is the filter file
2860 to be tested, and a test message must be supplied on the standard input. If
2861 there are no message-dependent tests in the filter, an empty file can be
2862 supplied.
2863
2864 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2865 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2866 filter and a user filter in the same run. For example:
2867 .code
2868 exim -bF /system/filter -bf /user/filter </test/message
2869 .endd
2870 This is helpful when the system filter adds header lines or sets filter
2871 variables that are used by the user filter.
2872
2873 If the test filter file does not begin with one of the special lines
2874 .code
2875 # Exim filter
2876 # Sieve filter
2877 .endd
2878 it is taken to be a normal &_.forward_& file, and is tested for validity under
2879 that interpretation. See sections &<<SECTitenonfilred>>& to
2880 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2881 redirection lists.
2882
2883 The result of an Exim command that uses &%-bf%&, provided no errors are
2884 detected, is a list of the actions that Exim would try to take if presented
2885 with the message for real. More details of filter testing are given in the
2886 separate document entitled &'Exim's interfaces to mail filtering'&.
2887
2888 When testing a filter file,
2889 .cindex "&""From""& line"
2890 .cindex "envelope from"
2891 .cindex "envelope sender"
2892 .oindex "&%-f%&" "for filter testing"
2893 the envelope sender can be set by the &%-f%& option,
2894 or by a &"From&~"& line at the start of the test message. Various parameters
2895 that would normally be taken from the envelope recipient address of the message
2896 can be set by means of additional command line options (see the next four
2897 options).
2898
2899 .vitem &%-bfd%&&~<&'domain'&>
2900 .oindex "&%-bfd%&"
2901 .vindex "&$qualify_domain$&"
2902 This sets the domain of the recipient address when a filter file is being
2903 tested by means of the &%-bf%& option. The default is the value of
2904 &$qualify_domain$&.
2905
2906 .vitem &%-bfl%&&~<&'local&~part'&>
2907 .oindex "&%-bfl%&"
2908 This sets the local part of the recipient address when a filter file is being
2909 tested by means of the &%-bf%& option. The default is the username of the
2910 process that calls Exim. A local part should be specified with any prefix or
2911 suffix stripped, because that is how it appears to the filter when a message is
2912 actually being delivered.
2913
2914 .vitem &%-bfp%&&~<&'prefix'&>
2915 .oindex "&%-bfp%&"
2916 .cindex affix "filter testing"
2917 This sets the prefix of the local part of the recipient address when a filter
2918 file is being tested by means of the &%-bf%& option. The default is an empty
2919 prefix.
2920
2921 .vitem &%-bfs%&&~<&'suffix'&>
2922 .oindex "&%-bfs%&"
2923 .cindex affix "filter testing"
2924 This sets the suffix of the local part of the recipient address when a filter
2925 file is being tested by means of the &%-bf%& option. The default is an empty
2926 suffix.
2927
2928 .vitem &%-bh%&&~<&'IP&~address'&>
2929 .oindex "&%-bh%&"
2930 .cindex "testing" "incoming SMTP"
2931 .cindex "SMTP" "testing incoming"
2932 .cindex "testing" "relay control"
2933 .cindex "relaying" "testing configuration"
2934 .cindex "policy control" "testing"
2935 .cindex "debugging" "&%-bh%& option"
2936 This option runs a fake SMTP session as if from the given IP address, using the
2937 standard input and output. The IP address may include a port number at the end,
2938 after a full stop. For example:
2939 .code
2940 exim -bh 10.9.8.7.1234
2941 exim -bh fe80::a00:20ff:fe86:a061.5678
2942 .endd
2943 When an IPv6 address is given, it is converted into canonical form. In the case
2944 of the second example above, the value of &$sender_host_address$& after
2945 conversion to the canonical form is
2946 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2947
2948 Comments as to what is going on are written to the standard error file. These
2949 include lines beginning with &"LOG"& for anything that would have been logged.
2950 This facility is provided for testing configuration options for incoming
2951 messages, to make sure they implement the required policy. For example, you can
2952 test your relay controls using &%-bh%&.
2953
2954 &*Warning 1*&:
2955 .cindex "RFC 1413"
2956 You can test features of the configuration that rely on ident (RFC 1413)
2957 information by using the &%-oMt%& option. However, Exim cannot actually perform
2958 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2959 connection.
2960
2961 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2962 are also skipped when testing using &%-bh%&. If you want these callouts to
2963 occur, use &%-bhc%& instead.
2964
2965 Messages supplied during the testing session are discarded, and nothing is
2966 written to any of the real log files. There may be pauses when DNS (and other)
2967 lookups are taking place, and of course these may time out. The &%-oMi%& option
2968 can be used to specify a specific IP interface and port if this is important,
2969 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2970 session were authenticated.
2971
2972 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2973 output just states whether a given recipient address from a given host is
2974 acceptable or not. See section &<<SECTcheckaccess>>&.
2975
2976 Features such as authentication and encryption, where the client input is not
2977 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2978 specialized SMTP test program such as
2979 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2980
2981 .vitem &%-bhc%&&~<&'IP&~address'&>
2982 .oindex "&%-bhc%&"
2983 This option operates in the same way as &%-bh%&, except that address
2984 verification callouts are performed if required. This includes consulting and
2985 updating the callout cache database.
2986
2987 .vitem &%-bi%&
2988 .oindex "&%-bi%&"
2989 .cindex "alias file" "building"
2990 .cindex "building alias file"
2991 .cindex "Sendmail compatibility" "&%-bi%& option"
2992 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2993 Exim does not have the concept of a single alias file, and so it cannot mimic
2994 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2995 tend to appear in various scripts such as NIS make files, so the option must be
2996 recognized.
2997
2998 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2999 configuration option is run, under the uid and gid of the caller of Exim. If
3000 the &%-oA%& option is used, its value is passed to the command as an argument.
3001 The command set by &%bi_command%& may not contain arguments. The command can
3002 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3003 if this is required. If the &%bi_command%& option is not set, calling Exim with
3004 &%-bi%& is a no-op.
3005
3006 . // Keep :help first, then the rest in alphabetical order
3007 .vitem &%-bI:help%&
3008 .oindex "&%-bI:help%&"
3009 .cindex "querying exim information"
3010 We shall provide various options starting &`-bI:`& for querying Exim for
3011 information.  The output of many of these will be intended for machine
3012 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3013 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3014 options shall cause Exim to exit after producing the requested output.
3015
3016 .vitem &%-bI:dscp%&
3017 .oindex "&%-bI:dscp%&"
3018 .cindex "DSCP" "values"
3019 This option causes Exim to emit an alphabetically sorted list of all
3020 recognised DSCP names.
3021
3022 .vitem &%-bI:sieve%&
3023 .oindex "&%-bI:sieve%&"
3024 .cindex "Sieve filter" "capabilities"
3025 This option causes Exim to emit an alphabetically sorted list of all supported
3026 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3027 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3028 &`SIEVE`& capability response line.  As the precise list may depend upon
3029 compile-time build options, which this option will adapt to, this is the only
3030 way to guarantee a correct response.
3031
3032 .vitem &%-bm%&
3033 .oindex "&%-bm%&"
3034 .cindex "local message reception"
3035 This option runs an Exim receiving process that accepts an incoming,
3036 locally-generated message on the standard input. The recipients are given as the
3037 command arguments (except when &%-t%& is also present &-- see below). Each
3038 argument can be a comma-separated list of RFC 2822 addresses. This is the
3039 default option for selecting the overall action of an Exim call; it is assumed
3040 if no other conflicting option is present.
3041
3042 If any addresses in the message are unqualified (have no domain), they are
3043 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3044 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3045 suppressing this for special cases.
3046
3047 Policy checks on the contents of local messages can be enforced by means of
3048 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3049
3050 .cindex "return code" "for &%-bm%&"
3051 The return code is zero if the message is successfully accepted. Otherwise, the
3052 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3053
3054 The format
3055 .cindex "message" "format"
3056 .cindex "format" "message"
3057 .cindex "&""From""& line"
3058 .cindex "UUCP" "&""From""& line"
3059 .cindex "Sendmail compatibility" "&""From""& line"
3060 of the message must be as defined in RFC 2822, except that, for
3061 compatibility with Sendmail and Smail, a line in one of the forms
3062 .code
3063 From sender Fri Jan  5 12:55 GMT 1997
3064 From sender Fri, 5 Jan 97 12:55:01
3065 .endd
3066 (with the weekday optional, and possibly with additional text after the date)
3067 is permitted to appear at the start of the message. There appears to be no
3068 authoritative specification of the format of this line. Exim recognizes it by
3069 matching against the regular expression defined by the &%uucp_from_pattern%&
3070 option, which can be changed if necessary.
3071
3072 .oindex "&%-f%&" "overriding &""From""& line"
3073 The specified sender is treated as if it were given as the argument to the
3074 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3075 preference to the address taken from the message. The caller of Exim must be a
3076 trusted user for the sender of a message to be set in this way.
3077
3078 .vitem &%-bmalware%&&~<&'filename'&>
3079 .oindex "&%-bmalware%&"
3080 .cindex "testing", "malware"
3081 .cindex "malware scan test"
3082 This debugging option causes Exim to scan the given file or directory
3083 (depending on the used scanner interface),
3084 using the malware scanning framework.  The option of &%av_scanner%& influences
3085 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3086 the expansion should have defaults which apply to this invocation.  ACLs are
3087 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3088 will never be populated and &%-bmalware%& will fail.
3089
3090 Exim will have changed working directory before resolving the filename, so
3091 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3092 user when it tries to open the file, rather than as the invoking user.
3093 This option requires admin privileges.
3094
3095 The &%-bmalware%& option will not be extended to be more generally useful,
3096 there are better tools for file-scanning.  This option exists to help
3097 administrators verify their Exim and AV scanner configuration.
3098
3099 .vitem &%-bnq%&
3100 .oindex "&%-bnq%&"
3101 .cindex "address qualification, suppressing"
3102 By default, Exim automatically qualifies unqualified addresses (those
3103 without domains) that appear in messages that are submitted locally (that
3104 is, not over TCP/IP). This qualification applies both to addresses in
3105 envelopes, and addresses in header lines. Sender addresses are qualified using
3106 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3107 defaults to the value of &%qualify_domain%&).
3108
3109 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3110 being used to re-submit messages that originally came from remote hosts after
3111 content scanning, you probably do not want to qualify unqualified addresses in
3112 header lines. (Such lines will be present only if you have not enabled a header
3113 syntax check in the appropriate ACL.)
3114
3115 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3116 messages that originate on the local host. When this is used, unqualified
3117 addresses in the envelope provoke errors (causing message rejection) and
3118 unqualified addresses in header lines are left alone.
3119
3120
3121 .vitem &%-bP%&
3122 .oindex "&%-bP%&"
3123 .cindex "configuration options" "extracting"
3124 .cindex "options" "configuration &-- extracting"
3125 If this option is given with no arguments, it causes the values of all Exim's
3126 main configuration options to be written to the standard output. The values
3127 of one or more specific options can be requested by giving their names as
3128 arguments, for example:
3129 .code
3130 exim -bP qualify_domain hold_domains
3131 .endd
3132 .cindex "hiding configuration option values"
3133 .cindex "configuration options" "hiding value of"
3134 .cindex "options" "hiding value of"
3135 However, any option setting that is preceded by the word &"hide"& in the
3136 configuration file is not shown in full, except to an admin user. For other
3137 users, the output is as in this example:
3138 .code
3139 mysql_servers = <value not displayable>
3140 .endd
3141 If &%config%& is given as an argument, the config is
3142 output, as it was parsed, any include file resolved, any comment removed.
3143
3144 If &%config_file%& is given as an argument, the name of the runtime
3145 configuration file is output. (&%configure_file%& works too, for
3146 backward compatibility.)
3147 If a list of configuration files was supplied, the value that is output here
3148 is the name of the file that was actually used.
3149
3150 .cindex "options" "hiding name of"
3151 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3152 name will not be output.
3153
3154 .cindex "daemon" "process id (pid)"
3155 .cindex "pid (process id)" "of daemon"
3156 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3157 directories where log files and daemon pid files are written are output,
3158 respectively. If these values are unset, log files are written in a
3159 sub-directory of the spool directory called &%log%&, and the pid file is
3160 written directly into the spool directory.
3161
3162 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3163 .code
3164 exim -bP +local_domains
3165 .endd
3166 it searches for a matching named list of any type (domain, host, address, or
3167 local part) and outputs what it finds.
3168
3169 .cindex "options" "router &-- extracting"
3170 .cindex "options" "transport &-- extracting"
3171 .cindex "options" "authenticator &-- extracting"
3172 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3173 followed by the name of an appropriate driver instance, the option settings for
3174 that driver are output. For example:
3175 .code
3176 exim -bP transport local_delivery
3177 .endd
3178 The generic driver options are output first, followed by the driver's private
3179 options. A list of the names of drivers of a particular type can be obtained by
3180 using one of the words &%router_list%&, &%transport_list%&, or
3181 &%authenticator_list%&, and a complete list of all drivers with their option
3182 settings can be obtained by using &%routers%&, &%transports%&, or
3183 &%authenticators%&.
3184
3185 .cindex "environment"
3186 If &%environment%& is given as an argument, the set of environment
3187 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3188 variables.
3189
3190 .cindex "options" "macro &-- extracting"
3191 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3192 are available, similarly to the drivers.  Because macros are sometimes used
3193 for storing passwords, this option is restricted.
3194 The output format is one item per line.
3195 For the "-bP macro <name>" form, if no such macro is found
3196 the exit status will be nonzero.
3197
3198 .vitem &%-bp%&
3199 .oindex "&%-bp%&"
3200 .cindex "queue" "listing messages in"
3201 .cindex "listing" "messages in the queue"
3202 This option requests a listing of the contents of the mail queue on the
3203 standard output. If the &%-bp%& option is followed by a list of message ids,
3204 just those messages are listed. By default, this option can be used only by an
3205 admin user. However, the &%queue_list_requires_admin%& option can be set false
3206 to allow any user to see the queue.
3207
3208 Each message in the queue is displayed as in the following example:
3209 .code
3210 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3211           red.king@looking-glass.fict.example
3212           <other addresses>
3213 .endd
3214 .cindex "message" "size in queue listing"
3215 .cindex "size" "of message"
3216 The first line contains the length of time the message has been in the queue
3217 (in this case 25 minutes), the size of the message (2.9K), the unique local
3218 identifier for the message, and the message sender, as contained in the
3219 envelope. For bounce messages, the sender address is empty, and appears as
3220 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3221 the default sender address, the user's login name is shown in parentheses
3222 before the sender address.
3223
3224 .cindex "frozen messages" "in queue listing"
3225 If the message is frozen (attempts to deliver it are suspended) then the text
3226 &"*** frozen ***"& is displayed at the end of this line.
3227
3228 The recipients of the message (taken from the envelope, not the headers) are
3229 displayed on subsequent lines. Those addresses to which the message has already
3230 been delivered are marked with the letter D. If an original address gets
3231 expanded into several addresses via an alias or forward file, the original is
3232 displayed with a D only when deliveries for all of its child addresses are
3233 complete.
3234
3235
3236 .vitem &%-bpa%&
3237 .oindex "&%-bpa%&"
3238 This option operates like &%-bp%&, but in addition it shows delivered addresses
3239 that were generated from the original top level address(es) in each message by
3240 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3241 of just &"D"&.
3242
3243
3244 .vitem &%-bpc%&
3245 .oindex "&%-bpc%&"
3246 .cindex "queue" "count of messages on"
3247 This option counts the number of messages in the queue, and writes the total
3248 to the standard output. It is restricted to admin users, unless
3249 &%queue_list_requires_admin%& is set false.
3250
3251
3252 .vitem &%-bpr%&
3253 .oindex "&%-bpr%&"
3254 This option operates like &%-bp%&, but the output is not sorted into
3255 chronological order of message arrival. This can speed it up when there are
3256 lots of messages in the queue, and is particularly useful if the output is
3257 going to be post-processed in a way that doesn't need the sorting.
3258
3259 .vitem &%-bpra%&
3260 .oindex "&%-bpra%&"
3261 This option is a combination of &%-bpr%& and &%-bpa%&.
3262
3263 .vitem &%-bpru%&
3264 .oindex "&%-bpru%&"
3265 This option is a combination of &%-bpr%& and &%-bpu%&.
3266
3267
3268 .vitem &%-bpu%&
3269 .oindex "&%-bpu%&"
3270 This option operates like &%-bp%& but shows only undelivered top-level
3271 addresses for each message displayed. Addresses generated by aliasing or
3272 forwarding are not shown, unless the message was deferred after processing by a
3273 router with the &%one_time%& option set.
3274
3275
3276 .vitem &%-brt%&
3277 .oindex "&%-brt%&"
3278 .cindex "testing" "retry configuration"
3279 .cindex "retry" "configuration testing"
3280 This option is for testing retry rules, and it must be followed by up to three
3281 arguments. It causes Exim to look for a retry rule that matches the values
3282 and to write it to the standard output. For example:
3283 .code
3284 exim -brt bach.comp.mus.example
3285 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3286 .endd
3287 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3288 argument, which is required, can be a complete address in the form
3289 &'local_part@domain'&, or it can be just a domain name. If the second argument
3290 contains a dot, it is interpreted as an optional second domain name; if no
3291 retry rule is found for the first argument, the second is tried. This ties in
3292 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3293 rule is found that matches the host, one that matches the mail domain is
3294 sought. Finally, an argument that is the name of a specific delivery error, as
3295 used in setting up retry rules, can be given. For example:
3296 .code
3297 exim -brt haydn.comp.mus.example quota_3d
3298 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3299 .endd
3300
3301 .vitem &%-brw%&
3302 .oindex "&%-brw%&"
3303 .cindex "testing" "rewriting"
3304 .cindex "rewriting" "testing"
3305 This option is for testing address rewriting rules, and it must be followed by
3306 a single argument, consisting of either a local part without a domain, or a
3307 complete address with a fully qualified domain. Exim outputs how this address
3308 would be rewritten for each possible place it might appear. See chapter
3309 &<<CHAPrewrite>>& for further details.
3310
3311 .vitem &%-bS%&
3312 .oindex "&%-bS%&"
3313 .cindex "SMTP" "batched incoming"
3314 .cindex "batched SMTP input"
3315 This option is used for batched SMTP input, which is an alternative interface
3316 for non-interactive local message submission. A number of messages can be
3317 submitted in a single run. However, despite its name, this is not really SMTP
3318 input. Exim reads each message's envelope from SMTP commands on the standard
3319 input, but generates no responses. If the caller is trusted, or
3320 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3321 believed; otherwise the sender is always the caller of Exim.
3322
3323 The message itself is read from the standard input, in SMTP format (leading
3324 dots doubled), terminated by a line containing just a single dot. An error is
3325 provoked if the terminating dot is missing. A further message may then follow.
3326
3327 As for other local message submissions, the contents of incoming batch SMTP
3328 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3329 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3330 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3331
3332 Some other SMTP commands are recognized in the input. HELO and EHLO act
3333 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3334 QUIT quits, ignoring the rest of the standard input.
3335
3336 .cindex "return code" "for &%-bS%&"
3337 If any error is encountered, reports are written to the standard output and
3338 error streams, and Exim gives up immediately. The return code is 0 if no error
3339 was detected; it is 1 if one or more messages were accepted before the error
3340 was detected; otherwise it is 2.
3341
3342 More details of input using batched SMTP are given in section
3343 &<<SECTincomingbatchedSMTP>>&.
3344
3345 .vitem &%-bs%&
3346 .oindex "&%-bs%&"
3347 .cindex "SMTP" "local input"
3348 .cindex "local SMTP input"
3349 This option causes Exim to accept one or more messages by reading SMTP commands
3350 on the standard input, and producing SMTP replies on the standard output. SMTP
3351 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3352 Some user agents use this interface as a way of passing locally-generated
3353 messages to the MTA.
3354
3355 In
3356 .cindex "sender" "source of"
3357 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3358 set, the senders of messages are taken from the SMTP MAIL commands.
3359 Otherwise the content of these commands is ignored and the sender is set up as
3360 the calling user. Unqualified addresses are automatically qualified using
3361 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3362 &%-bnq%& option is used.
3363
3364 .cindex "inetd"
3365 The
3366 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3367 using a listening daemon. Exim can distinguish the two cases by checking
3368 whether the standard input is a TCP/IP socket. When Exim is called from
3369 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3370 above concerning senders and qualification do not apply. In this situation,
3371 Exim behaves in exactly the same way as it does when receiving a message via
3372 the listening daemon.
3373
3374 .vitem &%-bt%&
3375 .oindex "&%-bt%&"
3376 .cindex "testing" "addresses"
3377 .cindex "address" "testing"
3378 This option runs Exim in address testing mode, in which each argument is taken
3379 as a recipient address to be tested for deliverability. The results are
3380 written to the standard output. If a test fails, and the caller is not an admin
3381 user, no details of the failure are output, because these might contain
3382 sensitive information such as usernames and passwords for database lookups.
3383
3384 If no arguments are given, Exim runs in an interactive manner, prompting with a
3385 right angle bracket for addresses to be tested.
3386
3387 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3388 &[readline()]& function, because it is running as &'root'& and there are
3389 security issues.
3390
3391 Each address is handled as if it were the recipient address of a message
3392 (compare the &%-bv%& option). It is passed to the routers and the result is
3393 written to the standard output. However, any router that has
3394 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3395 genuine routing tests if your first router passes everything to a scanner
3396 program.
3397
3398 .cindex "return code" "for &%-bt%&"
3399 The return code is 2 if any address failed outright; it is 1 if no address
3400 failed outright but at least one could not be resolved for some reason. Return
3401 code 0 is given only when all addresses succeed.
3402
3403 .cindex "duplicate addresses"
3404 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3405 addresses after routing is complete, so that only one delivery takes place.
3406 This does not happen when testing with &%-bt%&; the full results of routing are
3407 always shown.
3408
3409 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3410 routers in the configuration makes any tests on the sender address of a
3411 message,
3412 .oindex "&%-f%&" "for address testing"
3413 you can use the &%-f%& option to set an appropriate sender when running
3414 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3415 default qualifying domain. However, if you have set up (for example) routers
3416 whose behaviour depends on the contents of an incoming message, you cannot test
3417 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3418 doing such tests.
3419
3420 .vitem &%-bV%&
3421 .oindex "&%-bV%&"
3422 .cindex "version number of Exim"
3423 This option causes Exim to write the current version number, compilation
3424 number, and compilation date of the &'exim'& binary to the standard output.
3425 It also lists the DBM library that is being used, the optional modules (such as
3426 specific lookup types), the drivers that are included in the binary, and the
3427 name of the runtime configuration file that is in use.
3428
3429 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3430 configuration file. However, this is a static check only. It cannot check
3431 values that are to be expanded. For example, although a misspelt ACL verb is
3432 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3433 alone to discover (for example) all the typos in the configuration; some
3434 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3435 dynamic testing facilities.
3436
3437 .vitem &%-bv%&
3438 .oindex "&%-bv%&"
3439 .cindex "verifying address" "using &%-bv%&"
3440 .cindex "address" "verification"
3441 This option runs Exim in address verification mode, in which each argument is
3442 taken as a recipient address to be verified by the routers. (This does
3443 not involve any verification callouts). During normal operation, verification
3444 happens mostly as a consequence processing a &%verify%& condition in an ACL
3445 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3446 including callouts, see the &%-bh%& and &%-bhc%& options.
3447
3448 If verification fails, and the caller is not an admin user, no details of the
3449 failure are output, because these might contain sensitive information such as
3450 usernames and passwords for database lookups.
3451
3452 If no arguments are given, Exim runs in an interactive manner, prompting with a
3453 right angle bracket for addresses to be verified.
3454
3455 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3456 &[readline()]& function, because it is running as &'exim'& and there are
3457 security issues.
3458
3459 Verification differs from address testing (the &%-bt%& option) in that routers
3460 that have &%no_verify%& set are skipped, and if the address is accepted by a
3461 router that has &%fail_verify%& set, verification fails. The address is
3462 verified as a recipient if &%-bv%& is used; to test verification for a sender
3463 address, &%-bvs%& should be used.
3464
3465 If the &%-v%& option is not set, the output consists of a single line for each
3466 address, stating whether it was verified or not, and giving a reason in the
3467 latter case. Without &%-v%&, generating more than one address by redirection
3468 causes verification to end successfully, without considering the generated
3469 addresses. However, if just one address is generated, processing continues,
3470 and the generated address must verify successfully for the overall verification
3471 to succeed.
3472
3473 When &%-v%& is set, more details are given of how the address has been handled,
3474 and in the case of address redirection, all the generated addresses are also
3475 considered. Verification may succeed for some and fail for others.
3476
3477 The
3478 .cindex "return code" "for &%-bv%&"
3479 return code is 2 if any address failed outright; it is 1 if no address
3480 failed outright but at least one could not be resolved for some reason. Return
3481 code 0 is given only when all addresses succeed.
3482
3483 If any of the routers in the configuration makes any tests on the sender
3484 address of a message, you should use the &%-f%& option to set an appropriate
3485 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3486 calling user at the default qualifying domain.
3487
3488 .vitem &%-bvs%&
3489 .oindex "&%-bvs%&"
3490 This option acts like &%-bv%&, but verifies the address as a sender rather
3491 than a recipient address. This affects any rewriting and qualification that
3492 might happen.
3493
3494 .vitem &%-bw%&
3495 .oindex "&%-bw%&"
3496 .cindex "daemon"
3497 .cindex "inetd"
3498 .cindex "inetd" "wait mode"
3499 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3500 similarly to the &%-bd%& option.  All port specifications on the command-line
3501 and in the configuration file are ignored.  Queue-running may not be specified.
3502
3503 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3504 listening for connections.  This permits the system to start up and have
3505 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3506 each port only when the first connection is received.
3507
3508 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3509 which the daemon will exit, which should cause inetd to listen once more.
3510
3511 .vitem &%-C%&&~<&'filelist'&>
3512 .oindex "&%-C%&"
3513 .cindex "configuration file" "alternate"
3514 .cindex "CONFIGURE_FILE"
3515 .cindex "alternate configuration file"
3516 This option causes Exim to find the runtime configuration file from the given
3517 list instead of from the list specified by the CONFIGURE_FILE
3518 compile-time setting. Usually, the list will consist of just a single filename,
3519 but it can be a colon-separated list of names. In this case, the first
3520 file that exists is used. Failure to open an existing file stops Exim from
3521 proceeding any further along the list, and an error is generated.
3522
3523 When this option is used by a caller other than root, and the list is different
3524 from the compiled-in list, Exim gives up its root privilege immediately, and
3525 runs with the real and effective uid and gid set to those of the caller.
3526 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3527 file contains a list of full pathnames, one per line, for configuration files
3528 which are trusted. Root privilege is retained for any configuration file so
3529 listed, as long as the caller is the Exim user (or the user specified in the
3530 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3531 not writeable by inappropriate users or groups.
3532
3533 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3534 configuration using &%-C%& right through message reception and delivery,
3535 even if the caller is root. The reception works, but by that time, Exim is
3536 running as the Exim user, so when it re-executes to regain privilege for the
3537 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3538 test reception and delivery using two separate commands (one to put a message
3539 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3540
3541 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3542 prefix string with which any file named in a &%-C%& command line option
3543 must start. In addition, the filename must not contain the sequence &`/../`&.
3544 However, if the value of the &%-C%& option is identical to the value of
3545 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3546 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3547 unset, any filename can be used with &%-C%&.
3548
3549 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3550 to a directory to which only root has access. This prevents someone who has
3551 broken into the Exim account from running a privileged Exim with an arbitrary
3552 configuration file.
3553
3554 The &%-C%& facility is useful for ensuring that configuration files are
3555 syntactically correct, but cannot be used for test deliveries, unless the
3556 caller is privileged, or unless it is an exotic configuration that does not
3557 require privilege. No check is made on the owner or group of the files
3558 specified by this option.
3559
3560
3561 .vitem &%-D%&<&'macro'&>=<&'value'&>
3562 .oindex "&%-D%&"
3563 .cindex "macro" "setting on command line"
3564 This option can be used to override macro definitions in the configuration file
3565 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3566 unprivileged caller, it causes Exim to give up its root privilege.
3567 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3568 completely disabled, and its use causes an immediate error exit.
3569
3570 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3571 colon-separated list of macros which are considered safe and, if &%-D%& only
3572 supplies macros from this list, and the values are acceptable, then Exim will
3573 not give up root privilege if the caller is root, the Exim run-time user, or
3574 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3575 to be removed in the future.  Acceptable values for the macros satisfy the
3576 regexp: &`^[A-Za-z0-9_/.-]*$`&
3577
3578 The entire option (including equals sign if present) must all be within one
3579 command line item. &%-D%& can be used to set the value of a macro to the empty
3580 string, in which case the equals sign is optional. These two commands are
3581 synonymous:
3582 .code
3583 exim -DABC  ...
3584 exim -DABC= ...
3585 .endd
3586 To include spaces in a macro definition item, quotes must be used. If you use
3587 quotes, spaces are permitted around the macro name and the equals sign. For
3588 example:
3589 .code
3590 exim '-D ABC = something' ...
3591 .endd
3592 &%-D%& may be repeated up to 10 times on a command line.
3593 Only macro names up to 22 letters long can be set.
3594
3595
3596 .vitem &%-d%&<&'debug&~options'&>
3597 .oindex "&%-d%&"
3598 .cindex "debugging" "list of selectors"
3599 .cindex "debugging" "&%-d%& option"
3600 This option causes debugging information to be written to the standard
3601 error stream. It is restricted to admin users because debugging output may show
3602 database queries that contain password information. Also, the details of users'
3603 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3604 writes an error message to the standard error stream and exits with a non-zero
3605 return code.
3606
3607 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3608 standard debugging data is output. This can be reduced, or increased to include
3609 some more rarely needed information, by directly following &%-d%& with a string
3610 made up of names preceded by plus or minus characters. These add or remove sets
3611 of debugging data, respectively. For example, &%-d+filter%& adds filter
3612 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3613 no spaces are allowed in the debug setting. The available debugging categories
3614 are:
3615 .display
3616 &`acl            `& ACL interpretation
3617 &`auth           `& authenticators
3618 &`deliver        `& general delivery logic
3619 &`dns            `& DNS lookups (see also resolver)
3620 &`dnsbl          `& DNS black list (aka RBL) code
3621 &`exec           `& arguments for &[execv()]& calls
3622 &`expand         `& detailed debugging for string expansions
3623 &`filter         `& filter handling
3624 &`hints_lookup   `& hints data lookups
3625 &`host_lookup    `& all types of name-to-IP address handling
3626 &`ident          `& ident lookup
3627 &`interface      `& lists of local interfaces
3628 &`lists          `& matching things in lists
3629 &`load           `& system load checks
3630 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3631                     &<<CHAPlocalscan>>&)
3632 &`lookup         `& general lookup code and all lookups
3633 &`memory         `& memory handling
3634 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3635 &`pid            `& modifier: add pid to debug output lines
3636 &`process_info   `& setting info for the process log
3637 &`queue_run      `& queue runs
3638 &`receive        `& general message reception logic
3639 &`resolver       `& turn on the DNS resolver's debugging output
3640 &`retry          `& retry handling
3641 &`rewrite        `& address rewriting
3642 &`route          `& address routing
3643 &`timestamp      `& modifier: add timestamp to debug output lines
3644 &`tls            `& TLS logic
3645 &`transport      `& transports
3646 &`uid            `& changes of uid/gid and looking up uid/gid
3647 &`verify         `& address verification logic
3648 &`all            `& almost all of the above (see below), and also &%-v%&
3649 .endd
3650 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3651 for &`-all`&. The reason for this is that &`+all`& is something that people
3652 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3653 is included, an awful lot of output that is very rarely of interest is
3654 generated, so it now has to be explicitly requested. However, &`-all`& does
3655 turn everything off.
3656
3657 .cindex "resolver, debugging output"
3658 .cindex "DNS resolver, debugging output"
3659 The &`resolver`& option produces output only if the DNS resolver was compiled
3660 with DEBUG enabled. This is not the case in some operating systems. Also,
3661 unfortunately, debugging output from the DNS resolver is written to stdout
3662 rather than stderr.
3663
3664 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3665 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3666 However, the &`pid`& selector is forced when debugging is turned on for a
3667 daemon, which then passes it on to any re-executed Exims. Exim also
3668 automatically adds the pid to debug lines when several remote deliveries are
3669 run in parallel.
3670
3671 The &`timestamp`& selector causes the current time to be inserted at the start
3672 of all debug output lines. This can be useful when trying to track down delays
3673 in processing.
3674
3675 .cindex debugging "UTF-8 in"
3676 .cindex UTF-8 "in debug output"
3677 The &`noutf8`& selector disables the use of
3678 UTF-8 line-drawing characters to group related information.
3679 When disabled. ascii-art is used instead.
3680 Using the &`+all`& option does not set this modifier,
3681
3682 If the &%debug_print%& option is set in any driver, it produces output whenever
3683 any debugging is selected, or if &%-v%& is used.
3684
3685 .vitem &%-dd%&<&'debug&~options'&>
3686 .oindex "&%-dd%&"
3687 This option behaves exactly like &%-d%& except when used on a command that
3688 starts a daemon process. In that case, debugging is turned off for the
3689 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3690 behaviour of the daemon without creating as much output as full debugging does.
3691
3692 .vitem &%-dropcr%&
3693 .oindex "&%-dropcr%&"
3694 This is an obsolete option that is now a no-op. It used to affect the way Exim
3695 handled CR and LF characters in incoming messages. What happens now is
3696 described in section &<<SECTlineendings>>&.
3697
3698 .vitem &%-E%&
3699 .oindex "&%-E%&"
3700 .cindex "bounce message" "generating"
3701 This option specifies that an incoming message is a locally-generated delivery
3702 failure report. It is used internally by Exim when handling delivery failures
3703 and is not intended for external use. Its only effect is to stop Exim
3704 generating certain messages to the postmaster, as otherwise message cascades
3705 could occur in some situations. As part of the same option, a message id may
3706 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3707 new message contains the id, following &"R="&, as a cross-reference.
3708
3709 .vitem &%-e%&&'x'&
3710 .oindex "&%-e%&&'x'&"
3711 There are a number of Sendmail options starting with &%-oe%& which seem to be
3712 called by various programs without the leading &%o%& in the option. For
3713 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3714 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3715
3716 .vitem &%-F%&&~<&'string'&>
3717 .oindex "&%-F%&"
3718 .cindex "sender" "name"
3719 .cindex "name" "of sender"
3720 This option sets the sender's full name for use when a locally-generated
3721 message is being accepted. In the absence of this option, the user's &'gecos'&
3722 entry from the password data is used. As users are generally permitted to alter
3723 their &'gecos'& entries, no security considerations are involved. White space
3724 between &%-F%& and the <&'string'&> is optional.
3725
3726 .vitem &%-f%&&~<&'address'&>
3727 .oindex "&%-f%&"
3728 .cindex "sender" "address"
3729 .cindex "address" "sender"
3730 .cindex "trusted users"
3731 .cindex "envelope from"
3732 .cindex "envelope sender"
3733 .cindex "user" "trusted"
3734 This option sets the address of the envelope sender of a locally-generated
3735 message (also known as the return path). The option can normally be used only
3736 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3737 users to use it.
3738
3739 Processes running as root or the Exim user are always trusted. Other
3740 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3741 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3742 of a local message is set to the caller's login name at the default qualify
3743 domain.
3744
3745 There is one exception to the restriction on the use of &%-f%&: an empty sender
3746 can be specified by any user, trusted or not, to create a message that can
3747 never provoke a bounce. An empty sender can be specified either as an empty
3748 string, or as a pair of angle brackets with nothing between them, as in these
3749 examples of shell commands:
3750 .code
3751 exim -f '<>' user@domain
3752 exim -f "" user@domain
3753 .endd
3754 In addition, the use of &%-f%& is not restricted when testing a filter file
3755 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3756 &%-bv%& options.
3757
3758 Allowing untrusted users to change the sender address does not of itself make
3759 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3760 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3761 though this can be overridden by setting &%no_local_from_check%&.
3762
3763 White
3764 .cindex "&""From""& line"
3765 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3766 given as two arguments or one combined argument). The sender of a
3767 locally-generated message can also be set (when permitted) by an initial
3768 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3769 if &%-f%& is also present, it overrides &"From&~"&.
3770
3771 .vitem &%-G%&
3772 .oindex "&%-G%&"
3773 .cindex "submission fixups, suppressing (command-line)"
3774 This option is equivalent to an ACL applying:
3775 .code
3776 control = suppress_local_fixups
3777 .endd
3778 for every message received.  Note that Sendmail will complain about such
3779 bad formatting, where Exim silently just does not fix it up.  This may change
3780 in future.
3781
3782 As this affects audit information, the caller must be a trusted user to use
3783 this option.
3784
3785 .vitem &%-h%&&~<&'number'&>
3786 .oindex "&%-h%&"
3787 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3788 This option is accepted for compatibility with Sendmail, but has no effect. (In
3789 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3790 headers.)
3791
3792 .vitem &%-i%&
3793 .oindex "&%-i%&"
3794 .cindex "Solaris" "&'mail'& command"
3795 .cindex "dot" "in incoming non-SMTP message"
3796 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3797 line by itself should not terminate an incoming, non-SMTP message. I can find
3798 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3799 command in Solaris 2.4 uses it. See also &%-ti%&.
3800
3801 .vitem &%-L%&&~<&'tag'&>
3802 .oindex "&%-L%&"
3803 .cindex "syslog" "process name; set with flag"
3804 This option is equivalent to setting &%syslog_processname%& in the config
3805 file and setting &%log_file_path%& to &`syslog`&.
3806 Its use is restricted to administrators.  The configuration file has to be
3807 read and parsed, to determine access rights, before this is set and takes
3808 effect, so early configuration file errors will not honour this flag.
3809
3810 The tag should not be longer than 32 characters.
3811
3812 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3813 .oindex "&%-M%&"
3814 .cindex "forcing delivery"
3815 .cindex "delivery" "forcing attempt"
3816 .cindex "frozen messages" "forcing delivery"
3817 This option requests Exim to run a delivery attempt on each message in turn. If
3818 any of the messages are frozen, they are automatically thawed before the
3819 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3820 and &%hold_domains%& are ignored.
3821
3822 Retry
3823 .cindex "hints database" "overriding retry hints"
3824 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3825 the normal retry time has not yet been reached. This option requires the caller
3826 to be an admin user. However, there is an option called &%prod_requires_admin%&
3827 which can be set false to relax this restriction (and also the same requirement
3828 for the &%-q%&, &%-R%&, and &%-S%& options).
3829
3830 The deliveries happen synchronously, that is, the original Exim process does
3831 not terminate until all the delivery attempts have finished. No output is
3832 produced unless there is a serious error. If you want to see what is happening,
3833 use the &%-v%& option as well, or inspect Exim's main log.
3834
3835 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3836 .oindex "&%-Mar%&"
3837 .cindex "message" "adding recipients"
3838 .cindex "recipient" "adding"
3839 This option requests Exim to add the addresses to the list of recipients of the
3840 message (&"ar"& for &"add recipients"&). The first argument must be a message
3841 id, and the remaining ones must be email addresses. However, if the message is
3842 active (in the middle of a delivery attempt), it is not altered. This option
3843 can be used only by an admin user.
3844
3845 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3846         &~<&'message&~id'&>"
3847 .oindex "&%-MC%&"
3848 .cindex "SMTP" "passed connection"
3849 .cindex "SMTP" "multiple deliveries"
3850 .cindex "multiple SMTP deliveries"
3851 This option is not intended for use by external callers. It is used internally
3852 by Exim to invoke another instance of itself to deliver a waiting message using
3853 an existing SMTP connection, which is passed as the standard input. Details are
3854 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3855 must be root or the Exim user in order to use it.
3856
3857 .vitem &%-MCA%&
3858 .oindex "&%-MCA%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option. It signifies that the
3861 connection to the remote host has been authenticated.
3862
3863 .vitem &%-MCD%&
3864 .oindex "&%-MCD%&"
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-MC%& option. It signifies that the
3867 remote host supports the ESMTP &_DSN_& extension.
3868
3869 .vitem &%-MCG%&&~<&'queue&~name'&>
3870 .oindex "&%-MCG%&"
3871 This option is not intended for use by external callers. It is used internally
3872 by Exim in conjunction with the &%-MC%& option. It signifies that an
3873 alternate queue is used, named by the following argument.
3874
3875 .vitem &%-MCK%&
3876 .oindex "&%-MCK%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-MC%& option. It signifies that a
3879 remote host supports the ESMTP &_CHUNKING_& extension.
3880
3881 .vitem &%-MCP%&
3882 .oindex "&%-MCP%&"
3883 This option is not intended for use by external callers. It is used internally
3884 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3885 which Exim is connected supports pipelining.
3886
3887 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3888 .oindex "&%-MCQ%&"
3889 This option is not intended for use by external callers. It is used internally
3890 by Exim in conjunction with the &%-MC%& option when the original delivery was
3891 started by a queue runner. It passes on the process id of the queue runner,
3892 together with the file descriptor number of an open pipe. Closure of the pipe
3893 signals the final completion of the sequence of processes that are passing
3894 messages through the same SMTP connection.
3895
3896 .vitem &%-MCS%&
3897 .oindex "&%-MCS%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3900 SMTP SIZE option should be used on messages delivered down the existing
3901 connection.
3902
3903 .vitem &%-MCT%&
3904 .oindex "&%-MCT%&"
3905 This option is not intended for use by external callers. It is used internally
3906 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3907 host to which Exim is connected supports TLS encryption.
3908
3909 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3910 .oindex "&%-MCt%&"
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3913 connection is being proxied by a parent process for handling TLS encryption.
3914 The arguments give the local address and port being proxied, and the TLS cipher.
3915
3916 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3917 .oindex "&%-Mc%&"
3918 .cindex "hints database" "not overridden by &%-Mc%&"
3919 .cindex "delivery" "manually started &-- not forced"
3920 This option requests Exim to run a delivery attempt on each message, in turn,
3921 but unlike the &%-M%& option, it does check for retry hints, and respects any
3922 that are found. This option is not very useful to external callers. It is
3923 provided mainly for internal use by Exim when it needs to re-invoke itself in
3924 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3925 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3926 respects retry times and other options such as &%hold_domains%& that are
3927 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3928 If you want to run a specific delivery as if in a queue run, you should use
3929 &%-q%& with a message id argument. A distinction between queue run deliveries
3930 and other deliveries is made in one or two places.
3931
3932 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3933 .oindex "&%-Mes%&"
3934 .cindex "message" "changing sender"
3935 .cindex "sender" "changing"
3936 This option requests Exim to change the sender address in the message to the
3937 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3938 &"edit sender"&). There must be exactly two arguments. The first argument must
3939 be a message id, and the second one an email address. However, if the message
3940 is active (in the middle of a delivery attempt), its status is not altered.
3941 This option can be used only by an admin user.
3942
3943 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3944 .oindex "&%-Mf%&"
3945 .cindex "freezing messages"
3946 .cindex "message" "manually freezing"
3947 This option requests Exim to mark each listed message as &"frozen"&. This
3948 prevents any delivery attempts taking place until the message is &"thawed"&,
3949 either manually or as a result of the &%auto_thaw%& configuration option.
3950 However, if any of the messages are active (in the middle of a delivery
3951 attempt), their status is not altered. This option can be used only by an admin
3952 user.
3953
3954 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3955 .oindex "&%-Mg%&"
3956 .cindex "giving up on messages"
3957 .cindex "message" "abandoning delivery attempts"
3958 .cindex "delivery" "abandoning further attempts"
3959 This option requests Exim to give up trying to deliver the listed messages,
3960 including any that are frozen. However, if any of the messages are active,
3961 their status is not altered. For non-bounce messages, a delivery error message
3962 is sent to the sender, containing the text &"cancelled by administrator"&.
3963 Bounce messages are just discarded. This option can be used only by an admin
3964 user.
3965
3966 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3967 .oindex "&%-MG%&"
3968 .cindex queue named
3969 .cindex "named queues"
3970 .cindex "queue" "moving messages"
3971 This option requests that each listed message be moved from its current
3972 queue to the given named queue.
3973 The destination queue name argument is required, but can be an empty
3974 string to define the default queue.
3975 If the messages are not currently located in the default queue,
3976 a &%-qG<name>%& option will be required to define the source queue.
3977
3978 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3979 .oindex "&%-Mmad%&"
3980 .cindex "delivery" "cancelling all"
3981 This option requests Exim to mark all the recipient addresses in the messages
3982 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3983 message is active (in the middle of a delivery attempt), its status is not
3984 altered. This option can be used only by an admin user.
3985
3986 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3987 .oindex "&%-Mmd%&"
3988 .cindex "delivery" "cancelling by address"
3989 .cindex "recipient" "removing"
3990 .cindex "removing recipients"
3991 This option requests Exim to mark the given addresses as already delivered
3992 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3993 the remaining ones must be email addresses. These are matched to recipient
3994 addresses in the message in a case-sensitive manner. If the message is active
3995 (in the middle of a delivery attempt), its status is not altered. This option
3996 can be used only by an admin user.
3997
3998 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3999 .oindex "&%-Mrm%&"
4000 .cindex "removing messages"
4001 .cindex "abandoning mail"
4002 .cindex "message" "manually discarding"
4003 This option requests Exim to remove the given messages from the queue. No
4004 bounce messages are sent; each message is simply forgotten. However, if any of
4005 the messages are active, their status is not altered. This option can be used
4006 only by an admin user or by the user who originally caused the message to be
4007 placed in the queue.
4008
4009 . .new
4010 . .vitem &%-MS%&
4011 . .oindex "&%-MS%&"
4012 . .cindex REQUIRETLS
4013 . This option is used to request REQUIRETLS processing on the message.
4014 . It is used internally by Exim in conjunction with -E when generating
4015 . a bounce message.
4016 . .wen
4017
4018 .vitem &%-Mset%&&~<&'message&~id'&>
4019 .oindex "&%-Mset%&"
4020 .cindex "testing" "string expansion"
4021 .cindex "expansion" "testing"
4022 This option is useful only in conjunction with &%-be%& (that is, when testing
4023 string expansions). Exim loads the given message from its spool before doing
4024 the test expansions, thus setting message-specific variables such as
4025 &$message_size$& and the header variables. The &$recipients$& variable is made
4026 available. This feature is provided to make it easier to test expansions that
4027 make use of these variables. However, this option can be used only by an admin
4028 user. See also &%-bem%&.
4029
4030 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4031 .oindex "&%-Mt%&"
4032 .cindex "thawing messages"
4033 .cindex "unfreezing messages"
4034 .cindex "frozen messages" "thawing"
4035 .cindex "message" "thawing frozen"
4036 This option requests Exim to &"thaw"& any of the listed messages that are
4037 &"frozen"&, so that delivery attempts can resume. However, if any of the
4038 messages are active, their status is not altered. This option can be used only
4039 by an admin user.
4040
4041 .vitem &%-Mvb%&&~<&'message&~id'&>
4042 .oindex "&%-Mvb%&"
4043 .cindex "listing" "message body"
4044 .cindex "message" "listing body of"
4045 This option causes the contents of the message body (-D) spool file to be
4046 written to the standard output. This option can be used only by an admin user.
4047
4048 .vitem &%-Mvc%&&~<&'message&~id'&>
4049 .oindex "&%-Mvc%&"
4050 .cindex "message" "listing in RFC 2822 format"
4051 .cindex "listing" "message in RFC 2822 format"
4052 This option causes a copy of the complete message (header lines plus body) to
4053 be written to the standard output in RFC 2822 format. This option can be used
4054 only by an admin user.
4055
4056 .vitem &%-Mvh%&&~<&'message&~id'&>
4057 .oindex "&%-Mvh%&"
4058 .cindex "listing" "message headers"
4059 .cindex "header lines" "listing"
4060 .cindex "message" "listing header lines"
4061 This option causes the contents of the message headers (-H) spool file to be
4062 written to the standard output. This option can be used only by an admin user.
4063
4064 .vitem &%-Mvl%&&~<&'message&~id'&>
4065 .oindex "&%-Mvl%&"
4066 .cindex "listing" "message log"
4067 .cindex "message" "listing message log"
4068 This option causes the contents of the message log spool file to be written to
4069 the standard output. This option can be used only by an admin user.
4070
4071 .vitem &%-m%&
4072 .oindex "&%-m%&"
4073 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4074 treats it that way too.
4075
4076 .vitem &%-N%&
4077 .oindex "&%-N%&"
4078 .cindex "debugging" "&%-N%& option"
4079 .cindex "debugging" "suppressing delivery"
4080 This is a debugging option that inhibits delivery of a message at the transport
4081 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4082 it just doesn't actually transport the message, but instead behaves as if it
4083 had successfully done so. However, it does not make any updates to the retry
4084 database, and the log entries for deliveries are flagged with &"*>"& rather
4085 than &"=>"&.
4086
4087 Because &%-N%& discards any message to which it applies, only root or the Exim
4088 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4089 words, an ordinary user can use it only when supplying an incoming message to
4090 which it will apply. Although transportation never fails when &%-N%& is set, an
4091 address may be deferred because of a configuration problem on a transport, or a
4092 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4093 the message, and applies to any subsequent delivery attempts that may happen
4094 for that message.
4095
4096 .vitem &%-n%&
4097 .oindex "&%-n%&"
4098 This option is interpreted by Sendmail to mean &"no aliasing"&.
4099 For normal modes of operation, it is ignored by Exim.
4100 When combined with &%-bP%& it makes the output more terse (suppresses
4101 option names, environment values and config pretty printing).
4102
4103 .vitem &%-O%&&~<&'data'&>
4104 .oindex "&%-O%&"
4105 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4106 Exim.
4107
4108 .vitem &%-oA%&&~<&'file&~name'&>
4109 .oindex "&%-oA%&"
4110 .cindex "Sendmail compatibility" "&%-oA%& option"
4111 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4112 alternative alias filename. Exim handles &%-bi%& differently; see the
4113 description above.
4114
4115 .vitem &%-oB%&&~<&'n'&>
4116 .oindex "&%-oB%&"
4117 .cindex "SMTP" "passed connection"
4118 .cindex "SMTP" "multiple deliveries"
4119 .cindex "multiple SMTP deliveries"
4120 This is a debugging option which limits the maximum number of messages that can
4121 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4122 transport. If <&'n'&> is omitted, the limit is set to 1.
4123
4124 .vitem &%-odb%&
4125 .oindex "&%-odb%&"
4126 .cindex "background delivery"
4127 .cindex "delivery" "in the background"
4128 This option applies to all modes in which Exim accepts incoming messages,
4129 including the listening daemon. It requests &"background"& delivery of such
4130 messages, which means that the accepting process automatically starts a
4131 delivery process for each message received, but does not wait for the delivery
4132 processes to finish.
4133
4134 When all the messages have been received, the reception process exits,
4135 leaving the delivery processes to finish in their own time. The standard output
4136 and error streams are closed at the start of each delivery process.
4137 This is the default action if none of the &%-od%& options are present.
4138
4139 If one of the queueing options in the configuration file
4140 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4141 overrides it if &%queue_only_override%& is set true, which is the default
4142 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4143
4144 .vitem &%-odf%&
4145 .oindex "&%-odf%&"
4146 .cindex "foreground delivery"
4147 .cindex "delivery" "in the foreground"
4148 This option requests &"foreground"& (synchronous) delivery when Exim has
4149 accepted a locally-generated message. (For the daemon it is exactly the same as
4150 &%-odb%&.) A delivery process is automatically started to deliver the message,
4151 and Exim waits for it to complete before proceeding.
4152
4153 The original Exim reception process does not finish until the delivery
4154 process for the final message has ended. The standard error stream is left open
4155 during deliveries.
4156
4157 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4158 false and one of the queueing options in the configuration file is in effect.
4159
4160 If there is a temporary delivery error during foreground delivery, the
4161 message is left in the queue for later delivery, and the original reception
4162 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4163 restricted configuration that never queues messages.
4164
4165
4166 .vitem &%-odi%&
4167 .oindex "&%-odi%&"
4168 This option is synonymous with &%-odf%&. It is provided for compatibility with
4169 Sendmail.
4170
4171 .vitem &%-odq%&
4172 .oindex "&%-odq%&"
4173 .cindex "non-immediate delivery"
4174 .cindex "delivery" "suppressing immediate"
4175 .cindex "queueing incoming messages"
4176 This option applies to all modes in which Exim accepts incoming messages,
4177 including the listening daemon. It specifies that the accepting process should
4178 not automatically start a delivery process for each message received. Messages
4179 are placed in the queue, and remain there until a subsequent queue runner
4180 process encounters them. There are several configuration options (such as
4181 &%queue_only%&) that can be used to queue incoming messages under certain
4182 conditions. This option overrides all of them and also &%-odqs%&. It always
4183 forces queueing.
4184
4185 .vitem &%-odqs%&
4186 .oindex "&%-odqs%&"
4187 .cindex "SMTP" "delaying delivery"
4188 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4189 However, like &%-odb%& and &%-odi%&, this option has no effect if
4190 &%queue_only_override%& is false and one of the queueing options in the
4191 configuration file is in effect.
4192
4193 When &%-odqs%& does operate, a delivery process is started for each incoming
4194 message, in the background by default, but in the foreground if &%-odi%& is
4195 also present. The recipient addresses are routed, and local deliveries are done
4196 in the normal way. However, if any SMTP deliveries are required, they are not
4197 done at this time, so the message remains in the queue until a subsequent queue
4198 runner process encounters it. Because routing was done, Exim knows which
4199 messages are waiting for which hosts, and so a number of messages for the same
4200 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4201 configuration option has the same effect for specific domains. See also the
4202 &%-qq%& option.
4203
4204 .vitem &%-oee%&
4205 .oindex "&%-oee%&"
4206 .cindex "error" "reporting"
4207 If an error is detected while a non-SMTP message is being received (for
4208 example, a malformed address), the error is reported to the sender in a mail
4209 message.
4210
4211 .cindex "return code" "for &%-oee%&"
4212 Provided
4213 this error message is successfully sent, the Exim receiving process
4214 exits with a return code of zero. If not, the return code is 2 if the problem
4215 is that the original message has no recipients, or 1 for any other error.
4216 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4217
4218 .vitem &%-oem%&
4219 .oindex "&%-oem%&"
4220 .cindex "error" "reporting"
4221 .cindex "return code" "for &%-oem%&"
4222 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4223 return code, whether or not the error message was successfully sent.
4224 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4225
4226 .vitem &%-oep%&
4227 .oindex "&%-oep%&"
4228 .cindex "error" "reporting"
4229 If an error is detected while a non-SMTP message is being received, the
4230 error is reported by writing a message to the standard error file (stderr).
4231 .cindex "return code" "for &%-oep%&"
4232 The return code is 1 for all errors.
4233
4234 .vitem &%-oeq%&
4235 .oindex "&%-oeq%&"
4236 .cindex "error" "reporting"
4237 This option is supported for compatibility with Sendmail, but has the same
4238 effect as &%-oep%&.
4239
4240 .vitem &%-oew%&
4241 .oindex "&%-oew%&"
4242 .cindex "error" "reporting"
4243 This option is supported for compatibility with Sendmail, but has the same
4244 effect as &%-oem%&.
4245
4246 .vitem &%-oi%&
4247 .oindex "&%-oi%&"
4248 .cindex "dot" "in incoming non-SMTP message"
4249 This option, which has the same effect as &%-i%&, specifies that a dot on a
4250 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4251 single dot does terminate, though Exim does no special processing for other
4252 lines that start with a dot. This option is set by default if Exim is called as
4253 &'rmail'&. See also &%-ti%&.
4254
4255 .vitem &%-oitrue%&
4256 .oindex "&%-oitrue%&"
4257 This option is treated as synonymous with &%-oi%&.
4258
4259 .vitem &%-oMa%&&~<&'host&~address'&>
4260 .oindex "&%-oMa%&"
4261 .cindex "sender" "host address, specifying for local message"
4262 A number of options starting with &%-oM%& can be used to set values associated
4263 with remote hosts on locally-submitted messages (that is, messages not received
4264 over TCP/IP). These options can be used by any caller in conjunction with the
4265 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4266 other circumstances, they are ignored unless the caller is trusted.
4267
4268 The &%-oMa%& option sets the sender host address. This may include a port
4269 number at the end, after a full stop (period). For example:
4270 .code
4271 exim -bs -oMa 10.9.8.7.1234
4272 .endd
4273 An alternative syntax is to enclose the IP address in square brackets,
4274 followed by a colon and the port number:
4275 .code
4276 exim -bs -oMa [10.9.8.7]:1234
4277 .endd
4278 The IP address is placed in the &$sender_host_address$& variable, and the
4279 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4280 are present on the command line, the sender host IP address is taken from
4281 whichever one is last.
4282
4283 .vitem &%-oMaa%&&~<&'name'&>
4284 .oindex "&%-oMaa%&"
4285 .cindex "authentication" "name, specifying for local message"
4286 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4287 option sets the value of &$sender_host_authenticated$& (the authenticator
4288 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4289 This option can be used with &%-bh%& and &%-bs%& to set up an
4290 authenticated SMTP session without actually using the SMTP AUTH command.
4291
4292 .vitem &%-oMai%&&~<&'string'&>
4293 .oindex "&%-oMai%&"
4294 .cindex "authentication" "id, specifying for local message"
4295 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4296 option sets the value of &$authenticated_id$& (the id that was authenticated).
4297 This overrides the default value (the caller's login id, except with &%-bh%&,
4298 where there is no default) for messages from local sources. See chapter
4299 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4300
4301 .vitem &%-oMas%&&~<&'address'&>
4302 .oindex "&%-oMas%&"
4303 .cindex "authentication" "sender, specifying for local message"
4304 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4305 option sets the authenticated sender value in &$authenticated_sender$&. It
4306 overrides the sender address that is created from the caller's login id for
4307 messages from local sources, except when &%-bh%& is used, when there is no
4308 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4309 specified on a MAIL command overrides this value. See chapter
4310 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4311
4312 .vitem &%-oMi%&&~<&'interface&~address'&>
4313 .oindex "&%-oMi%&"
4314 .cindex "interface" "address, specifying for local message"
4315 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4316 option sets the IP interface address value. A port number may be included,
4317 using the same syntax as for &%-oMa%&. The interface address is placed in
4318 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4319
4320 .vitem &%-oMm%&&~<&'message&~reference'&>
4321 .oindex "&%-oMm%&"
4322 .cindex "message reference" "message reference, specifying for local message"
4323 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4324 option sets the message reference, e.g. message-id, and is logged during
4325 delivery. This is useful when some kind of audit trail is required to tie
4326 messages together. The format of the message reference is checked and will
4327 abort if the format is invalid. The option will only be accepted if exim is
4328 running in trusted mode, not as any regular user.
4329
4330 The best example of a message reference is when Exim sends a bounce message.
4331 The message reference is the message-id of the original message for which Exim
4332 is sending the bounce.
4333
4334 .vitem &%-oMr%&&~<&'protocol&~name'&>
4335 .oindex "&%-oMr%&"
4336 .cindex "protocol, specifying for local message"
4337 .vindex "&$received_protocol$&"
4338 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4339 option sets the received protocol value that is stored in
4340 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4341 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4342 SMTP protocol names (see the description of &$received_protocol$& in section
4343 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4344 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4345 be set by &%-oMr%&. Repeated use of this option is not supported.
4346
4347 .vitem &%-oMs%&&~<&'host&~name'&>
4348 .oindex "&%-oMs%&"
4349 .cindex "sender" "host name, specifying for local message"
4350 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4351 option sets the sender host name in &$sender_host_name$&. When this option is
4352 present, Exim does not attempt to look up a host name from an IP address; it
4353 uses the name it is given.
4354
4355 .vitem &%-oMt%&&~<&'ident&~string'&>
4356 .oindex "&%-oMt%&"
4357 .cindex "sender" "ident string, specifying for local message"
4358 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4359 option sets the sender ident value in &$sender_ident$&. The default setting for
4360 local callers is the login id of the calling process, except when &%-bh%& is
4361 used, when there is no default.
4362
4363 .vitem &%-om%&
4364 .oindex "&%-om%&"
4365 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4366 In Sendmail, this option means &"me too"&, indicating that the sender of a
4367 message should receive a copy of the message if the sender appears in an alias
4368 expansion. Exim always does this, so the option does nothing.
4369
4370 .vitem &%-oo%&
4371 .oindex "&%-oo%&"
4372 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4373 This option is ignored. In Sendmail it specifies &"old style headers"&,
4374 whatever that means.
4375
4376 .vitem &%-oP%&&~<&'path'&>
4377 .oindex "&%-oP%&"
4378 .cindex "pid (process id)" "of daemon"
4379 .cindex "daemon" "process id (pid)"
4380 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4381 value. The option specifies the file to which the process id of the daemon is
4382 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4383 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4384 because in those cases, the normal pid file is not used.
4385
4386 .new
4387 .vitem &%-oPX%&
4388 .oindex "&%-oPX%&"
4389 .cindex "pid (process id)" "of daemon"
4390 .cindex "daemon" "process id (pid)"
4391 This option is not intended for general use.
4392 The daemon uses it when terminating due to a SIGTEM, possibly in
4393 combination with &%-oP%&&~<&'path'&>.
4394 It causes the pid file to be removed.
4395 .wen
4396
4397 .vitem &%-or%&&~<&'time'&>
4398 .oindex "&%-or%&"
4399 .cindex "timeout" "for non-SMTP input"
4400 This option sets a timeout value for incoming non-SMTP messages. If it is not
4401 set, Exim will wait forever for the standard input. The value can also be set
4402 by the &%receive_timeout%& option. The format used for specifying times is
4403 described in section &<<SECTtimeformat>>&.
4404
4405 .vitem &%-os%&&~<&'time'&>
4406 .oindex "&%-os%&"
4407 .cindex "timeout" "for SMTP input"
4408 .cindex "SMTP" "input timeout"
4409 This option sets a timeout value for incoming SMTP messages. The timeout
4410 applies to each SMTP command and block of data. The value can also be set by
4411 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4412 for specifying times is described in section &<<SECTtimeformat>>&.
4413
4414 .vitem &%-ov%&
4415 .oindex "&%-ov%&"
4416 This option has exactly the same effect as &%-v%&.
4417
4418 .vitem &%-oX%&&~<&'number&~or&~string'&>
4419 .oindex "&%-oX%&"
4420 .cindex "TCP/IP" "setting listening ports"
4421 .cindex "TCP/IP" "setting listening interfaces"
4422 .cindex "port" "receiving TCP/IP"
4423 This option is relevant only when the &%-bd%& (start listening daemon) option
4424 is also given. It controls which ports and interfaces the daemon uses. Details
4425 of the syntax, and how it interacts with configuration file options, are given
4426 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4427 file is written unless &%-oP%& is also present to specify a pid filename.
4428
4429 .vitem &%-pd%&
4430 .oindex "&%-pd%&"
4431 .cindex "Perl" "starting the interpreter"
4432 This option applies when an embedded Perl interpreter is linked with Exim (see
4433 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4434 option, forcing the starting of the interpreter to be delayed until it is
4435 needed.
4436
4437 .vitem &%-ps%&
4438 .oindex "&%-ps%&"
4439 .cindex "Perl" "starting the interpreter"
4440 This option applies when an embedded Perl interpreter is linked with Exim (see
4441 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4442 option, forcing the starting of the interpreter to occur as soon as Exim is
4443 started.
4444
4445 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4446 .oindex "&%-p%&"
4447 For compatibility with Sendmail, this option is equivalent to
4448 .display
4449 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4450 .endd
4451 It sets the incoming protocol and host name (for trusted callers). The
4452 host name and its colon can be omitted when only the protocol is to be set.
4453 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4454 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4455 or &`s`& using this option (but that does not seem a real limitation).
4456 Repeated use of this option is not supported.
4457
4458 .vitem &%-q%&
4459 .oindex "&%-q%&"
4460 .cindex "queue runner" "starting manually"
4461 This option is normally restricted to admin users. However, there is a
4462 configuration option called &%prod_requires_admin%& which can be set false to
4463 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4464 and &%-S%& options).
4465
4466 .cindex "queue runner" "description of operation"
4467 If other commandline options do not specify an action,
4468 the &%-q%& option starts one queue runner process. This scans the queue of
4469 waiting messages, and runs a delivery process for each one in turn. It waits
4470 for each delivery process to finish before starting the next one. A delivery
4471 process may not actually do any deliveries if the retry times for the addresses
4472 have not been reached. Use &%-qf%& (see below) if you want to override this.
4473
4474 If
4475 .cindex "SMTP" "passed connection"
4476 .cindex "SMTP" "multiple deliveries"
4477 .cindex "multiple SMTP deliveries"
4478 the delivery process spawns other processes to deliver other messages down
4479 passed SMTP connections, the queue runner waits for these to finish before
4480 proceeding.
4481
4482 When all the queued messages have been considered, the original queue runner
4483 process terminates. In other words, a single pass is made over the waiting
4484 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4485 this to be repeated periodically.
4486
4487 Exim processes the waiting messages in an unpredictable order. It isn't very
4488 random, but it is likely to be different each time, which is all that matters.
4489 If one particular message screws up a remote MTA, other messages to the same
4490 MTA have a chance of getting through if they get tried first.
4491
4492 It is possible to cause the messages to be processed in lexical message id
4493 order, which is essentially the order in which they arrived, by setting the
4494 &%queue_run_in_order%& option, but this is not recommended for normal use.
4495
4496 .vitem &%-q%&<&'qflags'&>
4497 The &%-q%& option may be followed by one or more flag letters that change its
4498 behaviour. They are all optional, but if more than one is present, they must
4499 appear in the correct order. Each flag is described in a separate item below.
4500
4501 .vitem &%-qq...%&
4502 .oindex "&%-qq%&"
4503 .cindex "queue" "double scanning"
4504 .cindex "queue" "routing"
4505 .cindex "routing" "whole queue before delivery"
4506 An option starting with &%-qq%& requests a two-stage queue run. In the first
4507 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4508 every domain. Addresses are routed, local deliveries happen, but no remote
4509 transports are run.
4510
4511 .cindex "hints database" "remembering routing"
4512 The hints database that remembers which messages are waiting for specific hosts
4513 is updated, as if delivery to those hosts had been deferred. After this is
4514 complete, a second, normal queue scan happens, with routing and delivery taking
4515 place as normal. Messages that are routed to the same host should mostly be
4516 delivered down a single SMTP
4517 .cindex "SMTP" "passed connection"
4518 .cindex "SMTP" "multiple deliveries"
4519 .cindex "multiple SMTP deliveries"
4520 connection because of the hints that were set up during the first queue scan.
4521 This option may be useful for hosts that are connected to the Internet
4522 intermittently.
4523
4524 .vitem &%-q[q]i...%&
4525 .oindex "&%-qi%&"
4526 .cindex "queue" "initial delivery"
4527 If the &'i'& flag is present, the queue runner runs delivery processes only for
4528 those messages that haven't previously been tried. (&'i'& stands for &"initial
4529 delivery"&.) This can be helpful if you are putting messages in the queue using
4530 &%-odq%& and want a queue runner just to process the new messages.
4531
4532 .vitem &%-q[q][i]f...%&
4533 .oindex "&%-qf%&"
4534 .cindex "queue" "forcing delivery"
4535 .cindex "delivery" "forcing in queue run"
4536 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4537 message, whereas without &'f'& only those non-frozen addresses that have passed
4538 their retry times are tried.
4539
4540 .vitem &%-q[q][i]ff...%&
4541 .oindex "&%-qff%&"
4542 .cindex "frozen messages" "forcing delivery"
4543 If &'ff'& is present, a delivery attempt is forced for every message, whether
4544 frozen or not.
4545
4546 .vitem &%-q[q][i][f[f]]l%&
4547 .oindex "&%-ql%&"
4548 .cindex "queue" "local deliveries only"
4549 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4550 be done. If a message requires any remote deliveries, it remains in the queue
4551 for later delivery.
4552
4553 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4554 .oindex "&%-qG%&"
4555 .cindex queue named
4556 .cindex "named queues"
4557 .cindex "queue" "delivering specific messages"
4558 If the &'G'& flag and a name is present, the queue runner operates on the
4559 queue with the given name rather than the default queue.
4560 The name should not contain a &'/'& character.
4561 For a periodic queue run (see below)
4562 append to the name a slash and a time value.
4563
4564 If other commandline options specify an action, a &'-qG<name>'& option
4565 will specify a queue to operate on.
4566 For example:
4567 .code
4568 exim -bp -qGquarantine
4569 mailq -qGquarantine
4570 exim -qGoffpeak -Rf @special.domain.example
4571 .endd
4572
4573 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4574 When scanning the queue, Exim can be made to skip over messages whose ids are
4575 lexically less than a given value by following the &%-q%& option with a
4576 starting message id. For example:
4577 .code
4578 exim -q 0t5C6f-0000c8-00
4579 .endd
4580 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4581 second message id is given, messages whose ids are lexically greater than it
4582 are also skipped. If the same id is given twice, for example,
4583 .code
4584 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4585 .endd
4586 just one delivery process is started, for that message. This differs from
4587 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4588 that it counts as a delivery from a queue run. Note that the selection
4589 mechanism does not affect the order in which the messages are scanned. There
4590 are also other ways of selecting specific sets of messages for delivery in a
4591 queue run &-- see &%-R%& and &%-S%&.
4592
4593 .vitem &%-q%&<&'qflags'&><&'time'&>
4594 .cindex "queue runner" "starting periodically"
4595 .cindex "periodic queue running"
4596 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4597 starting a queue runner process at intervals specified by the given time value
4598 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4599 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4600 single daemon process handles both functions. A common way of starting up a
4601 combined daemon at system boot time is to use a command such as
4602 .code
4603 /usr/exim/bin/exim -bd -q30m
4604 .endd
4605 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4606 process every 30 minutes.
4607
4608 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4609 pid file is written unless one is explicitly requested by the &%-oP%& option.
4610
4611 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4612 .oindex "&%-qR%&"
4613 This option is synonymous with &%-R%&. It is provided for Sendmail
4614 compatibility.
4615
4616 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4617 .oindex "&%-qS%&"
4618 This option is synonymous with &%-S%&.
4619
4620 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4621 .oindex "&%-R%&"
4622 .cindex "queue runner" "for specific recipients"
4623 .cindex "delivery" "to given domain"
4624 .cindex "domain" "delivery to"
4625 The <&'rsflags'&> may be empty, in which case the white space before the string
4626 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4627 which are the possible values for <&'rsflags'&>. White space is required if
4628 <&'rsflags'&> is not empty.
4629
4630 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4631 perform a single queue run, except that, when scanning the messages on the
4632 queue, Exim processes only those that have at least one undelivered recipient
4633 address containing the given string, which is checked in a case-independent
4634 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4635 regular expression; otherwise it is a literal string.
4636
4637 If you want to do periodic queue runs for messages with specific recipients,
4638 you can combine &%-R%& with &%-q%& and a time value. For example:
4639 .code
4640 exim -q25m -R @special.domain.example
4641 .endd
4642 This example does a queue run for messages with recipients in the given domain
4643 every 25 minutes. Any additional flags that are specified with &%-q%& are
4644 applied to each queue run.
4645
4646 Once a message is selected for delivery by this mechanism, all its addresses
4647 are processed. For the first selected message, Exim overrides any retry
4648 information and forces a delivery attempt for each undelivered address. This
4649 means that if delivery of any address in the first message is successful, any
4650 existing retry information is deleted, and so delivery attempts for that
4651 address in subsequently selected messages (which are processed without forcing)
4652 will run. However, if delivery of any address does not succeed, the retry
4653 information is updated, and in subsequently selected messages, the failing
4654 address will be skipped.
4655
4656 .cindex "frozen messages" "forcing delivery"
4657 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4658 all selected messages, not just the first; frozen messages are included when
4659 &'ff'& is present.
4660
4661 The &%-R%& option makes it straightforward to initiate delivery of all messages
4662 to a given domain after a host has been down for some time. When the SMTP
4663 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4664 effect is to run Exim with the &%-R%& option, but it can be configured to run
4665 an arbitrary command instead.
4666
4667 .vitem &%-r%&
4668 .oindex "&%-r%&"
4669 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4670
4671 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4672 .oindex "&%-S%&"
4673 .cindex "delivery" "from given sender"
4674 .cindex "queue runner" "for specific senders"
4675 This option acts like &%-R%& except that it checks the string against each
4676 message's sender instead of against the recipients. If &%-R%& is also set, both
4677 conditions must be met for a message to be selected. If either of the options
4678 has &'f'& or &'ff'& in its flags, the associated action is taken.
4679
4680 .vitem &%-Tqt%&&~<&'times'&>
4681 .oindex "&%-Tqt%&"
4682 This is an option that is exclusively for use by the Exim testing suite. It is not
4683 recognized when Exim is run normally. It allows for the setting up of explicit
4684 &"queue times"& so that various warning/retry features can be tested.
4685
4686 .vitem &%-t%&
4687 .oindex "&%-t%&"
4688 .cindex "recipient" "extracting from header lines"
4689 .cindex "&'Bcc:'& header line"
4690 .cindex "&'Cc:'& header line"
4691 .cindex "&'To:'& header line"
4692 When Exim is receiving a locally-generated, non-SMTP message on its standard
4693 input, the &%-t%& option causes the recipients of the message to be obtained
4694 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4695 from the command arguments. The addresses are extracted before any rewriting
4696 takes place and the &'Bcc:'& header line, if present, is then removed.
4697
4698 .cindex "Sendmail compatibility" "&%-t%& option"
4699 If the command has any arguments, they specify addresses to which the message
4700 is &'not'& to be delivered. That is, the argument addresses are removed from
4701 the recipients list obtained from the headers. This is compatible with Smail 3
4702 and in accordance with the documented behaviour of several versions of
4703 Sendmail, as described in man pages on a number of operating systems (e.g.
4704 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4705 argument addresses to those obtained from the headers, and the O'Reilly
4706 Sendmail book documents it that way. Exim can be made to add argument addresses
4707 instead of subtracting them by setting the option
4708 &%extract_addresses_remove_arguments%& false.
4709
4710 .cindex "&%Resent-%& header lines" "with &%-t%&"
4711 If there are any &%Resent-%& header lines in the message, Exim extracts
4712 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4713 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4714 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4715 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4716
4717 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4718 message is resent several times). The RFC also specifies that they should be
4719 added at the front of the message, and separated by &'Received:'& lines. It is
4720 not at all clear how &%-t%& should operate in the present of multiple sets,
4721 nor indeed exactly what constitutes a &"set"&.
4722 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4723 are often added at the end of the header, and if a message is resent more than
4724 once, it is common for the original set of &%Resent-%& headers to be renamed as
4725 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4726
4727 .vitem &%-ti%&
4728 .oindex "&%-ti%&"
4729 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4730 compatibility with Sendmail.
4731
4732 .vitem &%-tls-on-connect%&
4733 .oindex "&%-tls-on-connect%&"
4734 .cindex "TLS" "use without STARTTLS"
4735 .cindex "TLS" "automatic start"
4736 This option is available when Exim is compiled with TLS support. It forces all
4737 incoming SMTP connections to behave as if the incoming port is listed in the
4738 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4739 &<<CHAPTLS>>& for further details.
4740
4741
4742 .vitem &%-U%&
4743 .oindex "&%-U%&"
4744 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4745 Sendmail uses this option for &"initial message submission"&, and its
4746 documentation states that in future releases, it may complain about
4747 syntactically invalid messages rather than fixing them when this flag is not
4748 set. Exim ignores this option.
4749
4750 .vitem &%-v%&
4751 .oindex "&%-v%&"
4752 This option causes Exim to write information to the standard error stream,
4753 describing what it is doing. In particular, it shows the log lines for
4754 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4755 dialogue is shown. Some of the log lines shown may not actually be written to
4756 the log if the setting of &%log_selector%& discards them. Any relevant
4757 selectors are shown with each log line. If none are shown, the logging is
4758 unconditional.
4759
4760 .vitem &%-x%&
4761 .oindex "&%-x%&"
4762 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4763 National Language Support extended characters in the body of the mail item"&).
4764 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4765 this option.
4766
4767 .vitem &%-X%&&~<&'logfile'&>
4768 .oindex "&%-X%&"
4769 This option is interpreted by Sendmail to cause debug information to be sent
4770 to the named file.  It is ignored by Exim.
4771
4772 .vitem &%-z%&&~<&'log-line'&>
4773 .oindex "&%-z%&"
4774 This option writes its argument to Exim's logfile.
4775 Use is restricted to administrators; the intent is for operational notes.
4776 Quotes should be used to maintain a multi-word item as a single argument,
4777 under most shells.
4778 .endlist
4779
4780 .ecindex IIDclo1
4781 .ecindex IIDclo2
4782
4783
4784 . ////////////////////////////////////////////////////////////////////////////
4785 . Insert a stylized DocBook comment here, to identify the end of the command
4786 . line options. This is for the benefit of the Perl script that automatically
4787 . creates a man page for the options.
4788 . ////////////////////////////////////////////////////////////////////////////
4789
4790 .literal xml
4791 <!-- === End of command line options === -->
4792 .literal off
4793
4794
4795
4796
4797
4798 . ////////////////////////////////////////////////////////////////////////////
4799 . ////////////////////////////////////////////////////////////////////////////
4800
4801
4802 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4803          "The runtime configuration file"
4804
4805 .cindex "runtime configuration"
4806 .cindex "configuration file" "general description"
4807 .cindex "CONFIGURE_FILE"
4808 .cindex "configuration file" "errors in"
4809 .cindex "error" "in configuration file"
4810 .cindex "return code" "for bad configuration"
4811 Exim uses a single runtime configuration file that is read whenever an Exim
4812 binary is executed. Note that in normal operation, this happens frequently,
4813 because Exim is designed to operate in a distributed manner, without central
4814 control.
4815
4816 If a syntax error is detected while reading the configuration file, Exim
4817 writes a message on the standard error, and exits with a non-zero return code.
4818 The message is also written to the panic log. &*Note*&: Only simple syntax
4819 errors can be detected at this time. The values of any expanded options are
4820 not checked until the expansion happens, even when the expansion does not
4821 actually alter the string.
4822
4823 The name of the configuration file is compiled into the binary for security
4824 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4825 most configurations, this specifies a single file. However, it is permitted to
4826 give a colon-separated list of filenames, in which case Exim uses the first
4827 existing file in the list.
4828
4829 .cindex "EXIM_USER"
4830 .cindex "EXIM_GROUP"
4831 .cindex "CONFIGURE_OWNER"
4832 .cindex "CONFIGURE_GROUP"
4833 .cindex "configuration file" "ownership"
4834 .cindex "ownership" "configuration file"
4835 The runtime configuration file must be owned by root or by the user that is
4836 specified at compile time by the CONFIGURE_OWNER option (if set). The
4837 configuration file must not be world-writeable, or group-writeable unless its
4838 group is the root group or the one specified at compile time by the
4839 CONFIGURE_GROUP option.
4840
4841 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4842 to root, anybody who is able to edit the runtime configuration file has an
4843 easy way to run commands as root. If you specify a user or group in the
4844 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4845 who are members of that group will trivially be able to obtain root privileges.
4846
4847 Up to Exim version 4.72, the runtime configuration file was also permitted to
4848 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4849 since it offered a simple privilege escalation for any attacker who managed to
4850 compromise the Exim user account.
4851
4852 A default configuration file, which will work correctly in simple situations,
4853 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4854 defines just one filename, the installation process copies the default
4855 configuration to a new file of that name if it did not previously exist. If
4856 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4857 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4858 configuration.
4859
4860
4861
4862 .section "Using a different configuration file" "SECID40"
4863 .cindex "configuration file" "alternate"
4864 A one-off alternate configuration can be specified by the &%-C%& command line
4865 option, which may specify a single file or a list of files. However, when
4866 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4867 unless the argument for &%-C%& is identical to the built-in value from
4868 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4869 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4870 is useful mainly for checking the syntax of configuration files before
4871 installing them. No owner or group checks are done on a configuration file
4872 specified by &%-C%&, if root privilege has been dropped.
4873
4874 Even the Exim user is not trusted to specify an arbitrary configuration file
4875 with the &%-C%& option to be used with root privileges, unless that file is
4876 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4877 testing a configuration using &%-C%& right through message reception and
4878 delivery, even if the caller is root. The reception works, but by that time,
4879 Exim is running as the Exim user, so when it re-execs to regain privilege for
4880 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4881 can test reception and delivery using two separate commands (one to put a
4882 message in the queue, using &%-odq%&, and another to do the delivery, using
4883 &%-M%&).
4884
4885 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4886 prefix string with which any file named in a &%-C%& command line option must
4887 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4888 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4889 filename can be used with &%-C%&.
4890
4891 One-off changes to a configuration can be specified by the &%-D%& command line
4892 option, which defines and overrides values for macros used inside the
4893 configuration file. However, like &%-C%&, the use of this option by a
4894 non-privileged user causes Exim to discard its root privilege.
4895 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4896 completely disabled, and its use causes an immediate error exit.
4897
4898 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4899 to declare certain macro names trusted, such that root privilege will not
4900 necessarily be discarded.
4901 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4902 considered safe and, if &%-D%& only supplies macros from this list, and the
4903 values are acceptable, then Exim will not give up root privilege if the caller
4904 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4905 transition mechanism and is expected to be removed in the future.  Acceptable
4906 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4907
4908 Some sites may wish to use the same Exim binary on different machines that
4909 share a file system, but to use different configuration files on each machine.
4910 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4911 looks for a file whose name is the configuration filename followed by a dot
4912 and the machine's node name, as obtained from the &[uname()]& function. If this
4913 file does not exist, the standard name is tried. This processing occurs for
4914 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4915
4916 In some esoteric situations different versions of Exim may be run under
4917 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4918 help with this. See the comments in &_src/EDITME_& for details.
4919
4920
4921
4922 .section "Configuration file format" "SECTconffilfor"
4923 .cindex "configuration file" "format of"
4924 .cindex "format" "configuration file"
4925 Exim's configuration file is divided into a number of different parts. General
4926 option settings must always appear at the start of the file. The other parts
4927 are all optional, and may appear in any order. Each part other than the first
4928 is introduced by the word &"begin"& followed by at least one literal
4929 space, and the name of the part. The optional parts are:
4930
4931 .ilist
4932 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4933 &<<CHAPACL>>&).
4934 .next
4935 .cindex "AUTH" "configuration"
4936 &'authenticators'&: Configuration settings for the authenticator drivers. These
4937 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4938 .next
4939 &'routers'&: Configuration settings for the router drivers. Routers process
4940 addresses and determine how the message is to be delivered (see chapters
4941 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4942 .next
4943 &'transports'&: Configuration settings for the transport drivers. Transports
4944 define mechanisms for copying messages to destinations (see chapters
4945 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4946 .next
4947 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4948 If there is no retry section, or if it is empty (that is, no retry rules are
4949 defined), Exim will not retry deliveries. In this situation, temporary errors
4950 are treated the same as permanent errors. Retry rules are discussed in chapter
4951 &<<CHAPretry>>&.
4952 .next
4953 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4954 when new addresses are generated during delivery. Rewriting is discussed in
4955 chapter &<<CHAPrewrite>>&.
4956 .next
4957 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4958 want to use this feature, you must set
4959 .code
4960 LOCAL_SCAN_HAS_OPTIONS=yes
4961 .endd
4962 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4963 facility are given in chapter &<<CHAPlocalscan>>&.
4964 .endlist
4965
4966 .cindex "configuration file" "leading white space in"
4967 .cindex "configuration file" "trailing white space in"
4968 .cindex "white space" "in configuration file"
4969 Leading and trailing white space in configuration lines is always ignored.
4970
4971 Blank lines in the file, and lines starting with a # character (ignoring
4972 leading white space) are treated as comments and are ignored. &*Note*&: A
4973 # character other than at the beginning of a line is not treated specially,
4974 and does not introduce a comment.
4975
4976 Any non-comment line can be continued by ending it with a backslash. Note that
4977 the general rule for white space means that trailing white space after the
4978 backslash and leading white space at the start of continuation
4979 lines is ignored. Comment lines beginning with # (but not empty lines) may
4980 appear in the middle of a sequence of continuation lines.
4981
4982 A convenient way to create a configuration file is to start from the
4983 default, which is supplied in &_src/configure.default_&, and add, delete, or
4984 change settings as required.
4985
4986 The ACLs, retry rules, and rewriting rules have their own syntax which is
4987 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4988 respectively. The other parts of the configuration file have some syntactic
4989 items in common, and these are described below, from section &<<SECTcos>>&
4990 onwards. Before that, the inclusion, macro, and conditional facilities are
4991 described.
4992
4993
4994
4995 .section "File inclusions in the configuration file" "SECID41"
4996 .cindex "inclusions in configuration file"
4997 .cindex "configuration file" "including other files"
4998 .cindex "&`.include`& in configuration file"
4999 .cindex "&`.include_if_exists`& in configuration file"
5000 You can include other files inside Exim's runtime configuration file by
5001 using this syntax:
5002 .display
5003 &`.include`& <&'filename'&>
5004 &`.include_if_exists`& <&'filename'&>
5005 .endd
5006 on a line by itself. Double quotes round the filename are optional. If you use
5007 the first form, a configuration error occurs if the file does not exist; the
5008 second form does nothing for non-existent files.
5009 The first form allows a relative name. It is resolved relative to
5010 the directory of the including file. For the second form an absolute filename
5011 is required.
5012
5013 Includes may be nested to any depth, but remember that Exim reads its
5014 configuration file often, so it is a good idea to keep them to a minimum.
5015 If you change the contents of an included file, you must HUP the daemon,
5016 because an included file is read only when the configuration itself is read.
5017
5018 The processing of inclusions happens early, at a physical line level, so, like
5019 comment lines, an inclusion can be used in the middle of an option setting,
5020 for example:
5021 .code
5022 hosts_lookup = a.b.c \
5023                .include /some/file
5024 .endd
5025 Include processing happens after macro processing (see below). Its effect is to
5026 process the lines of the included file as if they occurred inline where the
5027 inclusion appears.
5028
5029
5030
5031 .section "Macros in the configuration file" "SECTmacrodefs"
5032 .cindex "macro" "description of"
5033 .cindex "configuration file" "macros"
5034 If a line in the main part of the configuration (that is, before the first
5035 &"begin"& line) begins with an upper case letter, it is taken as a macro
5036 definition, and must be of the form
5037 .display
5038 <&'name'&> = <&'rest of line'&>
5039 .endd
5040 The name must consist of letters, digits, and underscores, and need not all be
5041 in upper case, though that is recommended. The rest of the line, including any
5042 continuations, is the replacement text, and has leading and trailing white
5043 space removed. Quotes are not removed. The replacement text can never end with
5044 a backslash character, but this doesn't seem to be a serious limitation.
5045
5046 Macros may also be defined between router, transport, authenticator, or ACL
5047 definitions. They may not, however, be defined within an individual driver or
5048 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5049
5050 .section "Macro substitution" "SECID42"
5051 Once a macro is defined, all subsequent lines in the file (and any included
5052 files) are scanned for the macro name; if there are several macros, the line is
5053 scanned for each, in turn, in the order in which the macros are defined. The
5054 replacement text is not re-scanned for the current macro, though it is scanned
5055 for subsequently defined macros. For this reason, a macro name may not contain
5056 the name of a previously defined macro as a substring. You could, for example,
5057 define
5058 .display
5059 &`ABCD_XYZ = `&<&'something'&>
5060 &`ABCD = `&<&'something else'&>
5061 .endd
5062 but putting the definitions in the opposite order would provoke a configuration
5063 error. Macro expansion is applied to individual physical lines from the file,
5064 before checking for line continuation or file inclusion (see above). If a line
5065 consists solely of a macro name, and the expansion of the macro is empty, the
5066 line is ignored. A macro at the start of a line may turn the line into a
5067 comment line or a &`.include`& line.
5068
5069
5070 .section "Redefining macros" "SECID43"
5071 Once defined, the value of a macro can be redefined later in the configuration
5072 (or in an included file). Redefinition is specified by using &'=='& instead of
5073 &'='&. For example:
5074 .code
5075 MAC =  initial value
5076 ...
5077 MAC == updated value
5078 .endd
5079 Redefinition does not alter the order in which the macros are applied to the
5080 subsequent lines of the configuration file. It is still the same order in which
5081 the macros were originally defined. All that changes is the macro's value.
5082 Redefinition makes it possible to accumulate values. For example:
5083 .code
5084 MAC =  initial value
5085 ...
5086 MAC == MAC and something added
5087 .endd
5088 This can be helpful in situations where the configuration file is built
5089 from a number of other files.
5090
5091 .section "Overriding macro values" "SECID44"
5092 The values set for macros in the configuration file can be overridden by the
5093 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5094 used, unless called by root or the Exim user. A definition on the command line
5095 using the &%-D%& option causes all definitions and redefinitions within the
5096 file to be ignored.
5097
5098
5099
5100 .section "Example of macro usage" "SECID45"
5101 As an example of macro usage, consider a configuration where aliases are looked
5102 up in a MySQL database. It helps to keep the file less cluttered if long
5103 strings such as SQL statements are defined separately as macros, for example:
5104 .code
5105 ALIAS_QUERY = select mailbox from user where \
5106               login='${quote_mysql:$local_part}';
5107 .endd
5108 This can then be used in a &(redirect)& router setting like this:
5109 .code
5110 data = ${lookup mysql{ALIAS_QUERY}}
5111 .endd
5112 In earlier versions of Exim macros were sometimes used for domain, host, or
5113 address lists. In Exim 4 these are handled better by named lists &-- see
5114 section &<<SECTnamedlists>>&.
5115
5116
5117 .section "Builtin macros" "SECTbuiltinmacros"
5118 Exim defines some macros depending on facilities available, which may
5119 differ due to build-time definitions and from one release to another.
5120 All of these macros start with an underscore.
5121 They can be used to conditionally include parts of a configuration
5122 (see below).
5123
5124 The following classes of macros are defined:
5125 .display
5126 &` _HAVE_*                    `&  build-time defines
5127 &` _DRIVER_ROUTER_*           `&  router drivers
5128 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5129 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5130 &` _LOG_*                     `&  log_selector values
5131 &` _OPT_MAIN_*                `&  main config options
5132 &` _OPT_ROUTERS_*             `&  generic router options
5133 &` _OPT_TRANSPORTS_*          `&  generic transport options
5134 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5135 &` _OPT_ROUTER_*_*            `&  private router options
5136 &` _OPT_TRANSPORT_*_*         `&  private transport options
5137 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5138 .endd
5139
5140 Use an &"exim -bP macros"& command to get the list of macros.
5141
5142
5143 .section "Conditional skips in the configuration file" "SECID46"
5144 .cindex "configuration file" "conditional skips"
5145 .cindex "&`.ifdef`&"
5146 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5147 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5148 portions of the configuration file. The processing happens whenever the file is
5149 read (that is, when an Exim binary starts to run).
5150
5151 The implementation is very simple. Instances of the first four directives must
5152 be followed by text that includes the names of one or macros. The condition
5153 that is tested is whether or not any macro substitution has taken place in the
5154 line. Thus:
5155 .code
5156 .ifdef AAA
5157 message_size_limit = 50M
5158 .else
5159 message_size_limit = 100M
5160 .endif
5161 .endd
5162 sets a message size limit of 50M if the macro &`AAA`& is defined
5163 (or &`A`& or &`AA`&), and 100M
5164 otherwise. If there is more than one macro named on the line, the condition
5165 is true if any of them are defined. That is, it is an &"or"& condition. To
5166 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5167
5168 Although you can use a macro expansion to generate one of these directives,
5169 it is not very useful, because the condition &"there was a macro substitution
5170 in this line"& will always be true.
5171
5172 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5173 to clarify complicated nestings.
5174
5175
5176
5177 .section "Common option syntax" "SECTcos"
5178 .cindex "common option syntax"
5179 .cindex "syntax of common options"
5180 .cindex "configuration file" "common option syntax"
5181 For the main set of options, driver options, and &[local_scan()]& options,
5182 each setting is on a line by itself, and starts with a name consisting of
5183 lower-case letters and underscores. Many options require a data value, and in
5184 these cases the name must be followed by an equals sign (with optional white
5185 space) and then the value. For example:
5186 .code
5187 qualify_domain = mydomain.example.com
5188 .endd
5189 .cindex "hiding configuration option values"
5190 .cindex "configuration options" "hiding value of"
5191 .cindex "options" "hiding value of"
5192 Some option settings may contain sensitive data, for example, passwords for
5193 accessing databases. To stop non-admin users from using the &%-bP%& command
5194 line option to read these values, you can precede the option settings with the
5195 word &"hide"&. For example:
5196 .code
5197 hide mysql_servers = localhost/users/admin/secret-password
5198 .endd
5199 For non-admin users, such options are displayed like this:
5200 .code
5201 mysql_servers = <value not displayable>
5202 .endd
5203 If &"hide"& is used on a driver option, it hides the value of that option on
5204 all instances of the same driver.
5205
5206 The following sections describe the syntax used for the different data types
5207 that are found in option settings.
5208
5209
5210 .section "Boolean options" "SECID47"
5211 .cindex "format" "boolean"
5212 .cindex "boolean configuration values"
5213 .oindex "&%no_%&&'xxx'&"
5214 .oindex "&%not_%&&'xxx'&"
5215 Options whose type is given as boolean are on/off switches. There are two
5216 different ways of specifying such options: with and without a data value. If
5217 the option name is specified on its own without data, the switch is turned on;
5218 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5219 boolean options may be followed by an equals sign and one of the words
5220 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5221 the following two settings have exactly the same effect:
5222 .code
5223 queue_only
5224 queue_only = true
5225 .endd
5226 The following two lines also have the same (opposite) effect:
5227 .code
5228 no_queue_only
5229 queue_only = false
5230 .endd
5231 You can use whichever syntax you prefer.
5232
5233
5234
5235
5236 .section "Integer values" "SECID48"
5237 .cindex "integer configuration values"
5238 .cindex "format" "integer"
5239 If an option's type is given as &"integer"&, the value can be given in decimal,
5240 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5241 number is assumed. Otherwise, it is treated as an octal number unless it starts
5242 with the characters &"0x"&, in which case the remainder is interpreted as a
5243 hexadecimal number.
5244
5245 If an integer value is followed by the letter K, it is multiplied by 1024; if
5246 it is followed by the letter M, it is multiplied by 1024x1024;
5247 if by the letter G, 1024x1024x1024.
5248 When the values
5249 of integer option settings are output, values which are an exact multiple of
5250 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5251 and M. The printing style is independent of the actual input format that was
5252 used.
5253
5254
5255 .section "Octal integer values" "SECID49"
5256 .cindex "integer format"
5257 .cindex "format" "octal integer"
5258 If an option's type is given as &"octal integer"&, its value is always
5259 interpreted as an octal number, whether or not it starts with the digit zero.
5260 Such options are always output in octal.
5261
5262
5263 .section "Fixed point numbers" "SECID50"
5264 .cindex "fixed point configuration values"
5265 .cindex "format" "fixed point"
5266 If an option's type is given as &"fixed-point"&, its value must be a decimal
5267 integer, optionally followed by a decimal point and up to three further digits.
5268
5269
5270
5271 .section "Time intervals" "SECTtimeformat"
5272 .cindex "time interval" "specifying in configuration"
5273 .cindex "format" "time interval"
5274 A time interval is specified as a sequence of numbers, each followed by one of
5275 the following letters, with no intervening white space:
5276
5277 .table2 30pt
5278 .irow &%s%& seconds
5279 .irow &%m%& minutes
5280 .irow &%h%& hours
5281 .irow &%d%& days
5282 .irow &%w%& weeks
5283 .endtable
5284
5285 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5286 intervals are output in the same format. Exim does not restrict the values; it
5287 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5288
5289
5290
5291 .section "String values" "SECTstrings"
5292 .cindex "string" "format of configuration values"
5293 .cindex "format" "string"
5294 If an option's type is specified as &"string"&, the value can be specified with
5295 or without double-quotes. If it does not start with a double-quote, the value
5296 consists of the remainder of the line plus any continuation lines, starting at
5297 the first character after any leading white space, with trailing white space
5298 removed, and with no interpretation of the characters in the string. Because
5299 Exim removes comment lines (those beginning with #) at an early stage, they can
5300 appear in the middle of a multi-line string. The following two settings are
5301 therefore equivalent:
5302 .code
5303 trusted_users = uucp:mail
5304 trusted_users = uucp:\
5305                 # This comment line is ignored
5306                 mail
5307 .endd
5308 .cindex "string" "quoted"
5309 .cindex "escape characters in quoted strings"
5310 If a string does start with a double-quote, it must end with a closing
5311 double-quote, and any backslash characters other than those used for line
5312 continuation are interpreted as escape characters, as follows:
5313
5314 .table2 100pt
5315 .irow &`\\`&                     "single backslash"
5316 .irow &`\n`&                     "newline"
5317 .irow &`\r`&                     "carriage return"
5318 .irow &`\t`&                     "tab"
5319 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5320 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5321                                    character"
5322 .endtable
5323
5324 If a backslash is followed by some other character, including a double-quote
5325 character, that character replaces the pair.
5326
5327 Quoting is necessary only if you want to make use of the backslash escapes to
5328 insert special characters, or if you need to specify a value with leading or
5329 trailing spaces. These cases are rare, so quoting is almost never needed in
5330 current versions of Exim. In versions of Exim before 3.14, quoting was required
5331 in order to continue lines, so you may come across older configuration files
5332 and examples that apparently quote unnecessarily.
5333
5334
5335 .section "Expanded strings" "SECID51"
5336 .cindex "expansion" "definition of"
5337 Some strings in the configuration file are subjected to &'string expansion'&,
5338 by which means various parts of the string may be changed according to the
5339 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5340 is as just described; in particular, the handling of backslashes in quoted
5341 strings is done as part of the input process, before expansion takes place.
5342 However, backslash is also an escape character for the expander, so any
5343 backslashes that are required for that reason must be doubled if they are
5344 within a quoted configuration string.
5345
5346
5347 .section "User and group names" "SECID52"
5348 .cindex "user name" "format of"
5349 .cindex "format" "user name"
5350 .cindex "groups" "name format"
5351 .cindex "format" "group name"
5352 User and group names are specified as strings, using the syntax described
5353 above, but the strings are interpreted specially. A user or group name must
5354 either consist entirely of digits, or be a name that can be looked up using the
5355 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5356
5357
5358 .section "List construction" "SECTlistconstruct"
5359 .cindex "list" "syntax of in configuration"
5360 .cindex "format" "list item in configuration"
5361 .cindex "string" "list, definition of"
5362 The data for some configuration options is a list of items, with colon as the
5363 default separator. Many of these options are shown with type &"string list"& in
5364 the descriptions later in this document. Others are listed as &"domain list"&,
5365 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5366 are all the same; however, those other than &"string list"& are subject to
5367 particular kinds of interpretation, as described in chapter
5368 &<<CHAPdomhosaddlists>>&.
5369
5370 In all these cases, the entire list is treated as a single string as far as the
5371 input syntax is concerned. The &%trusted_users%& setting in section
5372 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5373 in a list, it must be entered as two colons. Leading and trailing white space
5374 on each item in a list is ignored. This makes it possible to include items that
5375 start with a colon, and in particular, certain forms of IPv6 address. For
5376 example, the list
5377 .code
5378 local_interfaces = 127.0.0.1 : ::::1
5379 .endd
5380 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5381
5382 &*Note*&: Although leading and trailing white space is ignored in individual
5383 list items, it is not ignored when parsing the list. The space after the first
5384 colon in the example above is necessary. If it were not there, the list would
5385 be interpreted as the two items 127.0.0.1:: and 1.
5386
5387 .section "Changing list separators" "SECTlistsepchange"
5388 .cindex "list separator" "changing"
5389 .cindex "IPv6" "addresses in lists"
5390 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5391 introduced to allow the separator character to be changed. If a list begins
5392 with a left angle bracket, followed by any punctuation character, that
5393 character is used instead of colon as the list separator. For example, the list
5394 above can be rewritten to use a semicolon separator like this:
5395 .code
5396 local_interfaces = <; 127.0.0.1 ; ::1
5397 .endd
5398 This facility applies to all lists, with the exception of the list in
5399 &%log_file_path%&. It is recommended that the use of non-colon separators be
5400 confined to circumstances where they really are needed.
5401
5402 .cindex "list separator" "newline as"
5403 .cindex "newline" "as list separator"
5404 It is also possible to use newline and other control characters (those with
5405 code values less than 32, plus DEL) as separators in lists. Such separators
5406 must be provided literally at the time the list is processed. For options that
5407 are string-expanded, you can write the separator using a normal escape
5408 sequence. This will be processed by the expander before the string is
5409 interpreted as a list. For example, if a newline-separated list of domains is
5410 generated by a lookup, you can process it directly by a line such as this:
5411 .code
5412 domains = <\n ${lookup mysql{.....}}
5413 .endd
5414 This avoids having to change the list separator in such data. You are unlikely
5415 to want to use a control character as a separator in an option that is not
5416 expanded, because the value is literal text. However, it can be done by giving
5417 the value in quotes. For example:
5418 .code
5419 local_interfaces = "<\n 127.0.0.1 \n ::1"
5420 .endd
5421 Unlike printing character separators, which can be included in list items by
5422 doubling, it is not possible to include a control character as data when it is
5423 set as the separator. Two such characters in succession are interpreted as
5424 enclosing an empty list item.
5425
5426
5427
5428 .section "Empty items in lists" "SECTempitelis"
5429 .cindex "list" "empty item in"
5430 An empty item at the end of a list is always ignored. In other words, trailing
5431 separator characters are ignored. Thus, the list in
5432 .code
5433 senders = user@domain :
5434 .endd
5435 contains only a single item. If you want to include an empty string as one item
5436 in a list, it must not be the last item. For example, this list contains three
5437 items, the second of which is empty:
5438 .code
5439 senders = user1@domain : : user2@domain
5440 .endd
5441 &*Note*&: There must be white space between the two colons, as otherwise they
5442 are interpreted as representing a single colon data character (and the list
5443 would then contain just one item). If you want to specify a list that contains
5444 just one, empty item, you can do it as in this example:
5445 .code
5446 senders = :
5447 .endd
5448 In this case, the first item is empty, and the second is discarded because it
5449 is at the end of the list.
5450
5451
5452
5453
5454 .section "Format of driver configurations" "SECTfordricon"
5455 .cindex "drivers" "configuration format"
5456 There are separate parts in the configuration for defining routers, transports,
5457 and authenticators. In each part, you are defining a number of driver
5458 instances, each with its own set of options. Each driver instance is defined by
5459 a sequence of lines like this:
5460 .display
5461 <&'instance name'&>:
5462   <&'option'&>
5463   ...
5464   <&'option'&>
5465 .endd
5466 In the following example, the instance name is &(localuser)&, and it is
5467 followed by three options settings:
5468 .code
5469 localuser:
5470   driver = accept
5471   check_local_user
5472   transport = local_delivery
5473 .endd
5474 For each driver instance, you specify which Exim code module it uses &-- by the
5475 setting of the &%driver%& option &-- and (optionally) some configuration
5476 settings. For example, in the case of transports, if you want a transport to
5477 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5478 a local file you would use the &(appendfile)& driver. Each of the drivers is
5479 described in detail in its own separate chapter later in this manual.
5480
5481 You can have several routers, transports, or authenticators that are based on
5482 the same underlying driver (each must have a different instance name).
5483
5484 The order in which routers are defined is important, because addresses are
5485 passed to individual routers one by one, in order. The order in which
5486 transports are defined does not matter at all. The order in which
5487 authenticators are defined is used only when Exim, as a client, is searching
5488 them to find one that matches an authentication mechanism offered by the
5489 server.
5490
5491 .cindex "generic options"
5492 .cindex "options" "generic &-- definition of"
5493 Within a driver instance definition, there are two kinds of option: &'generic'&
5494 and &'private'&. The generic options are those that apply to all drivers of the
5495 same type (that is, all routers, all transports or all authenticators). The
5496 &%driver%& option is a generic option that must appear in every definition.
5497 .cindex "private options"
5498 The private options are special for each driver, and none need appear, because
5499 they all have default values.
5500
5501 The options may appear in any order, except that the &%driver%& option must
5502 precede any private options, since these depend on the particular driver. For
5503 this reason, it is recommended that &%driver%& always be the first option.
5504
5505 Driver instance names, which are used for reference in log entries and
5506 elsewhere, can be any sequence of letters, digits, and underscores (starting
5507 with a letter) and must be unique among drivers of the same type. A router and
5508 a transport (for example) can each have the same name, but no two router
5509 instances can have the same name. The name of a driver instance should not be
5510 confused with the name of the underlying driver module. For example, the
5511 configuration lines:
5512 .code
5513 remote_smtp:
5514   driver = smtp
5515 .endd
5516 create an instance of the &(smtp)& transport driver whose name is
5517 &(remote_smtp)&. The same driver code can be used more than once, with
5518 different instance names and different option settings each time. A second
5519 instance of the &(smtp)& transport, with different options, might be defined
5520 thus:
5521 .code
5522 special_smtp:
5523   driver = smtp
5524   port = 1234
5525   command_timeout = 10s
5526 .endd
5527 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5528 these transport instances from routers, and these names would appear in log
5529 lines.
5530
5531 Comment lines may be present in the middle of driver specifications. The full
5532 list of option settings for any particular driver instance, including all the
5533 defaulted values, can be extracted by making use of the &%-bP%& command line
5534 option.
5535
5536
5537
5538
5539
5540
5541 . ////////////////////////////////////////////////////////////////////////////
5542 . ////////////////////////////////////////////////////////////////////////////
5543
5544 .chapter "The default configuration file" "CHAPdefconfil"
5545 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5546 .cindex "default" "configuration file &""walk through""&"
5547 The default configuration file supplied with Exim as &_src/configure.default_&
5548 is sufficient for a host with simple mail requirements. As an introduction to
5549 the way Exim is configured, this chapter &"walks through"& the default
5550 configuration, giving brief explanations of the settings. Detailed descriptions
5551 of the options are given in subsequent chapters. The default configuration file
5552 itself contains extensive comments about ways you might want to modify the
5553 initial settings. However, note that there are many options that are not
5554 mentioned at all in the default configuration.
5555
5556
5557
5558 .section "Macros" "SECTdefconfmacros"
5559 All macros should be defined before any options.
5560
5561 One macro is specified, but commented out, in the default configuration:
5562 .code
5563 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5564 .endd
5565 If all off-site mail is expected to be delivered to a "smarthost", then set the
5566 hostname here and uncomment the macro.  This will affect which router is used
5567 later on.  If this is left commented out, then Exim will perform direct-to-MX
5568 deliveries using a &(dnslookup)& router.
5569
5570 In addition to macros defined here, Exim includes a number of built-in macros
5571 to enable configuration to be guarded by a binary built with support for a
5572 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5573
5574
5575 .section "Main configuration settings" "SECTdefconfmain"
5576 The main (global) configuration option settings section must always come first
5577 in the file, after the macros.
5578 The first thing you'll see in the file, after some initial comments, is the line
5579 .code
5580 # primary_hostname =
5581 .endd
5582 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5583 to know the official, fully qualified name of your host, and this is where you
5584 can specify it. However, in most cases you do not need to set this option. When
5585 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5586
5587 The first three non-comment configuration lines are as follows:
5588 .code
5589 domainlist local_domains    = @
5590 domainlist relay_to_domains =
5591 hostlist   relay_from_hosts = 127.0.0.1
5592 .endd
5593 These are not, in fact, option settings. They are definitions of two named
5594 domain lists and one named host list. Exim allows you to give names to lists of
5595 domains, hosts, and email addresses, in order to make it easier to manage the
5596 configuration file (see section &<<SECTnamedlists>>&).
5597
5598 The first line defines a domain list called &'local_domains'&; this is used
5599 later in the configuration to identify domains that are to be delivered
5600 on the local host.
5601
5602 .cindex "@ in a domain list"
5603 There is just one item in this list, the string &"@"&. This is a special form
5604 of entry which means &"the name of the local host"&. Thus, if the local host is
5605 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5606 be delivered locally. Because the local host's name is referenced indirectly,
5607 the same configuration file can be used on different hosts.
5608
5609 The second line defines a domain list called &'relay_to_domains'&, but the
5610 list itself is empty. Later in the configuration we will come to the part that
5611 controls mail relaying through the local host; it allows relaying to any
5612 domains in this list. By default, therefore, no relaying on the basis of a mail
5613 domain is permitted.
5614
5615 The third line defines a host list called &'relay_from_hosts'&. This list is
5616 used later in the configuration to permit relaying from any host or IP address
5617 that matches the list. The default contains just the IP address of the IPv4
5618 loopback interface, which means that processes on the local host are able to
5619 submit mail for relaying by sending it over TCP/IP to that interface. No other
5620 hosts are permitted to submit messages for relaying.
5621
5622 Just to be sure there's no misunderstanding: at this point in the configuration
5623 we aren't actually setting up any controls. We are just defining some domains
5624 and hosts that will be used in the controls that are specified later.
5625
5626 The next two configuration lines are genuine option settings:
5627 .code
5628 acl_smtp_rcpt = acl_check_rcpt
5629 acl_smtp_data = acl_check_data
5630 .endd
5631 These options specify &'Access Control Lists'& (ACLs) that are to be used
5632 during an incoming SMTP session for every recipient of a message (every RCPT
5633 command), and after the contents of the message have been received,
5634 respectively. The names of the lists are &'acl_check_rcpt'& and
5635 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5636 section of the configuration. The RCPT ACL controls which recipients are
5637 accepted for an incoming message &-- if a configuration does not provide an ACL
5638 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5639 contents of a message to be checked.
5640
5641 Two commented-out option settings are next:
5642 .code
5643 # av_scanner = clamd:/tmp/clamd
5644 # spamd_address = 127.0.0.1 783
5645 .endd
5646 These are example settings that can be used when Exim is compiled with the
5647 content-scanning extension. The first specifies the interface to the virus
5648 scanner, and the second specifies the interface to SpamAssassin. Further
5649 details are given in chapter &<<CHAPexiscan>>&.
5650
5651 Three more commented-out option settings follow:
5652 .code
5653 # tls_advertise_hosts = *
5654 # tls_certificate = /etc/ssl/exim.crt
5655 # tls_privatekey = /etc/ssl/exim.pem
5656 .endd
5657 These are example settings that can be used when Exim is compiled with
5658 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5659 first one specifies the list of clients that are allowed to use TLS when
5660 connecting to this server; in this case, the wildcard means all clients. The
5661 other options specify where Exim should find its TLS certificate and private
5662 key, which together prove the server's identity to any clients that connect.
5663 More details are given in chapter &<<CHAPTLS>>&.
5664
5665 Another two commented-out option settings follow:
5666 .code
5667 # daemon_smtp_ports = 25 : 465 : 587
5668 # tls_on_connect_ports = 465
5669 .endd
5670 .cindex "port" "465 and 587"
5671 .cindex "port" "for message submission"
5672 .cindex "message" "submission, ports for"
5673 .cindex "submissions protocol"
5674 .cindex "smtps protocol"
5675 .cindex "ssmtp protocol"
5676 .cindex "SMTP" "submissions protocol"
5677 .cindex "SMTP" "ssmtp protocol"
5678 .cindex "SMTP" "smtps protocol"
5679 These options provide better support for roaming users who wish to use this
5680 server for message submission. They are not much use unless you have turned on
5681 TLS (as described in the previous paragraph) and authentication (about which
5682 more in section &<<SECTdefconfauth>>&).
5683 Mail submission from mail clients (MUAs) should be separate from inbound mail
5684 to your domain (MX delivery) for various good reasons (eg, ability to impose
5685 much saner TLS protocol and ciphersuite requirements without unintended
5686 consequences).
5687 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5688 which uses STARTTLS, so this is the &"submission"& port.
5689 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5690 which should be used in preference to 587.
5691 You should also consider deploying SRV records to help clients find
5692 these ports.
5693 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5694
5695 Two more commented-out options settings follow:
5696 .code
5697 # qualify_domain =
5698 # qualify_recipient =
5699 .endd
5700 The first of these specifies a domain that Exim uses when it constructs a
5701 complete email address from a local login name. This is often needed when Exim
5702 receives a message from a local process. If you do not set &%qualify_domain%&,
5703 the value of &%primary_hostname%& is used. If you set both of these options,
5704 you can have different qualification domains for sender and recipient
5705 addresses. If you set only the first one, its value is used in both cases.
5706
5707 .cindex "domain literal" "recognizing format"
5708 The following line must be uncommented if you want Exim to recognize
5709 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5710 (an IP address within square brackets) instead of a named domain.
5711 .code
5712 # allow_domain_literals
5713 .endd
5714 The RFCs still require this form, but many people think that in the modern
5715 Internet it makes little sense to permit mail to be sent to specific hosts by
5716 quoting their IP addresses. This ancient format has been used by people who
5717 try to abuse hosts by using them for unwanted relaying. However, some
5718 people believe there are circumstances (for example, messages addressed to
5719 &'postmaster'&) where domain literals are still useful.
5720
5721 The next configuration line is a kind of trigger guard:
5722 .code
5723 never_users = root
5724 .endd
5725 It specifies that no delivery must ever be run as the root user. The normal
5726 convention is to set up &'root'& as an alias for the system administrator. This
5727 setting is a guard against slips in the configuration.
5728 The list of users specified by &%never_users%& is not, however, the complete
5729 list; the build-time configuration in &_Local/Makefile_& has an option called
5730 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5731 contents of &%never_users%& are added to this list. By default
5732 FIXED_NEVER_USERS also specifies root.
5733
5734 When a remote host connects to Exim in order to send mail, the only information
5735 Exim has about the host's identity is its IP address. The next configuration
5736 line,
5737 .code
5738 host_lookup = *
5739 .endd
5740 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5741 in order to get a host name. This improves the quality of the logging
5742 information, but if you feel it is too expensive, you can remove it entirely,
5743 or restrict the lookup to hosts on &"nearby"& networks.
5744 Note that it is not always possible to find a host name from an IP address,
5745 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5746 unreachable.
5747
5748 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5749 1413 (hence their names):
5750 .code
5751 rfc1413_hosts = *
5752 rfc1413_query_timeout = 0s
5753 .endd
5754 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5755 Few hosts offer RFC1413 service these days; calls have to be
5756 terminated by a timeout and this needlessly delays the startup
5757 of an incoming SMTP connection.
5758 If you have hosts for which you trust RFC1413 and need this
5759 information, you can change this.
5760
5761 This line enables an efficiency SMTP option.  It is negotiated by clients
5762 and not expected to cause problems but can be disabled if needed.
5763 .code
5764 prdr_enable = true
5765 .endd
5766
5767 When Exim receives messages over SMTP connections, it expects all addresses to
5768 be fully qualified with a domain, as required by the SMTP definition. However,
5769 if you are running a server to which simple clients submit messages, you may
5770 find that they send unqualified addresses. The two commented-out options:
5771 .code
5772 # sender_unqualified_hosts =
5773 # recipient_unqualified_hosts =
5774 .endd
5775 show how you can specify hosts that are permitted to send unqualified sender
5776 and recipient addresses, respectively.
5777
5778 The &%log_selector%& option is used to increase the detail of logging
5779 over the default:
5780 .code
5781 log_selector = +smtp_protocol_error +smtp_syntax_error \
5782                +tls_certificate_verified
5783 .endd
5784
5785 The &%percent_hack_domains%& option is also commented out:
5786 .code
5787 # percent_hack_domains =
5788 .endd
5789 It provides a list of domains for which the &"percent hack"& is to operate.
5790 This is an almost obsolete form of explicit email routing. If you do not know
5791 anything about it, you can safely ignore this topic.
5792
5793 The next two settings in the main part of the default configuration are
5794 concerned with messages that have been &"frozen"& on Exim's queue. When a
5795 message is frozen, Exim no longer continues to try to deliver it. Freezing
5796 occurs when a bounce message encounters a permanent failure because the sender
5797 address of the original message that caused the bounce is invalid, so the
5798 bounce cannot be delivered. This is probably the most common case, but there
5799 are also other conditions that cause freezing, and frozen messages are not
5800 always bounce messages.
5801 .code
5802 ignore_bounce_errors_after = 2d
5803 timeout_frozen_after = 7d
5804 .endd
5805 The first of these options specifies that failing bounce messages are to be
5806 discarded after 2 days in the queue. The second specifies that any frozen
5807 message (whether a bounce message or not) is to be timed out (and discarded)
5808 after a week. In this configuration, the first setting ensures that no failing
5809 bounce message ever lasts a week.
5810
5811 Exim queues it's messages in a spool directory. If you expect to have
5812 large queues, you may consider using this option. It splits the spool
5813 directory into subdirectories to avoid file system degradation from
5814 many files in a single directory, resulting in better performance.
5815 Manual manipulation of queued messages becomes more complex (though fortunately
5816 not often needed).
5817 .code
5818 # split_spool_directory = true
5819 .endd
5820
5821 In an ideal world everybody follows the standards. For non-ASCII
5822 messages RFC 2047 is a standard, allowing a maximum line length of 76
5823 characters. Exim adheres that standard and won't process messages which
5824 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5825 In particular, the Exim maintainers have had multiple reports of
5826 problems from Russian administrators of issues until they disable this
5827 check, because of some popular, yet buggy, mail composition software.
5828 .code
5829 # check_rfc2047_length = false
5830 .endd
5831
5832 If you need to be strictly RFC compliant you may wish to disable the
5833 8BITMIME advertisement. Use this, if you exchange mails with systems
5834 that are not 8-bit clean.
5835 .code
5836 # accept_8bitmime = false
5837 .endd
5838
5839 Libraries you use may depend on specific environment settings.  This
5840 imposes a security risk (e.g. PATH). There are two lists:
5841 &%keep_environment%& for the variables to import as they are, and
5842 &%add_environment%& for variables we want to set to a fixed value.
5843 Note that TZ is handled separately, by the $%timezone%$ runtime
5844 option and by the TIMEZONE_DEFAULT buildtime option.
5845 .code
5846 # keep_environment = ^LDAP
5847 # add_environment = PATH=/usr/bin::/bin
5848 .endd
5849
5850
5851 .section "ACL configuration" "SECID54"
5852 .cindex "default" "ACLs"
5853 .cindex "&ACL;" "default configuration"
5854 In the default configuration, the ACL section follows the main configuration.
5855 It starts with the line
5856 .code
5857 begin acl
5858 .endd
5859 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5860 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5861 and &%acl_smtp_data%& above.
5862
5863 .cindex "RCPT" "ACL for"
5864 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5865 RCPT command specifies one of the message's recipients. The ACL statements
5866 are considered in order, until the recipient address is either accepted or
5867 rejected. The RCPT command is then accepted or rejected, according to the
5868 result of the ACL processing.
5869 .code
5870 acl_check_rcpt:
5871 .endd
5872 This line, consisting of a name terminated by a colon, marks the start of the
5873 ACL, and names it.
5874 .code
5875 accept  hosts = :
5876 .endd
5877 This ACL statement accepts the recipient if the sending host matches the list.
5878 But what does that strange list mean? It doesn't actually contain any host
5879 names or IP addresses. The presence of the colon puts an empty item in the
5880 list; Exim matches this only if the incoming message did not come from a remote
5881 host, because in that case, the remote hostname is empty. The colon is
5882 important. Without it, the list itself is empty, and can never match anything.
5883
5884 What this statement is doing is to accept unconditionally all recipients in
5885 messages that are submitted by SMTP from local processes using the standard
5886 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5887 manner.
5888 .code
5889 deny    message       = Restricted characters in address
5890         domains       = +local_domains
5891         local_parts   = ^[.] : ^.*[@%!/|]
5892
5893 deny    message       = Restricted characters in address
5894         domains       = !+local_domains
5895         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5896 .endd
5897 These statements are concerned with local parts that contain any of the
5898 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5899 Although these characters are entirely legal in local parts (in the case of
5900 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5901 in Internet mail addresses.
5902
5903 The first three have in the past been associated with explicitly routed
5904 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5905 option). Addresses containing these characters are regularly tried by spammers
5906 in an attempt to bypass relaying restrictions, and also by open relay testing
5907 programs. Unless you really need them it is safest to reject these characters
5908 at this early stage. This configuration is heavy-handed in rejecting these
5909 characters for all messages it accepts from remote hosts. This is a deliberate
5910 policy of being as safe as possible.
5911
5912 The first rule above is stricter, and is applied to messages that are addressed
5913 to one of the local domains handled by this host. This is implemented by the
5914 first condition, which restricts it to domains that are listed in the
5915 &'local_domains'& domain list. The &"+"& character is used to indicate a
5916 reference to a named list. In this configuration, there is just one domain in
5917 &'local_domains'&, but in general there may be many.
5918
5919 The second condition on the first statement uses two regular expressions to
5920 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5921 or &"|"&. If you have local accounts that include these characters, you will
5922 have to modify this rule.
5923
5924 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5925 allows them because they have been encountered in practice. (Consider the
5926 common convention of local parts constructed as
5927 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5928 the author of Exim, who has no second initial.) However, a local part starting
5929 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5930 filename (for example, for a mailing list). This is also true for local parts
5931 that contain slashes. A pipe symbol can also be troublesome if the local part
5932 is incorporated unthinkingly into a shell command line.
5933
5934 The second rule above applies to all other domains, and is less strict. This
5935 allows your own users to send outgoing messages to sites that use slashes
5936 and vertical bars in their local parts. It blocks local parts that begin
5937 with a dot, slash, or vertical bar, but allows these characters within the
5938 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5939 and &"!"& is blocked, as before. The motivation here is to prevent your users
5940 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5941 .code
5942 accept  local_parts   = postmaster
5943         domains       = +local_domains
5944 .endd
5945 This statement, which has two conditions, accepts an incoming address if the
5946 local part is &'postmaster'& and the domain is one of those listed in the
5947 &'local_domains'& domain list. The &"+"& character is used to indicate a
5948 reference to a named list. In this configuration, there is just one domain in
5949 &'local_domains'&, but in general there may be many.
5950
5951 The presence of this statement means that mail to postmaster is never blocked
5952 by any of the subsequent tests. This can be helpful while sorting out problems
5953 in cases where the subsequent tests are incorrectly denying access.
5954 .code
5955 require verify        = sender
5956 .endd
5957 This statement requires the sender address to be verified before any subsequent
5958 ACL statement can be used. If verification fails, the incoming recipient
5959 address is refused. Verification consists of trying to route the address, to
5960 see if a bounce message could be delivered to it. In the case of remote
5961 addresses, basic verification checks only the domain, but &'callouts'& can be
5962 used for more verification if required. Section &<<SECTaddressverification>>&
5963 discusses the details of address verification.
5964 .code
5965 accept  hosts         = +relay_from_hosts
5966         control       = submission
5967 .endd
5968 This statement accepts the address if the message is coming from one of the
5969 hosts that are defined as being allowed to relay through this host. Recipient
5970 verification is omitted here, because in many cases the clients are dumb MUAs
5971 that do not cope well with SMTP error responses. For the same reason, the
5972 second line specifies &"submission mode"& for messages that are accepted. This
5973 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5974 messages that are deficient in some way, for example, because they lack a
5975 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5976 probably add recipient verification here, and disable submission mode.
5977 .code
5978 accept  authenticated = *
5979         control       = submission
5980 .endd
5981 This statement accepts the address if the client host has authenticated itself.
5982 Submission mode is again specified, on the grounds that such messages are most
5983 likely to come from MUAs. The default configuration does not define any
5984 authenticators, though it does include some nearly complete commented-out
5985 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5986 fact authenticate until you complete the authenticator definitions.
5987 .code
5988 require message = relay not permitted
5989         domains = +local_domains : +relay_to_domains
5990 .endd
5991 This statement rejects the address if its domain is neither a local domain nor
5992 one of the domains for which this host is a relay.
5993 .code
5994 require verify = recipient
5995 .endd
5996 This statement requires the recipient address to be verified; if verification
5997 fails, the address is rejected.
5998 .code
5999 # deny    message     = rejected because $sender_host_address \
6000 #                       is in a black list at $dnslist_domain\n\
6001 #                       $dnslist_text
6002 #         dnslists    = black.list.example
6003 #
6004 # warn    dnslists    = black.list.example
6005 #         add_header  = X-Warning: $sender_host_address is in \
6006 #                       a black list at $dnslist_domain
6007 #         log_message = found in $dnslist_domain
6008 .endd
6009 These commented-out lines are examples of how you could configure Exim to check
6010 sending hosts against a DNS black list. The first statement rejects messages
6011 from blacklisted hosts, whereas the second just inserts a warning header
6012 line.
6013 .code
6014 # require verify = csa
6015 .endd
6016 This commented-out line is an example of how you could turn on client SMTP
6017 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6018 records.
6019 .code
6020 accept
6021 .endd
6022 The final statement in the first ACL unconditionally accepts any recipient
6023 address that has successfully passed all the previous tests.
6024 .code
6025 acl_check_data:
6026 .endd
6027 This line marks the start of the second ACL, and names it. Most of the contents
6028 of this ACL are commented out:
6029 .code
6030 # deny    malware   = *
6031 #         message   = This message contains a virus \
6032 #                     ($malware_name).
6033 .endd
6034 These lines are examples of how to arrange for messages to be scanned for
6035 viruses when Exim has been compiled with the content-scanning extension, and a
6036 suitable virus scanner is installed. If the message is found to contain a
6037 virus, it is rejected with the given custom error message.
6038 .code
6039 # warn    spam      = nobody
6040 #         message   = X-Spam_score: $spam_score\n\
6041 #                     X-Spam_score_int: $spam_score_int\n\
6042 #                     X-Spam_bar: $spam_bar\n\
6043 #                     X-Spam_report: $spam_report
6044 .endd
6045 These lines are an example of how to arrange for messages to be scanned by
6046 SpamAssassin when Exim has been compiled with the content-scanning extension,
6047 and SpamAssassin has been installed. The SpamAssassin check is run with
6048 &`nobody`& as its user parameter, and the results are added to the message as a
6049 series of extra header line. In this case, the message is not rejected,
6050 whatever the spam score.
6051 .code
6052 accept
6053 .endd
6054 This final line in the DATA ACL accepts the message unconditionally.
6055
6056
6057 .section "Router configuration" "SECID55"
6058 .cindex "default" "routers"
6059 .cindex "routers" "default"
6060 The router configuration comes next in the default configuration, introduced
6061 by the line
6062 .code
6063 begin routers
6064 .endd
6065 Routers are the modules in Exim that make decisions about where to send
6066 messages. An address is passed to each router, in turn, until it is either
6067 accepted, or failed. This means that the order in which you define the routers
6068 matters. Each router is fully described in its own chapter later in this
6069 manual. Here we give only brief overviews.
6070 .code
6071 # domain_literal:
6072 #   driver = ipliteral
6073 #   domains = !+local_domains
6074 #   transport = remote_smtp
6075 .endd
6076 .cindex "domain literal" "default router"
6077 This router is commented out because the majority of sites do not want to
6078 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6079 you uncomment this router, you also need to uncomment the setting of
6080 &%allow_domain_literals%& in the main part of the configuration.
6081
6082 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6083 macro has been defined, per
6084 .code
6085 .ifdef ROUTER_SMARTHOST
6086 smarthost:
6087 #...
6088 .else
6089 dnslookup:
6090 #...
6091 .endif
6092 .endd
6093
6094 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6095 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6096 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6097 skip these routers because of the &%domains%& option.
6098
6099 .code
6100 smarthost:
6101   driver = manualroute
6102   domains = ! +local_domains
6103   transport = smarthost_smtp
6104   route_data = ROUTER_SMARTHOST
6105   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6106   no_more
6107 .endd
6108 This router only handles mail which is not to any local domains; this is
6109 specified by the line
6110 .code
6111 domains = ! +local_domains
6112 .endd
6113 The &%domains%& option lists the domains to which this router applies, but the
6114 exclamation mark is a negation sign, so the router is used only for domains
6115 that are not in the domain list called &'local_domains'& (which was defined at
6116 the start of the configuration). The plus sign before &'local_domains'&
6117 indicates that it is referring to a named list. Addresses in other domains are
6118 passed on to the following routers.
6119
6120 The name of the router driver is &(manualroute)& because we are manually
6121 specifying how mail should be routed onwards, instead of using DNS MX.
6122 While the name of this router instance is arbitrary, the &%driver%& option must
6123 be one of the driver modules that is in the Exim binary.
6124
6125 With no pre-conditions other than &%domains%&, all mail for non-local domains
6126 will be handled by this router, and the &%no_more%& setting will ensure that no
6127 other routers will be used for messages matching the pre-conditions.  See
6128 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6129 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6130 and the macro supplies the value; the address is then queued for the
6131 &(smarthost_smtp)& transport.
6132
6133 .code
6134 dnslookup:
6135   driver = dnslookup
6136   domains = ! +local_domains
6137   transport = remote_smtp
6138   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6139   no_more
6140 .endd
6141 The &%domains%& option behaves as per smarthost, above.
6142
6143 The name of the router driver is &(dnslookup)&,
6144 and is specified by the &%driver%& option. Do not be confused by the fact that
6145 the name of this router instance is the same as the name of the driver. The
6146 instance name is arbitrary, but the name set in the &%driver%& option must be
6147 one of the driver modules that is in the Exim binary.
6148
6149 The &(dnslookup)& router routes addresses by looking up their domains in the
6150 DNS in order to obtain a list of hosts to which the address is routed. If the
6151 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6152 specified by the &%transport%& option. If the router does not find the domain
6153 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6154 the address fails and is bounced.
6155
6156 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6157 be entirely ignored. This option is present because a number of cases have been
6158 encountered where MX records in the DNS point to host names
6159 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6160 Completely ignoring these IP addresses causes Exim to fail to route the
6161 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6162 continue to try to deliver the message periodically until the address timed
6163 out.
6164 .code
6165 system_aliases:
6166   driver = redirect
6167   allow_fail
6168   allow_defer
6169   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6170 # user = exim
6171   file_transport = address_file
6172   pipe_transport = address_pipe
6173 .endd
6174 Control reaches this and subsequent routers only for addresses in the local
6175 domains. This router checks to see whether the local part is defined as an
6176 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6177 data that it looks up from that file. If no data is found for the local part,
6178 the value of the &%data%& option is empty, causing the address to be passed to
6179 the next router.
6180
6181 &_/etc/aliases_& is a conventional name for the system aliases file that is
6182 often used. That is why it is referenced by from the default configuration
6183 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6184 &_Local/Makefile_& before building Exim.
6185 .code
6186 userforward:
6187   driver = redirect
6188   check_local_user
6189 # local_part_suffix = +* : -*
6190 # local_part_suffix_optional
6191   file = $home/.forward
6192 # allow_filter
6193   no_verify
6194   no_expn
6195   check_ancestor
6196   file_transport = address_file
6197   pipe_transport = address_pipe
6198   reply_transport = address_reply
6199 .endd
6200 This is the most complicated router in the default configuration. It is another
6201 redirection router, but this time it is looking for forwarding data set up by
6202 individual users. The &%check_local_user%& setting specifies a check that the
6203 local part of the address is the login name of a local user. If it is not, the
6204 router is skipped. The two commented options that follow &%check_local_user%&,
6205 namely:
6206 .code
6207 # local_part_suffix = +* : -*
6208 # local_part_suffix_optional
6209 .endd
6210 .vindex "&$local_part_suffix$&"
6211 show how you can specify the recognition of local part suffixes. If the first
6212 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6213 by any sequence of characters, is removed from the local part and placed in the
6214 variable &$local_part_suffix$&. The second suffix option specifies that the
6215 presence of a suffix in the local part is optional. When a suffix is present,
6216 the check for a local login uses the local part with the suffix removed.
6217
6218 When a local user account is found, the file called &_.forward_& in the user's
6219 home directory is consulted. If it does not exist, or is empty, the router
6220 declines. Otherwise, the contents of &_.forward_& are interpreted as
6221 redirection data (see chapter &<<CHAPredirect>>& for more details).
6222
6223 .cindex "Sieve filter" "enabling in default router"
6224 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6225 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6226 is commented out by default), the contents of the file are interpreted as a set
6227 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6228 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6229 separate document entitled &'Exim's interfaces to mail filtering'&.
6230
6231 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6232 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6233 There are two reasons for doing this:
6234
6235 .olist
6236 Whether or not a local user has a &_.forward_& file is not really relevant when
6237 checking an address for validity; it makes sense not to waste resources doing
6238 unnecessary work.
6239 .next
6240 More importantly, when Exim is verifying addresses or handling an EXPN
6241 command during an SMTP session, it is running as the Exim user, not as root.
6242 The group is the Exim group, and no additional groups are set up.
6243 It may therefore not be possible for Exim to read users' &_.forward_& files at
6244 this time.
6245 .endlist
6246
6247 The setting of &%check_ancestor%& prevents the router from generating a new
6248 address that is the same as any previous address that was redirected. (This
6249 works round a problem concerning a bad interaction between aliasing and
6250 forwarding &-- see section &<<SECTredlocmai>>&).
6251
6252 The final three option settings specify the transports that are to be used when
6253 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6254 auto-reply, respectively. For example, if a &_.forward_& file contains
6255 .code
6256 a.nother@elsewhere.example, /home/spqr/archive
6257 .endd
6258 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6259 transport.
6260 .code
6261 localuser:
6262   driver = accept
6263   check_local_user
6264 # local_part_suffix = +* : -*
6265 # local_part_suffix_optional
6266   transport = local_delivery
6267 .endd
6268 The final router sets up delivery into local mailboxes, provided that the local
6269 part is the name of a local login, by accepting the address and assigning it to
6270 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6271 routers, so the address is bounced. The commented suffix settings fulfil the
6272 same purpose as they do for the &(userforward)& router.
6273
6274
6275 .section "Transport configuration" "SECID56"
6276 .cindex "default" "transports"
6277 .cindex "transports" "default"
6278 Transports define mechanisms for actually delivering messages. They operate
6279 only when referenced from routers, so the order in which they are defined does
6280 not matter. The transports section of the configuration starts with
6281 .code
6282 begin transports
6283 .endd
6284 Two remote transports and four local transports are defined.
6285 .code
6286 remote_smtp:
6287   driver = smtp
6288   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6289 .ifdef _HAVE_PRDR
6290   hosts_try_prdr = *
6291 .endif
6292 .endd
6293 This transport is used for delivering messages over SMTP connections.
6294 The list of remote hosts comes from the router.
6295 The &%message_size_limit%& usage is a hack to avoid sending on messages
6296 with over-long lines.
6297
6298 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6299 negotiated between client and server and not expected to cause problems
6300 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6301 use of the &%hosts_try_prdr%& configuration option.
6302
6303 The other remote transport is used when delivering to a specific smarthost
6304 with whom there must be some kind of existing relationship, instead of the
6305 usual federated system.
6306
6307 .code
6308 smarthost_smtp:
6309   driver = smtp
6310   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6311   multi_domain
6312   #
6313 .ifdef _HAVE_TLS
6314   # Comment out any of these which you have to, then file a Support
6315   # request with your smarthost provider to get things fixed:
6316   hosts_require_tls = *
6317   tls_verify_hosts = *
6318   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6319   # have to comment it out then this will at least log whether you succeed
6320   # or not:
6321   tls_try_verify_hosts = *
6322   #
6323   # The SNI name should match the name which we'll expect to verify;
6324   # many mail systems don't use SNI and this doesn't matter, but if it does,
6325   # we need to send a name which the remote site will recognize.
6326   # This _should_ be the name which the smarthost operators specified as
6327   # the hostname for sending your mail to.
6328   tls_sni = ROUTER_SMARTHOST
6329   #
6330 .ifdef _HAVE_OPENSSL
6331   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6332 .endif
6333 .ifdef _HAVE_GNUTLS
6334   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6335 .endif
6336 .endif
6337 .ifdef _HAVE_PRDR
6338   hosts_try_prdr = *
6339 .endif
6340 .endd
6341 After the same &%message_size_limit%& hack, we then specify that this Transport
6342 can handle messages to multiple domains in one run.  The assumption here is
6343 that you're routing all non-local mail to the same place and that place is
6344 happy to take all messages from you as quickly as possible.
6345 All other options depend upon built-in macros; if Exim was built without TLS support
6346 then no other options are defined.
6347 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6348 and versions using the &%tls_require_ciphers%& option, where the value to be
6349 used depends upon the library providing TLS.
6350 Beyond that, the options adopt the stance that you should have TLS support available
6351 from your smarthost on today's Internet, so we turn on requiring TLS for the
6352 mail to be delivered, and requiring that the certificate be valid, and match
6353 the expected hostname.  The &%tls_sni%& option can be used by service providers
6354 to select an appropriate certificate to present to you and here we re-use the
6355 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6356 You want to specify the hostname which you'll expect to validate for, and that
6357 should not be subject to insecure tampering via DNS results.
6358
6359 For the &%hosts_try_prdr%& option see the previous transport.
6360
6361 All other options are defaulted.
6362 .code
6363 local_delivery:
6364   driver = appendfile
6365   file = /var/mail/$local_part
6366   delivery_date_add
6367   envelope_to_add
6368   return_path_add
6369 # group = mail
6370 # mode = 0660
6371 .endd
6372 This &(appendfile)& transport is used for local delivery to user mailboxes in
6373 traditional BSD mailbox format. By default it runs under the uid and gid of the
6374 local user, which requires the sticky bit to be set on the &_/var/mail_&
6375 directory. Some systems use the alternative approach of running mail deliveries
6376 under a particular group instead of using the sticky bit. The commented options
6377 show how this can be done.
6378
6379 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6380 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6381 similarly-named options above.
6382 .code
6383 address_pipe:
6384   driver = pipe
6385   return_output
6386 .endd
6387 This transport is used for handling deliveries to pipes that are generated by
6388 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6389 option specifies that any output on stdout or stderr generated by the pipe is to
6390 be returned to the sender.
6391 .code
6392 address_file:
6393   driver = appendfile
6394   delivery_date_add
6395   envelope_to_add
6396   return_path_add
6397 .endd
6398 This transport is used for handling deliveries to files that are generated by
6399 redirection. The name of the file is not specified in this instance of
6400 &(appendfile)&, because it comes from the &(redirect)& router.
6401 .code
6402 address_reply:
6403   driver = autoreply
6404 .endd
6405 This transport is used for handling automatic replies generated by users'
6406 filter files.
6407
6408
6409
6410 .section "Default retry rule" "SECID57"
6411 .cindex "retry" "default rule"
6412 .cindex "default" "retry rule"
6413 The retry section of the configuration file contains rules which affect the way
6414 Exim retries deliveries that cannot be completed at the first attempt. It is
6415 introduced by the line
6416 .code
6417 begin retry
6418 .endd
6419 In the default configuration, there is just one rule, which applies to all
6420 errors:
6421 .code
6422 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6423 .endd
6424 This causes any temporarily failing address to be retried every 15 minutes for
6425 2 hours, then at intervals starting at one hour and increasing by a factor of
6426 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6427 is not delivered after 4 days of temporary failure, it is bounced. The time is
6428 measured from first failure, not from the time the message was received.
6429
6430 If the retry section is removed from the configuration, or is empty (that is,
6431 if no retry rules are defined), Exim will not retry deliveries. This turns
6432 temporary errors into permanent errors.
6433
6434
6435 .section "Rewriting configuration" "SECID58"
6436 The rewriting section of the configuration, introduced by
6437 .code
6438 begin rewrite
6439 .endd
6440 contains rules for rewriting addresses in messages as they arrive. There are no
6441 rewriting rules in the default configuration file.
6442
6443
6444
6445 .section "Authenticators configuration" "SECTdefconfauth"
6446 .cindex "AUTH" "configuration"
6447 The authenticators section of the configuration, introduced by
6448 .code
6449 begin authenticators
6450 .endd
6451 defines mechanisms for the use of the SMTP AUTH command. The default
6452 configuration file contains two commented-out example authenticators
6453 which support plaintext username/password authentication using the
6454 standard PLAIN mechanism and the traditional but non-standard LOGIN
6455 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6456 to support most MUA software.
6457
6458 The example PLAIN authenticator looks like this:
6459 .code
6460 #PLAIN:
6461 #  driver                  = plaintext
6462 #  server_set_id           = $auth2
6463 #  server_prompts          = :
6464 #  server_condition        = Authentication is not yet configured
6465 #  server_advertise_condition = ${if def:tls_in_cipher }
6466 .endd
6467 And the example LOGIN authenticator looks like this:
6468 .code
6469 #LOGIN:
6470 #  driver                  = plaintext
6471 #  server_set_id           = $auth1
6472 #  server_prompts          = <| Username: | Password:
6473 #  server_condition        = Authentication is not yet configured
6474 #  server_advertise_condition = ${if def:tls_in_cipher }
6475 .endd
6476
6477 The &%server_set_id%& option makes Exim remember the authenticated username
6478 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6479 &%server_prompts%& option configures the &(plaintext)& authenticator so
6480 that it implements the details of the specific authentication mechanism,
6481 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6482 when Exim offers authentication to clients; in the examples, this is only
6483 when TLS or SSL has been started, so to enable the authenticators you also
6484 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6485
6486 The &%server_condition%& setting defines how to verify that the username and
6487 password are correct. In the examples it just produces an error message.
6488 To make the authenticators work, you can use a string expansion
6489 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6490
6491 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6492 usercode and password are in different positions.
6493 Chapter &<<CHAPplaintext>>& covers both.
6494
6495 .ecindex IIDconfiwal
6496
6497
6498
6499 . ////////////////////////////////////////////////////////////////////////////
6500 . ////////////////////////////////////////////////////////////////////////////
6501
6502 .chapter "Regular expressions" "CHAPregexp"
6503
6504 .cindex "regular expressions" "library"
6505 .cindex "PCRE"
6506 Exim supports the use of regular expressions in many of its options. It
6507 uses the PCRE regular expression library; this provides regular expression
6508 matching that is compatible with Perl 5. The syntax and semantics of
6509 regular expressions is discussed in
6510 online Perl manpages, in
6511 many Perl reference books, and also in
6512 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6513 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6514 . --- the http: URL here redirects to another page with the ISBN in the URL
6515 . --- where trying to use https: just redirects back to http:, so sticking
6516 . --- to the old URL for now.  2018-09-07.
6517
6518 The documentation for the syntax and semantics of the regular expressions that
6519 are supported by PCRE is included in the PCRE distribution, and no further
6520 description is included here. The PCRE functions are called from Exim using
6521 the default option settings (that is, with no PCRE options set), except that
6522 the PCRE_CASELESS option is set when the matching is required to be
6523 case-insensitive.
6524
6525 In most cases, when a regular expression is required in an Exim configuration,
6526 it has to start with a circumflex, in order to distinguish it from plain text
6527 or an &"ends with"& wildcard. In this example of a configuration setting, the
6528 second item in the colon-separated list is a regular expression.
6529 .code
6530 domains = a.b.c : ^\\d{3} : *.y.z : ...
6531 .endd
6532 The doubling of the backslash is required because of string expansion that
6533 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6534 of this issue, and a way of avoiding the need for doubling backslashes. The
6535 regular expression that is eventually used in this example contains just one
6536 backslash. The circumflex is included in the regular expression, and has the
6537 normal effect of &"anchoring"& it to the start of the string that is being
6538 matched.
6539
6540 There are, however, two cases where a circumflex is not required for the
6541 recognition of a regular expression: these are the &%match%& condition in a
6542 string expansion, and the &%matches%& condition in an Exim filter file. In
6543 these cases, the relevant string is always treated as a regular expression; if
6544 it does not start with a circumflex, the expression is not anchored, and can
6545 match anywhere in the subject string.
6546
6547 In all cases, if you want a regular expression to match at the end of a string,
6548 you must code the $ metacharacter to indicate this. For example:
6549 .code
6550 domains = ^\\d{3}\\.example
6551 .endd
6552 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6553 You need to use:
6554 .code
6555 domains = ^\\d{3}\\.example\$
6556 .endd
6557 if you want &'example'& to be the top-level domain. The backslash before the
6558 $ is needed because string expansion also interprets dollar characters.
6559
6560
6561
6562 . ////////////////////////////////////////////////////////////////////////////
6563 . ////////////////////////////////////////////////////////////////////////////
6564
6565 .chapter "File and database lookups" "CHAPfdlookup"
6566 .scindex IIDfidalo1 "file" "lookups"
6567 .scindex IIDfidalo2 "database" "lookups"
6568 .cindex "lookup" "description of"
6569 Exim can be configured to look up data in files or databases as it processes
6570 messages. Two different kinds of syntax are used:
6571
6572 .olist
6573 A string that is to be expanded may contain explicit lookup requests. These
6574 cause parts of the string to be replaced by data that is obtained from the
6575 lookup. Lookups of this type are conditional expansion items. Different results
6576 can be defined for the cases of lookup success and failure. See chapter
6577 &<<CHAPexpand>>&, where string expansions are described in detail.
6578 The key for the lookup is specified as part of the string expansion.
6579 .next
6580 Lists of domains, hosts, and email addresses can contain lookup requests as a
6581 way of avoiding excessively long linear lists. In this case, the data that is
6582 returned by the lookup is often (but not always) discarded; whether the lookup
6583 succeeds or fails is what really counts. These kinds of list are described in
6584 chapter &<<CHAPdomhosaddlists>>&.
6585 The key for the lookup is given by the context in which the list is expanded.
6586 .endlist
6587
6588 String expansions, lists, and lookups interact with each other in such a way
6589 that there is no order in which to describe any one of them that does not
6590 involve references to the others. Each of these three chapters makes more sense
6591 if you have read the other two first. If you are reading this for the first
6592 time, be aware that some of it will make a lot more sense after you have read
6593 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6594
6595 .section "Examples of different lookup syntax" "SECID60"
6596 It is easy to confuse the two different kinds of lookup, especially as the
6597 lists that may contain the second kind are always expanded before being
6598 processed as lists. Therefore, they may also contain lookups of the first kind.
6599 Be careful to distinguish between the following two examples:
6600 .code
6601 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6602 domains = lsearch;/some/file
6603 .endd
6604 The first uses a string expansion, the result of which must be a domain list.
6605 No strings have been specified for a successful or a failing lookup; the
6606 defaults in this case are the looked-up data and an empty string, respectively.
6607 The expansion takes place before the string is processed as a list, and the
6608 file that is searched could contain lines like this:
6609 .code
6610 192.168.3.4: domain1:domain2:...
6611 192.168.1.9: domain3:domain4:...
6612 .endd
6613 When the lookup succeeds, the result of the expansion is a list of domains (and
6614 possibly other types of item that are allowed in domain lists).
6615
6616 In the second example, the lookup is a single item in a domain list. It causes
6617 Exim to use a lookup to see if the domain that is being processed can be found
6618 in the file. The file could contains lines like this:
6619 .code
6620 domain1:
6621 domain2:
6622 .endd
6623 Any data that follows the keys is not relevant when checking that the domain
6624 matches the list item.
6625
6626 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6627 Consider a file containing lines like this:
6628 .code
6629 192.168.5.6: lsearch;/another/file
6630 .endd
6631 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6632 first &%domains%& setting above generates the second setting, which therefore
6633 causes a second lookup to occur.
6634
6635 The rest of this chapter describes the different lookup types that are
6636 available. Any of them can be used in any part of the configuration where a
6637 lookup is permitted.
6638
6639
6640 .section "Lookup types" "SECID61"
6641 .cindex "lookup" "types of"
6642 .cindex "single-key lookup" "definition of"
6643 Two different types of data lookup are implemented:
6644
6645 .ilist
6646 The &'single-key'& type requires the specification of a file in which to look,
6647 and a single key to search for. The key must be a non-empty string for the
6648 lookup to succeed. The lookup type determines how the file is searched.
6649 .next
6650 .cindex "query-style lookup" "definition of"
6651 The &'query-style'& type accepts a generalized database query. No particular
6652 key value is assumed by Exim for query-style lookups. You can use whichever
6653 Exim variables you need to construct the database query.
6654 .endlist
6655
6656 The code for each lookup type is in a separate source file that is included in
6657 the binary of Exim only if the corresponding compile-time option is set. The
6658 default settings in &_src/EDITME_& are:
6659 .code
6660 LOOKUP_DBM=yes
6661 LOOKUP_LSEARCH=yes
6662 .endd
6663 which means that only linear searching and DBM lookups are included by default.
6664 For some types of lookup (e.g. SQL databases), you need to install appropriate
6665 libraries and header files before building Exim.
6666
6667
6668
6669
6670 .section "Single-key lookup types" "SECTsinglekeylookups"
6671 .cindex "lookup" "single-key types"
6672 .cindex "single-key lookup" "list of types"
6673 The following single-key lookup types are implemented:
6674
6675 .ilist
6676 .cindex "cdb" "description of"
6677 .cindex "lookup" "cdb"
6678 .cindex "binary zero" "in lookup key"
6679 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6680 string without a terminating binary zero. The cdb format is designed for
6681 indexed files that are read frequently and never updated, except by total
6682 re-creation. As such, it is particularly suitable for large files containing
6683 aliases or other indexed data referenced by an MTA. Information about cdb and
6684 tools for building the files can be found in several places:
6685 .display
6686 &url(https://cr.yp.to/cdb.html)
6687 &url(https://www.corpit.ru/mjt/tinycdb.html)
6688 &url(https://packages.debian.org/stable/utils/freecdb)
6689 &url(https://github.com/philpennock/cdbtools) (in Go)
6690 .endd
6691 A cdb distribution is not needed in order to build Exim with cdb support,
6692 because the code for reading cdb files is included directly in Exim itself.
6693 However, no means of building or testing cdb files is provided with Exim, so
6694 you need to obtain a cdb distribution in order to do this.
6695 .next
6696 .cindex "DBM" "lookup type"
6697 .cindex "lookup" "dbm"
6698 .cindex "binary zero" "in lookup key"
6699 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6700 DBM file by looking up the record with the given key. A terminating binary
6701 zero is included in the key that is passed to the DBM library. See section
6702 &<<SECTdb>>& for a discussion of DBM libraries.
6703
6704 .cindex "Berkeley DB library" "file format"
6705 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6706 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6707 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6708 the DB_UNKNOWN option. This enables it to handle any of the types of database
6709 that the library supports, and can be useful for accessing DBM files created by
6710 other applications. (For earlier DB versions, DB_HASH is always used.)
6711 .next
6712 .cindex "lookup" "dbmjz"
6713 .cindex "lookup" "dbm &-- embedded NULs"
6714 .cindex "sasldb2"
6715 .cindex "dbmjz lookup type"
6716 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6717 interpreted as an Exim list; the elements of the list are joined together with
6718 ASCII NUL characters to form the lookup key.  An example usage would be to
6719 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6720 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6721 &(cram_md5)& authenticator.
6722 .next
6723 .cindex "lookup" "dbmnz"
6724 .cindex "lookup" "dbm &-- terminating zero"
6725 .cindex "binary zero" "in lookup key"
6726 .cindex "Courier"
6727 .cindex "&_/etc/userdbshadow.dat_&"
6728 .cindex "dbmnz lookup type"
6729 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6730 is not included in the key that is passed to the DBM library. You may need this
6731 if you want to look up data in files that are created by or shared with some
6732 other application that does not use terminating zeros. For example, you need to
6733 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6734 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6735 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6736 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6737 .next
6738 .cindex "lookup" "dsearch"
6739 .cindex "dsearch lookup type"
6740 &(dsearch)&: The given file must be a directory; this is searched for an entry
6741 whose name is the key by calling the &[lstat()]& function. The key may not
6742 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6743 the lookup is the name of the entry, which may be a file, directory,
6744 symbolic link, or any other kind of directory entry. An example of how this
6745 lookup can be used to support virtual domains is given in section
6746 &<<SECTvirtualdomains>>&.
6747 .next
6748 .cindex "lookup" "iplsearch"
6749 .cindex "iplsearch lookup type"
6750 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6751 terminated by a colon or white space or the end of the line. The keys in the
6752 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6753 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6754 being interpreted as a key terminator. For example:
6755 .code
6756 1.2.3.4:           data for 1.2.3.4
6757 192.168.0.0/16:    data for 192.168.0.0/16
6758 "abcd::cdab":      data for abcd::cdab
6759 "abcd:abcd::/32"   data for abcd:abcd::/32
6760 .endd
6761 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6762 file is searched linearly, using the CIDR masks where present, until a matching
6763 key is found. The first key that matches is used; there is no attempt to find a
6764 &"best"& match. Apart from the way the keys are matched, the processing for
6765 &(iplsearch)& is the same as for &(lsearch)&.
6766
6767 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6768 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6769 lookup types support only literal keys.
6770
6771 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6772 the implicit key is the host's IP address rather than its name (see section
6773 &<<SECThoslispatsikey>>&).
6774
6775 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6776 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6777 notation before executing the lookup.)
6778 .next
6779 .cindex lookup json
6780 .cindex json "lookup type"
6781 .cindex JSON expansions
6782 &(json)&: The given file is a text file with a JSON structure.
6783 An element of the structure is extracted, defined by the search key.
6784 The key is a list of subelement selectors
6785 (colon-separated by default but changeable in the usual way)
6786 which are applied in turn to select smaller and smaller portions
6787 of the JSON structure.
6788 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6789 nunbered array element is selected.
6790 Otherwise it must apply to a JSON object; the named element is selected.
6791 The final resulting element can be a simple JSON type or a JSON object
6792 or array; for the latter two a string-representation os the JSON
6793 is returned.
6794 For elements of type string, the returned value is de-quoted.
6795 .next
6796 .cindex "linear search"
6797 .cindex "lookup" "lsearch"
6798 .cindex "lsearch lookup type"
6799 .cindex "case sensitivity" "in lsearch lookup"
6800 &(lsearch)&: The given file is a text file that is searched linearly for a
6801 line beginning with the search key, terminated by a colon or white space or the
6802 end of the line. The search is case-insensitive; that is, upper and lower case
6803 letters are treated as the same. The first occurrence of the key that is found
6804 in the file is used.
6805
6806 White space between the key and the colon is permitted. The remainder of the
6807 line, with leading and trailing white space removed, is the data. This can be
6808 continued onto subsequent lines by starting them with any amount of white
6809 space, but only a single space character is included in the data at such a
6810 junction. If the data begins with a colon, the key must be terminated by a
6811 colon, for example:
6812 .code
6813 baduser:  :fail:
6814 .endd
6815 Empty lines and lines beginning with # are ignored, even if they occur in the
6816 middle of an item. This is the traditional textual format of alias files. Note
6817 that the keys in an &(lsearch)& file are literal strings. There is no
6818 wildcarding of any kind.
6819
6820 .cindex "lookup" "lsearch &-- colons in keys"
6821 .cindex "white space" "in lsearch key"
6822 In most &(lsearch)& files, keys are not required to contain colons or #
6823 characters, or white space. However, if you need this feature, it is available.
6824 If a key begins with a doublequote character, it is terminated only by a
6825 matching quote (or end of line), and the normal escaping rules apply to its
6826 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6827 quoted keys (exactly as for unquoted keys). There is no special handling of
6828 quotes for the data part of an &(lsearch)& line.
6829
6830 .next
6831 .cindex "NIS lookup type"
6832 .cindex "lookup" "NIS"
6833 .cindex "binary zero" "in lookup key"
6834 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6835 the given key, without a terminating binary zero. There is a variant called
6836 &(nis0)& which does include the terminating binary zero in the key. This is
6837 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6838 aliases; the full map names must be used.
6839
6840 .next
6841 .cindex "wildlsearch lookup type"
6842 .cindex "lookup" "wildlsearch"
6843 .cindex "nwildlsearch lookup type"
6844 .cindex "lookup" "nwildlsearch"
6845 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6846 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6847 the file may be wildcarded. The difference between these two lookup types is
6848 that for &(wildlsearch)&, each key in the file is string-expanded before being
6849 used, whereas for &(nwildlsearch)&, no expansion takes place.
6850
6851 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6852 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6853 file that are regular expressions can be made case-sensitive by the use of
6854 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6855
6856 . ==== As this is a nested list, any displays it contains must be indented
6857 . ==== as otherwise they are too far to the left.
6858
6859 .olist
6860 The string may begin with an asterisk to mean &"ends with"&. For example:
6861 .code
6862     *.a.b.c       data for anything.a.b.c
6863     *fish         data for anythingfish
6864 .endd
6865 .next
6866 The string may begin with a circumflex to indicate a regular expression. For
6867 example, for &(wildlsearch)&:
6868 .code
6869     ^\N\d+\.a\.b\N    data for <digits>.a.b
6870 .endd
6871 Note the use of &`\N`& to disable expansion of the contents of the regular
6872 expression. If you are using &(nwildlsearch)&, where the keys are not
6873 string-expanded, the equivalent entry is:
6874 .code
6875     ^\d+\.a\.b        data for <digits>.a.b
6876 .endd
6877 The case-insensitive flag is set at the start of compiling the regular
6878 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6879 For example, to make the entire pattern case-sensitive:
6880 .code
6881     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6882 .endd
6883
6884 If the regular expression contains white space or colon characters, you must
6885 either quote it (see &(lsearch)& above), or represent these characters in other
6886 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6887 colon. This may be easier than quoting, because if you quote, you have to
6888 escape all the backslashes inside the quotes.
6889
6890 &*Note*&: It is not possible to capture substrings in a regular expression
6891 match for later use, because the results of all lookups are cached. If a lookup
6892 is repeated, the result is taken from the cache, and no actual pattern matching
6893 takes place. The values of all the numeric variables are unset after a
6894 &((n)wildlsearch)& match.
6895
6896 .next
6897 Although I cannot see it being of much use, the general matching function that
6898 is used to implement &((n)wildlsearch)& means that the string may begin with a
6899 lookup name terminated by a semicolon, and followed by lookup data. For
6900 example:
6901 .code
6902     cdb;/some/file  data for keys that match the file
6903 .endd
6904 The data that is obtained from the nested lookup is discarded.
6905 .endlist olist
6906
6907 Keys that do not match any of these patterns are interpreted literally. The
6908 continuation rules for the data are the same as for &(lsearch)&, and keys may
6909 be followed by optional colons.
6910
6911 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6912 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6913 lookup types support only literal keys.
6914
6915 .next
6916 .cindex "lookup" "spf"
6917 If Exim is built with SPF support, manual lookups can be done
6918 (as opposed to the standard ACL condition method.
6919 For details see section &<<SECSPF>>&.
6920 .endlist ilist
6921
6922
6923 .section "Query-style lookup types" "SECTquerystylelookups"
6924 .cindex "lookup" "query-style types"
6925 .cindex "query-style lookup" "list of types"
6926 The supported query-style lookup types are listed below. Further details about
6927 many of them are given in later sections.
6928
6929 .ilist
6930 .cindex "DNS" "as a lookup type"
6931 .cindex "lookup" "DNS"
6932 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6933 are given in the supplied query. The resulting data is the contents of the
6934 records. See section &<<SECTdnsdb>>&.
6935 .next
6936 .cindex "InterBase lookup type"
6937 .cindex "lookup" "InterBase"
6938 &(ibase)&: This does a lookup in an InterBase database.
6939 .next
6940 .cindex "LDAP" "lookup type"
6941 .cindex "lookup" "LDAP"
6942 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6943 returns attributes from a single entry. There is a variant called &(ldapm)&
6944 that permits values from multiple entries to be returned. A third variant
6945 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6946 any attribute values. See section &<<SECTldap>>&.
6947 .next
6948 .cindex "MySQL" "lookup type"
6949 .cindex "lookup" "MySQL"
6950 &(mysql)&: The format of the query is an SQL statement that is passed to a
6951 MySQL database. See section &<<SECTsql>>&.
6952 .next
6953 .cindex "NIS+ lookup type"
6954 .cindex "lookup" "NIS+"
6955 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6956 the field to be returned. See section &<<SECTnisplus>>&.
6957 .next
6958 .cindex "Oracle" "lookup type"
6959 .cindex "lookup" "Oracle"
6960 &(oracle)&: The format of the query is an SQL statement that is passed to an
6961 Oracle database. See section &<<SECTsql>>&.
6962 .next
6963 .cindex "lookup" "passwd"
6964 .cindex "passwd lookup type"
6965 .cindex "&_/etc/passwd_&"
6966 &(passwd)& is a query-style lookup with queries that are just user names. The
6967 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6968 success, the result string is the same as you would get from an &(lsearch)&
6969 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6970 password value. For example:
6971 .code
6972 *:42:42:King Rat:/home/kr:/bin/bash
6973 .endd
6974 .next
6975 .cindex "PostgreSQL lookup type"
6976 .cindex "lookup" "PostgreSQL"
6977 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6978 PostgreSQL database. See section &<<SECTsql>>&.
6979
6980 .next
6981 .cindex "Redis lookup type"
6982 .cindex lookup Redis
6983 &(redis)&: The format of the query is either a simple get or simple set,
6984 passed to a Redis database. See section &<<SECTsql>>&.
6985
6986 .next
6987 .cindex "sqlite lookup type"
6988 .cindex "lookup" "sqlite"
6989 &(sqlite)&: The format of the query is a filename followed by an SQL statement
6990 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6991
6992 .next
6993 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6994 not likely to be useful in normal operation.
6995 .next
6996 .cindex "whoson lookup type"
6997 .cindex "lookup" "whoson"
6998 . --- still http:-only, 2018-09-07
6999 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7000 allows a server to check whether a particular (dynamically allocated) IP
7001 address is currently allocated to a known (trusted) user and, optionally, to
7002 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7003 at one time for &"POP before SMTP"& authentication, but that approach has been
7004 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7005 &"POP before SMTP"& checking using ACL statements such as
7006 .code
7007 require condition = \
7008   ${lookup whoson {$sender_host_address}{yes}{no}}
7009 .endd
7010 The query consists of a single IP address. The value returned is the name of
7011 the authenticated user, which is stored in the variable &$value$&. However, in
7012 this example, the data in &$value$& is not used; the result of the lookup is
7013 one of the fixed strings &"yes"& or &"no"&.
7014 .endlist
7015
7016
7017
7018 .section "Temporary errors in lookups" "SECID63"
7019 .cindex "lookup" "temporary error in"
7020 Lookup functions can return temporary error codes if the lookup cannot be
7021 completed. For example, an SQL or LDAP database might be unavailable. For this
7022 reason, it is not advisable to use a lookup that might do this for critical
7023 options such as a list of local domains.
7024
7025 When a lookup cannot be completed in a router or transport, delivery
7026 of the message (to the relevant address) is deferred, as for any other
7027 temporary error. In other circumstances Exim may assume the lookup has failed,
7028 or may give up altogether.
7029
7030
7031
7032 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7033 .cindex "wildcard lookups"
7034 .cindex "lookup" "default values"
7035 .cindex "lookup" "wildcard"
7036 .cindex "lookup" "* added to type"
7037 .cindex "default" "in single-key lookups"
7038 In this context, a &"default value"& is a value specified by the administrator
7039 that is to be used if a lookup fails.
7040
7041 &*Note:*& This section applies only to single-key lookups. For query-style
7042 lookups, the facilities of the query language must be used. An attempt to
7043 specify a default for a query-style lookup provokes an error.
7044
7045 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7046 and the initial lookup fails, the key &"*"& is looked up in the file to
7047 provide a default value. See also the section on partial matching below.
7048
7049 .cindex "*@ with single-key lookup"
7050 .cindex "lookup" "*@ added to type"
7051 .cindex "alias file" "per-domain default"
7052 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7053 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7054 character, a second lookup is done with everything before the last @ replaced
7055 by *. This makes it possible to provide per-domain defaults in alias files
7056 that include the domains in the keys. If the second lookup fails (or doesn't
7057 take place because there is no @ in the key), &"*"& is looked up.
7058 For example, a &(redirect)& router might contain:
7059 .code
7060 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7061 .endd
7062 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7063 looks up these keys, in this order:
7064 .code
7065 jane@eyre.example
7066 *@eyre.example
7067 *
7068 .endd
7069 The data is taken from whichever key it finds first. &*Note*&: In an
7070 &(lsearch)& file, this does not mean the first of these keys in the file. A
7071 complete scan is done for each key, and only if it is not found at all does
7072 Exim move on to try the next key.
7073
7074
7075
7076 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7077 .cindex "partial matching"
7078 .cindex "wildcard lookups"
7079 .cindex "lookup" "partial matching"
7080 .cindex "lookup" "wildcard"
7081 .cindex "asterisk" "in search type"
7082 The normal operation of a single-key lookup is to search the file for an exact
7083 match with the given key. However, in a number of situations where domains are
7084 being looked up, it is useful to be able to do partial matching. In this case,
7085 information in the file that has a key starting with &"*."& is matched by any
7086 domain that ends with the components that follow the full stop. For example, if
7087 a key in a DBM file is
7088 .code
7089 *.dates.fict.example
7090 .endd
7091 then when partial matching is enabled this is matched by (amongst others)
7092 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7093 by &'dates.fict.example'&, if that does not appear as a separate key in the
7094 file.
7095
7096 &*Note*&: Partial matching is not available for query-style lookups. It is
7097 also not available for any lookup items in address lists (see section
7098 &<<SECTaddresslist>>&).
7099
7100 Partial matching is implemented by doing a series of separate lookups using
7101 keys constructed by modifying the original subject key. This means that it can
7102 be used with any of the single-key lookup types, provided that
7103 partial matching keys
7104 beginning with a special prefix (default &"*."&) are included in the data file.
7105 Keys in the file that do not begin with the prefix are matched only by
7106 unmodified subject keys when partial matching is in use.
7107
7108 Partial matching is requested by adding the string &"partial-"& to the front of
7109 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7110 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7111 is added at the start of the subject key, and it is looked up again. If that
7112 fails, further lookups are tried with dot-separated components removed from the
7113 start of the subject key, one-by-one, and &"*."& added on the front of what
7114 remains.
7115
7116 A minimum number of two non-* components are required. This can be adjusted
7117 by including a number before the hyphen in the search type. For example,
7118 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7119 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7120 subject key is &'2250.dates.fict.example'& then the following keys are looked
7121 up when the minimum number of non-* components is two:
7122 .code
7123 2250.dates.fict.example
7124 *.2250.dates.fict.example
7125 *.dates.fict.example
7126 *.fict.example
7127 .endd
7128 As soon as one key in the sequence is successfully looked up, the lookup
7129 finishes.
7130
7131 .cindex "lookup" "partial matching &-- changing prefix"
7132 .cindex "prefix" "for partial matching"
7133 The use of &"*."& as the partial matching prefix is a default that can be
7134 changed. The motivation for this feature is to allow Exim to operate with file
7135 formats that are used by other MTAs. A different prefix can be supplied in
7136 parentheses instead of the hyphen after &"partial"&. For example:
7137 .code
7138 domains = partial(.)lsearch;/some/file
7139 .endd
7140 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7141 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7142 components is unchanged). The prefix may consist of any punctuation characters
7143 other than a closing parenthesis. It may be empty, for example:
7144 .code
7145 domains = partial1()cdb;/some/file
7146 .endd
7147 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7148 &`a.b.c`&, &`b.c`&, and &`c`&.
7149
7150 If &"partial0"& is specified, what happens at the end (when the lookup with
7151 just one non-wild component has failed, and the original key is shortened right
7152 down to the null string) depends on the prefix:
7153
7154 .ilist
7155 If the prefix has zero length, the whole lookup fails.
7156 .next
7157 If the prefix has length 1, a lookup for just the prefix is done. For
7158 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7159 .next
7160 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7161 remainder is looked up. With the default prefix, therefore, the final lookup is
7162 for &"*"& on its own.
7163 .next
7164 Otherwise, the whole prefix is looked up.
7165 .endlist
7166
7167
7168 If the search type ends in &"*"& or &"*@"& (see section
7169 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7170 this implies happens after all partial lookups have failed. If &"partial0"& is
7171 specified, adding &"*"& to the search type has no effect with the default
7172 prefix, because the &"*"& key is already included in the sequence of partial
7173 lookups. However, there might be a use for lookup types such as
7174 &"partial0(.)lsearch*"&.
7175
7176 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7177 in domain lists and the like. Partial matching works only in terms of
7178 dot-separated components; a key such as &`*fict.example`&
7179 in a database file is useless, because the asterisk in a partial matching
7180 subject key is always followed by a dot.
7181
7182
7183
7184
7185 .section "Lookup caching" "SECID64"
7186 .cindex "lookup" "caching"
7187 .cindex "caching" "lookup data"
7188 Exim caches all lookup results in order to avoid needless repetition of
7189 lookups. However, because (apart from the daemon) Exim operates as a collection
7190 of independent, short-lived processes, this caching applies only within a
7191 single Exim process. There is no inter-process lookup caching facility.
7192
7193 For single-key lookups, Exim keeps the relevant files open in case there is
7194 another lookup that needs them. In some types of configuration this can lead to
7195 many files being kept open for messages with many recipients. To avoid hitting
7196 the operating system limit on the number of simultaneously open files, Exim
7197 closes the least recently used file when it needs to open more files than its
7198 own internal limit, which can be changed via the &%lookup_open_max%& option.
7199
7200 The single-key lookup files are closed and the lookup caches are flushed at
7201 strategic points during delivery &-- for example, after all routing is
7202 complete.
7203
7204
7205
7206
7207 .section "Quoting lookup data" "SECID65"
7208 .cindex "lookup" "quoting"
7209 .cindex "quoting" "in lookups"
7210 When data from an incoming message is included in a query-style lookup, there
7211 is the possibility of special characters in the data messing up the syntax of
7212 the query. For example, a NIS+ query that contains
7213 .code
7214 [name=$local_part]
7215 .endd
7216 will be broken if the local part happens to contain a closing square bracket.
7217 For NIS+, data can be enclosed in double quotes like this:
7218 .code
7219 [name="$local_part"]
7220 .endd
7221 but this still leaves the problem of a double quote in the data. The rule for
7222 NIS+ is that double quotes must be doubled. Other lookup types have different
7223 rules, and to cope with the differing requirements, an expansion operator
7224 of the following form is provided:
7225 .code
7226 ${quote_<lookup-type>:<string>}
7227 .endd
7228 For example, the safest way to write the NIS+ query is
7229 .code
7230 [name="${quote_nisplus:$local_part}"]
7231 .endd
7232 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7233 operator can be used for all lookup types, but has no effect for single-key
7234 lookups, since no quoting is ever needed in their key strings.
7235
7236
7237
7238
7239 .section "More about dnsdb" "SECTdnsdb"
7240 .cindex "dnsdb lookup"
7241 .cindex "lookup" "dnsdb"
7242 .cindex "DNS" "as a lookup type"
7243 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7244 of a record type and a domain name, separated by an equals sign. For example,
7245 an expansion string could contain:
7246 .code
7247 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7248 .endd
7249 If the lookup succeeds, the result is placed in &$value$&, which in this case
7250 is used on its own as the result. If the lookup does not succeed, the
7251 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7252 &<<SECTforexpfai>>& for an explanation of what this means.
7253
7254 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7255 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7256 If no type is given, TXT is assumed.
7257
7258 For any record type, if multiple records are found, the data is returned as a
7259 concatenation, with newline as the default separator. The order, of course,
7260 depends on the DNS resolver. You can specify a different separator character
7261 between multiple records by putting a right angle-bracket followed immediately
7262 by the new separator at the start of the query. For example:
7263 .code
7264 ${lookup dnsdb{>: a=host1.example}}
7265 .endd
7266 It is permitted to specify a space as the separator character. Further
7267 white space is ignored.
7268 For lookup types that return multiple fields per record,
7269 an alternate field separator can be specified using a comma after the main
7270 separator character, followed immediately by the field separator.
7271
7272 .cindex "PTR record" "in &(dnsdb)& lookup"
7273 When the type is PTR,
7274 the data can be an IP address, written as normal; inversion and the addition of
7275 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7276 .code
7277 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7278 .endd
7279 If the data for a PTR record is not a syntactically valid IP address, it is not
7280 altered and nothing is added.
7281
7282 .cindex "MX record" "in &(dnsdb)& lookup"
7283 .cindex "SRV record" "in &(dnsdb)& lookup"
7284 For an MX lookup, both the preference value and the host name are returned for
7285 each record, separated by a space. For an SRV lookup, the priority, weight,
7286 port, and host name are returned for each record, separated by spaces.
7287 The field separator can be modified as above.
7288
7289 .cindex "TXT record" "in &(dnsdb)& lookup"
7290 .cindex "SPF record" "in &(dnsdb)& lookup"
7291 For TXT records with multiple items of data, only the first item is returned,
7292 unless a field separator is specified.
7293 To concatenate items without a separator, use a semicolon instead.
7294 For SPF records the
7295 default behaviour is to concatenate multiple items without using a separator.
7296 .code
7297 ${lookup dnsdb{>\n,: txt=a.b.example}}
7298 ${lookup dnsdb{>\n; txt=a.b.example}}
7299 ${lookup dnsdb{spf=example.org}}
7300 .endd
7301 It is permitted to specify a space as the separator character. Further
7302 white space is ignored.
7303
7304 .cindex "SOA record" "in &(dnsdb)& lookup"
7305 For an SOA lookup, while no result is obtained the lookup is redone with
7306 successively more leading components dropped from the given domain.
7307 Only the primary-nameserver field is returned unless a field separator is
7308 specified.
7309 .code
7310 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7311 .endd
7312
7313 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7314 .cindex "dnsdb modifiers"
7315 .cindex "modifiers" "dnsdb"
7316 .cindex "options" "dnsdb"
7317 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7318 each followed by a comma,
7319 that may appear before the record type.
7320
7321 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7322 temporary DNS error for any of them, the behaviour is controlled by
7323 a defer-option modifier.
7324 The possible keywords are
7325 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7326 With &"strict"& behaviour, any temporary DNS error causes the
7327 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7328 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7329 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7330 error causes the whole lookup to defer only if none of the other lookups
7331 succeed. The default is &"lax"&, so the following lookups are equivalent:
7332 .code
7333 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7334 ${lookup dnsdb{a=one.host.com:two.host.com}}
7335 .endd
7336 Thus, in the default case, as long as at least one of the DNS lookups
7337 yields some data, the lookup succeeds.
7338
7339 .cindex "DNSSEC" "dns lookup"
7340 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7341 The possible keywords are
7342 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7343 With &"strict"& or &"lax"& DNSSEC information is requested
7344 with the lookup.
7345 With &"strict"& a response from the DNS resolver that
7346 is not labelled as authenticated data
7347 is treated as equivalent to a temporary DNS error.
7348 The default is &"lax"&.
7349
7350 See also the &$lookup_dnssec_authenticated$& variable.
7351
7352 .cindex timeout "dns lookup"
7353 .cindex "DNS" timeout
7354 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7355 The form is &"retrans_VAL"& where VAL is an Exim time specification
7356 (e.g. &"5s"&).
7357 The default value is set by the main configuration option &%dns_retrans%&.
7358
7359 Retries for the dnsdb lookup can be controlled by a retry modifier.
7360 The form if &"retry_VAL"& where VAL is an integer.
7361 The default count is set by the main configuration option &%dns_retry%&.
7362
7363 .cindex caching "of dns lookup"
7364 .cindex TTL "of dns lookup"
7365 .cindex DNS TTL
7366 Dnsdb lookup results are cached within a single process (and its children).
7367 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7368 value of the set of returned DNS records.
7369
7370
7371 .section "Pseudo dnsdb record types" "SECID66"
7372 .cindex "MX record" "in &(dnsdb)& lookup"
7373 By default, both the preference value and the host name are returned for
7374 each MX record, separated by a space. If you want only host names, you can use
7375 the pseudo-type MXH:
7376 .code
7377 ${lookup dnsdb{mxh=a.b.example}}
7378 .endd
7379 In this case, the preference values are omitted, and just the host names are
7380 returned.
7381
7382 .cindex "name server for enclosing domain"
7383 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7384 records on the given domain, but if none are found, it removes the first
7385 component of the domain name, and tries again. This process continues until NS
7386 records are found or there are no more components left (or there is a DNS
7387 error). In other words, it may return the name servers for a top-level domain,
7388 but it never returns the root name servers. If there are no NS records for the
7389 top-level domain, the lookup fails. Consider these examples:
7390 .code
7391 ${lookup dnsdb{zns=xxx.quercite.com}}
7392 ${lookup dnsdb{zns=xxx.edu}}
7393 .endd
7394 Assuming that in each case there are no NS records for the full domain name,
7395 the first returns the name servers for &%quercite.com%&, and the second returns
7396 the name servers for &%edu%&.
7397
7398 You should be careful about how you use this lookup because, unless the
7399 top-level domain does not exist, the lookup always returns some host names. The
7400 sort of use to which this might be put is for seeing if the name servers for a
7401 given domain are on a blacklist. You can probably assume that the name servers
7402 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7403 such a list.
7404
7405 .cindex "CSA" "in &(dnsdb)& lookup"
7406 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7407 records according to the CSA rules, which are described in section
7408 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7409 not sufficient because of the extra parent domain search behaviour of CSA. The
7410 result of a successful lookup such as:
7411 .code
7412 ${lookup dnsdb {csa=$sender_helo_name}}
7413 .endd
7414 has two space-separated fields: an authorization code and a target host name.
7415 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7416 authorization required but absent, or &"?"& for unknown.
7417
7418 .cindex "A+" "in &(dnsdb)& lookup"
7419 The pseudo-type A+ performs an AAAA
7420 and then an A lookup.  All results are returned; defer processing
7421 (see below) is handled separately for each lookup.  Example:
7422 .code
7423 ${lookup dnsdb {>; a+=$sender_helo_name}}
7424 .endd
7425
7426
7427 .section "Multiple dnsdb lookups" "SECID67"
7428 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7429 However, you can specify a list of domains or IP addresses in a single
7430 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7431 the default separator, but with the ability to change this. For example:
7432 .code
7433 ${lookup dnsdb{one.domain.com:two.domain.com}}
7434 ${lookup dnsdb{a=one.host.com:two.host.com}}
7435 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7436 .endd
7437 In order to retain backwards compatibility, there is one special case: if
7438 the lookup type is PTR and no change of separator is specified, Exim looks
7439 to see if the rest of the string is precisely one IPv6 address. In this
7440 case, it does not treat it as a list.
7441
7442 The data from each lookup is concatenated, with newline separators by default,
7443 in the same way that multiple DNS records for a single item are handled. A
7444 different separator can be specified, as described above.
7445
7446
7447
7448
7449 .section "More about LDAP" "SECTldap"
7450 .cindex "LDAP" "lookup, more about"
7451 .cindex "lookup" "LDAP"
7452 .cindex "Solaris" "LDAP"
7453 The original LDAP implementation came from the University of Michigan; this has
7454 become &"Open LDAP"&, and there are now two different releases. Another
7455 implementation comes from Netscape, and Solaris 7 and subsequent releases
7456 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7457 the lookup function level, their error handling is different. For this reason
7458 it is necessary to set a compile-time variable when building Exim with LDAP, to
7459 indicate which LDAP library is in use. One of the following should appear in
7460 your &_Local/Makefile_&:
7461 .code
7462 LDAP_LIB_TYPE=UMICHIGAN
7463 LDAP_LIB_TYPE=OPENLDAP1
7464 LDAP_LIB_TYPE=OPENLDAP2
7465 LDAP_LIB_TYPE=NETSCAPE
7466 LDAP_LIB_TYPE=SOLARIS
7467 .endd
7468 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7469 same interface as the University of Michigan version.
7470
7471 There are three LDAP lookup types in Exim. These behave slightly differently in
7472 the way they handle the results of a query:
7473
7474 .ilist
7475 &(ldap)& requires the result to contain just one entry; if there are more, it
7476 gives an error.
7477 .next
7478 &(ldapdn)& also requires the result to contain just one entry, but it is the
7479 Distinguished Name that is returned rather than any attribute values.
7480 .next
7481 &(ldapm)& permits the result to contain more than one entry; the attributes
7482 from all of them are returned.
7483 .endlist
7484
7485
7486 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7487 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7488 the data returned by a successful lookup is described in the next section.
7489 First we explain how LDAP queries are coded.
7490
7491
7492 .section "Format of LDAP queries" "SECTforldaque"
7493 .cindex "LDAP" "query format"
7494 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7495 the configuration of a &(redirect)& router one might have this setting:
7496 .code
7497 data = ${lookup ldap \
7498   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7499   c=UK?mailbox?base?}}
7500 .endd
7501 .cindex "LDAP" "with TLS"
7502 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7503 secure (encrypted) LDAP connections. The second of these ensures that an
7504 encrypted TLS connection is used.
7505
7506 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7507 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7508 See the &%ldap_start_tls%& option.
7509
7510 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7511 controlled. Every part of the TLS configuration can be configured by settings in
7512 &_exim.conf_&. Depending on the version of the client libraries installed on
7513 your system, some of the initialization may have required setting options in
7514 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7515 certificates. This revealed a nuance where the current UID that exim was
7516 running as could affect which config files it read. With Exim 4.83, these
7517 methods become optional, only taking effect if not specifically set in
7518 &_exim.conf_&.
7519
7520
7521 .section "LDAP quoting" "SECID68"
7522 .cindex "LDAP" "quoting"
7523 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7524 and the second because the LDAP query is represented as a URL. Furthermore,
7525 within an LDAP query, two different kinds of quoting are required. For this
7526 reason, there are two different LDAP-specific quoting operators.
7527
7528 The &%quote_ldap%& operator is designed for use on strings that are part of
7529 filter specifications. Conceptually, it first does the following conversions on
7530 the string:
7531 .code
7532 *   =>   \2A
7533 (   =>   \28
7534 )   =>   \29
7535 \   =>   \5C
7536 .endd
7537 in accordance with RFC 2254. The resulting string is then quoted according
7538 to the rules for URLs, that is, all non-alphanumeric characters except
7539 .code
7540 ! $ ' - . _ ( ) * +
7541 .endd
7542 are converted to their hex values, preceded by a percent sign. For example:
7543 .code
7544 ${quote_ldap: a(bc)*, a<yz>; }
7545 .endd
7546 yields
7547 .code
7548 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7549 .endd
7550 Removing the URL quoting, this is (with a leading and a trailing space):
7551 .code
7552 a\28bc\29\2A, a<yz>;
7553 .endd
7554 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7555 base DN specifications in queries. Conceptually, it first converts the string
7556 by inserting a backslash in front of any of the following characters:
7557 .code
7558 , + " \ < > ;
7559 .endd
7560 It also inserts a backslash before any leading spaces or # characters, and
7561 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7562 is then quoted according to the rules for URLs. For example:
7563 .code
7564 ${quote_ldap_dn: a(bc)*, a<yz>; }
7565 .endd
7566 yields
7567 .code
7568 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7569 .endd
7570 Removing the URL quoting, this is (with a trailing space):
7571 .code
7572 \ a(bc)*\, a\<yz\>\;\
7573 .endd
7574 There are some further comments about quoting in the section on LDAP
7575 authentication below.
7576
7577
7578 .section "LDAP connections" "SECID69"
7579 .cindex "LDAP" "connections"
7580 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7581 is in use, via a Unix domain socket. The example given above does not specify
7582 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7583 by starting it with
7584 .code
7585 ldap://<hostname>:<port>/...
7586 .endd
7587 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7588 used. When no server is specified in a query, a list of default servers is
7589 taken from the &%ldap_default_servers%& configuration option. This supplies a
7590 colon-separated list of servers which are tried in turn until one successfully
7591 handles a query, or there is a serious error. Successful handling either
7592 returns the requested data, or indicates that it does not exist. Serious errors
7593 are syntactical, or multiple values when only a single value is expected.
7594 Errors which cause the next server to be tried are connection failures, bind
7595 failures, and timeouts.
7596
7597 For each server name in the list, a port number can be given. The standard way
7598 of specifying a host and port is to use a colon separator (RFC 1738). Because
7599 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7600 doubled. For example
7601 .code
7602 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7603 .endd
7604 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7605 to the LDAP library with no server name, and the library's default (normally
7606 the local host) is used.
7607
7608 If you are using the OpenLDAP library, you can connect to an LDAP server using
7609 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7610 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7611 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7612 not available.
7613
7614 For this type of connection, instead of a host name for the server, a pathname
7615 for the socket is required, and the port number is not relevant. The pathname
7616 can be specified either as an item in &%ldap_default_servers%&, or inline in
7617 the query. In the former case, you can have settings such as
7618 .code
7619 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7620 .endd
7621 When the pathname is given in the query, you have to escape the slashes as
7622 &`%2F`& to fit in with the LDAP URL syntax. For example:
7623 .code
7624 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7625 .endd
7626 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7627 a pathname, it uses the Unix domain socket code, even if the query actually
7628 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7629 socket connection. This behaviour means that you can use a setting of
7630 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7631 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7632 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7633 backup host.
7634
7635 If an explicit &`ldapi`& type is given in a query when a host name is
7636 specified, an error is diagnosed. However, if there are more items in
7637 &%ldap_default_servers%&, they are tried. In other words:
7638
7639 .ilist
7640 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7641 interface.
7642 .next
7643 Using &`ldapi`& with a host name causes an error.
7644 .endlist
7645
7646
7647 Using &`ldapi`& with no host or path in the query, and no setting of
7648 &%ldap_default_servers%&, does whatever the library does by default.
7649
7650
7651
7652 .section "LDAP authentication and control information" "SECID70"
7653 .cindex "LDAP" "authentication"
7654 The LDAP URL syntax provides no way of passing authentication and other control
7655 information to the server. To make this possible, the URL in an LDAP query may
7656 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7657 spaces. If a value contains spaces it must be enclosed in double quotes, and
7658 when double quotes are used, backslash is interpreted in the usual way inside
7659 them. The following names are recognized:
7660 .display
7661 &`DEREFERENCE`&  set the dereferencing parameter
7662 &`NETTIME    `&  set a timeout for a network operation
7663 &`USER       `&  set the DN, for authenticating the LDAP bind
7664 &`PASS       `&  set the password, likewise
7665 &`REFERRALS  `&  set the referrals parameter
7666 &`SERVERS    `&  set alternate server list for this query only
7667 &`SIZE       `&  set the limit for the number of entries returned
7668 &`TIME       `&  set the maximum waiting time for a query
7669 .endd
7670 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7671 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7672 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7673 library from trying to follow referrals issued by the LDAP server.
7674
7675 .cindex LDAP timeout
7676 .cindex timeout "LDAP lookup"
7677 The name CONNECT is an obsolete name for NETTIME, retained for
7678 backwards compatibility. This timeout (specified as a number of seconds) is
7679 enforced from the client end for operations that can be carried out over a
7680 network. Specifically, it applies to network connections and calls to the
7681 &'ldap_result()'& function. If the value is greater than zero, it is used if
7682 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7683 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7684 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7685 Netscape SDK; for OpenLDAP no action is taken.
7686
7687 The TIME parameter (also a number of seconds) is passed to the server to
7688 set a server-side limit on the time taken to complete a search.
7689
7690 The SERVERS parameter allows you to specify an alternate list of ldap servers
7691 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7692 default list of ldap servers, and a single lookup can specify a single ldap
7693 server to use.  But when you need to do a lookup with a list of servers that is
7694 different than the default list (maybe different order, maybe a completely
7695 different set of servers), the SERVERS parameter allows you to specify this
7696 alternate list (colon-separated).
7697
7698 Here is an example of an LDAP query in an Exim lookup that uses some of these
7699 values. This is a single line, folded to fit on the page:
7700 .code
7701 ${lookup ldap
7702   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7703   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7704   {$value}fail}
7705 .endd
7706 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7707 any of the auxiliary data. Exim configuration settings that include lookups
7708 which contain password information should be preceded by &"hide"& to prevent
7709 non-admin users from using the &%-bP%& option to see their values.
7710
7711 The auxiliary data items may be given in any order. The default is no
7712 connection timeout (the system timeout is used), no user or password, no limit
7713 on the number of entries returned, and no time limit on queries.
7714
7715 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7716 removes any URL quoting that it may contain before passing it LDAP. Apparently
7717 some libraries do this for themselves, but some do not. Removing the URL
7718 quoting has two advantages:
7719
7720 .ilist
7721 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7722 DNs as with DNs inside actual queries.
7723 .next
7724 It permits spaces inside USER= DNs.
7725 .endlist
7726
7727 For example, a setting such as
7728 .code
7729 USER=cn=${quote_ldap_dn:$1}
7730 .endd
7731 should work even if &$1$& contains spaces.
7732
7733 Expanded data for the PASS= value should be quoted using the &%quote%&
7734 expansion operator, rather than the LDAP quote operators. The only reason this
7735 field needs quoting is to ensure that it conforms to the Exim syntax, which
7736 does not allow unquoted spaces. For example:
7737 .code
7738 PASS=${quote:$3}
7739 .endd
7740 The LDAP authentication mechanism can be used to check passwords as part of
7741 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7742 &<<CHAPexpand>>&.
7743
7744
7745
7746 .section "Format of data returned by LDAP" "SECID71"
7747 .cindex "LDAP" "returned data formats"
7748 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7749 as a sequence of values, for example
7750 .code
7751 cn=manager,o=University of Cambridge,c=UK
7752 .endd
7753 The &(ldap)& lookup type generates an error if more than one entry matches the
7754 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7755 the result between the data from different entries. It is possible for multiple
7756 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7757 you know that whatever values are returned all came from a single entry in the
7758 directory.
7759
7760 In the common case where you specify a single attribute in your LDAP query, the
7761 result is not quoted, and does not contain the attribute name. If the attribute
7762 has multiple values, they are separated by commas. Any comma that is
7763 part of an attribute's value is doubled.
7764
7765 If you specify multiple attributes, the result contains space-separated, quoted
7766 strings, each preceded by the attribute name and an equals sign. Within the
7767 quotes, the quote character, backslash, and newline are escaped with
7768 backslashes, and commas are used to separate multiple values for the attribute.
7769 Any commas in attribute values are doubled
7770 (permitting treatment of the values as a comma-separated list).
7771 Apart from the escaping, the string within quotes takes the same form as the
7772 output when a single attribute is requested. Specifying no attributes is the
7773 same as specifying all of an entry's attributes.
7774
7775 Here are some examples of the output format. The first line of each pair is an
7776 LDAP query, and the second is the data that is returned. The attribute called
7777 &%attr1%& has two values, one of them with an embedded comma, whereas
7778 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7779 (they have SUP &%attr%& in their schema definitions).
7780
7781 .code
7782 ldap:///o=base?attr1?sub?(uid=fred)
7783 value1.1,value1,,2
7784
7785 ldap:///o=base?attr2?sub?(uid=fred)
7786 value two
7787
7788 ldap:///o=base?attr?sub?(uid=fred)
7789 value1.1,value1,,2,value two
7790
7791 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7792 attr1="value1.1,value1,,2" attr2="value two"
7793
7794 ldap:///o=base??sub?(uid=fred)
7795 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7796 .endd
7797 You can
7798 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7799 results of LDAP lookups.
7800 The &%extract%& operator in string expansions can be used to pick out
7801 individual fields from data that consists of &'key'&=&'value'& pairs.
7802 The &%listextract%& operator should be used to pick out individual values
7803 of attributes, even when only a single value is expected.
7804 The doubling of embedded commas allows you to use the returned data as a
7805 comma separated list (using the "<," syntax for changing the input list separator).
7806
7807
7808
7809
7810 .section "More about NIS+" "SECTnisplus"
7811 .cindex "NIS+ lookup type"
7812 .cindex "lookup" "NIS+"
7813 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7814 and field name. If this is given, the result of a successful query is the
7815 contents of the named field; otherwise the result consists of a concatenation
7816 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7817 values containing spaces are quoted. For example, the query
7818 .code
7819 [name=mg1456],passwd.org_dir
7820 .endd
7821 might return the string
7822 .code
7823 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7824 home=/home/mg1456 shell=/bin/bash shadow=""
7825 .endd
7826 (split over two lines here to fit on the page), whereas
7827 .code
7828 [name=mg1456],passwd.org_dir:gcos
7829 .endd
7830 would just return
7831 .code
7832 Martin Guerre
7833 .endd
7834 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7835 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7836 operator is to double any quote characters within the text.
7837
7838
7839
7840 .section "SQL lookups" "SECTsql"
7841 .cindex "SQL lookup types"
7842 .cindex "MySQL" "lookup type"
7843 .cindex "PostgreSQL lookup type"
7844 .cindex "lookup" "MySQL"
7845 .cindex "lookup" "PostgreSQL"
7846 .cindex "Oracle" "lookup type"
7847 .cindex "lookup" "Oracle"
7848 .cindex "InterBase lookup type"
7849 .cindex "lookup" "InterBase"
7850 .cindex "Redis lookup type"
7851 .cindex lookup Redis
7852 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7853 and SQLite
7854 databases. Queries for these databases contain SQL statements, so an example
7855 might be
7856 .code
7857 ${lookup mysql{select mailbox from users where id='userx'}\
7858   {$value}fail}
7859 .endd
7860 If the result of the query contains more than one field, the data for each
7861 field in the row is returned, preceded by its name, so the result of
7862 .code
7863 ${lookup pgsql{select home,name from users where id='userx'}\
7864   {$value}}
7865 .endd
7866 might be
7867 .code
7868 home=/home/userx name="Mister X"
7869 .endd
7870 Empty values and values containing spaces are double quoted, with embedded
7871 quotes escaped by a backslash. If the result of the query contains just one
7872 field, the value is passed back verbatim, without a field name, for example:
7873 .code
7874 Mister X
7875 .endd
7876 If the result of the query yields more than one row, it is all concatenated,
7877 with a newline between the data for each row.
7878
7879
7880 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7881 .cindex "MySQL" "lookup type"
7882 .cindex "PostgreSQL lookup type"
7883 .cindex "lookup" "MySQL"
7884 .cindex "lookup" "PostgreSQL"
7885 .cindex "Oracle" "lookup type"
7886 .cindex "lookup" "Oracle"
7887 .cindex "InterBase lookup type"
7888 .cindex "lookup" "InterBase"
7889 .cindex "Redis lookup type"
7890 .cindex lookup Redis
7891 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7892 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7893 or &%redis_servers%&
7894 option (as appropriate) must be set to a colon-separated list of server
7895 information.
7896 (For MySQL and PostgreSQL, the global option need not be set if all
7897 queries contain their own server information &-- see section
7898 &<<SECTspeserque>>&.)
7899 For all but Redis
7900 each item in the list is a slash-separated list of four
7901 items: host name, database name, user name, and password. In the case of
7902 Oracle, the host name field is used for the &"service name"&, and the database
7903 name field is not used and should be empty. For example:
7904 .code
7905 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7906 .endd
7907 Because password data is sensitive, you should always precede the setting with
7908 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7909 option. Here is an example where two MySQL servers are listed:
7910 .code
7911 hide mysql_servers = localhost/users/root/secret:\
7912                      otherhost/users/root/othersecret
7913 .endd
7914 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7915 because this is a colon-separated list, the colon has to be doubled. For each
7916 query, these parameter groups are tried in order until a connection is made and
7917 a query is successfully processed. The result of a query may be that no data is
7918 found, but that is still a successful query. In other words, the list of
7919 servers provides a backup facility, not a list of different places to look.
7920
7921 For Redis the global option need not be specified if all queries contain their
7922 own server information &-- see section &<<SECTspeserque>>&.
7923 If specified, the option must be set to a colon-separated list of server
7924 information.
7925 Each item in the list is a slash-separated list of three items:
7926 host, database number, and password.
7927 .olist
7928 The host is required and may be either an IPv4 address and optional
7929 port number (separated by a colon, which needs doubling due to the
7930 higher-level list), or a Unix socket pathname enclosed in parentheses
7931 .next
7932 The database number is optional; if present that number is selected in the backend
7933 .next
7934 The password is optional; if present it is used to authenticate to the backend
7935 .endlist
7936
7937 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7938 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7939 respectively, and the characters single-quote, double-quote, and backslash
7940 itself are escaped with backslashes.
7941
7942 The &%quote_redis%& expansion operator
7943 escapes whitespace and backslash characters with a backslash.
7944
7945 .section "Specifying the server in the query" "SECTspeserque"
7946 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7947 it is possible to specify a list of servers with an individual query. This is
7948 done by starting the query with
7949 .display
7950 &`servers=`&&'server1:server2:server3:...'&&`;`&
7951 .endd
7952 Each item in the list may take one of two forms:
7953 .olist
7954 If it contains no slashes it is assumed to be just a host name. The appropriate
7955 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7956 of the same name, and the remaining parameters (database, user, password) are
7957 taken from there.
7958 .next
7959 If it contains any slashes, it is taken as a complete parameter set.
7960 .endlist
7961 The list of servers is used in exactly the same way as the global list.
7962 Once a connection to a server has happened and a query has been
7963 successfully executed, processing of the lookup ceases.
7964
7965 This feature is intended for use in master/slave situations where updates
7966 are occurring and you want to update the master rather than a slave. If the
7967 master is in the list as a backup for reading, you might have a global setting
7968 like this:
7969 .code
7970 mysql_servers = slave1/db/name/pw:\
7971                 slave2/db/name/pw:\
7972                 master/db/name/pw
7973 .endd
7974 In an updating lookup, you could then write:
7975 .code
7976 ${lookup mysql{servers=master; UPDATE ...} }
7977 .endd
7978 That query would then be sent only to the master server. If, on the other hand,
7979 the master is not to be used for reading, and so is not present in the global
7980 option, you can still update it by a query of this form:
7981 .code
7982 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7983 .endd
7984
7985
7986 .section "Special MySQL features" "SECID73"
7987 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7988 causes a connection to the server on the local host by means of a Unix domain
7989 socket. An alternate socket can be specified in parentheses.
7990 An option group name for MySQL option files can be specified in square brackets;
7991 the default value is &"exim"&.
7992 The full syntax of each item in &%mysql_servers%& is:
7993 .display
7994 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7995   <&'database'&>/<&'user'&>/<&'password'&>
7996 .endd
7997 Any of the four sub-parts of the first field can be omitted. For normal use on
7998 the local host it can be left blank or set to just &"localhost"&.
7999
8000 No database need be supplied &-- but if it is absent here, it must be given in
8001 the queries.
8002
8003 If a MySQL query is issued that does not request any data (an insert, update,
8004 or delete command), the result of the lookup is the number of rows affected.
8005
8006 &*Warning*&: This can be misleading. If an update does not actually change
8007 anything (for example, setting a field to the value it already has), the result
8008 is zero because no rows are affected.
8009
8010
8011 .section "Special PostgreSQL features" "SECID74"
8012 PostgreSQL lookups can also use Unix domain socket connections to the database.
8013 This is usually faster and costs less CPU time than a TCP/IP connection.
8014 However it can be used only if the mail server runs on the same machine as the
8015 database server. A configuration line for PostgreSQL via Unix domain sockets
8016 looks like this:
8017 .code
8018 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8019 .endd
8020 In other words, instead of supplying a host name, a path to the socket is
8021 given. The path name is enclosed in parentheses so that its slashes aren't
8022 visually confused with the delimiters for the other server parameters.
8023
8024 If a PostgreSQL query is issued that does not request any data (an insert,
8025 update, or delete command), the result of the lookup is the number of rows
8026 affected.
8027
8028 .section "More about SQLite" "SECTsqlite"
8029 .cindex "lookup" "SQLite"
8030 .cindex "sqlite lookup type"
8031 SQLite is different to the other SQL lookups because a filename is required in
8032 addition to the SQL query. An SQLite database is a single file, and there is no
8033 daemon as in the other SQL databases. The interface to Exim requires the name
8034 of the file, as an absolute path, to be given at the start of the query. It is
8035 separated from the query by white space. This means that the path name cannot
8036 contain white space. Here is a lookup expansion example:
8037 .code
8038 ${lookup sqlite {/some/thing/sqlitedb \
8039   select name from aliases where id='userx';}}
8040 .endd
8041 In a list, the syntax is similar. For example:
8042 .code
8043 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8044    select * from relays where ip='$sender_host_address';
8045 .endd
8046 The only character affected by the &%quote_sqlite%& operator is a single
8047 quote, which it doubles.
8048
8049 .cindex timeout SQLite
8050 .cindex sqlite "lookup timeout"
8051 The SQLite library handles multiple simultaneous accesses to the database
8052 internally. Multiple readers are permitted, but only one process can
8053 update at once. Attempts to access the database while it is being updated
8054 are rejected after a timeout period, during which the SQLite library
8055 waits for the lock to be released. In Exim, the default timeout is set
8056 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8057 option.
8058
8059 .section "More about Redis" "SECTredis"
8060 .cindex "lookup" "Redis"
8061 .cindex "redis lookup type"
8062 Redis is a non-SQL database. Commands are simple get and set.
8063 Examples:
8064 .code
8065 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8066 ${lookup redis{get keyname}}
8067 .endd
8068
8069 As of release 4.91, "lightweight" support for Redis Cluster is available.
8070 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8071 of which must be reachable from the running exim instance. If the cluster has
8072 master/slave replication, the list must contain all the master and slave
8073 servers.
8074
8075 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8076 immediately follow the redirection but treats the response as a DEFER, moving on
8077 to the next server in the &%redis_servers%& list until the correct server is
8078 reached.
8079
8080 .ecindex IIDfidalo1
8081 .ecindex IIDfidalo2
8082
8083
8084 . ////////////////////////////////////////////////////////////////////////////
8085 . ////////////////////////////////////////////////////////////////////////////
8086
8087 .chapter "Domain, host, address, and local part lists" &&&
8088          "CHAPdomhosaddlists" &&&
8089          "Domain, host, and address lists"
8090 .scindex IIDdohoadli "lists of domains; hosts; etc."
8091 A number of Exim configuration options contain lists of domains, hosts,
8092 email addresses, or local parts. For example, the &%hold_domains%& option
8093 contains a list of domains whose delivery is currently suspended. These lists
8094 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8095 arguments to expansion conditions such as &%match_domain%&.
8096
8097 Each item in one of these lists is a pattern to be matched against a domain,
8098 host, email address, or local part, respectively. In the sections below, the
8099 different types of pattern for each case are described, but first we cover some
8100 general facilities that apply to all four kinds of list.
8101
8102 Note that other parts of Exim use a &'string list'& which does not
8103 support all the complexity available in
8104 domain, host, address and local part lists.
8105
8106
8107
8108 .section "Expansion of lists" "SECTlistexpand"
8109 .cindex "expansion" "of lists"
8110 Each list is expanded as a single string before it is used.
8111
8112 &'Exception: the router headers_remove option, where list-item
8113 splitting is done before string-expansion.'&
8114
8115 The result of
8116 expansion must be a list, possibly containing empty items, which is split up
8117 into separate items for matching. By default, colon is the separator character,
8118 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8119 &<<SECTempitelis>>& for details of the list syntax; the second of these
8120 discusses the way to specify empty list items.
8121
8122
8123 If the string expansion is forced to fail, Exim behaves as if the item it is
8124 testing (domain, host, address, or local part) is not in the list. Other
8125 expansion failures cause temporary errors.
8126
8127 If an item in a list is a regular expression, backslashes, dollars and possibly
8128 other special characters in the expression must be protected against
8129 misinterpretation by the string expander. The easiest way to do this is to use
8130 the &`\N`& expansion feature to indicate that the contents of the regular
8131 expression should not be expanded. For example, in an ACL you might have:
8132 .code
8133 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8134                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8135 .endd
8136 The first item is a regular expression that is protected from expansion by
8137 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8138 senders based on the receiving domain.
8139
8140
8141
8142
8143 .section "Negated items in lists" "SECID76"
8144 .cindex "list" "negation"
8145 .cindex "negation" "in lists"
8146 Items in a list may be positive or negative. Negative items are indicated by a
8147 leading exclamation mark, which may be followed by optional white space. A list
8148 defines a set of items (domains, etc). When Exim processes one of these lists,
8149 it is trying to find out whether a domain, host, address, or local part
8150 (respectively) is in the set that is defined by the list. It works like this:
8151
8152 The list is scanned from left to right. If a positive item is matched, the
8153 subject that is being checked is in the set; if a negative item is matched, the
8154 subject is not in the set. If the end of the list is reached without the
8155 subject having matched any of the patterns, it is in the set if the last item
8156 was a negative one, but not if it was a positive one. For example, the list in
8157 .code
8158 domainlist relay_to_domains = !a.b.c : *.b.c
8159 .endd
8160 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8161 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8162 list is positive. However, if the setting were
8163 .code
8164 domainlist relay_to_domains = !a.b.c
8165 .endd
8166 then all domains other than &'a.b.c'& would match because the last item in the
8167 list is negative. In other words, a list that ends with a negative item behaves
8168 as if it had an extra item &`:*`& on the end.
8169
8170 Another way of thinking about positive and negative items in lists is to read
8171 the connector as &"or"& after a positive item and as &"and"& after a negative
8172 item.
8173
8174
8175
8176 .section "File names in lists" "SECTfilnamlis"
8177 .cindex "list" "filename in"
8178 If an item in a domain, host, address, or local part list is an absolute
8179 filename (beginning with a slash character), each line of the file is read and
8180 processed as if it were an independent item in the list, except that further
8181 filenames are not allowed,
8182 and no expansion of the data from the file takes place.
8183 Empty lines in the file are ignored, and the file may also contain comment
8184 lines:
8185
8186 .ilist
8187 For domain and host lists, if a # character appears anywhere in a line of the
8188 file, it and all following characters are ignored.
8189 .next
8190 Because local parts may legitimately contain # characters, a comment in an
8191 address list or local part list file is recognized only if # is preceded by
8192 white space or the start of the line. For example:
8193 .code
8194 not#comment@x.y.z   # but this is a comment
8195 .endd
8196 .endlist
8197
8198 Putting a filename in a list has the same effect as inserting each line of the
8199 file as an item in the list (blank lines and comments excepted). However, there
8200 is one important difference: the file is read each time the list is processed,
8201 so if its contents vary over time, Exim's behaviour changes.
8202
8203 If a filename is preceded by an exclamation mark, the sense of any match
8204 within the file is inverted. For example, if
8205 .code
8206 hold_domains = !/etc/nohold-domains
8207 .endd
8208 and the file contains the lines
8209 .code
8210 !a.b.c
8211 *.b.c
8212 .endd
8213 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8214 any domain matching &`*.b.c`& is not.
8215
8216
8217
8218 .section "An lsearch file is not an out-of-line list" "SECID77"
8219 As will be described in the sections that follow, lookups can be used in lists
8220 to provide indexed methods of checking list membership. There has been some
8221 confusion about the way &(lsearch)& lookups work in lists. Because
8222 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8223 sometimes thought that it is allowed to contain wild cards and other kinds of
8224 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8225 always fixed strings, just as for any other single-key lookup type.
8226
8227 If you want to use a file to contain wild-card patterns that form part of a
8228 list, just give the filename on its own, without a search type, as described
8229 in the previous section. You could also use the &(wildlsearch)& or
8230 &(nwildlsearch)&, but there is no advantage in doing this.
8231
8232
8233
8234
8235 .section "Named lists" "SECTnamedlists"
8236 .cindex "named lists"
8237 .cindex "list" "named"
8238 A list of domains, hosts, email addresses, or local parts can be given a name
8239 which is then used to refer to the list elsewhere in the configuration. This is
8240 particularly convenient if the same list is required in several different
8241 places. It also allows lists to be given meaningful names, which can improve
8242 the readability of the configuration. For example, it is conventional to define
8243 a domain list called &'local_domains'& for all the domains that are handled
8244 locally on a host, using a configuration line such as
8245 .code
8246 domainlist local_domains = localhost:my.dom.example
8247 .endd
8248 Named lists are referenced by giving their name preceded by a plus sign, so,
8249 for example, a router that is intended to handle local domains would be
8250 configured with the line
8251 .code
8252 domains = +local_domains
8253 .endd
8254 The first router in a configuration is often one that handles all domains
8255 except the local ones, using a configuration with a negated item like this:
8256 .code
8257 dnslookup:
8258   driver = dnslookup
8259   domains = ! +local_domains
8260   transport = remote_smtp
8261   no_more
8262 .endd
8263 The four kinds of named list are created by configuration lines starting with
8264 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8265 respectively. Then there follows the name that you are defining, followed by an
8266 equals sign and the list itself. For example:
8267 .code
8268 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8269 addresslist bad_senders = cdb;/etc/badsenders
8270 .endd
8271 A named list may refer to other named lists:
8272 .code
8273 domainlist  dom1 = first.example : second.example
8274 domainlist  dom2 = +dom1 : third.example
8275 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8276 .endd
8277 &*Warning*&: If the last item in a referenced list is a negative one, the
8278 effect may not be what you intended, because the negation does not propagate
8279 out to the higher level. For example, consider:
8280 .code
8281 domainlist  dom1 = !a.b
8282 domainlist  dom2 = +dom1 : *.b
8283 .endd
8284 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8285 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8286 means it matches the second list as well. The effect is not the same as
8287 .code
8288 domainlist  dom2 = !a.b : *.b
8289 .endd
8290 where &'x.y'& does not match. It's best to avoid negation altogether in
8291 referenced lists if you can.
8292
8293 Named lists may have a performance advantage. When Exim is routing an
8294 address or checking an incoming message, it caches the result of tests on named
8295 lists. So, if you have a setting such as
8296 .code
8297 domains = +local_domains
8298 .endd
8299 on several of your routers
8300 or in several ACL statements,
8301 the actual test is done only for the first one. However, the caching works only
8302 if there are no expansions within the list itself or any sublists that it
8303 references. In other words, caching happens only for lists that are known to be
8304 the same each time they are referenced.
8305
8306 By default, there may be up to 16 named lists of each type. This limit can be
8307 extended by changing a compile-time variable. The use of domain and host lists
8308 is recommended for concepts such as local domains, relay domains, and relay
8309 hosts. The default configuration is set up like this.
8310
8311
8312
8313 .section "Named lists compared with macros" "SECID78"
8314 .cindex "list" "named compared with macro"
8315 .cindex "macro" "compared with named list"
8316 At first sight, named lists might seem to be no different from macros in the
8317 configuration file. However, macros are just textual substitutions. If you
8318 write
8319 .code
8320 ALIST = host1 : host2
8321 auth_advertise_hosts = !ALIST
8322 .endd
8323 it probably won't do what you want, because that is exactly the same as
8324 .code
8325 auth_advertise_hosts = !host1 : host2
8326 .endd
8327 Notice that the second host name is not negated. However, if you use a host
8328 list, and write
8329 .code
8330 hostlist alist = host1 : host2
8331 auth_advertise_hosts = ! +alist
8332 .endd
8333 the negation applies to the whole list, and so that is equivalent to
8334 .code
8335 auth_advertise_hosts = !host1 : !host2
8336 .endd
8337
8338
8339 .section "Named list caching" "SECID79"
8340 .cindex "list" "caching of named"
8341 .cindex "caching" "named lists"
8342 While processing a message, Exim caches the result of checking a named list if
8343 it is sure that the list is the same each time. In practice, this means that
8344 the cache operates only if the list contains no $ characters, which guarantees
8345 that it will not change when it is expanded. Sometimes, however, you may have
8346 an expanded list that you know will be the same each time within a given
8347 message. For example:
8348 .code
8349 domainlist special_domains = \
8350            ${lookup{$sender_host_address}cdb{/some/file}}
8351 .endd
8352 This provides a list of domains that depends only on the sending host's IP
8353 address. If this domain list is referenced a number of times (for example,
8354 in several ACL lines, or in several routers) the result of the check is not
8355 cached by default, because Exim does not know that it is going to be the
8356 same list each time.
8357
8358 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8359 cache the result anyway. For example:
8360 .code
8361 domainlist_cache special_domains = ${lookup{...
8362 .endd
8363 If you do this, you should be absolutely sure that caching is going to do
8364 the right thing in all cases. When in doubt, leave it out.
8365
8366
8367
8368 .section "Domain lists" "SECTdomainlist"
8369 .cindex "domain list" "patterns for"
8370 .cindex "list" "domain list"
8371 Domain lists contain patterns that are to be matched against a mail domain.
8372 The following types of item may appear in domain lists:
8373
8374 .ilist
8375 .cindex "primary host name"
8376 .cindex "host name" "matched in domain list"
8377 .oindex "&%primary_hostname%&"
8378 .cindex "domain list" "matching primary host name"
8379 .cindex "@ in a domain list"
8380 If a pattern consists of a single @ character, it matches the local host name,
8381 as set by the &%primary_hostname%& option (or defaulted). This makes it
8382 possible to use the same configuration file on several different hosts that
8383 differ only in their names.
8384 .next
8385 .cindex "@[] in a domain list"
8386 .cindex "domain list" "matching local IP interfaces"
8387 .cindex "domain literal"
8388 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8389 in square brackets (as in an email address that contains a domain literal), but
8390 only if that IP address is recognized as local for email routing purposes. The
8391 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8392 control which of a host's several IP addresses are treated as local.
8393 In today's Internet, the use of domain literals is controversial.
8394 .next
8395 .cindex "@mx_any"
8396 .cindex "@mx_primary"
8397 .cindex "@mx_secondary"
8398 .cindex "domain list" "matching MX pointers to local host"
8399 If a pattern consists of the string &`@mx_any`& it matches any domain that
8400 has an MX record pointing to the local host or to any host that is listed in
8401 .oindex "&%hosts_treat_as_local%&"
8402 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8403 are similar, except that the first matches only when a primary MX target is the
8404 local host, and the second only when no primary MX target is the local host,
8405 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8406 preference value &-- there may of course be more than one of them.
8407
8408 The MX lookup that takes place when matching a pattern of this type is
8409 performed with the resolver options for widening names turned off. Thus, for
8410 example, a single-component domain will &'not'& be expanded by adding the
8411 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8412 options of the &(dnslookup)& router for a discussion of domain widening.
8413
8414 Sometimes you may want to ignore certain IP addresses when using one of these
8415 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8416 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8417 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8418 on a router). For example:
8419 .code
8420 domains = @mx_any/ignore=127.0.0.1
8421 .endd
8422 This example matches any domain that has an MX record pointing to one of
8423 the local host's IP addresses other than 127.0.0.1.
8424
8425 The list of IP addresses is in fact processed by the same code that processes
8426 host lists, so it may contain CIDR-coded network specifications and it may also
8427 contain negative items.
8428
8429 Because the list of IP addresses is a sublist within a domain list, you have to
8430 be careful about delimiters if there is more than one address. Like any other
8431 list, the default delimiter can be changed. Thus, you might have:
8432 .code
8433 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8434           an.other.domain : ...
8435 .endd
8436 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8437 involved, it is easiest to change the delimiter for the main list as well:
8438 .code
8439 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8440           an.other.domain ? ...
8441 .endd
8442 .next
8443 .cindex "asterisk" "in domain list"
8444 .cindex "domain list" "asterisk in"
8445 .cindex "domain list" "matching &""ends with""&"
8446 If a pattern starts with an asterisk, the remaining characters of the pattern
8447 are compared with the terminating characters of the domain. The use of &"*"& in
8448 domain lists differs from its use in partial matching lookups. In a domain
8449 list, the character following the asterisk need not be a dot, whereas partial
8450 matching works only in terms of dot-separated components. For example, a domain
8451 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8452 &'cipher.key.ex'&.
8453
8454 .next
8455 .cindex "regular expressions" "in domain list"
8456 .cindex "domain list" "matching regular expression"
8457 If a pattern starts with a circumflex character, it is treated as a regular
8458 expression, and matched against the domain using a regular expression matching
8459 function. The circumflex is treated as part of the regular expression.
8460 Email domains are case-independent, so this regular expression match is by
8461 default case-independent, but you can make it case-dependent by starting it
8462 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8463 are given in chapter &<<CHAPregexp>>&.
8464
8465 &*Warning*&: Because domain lists are expanded before being processed, you
8466 must escape any backslash and dollar characters in the regular expression, or
8467 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8468 it is not to be expanded (unless you really do want to build a regular
8469 expression by expansion, of course).
8470 .next
8471 .cindex "lookup" "in domain list"
8472 .cindex "domain list" "matching by lookup"
8473 If a pattern starts with the name of a single-key lookup type followed by a
8474 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8475 must be a filename in a suitable format for the lookup type. For example, for
8476 &"cdb;"& it must be an absolute path:
8477 .code
8478 domains = cdb;/etc/mail/local_domains.cdb
8479 .endd
8480 The appropriate type of lookup is done on the file using the domain name as the
8481 key. In most cases, the data that is looked up is not used; Exim is interested
8482 only in whether or not the key is present in the file. However, when a lookup
8483 is used for the &%domains%& option on a router
8484 or a &%domains%& condition in an ACL statement, the data is preserved in the
8485 &$domain_data$& variable and can be referred to in other router options or
8486 other statements in the same ACL.
8487
8488 .next
8489 Any of the single-key lookup type names may be preceded by
8490 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8491 .code
8492 domains = partial-dbm;/partial/domains
8493 .endd
8494 This causes partial matching logic to be invoked; a description of how this
8495 works is given in section &<<SECTpartiallookup>>&.
8496
8497 .next
8498 .cindex "asterisk" "in lookup type"
8499 Any of the single-key lookup types may be followed by an asterisk. This causes
8500 a default lookup for a key consisting of a single asterisk to be done if the
8501 original lookup fails. This is not a useful feature when using a domain list to
8502 select particular domains (because any domain would match), but it might have
8503 value if the result of the lookup is being used via the &$domain_data$&
8504 expansion variable.
8505 .next
8506 If the pattern starts with the name of a query-style lookup type followed by a
8507 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8508 pattern must be an appropriate query for the lookup type, as described in
8509 chapter &<<CHAPfdlookup>>&. For example:
8510 .code
8511 hold_domains = mysql;select domain from holdlist \
8512   where domain = '${quote_mysql:$domain}';
8513 .endd
8514 In most cases, the data that is looked up is not used (so for an SQL query, for
8515 example, it doesn't matter what field you select). Exim is interested only in
8516 whether or not the query succeeds. However, when a lookup is used for the
8517 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8518 variable and can be referred to in other options.
8519 .next
8520 .cindex "domain list" "matching literal domain name"
8521 If none of the above cases apply, a caseless textual comparison is made
8522 between the pattern and the domain.
8523 .endlist
8524
8525 Here is an example that uses several different kinds of pattern:
8526 .code
8527 domainlist funny_domains = \
8528   @ : \
8529   lib.unseen.edu : \
8530   *.foundation.fict.example : \
8531   \N^[1-2]\d{3}\.fict\.example$\N : \
8532   partial-dbm;/opt/data/penguin/book : \
8533   nis;domains.byname : \
8534   nisplus;[name=$domain,status=local],domains.org_dir
8535 .endd
8536 There are obvious processing trade-offs among the various matching modes. Using
8537 an asterisk is faster than a regular expression, and listing a few names
8538 explicitly probably is too. The use of a file or database lookup is expensive,
8539 but may be the only option if hundreds of names are required. Because the
8540 patterns are tested in order, it makes sense to put the most commonly matched
8541 patterns earlier.
8542
8543
8544
8545 .section "Host lists" "SECThostlist"
8546 .cindex "host list" "patterns in"
8547 .cindex "list" "host list"
8548 Host lists are used to control what remote hosts are allowed to do. For
8549 example, some hosts may be allowed to use the local host as a relay, and some
8550 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8551 two different ways, by name or by IP address. In a host list, some types of
8552 pattern are matched to a host name, and some are matched to an IP address.
8553 You need to be particularly careful with this when single-key lookups are
8554 involved, to ensure that the right value is being used as the key.
8555
8556
8557 .section "Special host list patterns" "SECID80"
8558 .cindex "empty item in hosts list"
8559 .cindex "host list" "empty string in"
8560 If a host list item is the empty string, it matches only when no remote host is
8561 involved. This is the case when a message is being received from a local
8562 process using SMTP on the standard input, that is, when a TCP/IP connection is
8563 not used.
8564
8565 .cindex "asterisk" "in host list"
8566 The special pattern &"*"& in a host list matches any host or no host. Neither
8567 the IP address nor the name is actually inspected.
8568
8569
8570
8571 .section "Host list patterns that match by IP address" "SECThoslispatip"
8572 .cindex "host list" "matching IP addresses"
8573 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8574 the incoming address actually appears in the IPv6 host as
8575 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8576 list, it is converted into a traditional IPv4 address first. (Not all operating
8577 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8578 concerns.)
8579
8580 The following types of pattern in a host list check the remote host by
8581 inspecting its IP address:
8582
8583 .ilist
8584 If the pattern is a plain domain name (not a regular expression, not starting
8585 with *, not a lookup of any kind), Exim calls the operating system function
8586 to find the associated IP address(es). Exim uses the newer
8587 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8588 This typically causes a forward DNS lookup of the name. The result is compared
8589 with the IP address of the subject host.
8590
8591 If there is a temporary problem (such as a DNS timeout) with the host name
8592 lookup, a temporary error occurs. For example, if the list is being used in an
8593 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8594 temporary SMTP error code. If no IP address can be found for the host name,
8595 what happens is described in section &<<SECTbehipnot>>& below.
8596
8597 .next
8598 .cindex "@ in a host list"
8599 If the pattern is &"@"&, the primary host name is substituted and used as a
8600 domain name, as just described.
8601
8602 .next
8603 If the pattern is an IP address, it is matched against the IP address of the
8604 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8605 IPv6 addresses can be given in colon-separated format, but the colons have to
8606 be doubled so as not to be taken as item separators when the default list
8607 separator is used. IPv6 addresses are recognized even when Exim is compiled
8608 without IPv6 support. This means that if they appear in a host list on an
8609 IPv4-only host, Exim will not treat them as host names. They are just addresses
8610 that can never match a client host.
8611
8612 .next
8613 .cindex "@[] in a host list"
8614 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8615 the local host. For example, if the local host is an IPv4 host with one
8616 interface address 10.45.23.56, these two ACL statements have the same effect:
8617 .code
8618 accept hosts = 127.0.0.1 : 10.45.23.56
8619 accept hosts = @[]
8620 .endd
8621 .next
8622 .cindex "CIDR notation"
8623 If the pattern is an IP address followed by a slash and a mask length (for
8624 example 10.11.42.0/24), it is matched against the IP address of the subject
8625 host under the given mask. This allows, an entire network of hosts to be
8626 included (or excluded) by a single item. The mask uses CIDR notation; it
8627 specifies the number of address bits that must match, starting from the most
8628 significant end of the address.
8629
8630 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8631 of a range of addresses. It is the number of bits in the network portion of the
8632 address. The above example specifies a 24-bit netmask, so it matches all 256
8633 addresses in the 10.11.42.0 network. An item such as
8634 .code
8635 192.168.23.236/31
8636 .endd
8637 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8638 32 for an IPv4 address is the same as no mask at all; just a single address
8639 matches.
8640
8641 Here is another example which shows an IPv4 and an IPv6 network:
8642 .code
8643 recipient_unqualified_hosts = 192.168.0.0/16: \
8644                               3ffe::ffff::836f::::/48
8645 .endd
8646 The doubling of list separator characters applies only when these items
8647 appear inline in a host list. It is not required when indirecting via a file.
8648 For example:
8649 .code
8650 recipient_unqualified_hosts = /opt/exim/unqualnets
8651 .endd
8652 could make use of a file containing
8653 .code
8654 172.16.0.0/12
8655 3ffe:ffff:836f::/48
8656 .endd
8657 to have exactly the same effect as the previous example. When listing IPv6
8658 addresses inline, it is usually more convenient to use the facility for
8659 changing separator characters. This list contains the same two networks:
8660 .code
8661 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8662                                  3ffe:ffff:836f::/48
8663 .endd
8664 The separator is changed to semicolon by the leading &"<;"& at the start of the
8665 list.
8666 .endlist
8667
8668
8669
8670 .section "Host list patterns for single-key lookups by host address" &&&
8671          "SECThoslispatsikey"
8672 .cindex "host list" "lookup of IP address"
8673 When a host is to be identified by a single-key lookup of its complete IP
8674 address, the pattern takes this form:
8675 .display
8676 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8677 .endd
8678 For example:
8679 .code
8680 hosts_lookup = net-cdb;/hosts-by-ip.db
8681 .endd
8682 The text form of the IP address of the subject host is used as the lookup key.
8683 IPv6 addresses are converted to an unabbreviated form, using lower case
8684 letters, with dots as separators because colon is the key terminator in
8685 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8686 quoting the keys, but this is a facility that was added later.] The data
8687 returned by the lookup is not used.
8688
8689 .cindex "IP address" "masking"
8690 .cindex "host list" "masked IP address"
8691 Single-key lookups can also be performed using masked IP addresses, using
8692 patterns of this form:
8693 .display
8694 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8695 .endd
8696 For example:
8697 .code
8698 net24-dbm;/networks.db
8699 .endd
8700 The IP address of the subject host is masked using <&'number'&> as the mask
8701 length. A textual string is constructed from the masked value, followed by the
8702 mask, and this is used as the lookup key. For example, if the host's IP address
8703 is 192.168.34.6, the key that is looked up for the above example is
8704 &"192.168.34.0/24"&.
8705
8706 When an IPv6 address is converted to a string, dots are normally used instead
8707 of colons, so that keys in &(lsearch)& files need not contain colons (which
8708 terminate &(lsearch)& keys). This was implemented some time before the ability
8709 to quote keys was made available in &(lsearch)& files. However, the more
8710 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8711 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8712 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8713 converted using colons and not dots.
8714 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8715 addresses are always used.
8716 The latter are converted to IPv4 addresses, in dotted-quad form.
8717
8718 Ideally, it would be nice to tidy up this anomalous situation by changing to
8719 colons in all cases, given that quoting is now available for &(lsearch)&.
8720 However, this would be an incompatible change that might break some existing
8721 configurations.
8722
8723 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8724 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8725 the former case the key strings include the mask value, whereas in the latter
8726 case the IP address is used on its own.
8727
8728
8729
8730 .section "Host list patterns that match by host name" "SECThoslispatnam"
8731 .cindex "host" "lookup failures"
8732 .cindex "unknown host name"
8733 .cindex "host list" "matching host name"
8734 There are several types of pattern that require Exim to know the name of the
8735 remote host. These are either wildcard patterns or lookups by name. (If a
8736 complete hostname is given without any wildcarding, it is used to find an IP
8737 address to match against, as described in section &<<SECThoslispatip>>&
8738 above.)
8739
8740 If the remote host name is not already known when Exim encounters one of these
8741 patterns, it has to be found from the IP address.
8742 Although many sites on the Internet are conscientious about maintaining reverse
8743 DNS data for their hosts, there are also many that do not do this.
8744 Consequently, a name cannot always be found, and this may lead to unwanted
8745 effects. Take care when configuring host lists with wildcarded name patterns.
8746 Consider what will happen if a name cannot be found.
8747
8748 Because of the problems of determining host names from IP addresses, matching
8749 against host names is not as common as matching against IP addresses.
8750
8751 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8752 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8753 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8754 are done can be changed by setting the &%host_lookup_order%& option. For
8755 security, once Exim has found one or more names, it looks up the IP addresses
8756 for these names and compares them with the IP address that it started with.
8757 Only those names whose IP addresses match are accepted. Any other names are
8758 discarded. If no names are left, Exim behaves as if the host name cannot be
8759 found. In the most common case there is only one name and one IP address.
8760
8761 There are some options that control what happens if a host name cannot be
8762 found. These are described in section &<<SECTbehipnot>>& below.
8763
8764 .cindex "host" "alias for"
8765 .cindex "alias for host"
8766 As a result of aliasing, hosts may have more than one name. When processing any
8767 of the following types of pattern, all the host's names are checked:
8768
8769 .ilist
8770 .cindex "asterisk" "in host list"
8771 If a pattern starts with &"*"& the remainder of the item must match the end of
8772 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8773 &'.b.c'&. This special simple form is provided because this is a very common
8774 requirement. Other kinds of wildcarding require the use of a regular
8775 expression.
8776 .next
8777 .cindex "regular expressions" "in host list"
8778 .cindex "host list" "regular expression in"
8779 If the item starts with &"^"& it is taken to be a regular expression which is
8780 matched against the host name. Host names are case-independent, so this regular
8781 expression match is by default case-independent, but you can make it
8782 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8783 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8784 example,
8785 .code
8786 ^(a|b)\.c\.d$
8787 .endd
8788 is a regular expression that matches either of the two hosts &'a.c.d'& or
8789 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8790 that backslash and dollar characters are not misinterpreted as part of the
8791 string expansion. The simplest way to do this is to use &`\N`& to mark that
8792 part of the string as non-expandable. For example:
8793 .code
8794 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8795 .endd
8796 &*Warning*&: If you want to match a complete host name, you must include the
8797 &`$`& terminating metacharacter in the regular expression, as in the above
8798 example. Without it, a match at the start of the host name is all that is
8799 required.
8800 .endlist
8801
8802
8803
8804
8805 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8806 .cindex "host" "lookup failures, permanent"
8807 While processing a host list, Exim may need to look up an IP address from a
8808 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8809 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8810 behaviour when it fails to find the information it is seeking is the same.
8811
8812 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8813 apply to temporary DNS errors, whose handling is described in the next section.
8814
8815 .cindex "&`+include_unknown`&"
8816 .cindex "&`+ignore_unknown`&"
8817 Exim parses a host list from left to right. If it encounters a permanent
8818 lookup failure in any item in the host list before it has found a match,
8819 Exim treats it as a failure and the default behavior is as if the host
8820 does not match the list. This may not always be what you want to happen.
8821 To change Exim's behaviour, the special items &`+include_unknown`& or
8822 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8823 not recognized in an indirected file).
8824
8825 .ilist
8826 If any item that follows &`+include_unknown`& requires information that
8827 cannot found, Exim behaves as if the host does match the list. For example,
8828 .code
8829 host_reject_connection = +include_unknown:*.enemy.ex
8830 .endd
8831 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8832 any hosts whose name it cannot find.
8833
8834 .next
8835 If any item that follows &`+ignore_unknown`& requires information that cannot
8836 be found, Exim ignores that item and proceeds to the rest of the list. For
8837 example:
8838 .code
8839 accept hosts = +ignore_unknown : friend.example : \
8840                192.168.4.5
8841 .endd
8842 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8843 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8844 name can be found for 192.168.4.5, it is rejected.
8845 .endlist
8846
8847 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8848 list. The effect of each one lasts until the next, or until the end of the
8849 list.
8850
8851 .section "Mixing wildcarded host names and addresses in host lists" &&&
8852          "SECTmixwilhos"
8853 .cindex "host list" "mixing names and addresses in"
8854
8855 This section explains the host/ip processing logic with the same concepts
8856 as the previous section, but specifically addresses what happens when a
8857 wildcarded hostname is one of the items in the hostlist.
8858
8859 .ilist
8860 If you have name lookups or wildcarded host names and
8861 IP addresses in the same host list, you should normally put the IP
8862 addresses first. For example, in an ACL you could have:
8863 .code
8864 accept hosts = 10.9.8.7 : *.friend.example
8865 .endd
8866 The reason you normally would order it this way lies in the
8867 left-to-right way that Exim processes lists.  It can test IP addresses
8868 without doing any DNS lookups, but when it reaches an item that requires
8869 a host name, it fails if it cannot find a host name to compare with the
8870 pattern. If the above list is given in the opposite order, the
8871 &%accept%& statement fails for a host whose name cannot be found, even
8872 if its IP address is 10.9.8.7.
8873
8874 .next
8875 If you really do want to do the name check first, and still recognize the IP
8876 address, you can rewrite the ACL like this:
8877 .code
8878 accept hosts = *.friend.example
8879 accept hosts = 10.9.8.7
8880 .endd
8881 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8882 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8883 &`+ignore_unknown`&, which was discussed in depth in the first example in
8884 this section.
8885 .endlist
8886
8887
8888 .section "Temporary DNS errors when looking up host information" &&&
8889          "SECTtemdnserr"
8890 .cindex "host" "lookup failures, temporary"
8891 .cindex "&`+include_defer`&"
8892 .cindex "&`+ignore_defer`&"
8893 A temporary DNS lookup failure normally causes a defer action (except when
8894 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8895 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8896 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8897 section. These options should be used with care, probably only in non-critical
8898 host lists such as whitelists.
8899
8900
8901
8902 .section "Host list patterns for single-key lookups by host name" &&&
8903          "SECThoslispatnamsk"
8904 .cindex "unknown host name"
8905 .cindex "host list" "matching host name"
8906 If a pattern is of the form
8907 .display
8908 <&'single-key-search-type'&>;<&'search-data'&>
8909 .endd
8910 for example
8911 .code
8912 dbm;/host/accept/list
8913 .endd
8914 a single-key lookup is performed, using the host name as its key. If the
8915 lookup succeeds, the host matches the item. The actual data that is looked up
8916 is not used.
8917
8918 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8919 keys in the file, not IP addresses. If you want to do lookups based on IP
8920 addresses, you must precede the search type with &"net-"& (see section
8921 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8922 two items in the same list, one doing an address lookup and one doing a name
8923 lookup, both using the same file.
8924
8925
8926
8927 .section "Host list patterns for query-style lookups" "SECID81"
8928 If a pattern is of the form
8929 .display
8930 <&'query-style-search-type'&>;<&'query'&>
8931 .endd
8932 the query is obeyed, and if it succeeds, the host matches the item. The actual
8933 data that is looked up is not used. The variables &$sender_host_address$& and
8934 &$sender_host_name$& can be used in the query. For example:
8935 .code
8936 hosts_lookup = pgsql;\
8937   select ip from hostlist where ip='$sender_host_address'
8938 .endd
8939 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8940 can use the &%sg%& expansion item to change this if you need to. If you want to
8941 use masked IP addresses in database queries, you can use the &%mask%& expansion
8942 operator.
8943
8944 If the query contains a reference to &$sender_host_name$&, Exim automatically
8945 looks up the host name if it has not already done so. (See section
8946 &<<SECThoslispatnam>>& for comments on finding host names.)
8947
8948 Historical note: prior to release 4.30, Exim would always attempt to find a
8949 host name before running the query, unless the search type was preceded by
8950 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8951 still recognized for query-style lookups, but its presence or absence has no
8952 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8953 See section &<<SECThoslispatsikey>>&.)
8954
8955
8956
8957
8958
8959 .section "Address lists" "SECTaddresslist"
8960 .cindex "list" "address list"
8961 .cindex "address list" "empty item"
8962 .cindex "address list" "patterns"
8963 Address lists contain patterns that are matched against mail addresses. There
8964 is one special case to be considered: the sender address of a bounce message is
8965 always empty. You can test for this by providing an empty item in an address
8966 list. For example, you can set up a router to process bounce messages by
8967 using this option setting:
8968 .code
8969 senders = :
8970 .endd
8971 The presence of the colon creates an empty item. If you do not provide any
8972 data, the list is empty and matches nothing. The empty sender can also be
8973 detected by a regular expression that matches an empty string,
8974 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8975
8976 Non-empty items in an address list can be straightforward email addresses. For
8977 example:
8978 .code
8979 senders = jbc@askone.example : hs@anacreon.example
8980 .endd
8981 A certain amount of wildcarding is permitted. If a pattern contains an @
8982 character, but is not a regular expression and does not begin with a
8983 semicolon-terminated lookup type (described below), the local part of the
8984 subject address is compared with the local part of the pattern, which may start
8985 with an asterisk. If the local parts match, the domain is checked in exactly
8986 the same way as for a pattern in a domain list. For example, the domain can be
8987 wildcarded, refer to a named list, or be a lookup:
8988 .code
8989 deny senders = *@*.spamming.site:\
8990                *@+hostile_domains:\
8991                bozo@partial-lsearch;/list/of/dodgy/sites:\
8992                *@dbm;/bad/domains.db
8993 .endd
8994 .cindex "local part" "starting with !"
8995 .cindex "address list" "local part starting with !"
8996 If a local part that begins with an exclamation mark is required, it has to be
8997 specified using a regular expression, because otherwise the exclamation mark is
8998 treated as a sign of negation, as is standard in lists.
8999
9000 If a non-empty pattern that is not a regular expression or a lookup does not
9001 contain an @ character, it is matched against the domain part of the subject
9002 address. The only two formats that are recognized this way are a literal
9003 domain, or a domain pattern that starts with *. In both these cases, the effect
9004 is the same as if &`*@`& preceded the pattern. For example:
9005 .code
9006 deny senders = enemy.domain : *.enemy.domain
9007 .endd
9008
9009 The following kinds of more complicated address list pattern can match any
9010 address, including the empty address that is characteristic of bounce message
9011 senders:
9012
9013 .ilist
9014 .cindex "regular expressions" "in address list"
9015 .cindex "address list" "regular expression in"
9016 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9017 done against the complete address, with the pattern as the regular expression.
9018 You must take care that backslash and dollar characters are not misinterpreted
9019 as part of the string expansion. The simplest way to do this is to use &`\N`&
9020 to mark that part of the string as non-expandable. For example:
9021 .code
9022 deny senders = \N^.*this.*@example\.com$\N : \
9023                \N^\d{8}.+@spamhaus.example$\N : ...
9024 .endd
9025 The &`\N`& sequences are removed by the expansion, so these items do indeed
9026 start with &"^"& by the time they are being interpreted as address patterns.
9027
9028 .next
9029 .cindex "address list" "lookup for complete address"
9030 Complete addresses can be looked up by using a pattern that starts with a
9031 lookup type terminated by a semicolon, followed by the data for the lookup. For
9032 example:
9033 .code
9034 deny senders = cdb;/etc/blocked.senders : \
9035   mysql;select address from blocked where \
9036   address='${quote_mysql:$sender_address}'
9037 .endd
9038 Both query-style and single-key lookup types can be used. For a single-key
9039 lookup type, Exim uses the complete address as the key. However, empty keys are
9040 not supported for single-key lookups, so a match against the empty address
9041 always fails. This restriction does not apply to query-style lookups.
9042
9043 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9044 cannot be used, and is ignored if specified, with an entry being written to the
9045 panic log.
9046 .cindex "*@ with single-key lookup"
9047 However, you can configure lookup defaults, as described in section
9048 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9049 default. For example, with this lookup:
9050 .code
9051 accept senders = lsearch*@;/some/file
9052 .endd
9053 the file could contains lines like this:
9054 .code
9055 user1@domain1.example
9056 *@domain2.example
9057 .endd
9058 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9059 that are tried is:
9060 .code
9061 nimrod@jaeger.example
9062 *@jaeger.example
9063 *
9064 .endd
9065 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9066 would mean that every address matches, thus rendering the test useless.
9067
9068 &*Warning 2*&: Do not confuse these two kinds of item:
9069 .code
9070 deny recipients = dbm*@;/some/file
9071 deny recipients = *@dbm;/some/file
9072 .endd
9073 The first does a whole address lookup, with defaulting, as just described,
9074 because it starts with a lookup type. The second matches the local part and
9075 domain independently, as described in a bullet point below.
9076 .endlist
9077
9078
9079 The following kinds of address list pattern can match only non-empty addresses.
9080 If the subject address is empty, a match against any of these pattern types
9081 always fails.
9082
9083
9084 .ilist
9085 .cindex "@@ with single-key lookup"
9086 .cindex "address list" "@@ lookup type"
9087 .cindex "address list" "split local part and domain"
9088 If a pattern starts with &"@@"& followed by a single-key lookup item
9089 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9090 split into a local part and a domain. The domain is looked up in the file. If
9091 it is not found, there is no match. If it is found, the data that is looked up
9092 from the file is treated as a colon-separated list of local part patterns, each
9093 of which is matched against the subject local part in turn.
9094
9095 .cindex "asterisk" "in address list"
9096 The lookup may be a partial one, and/or one involving a search for a default
9097 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9098 patterns that are looked up can be regular expressions or begin with &"*"&, or
9099 even be further lookups. They may also be independently negated. For example,
9100 with
9101 .code
9102 deny senders = @@dbm;/etc/reject-by-domain
9103 .endd
9104 the data from which the DBM file is built could contain lines like
9105 .code
9106 baddomain.com:  !postmaster : *
9107 .endd
9108 to reject all senders except &%postmaster%& from that domain.
9109
9110 .cindex "local part" "starting with !"
9111 If a local part that actually begins with an exclamation mark is required, it
9112 has to be specified using a regular expression. In &(lsearch)& files, an entry
9113 may be split over several lines by indenting the second and subsequent lines,
9114 but the separating colon must still be included at line breaks. White space
9115 surrounding the colons is ignored. For example:
9116 .code
9117 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9118   spammer3 : spammer4
9119 .endd
9120 As in all colon-separated lists in Exim, a colon can be included in an item by
9121 doubling.
9122
9123 If the last item in the list starts with a right angle-bracket, the remainder
9124 of the item is taken as a new key to look up in order to obtain a continuation
9125 list of local parts. The new key can be any sequence of characters. Thus one
9126 might have entries like
9127 .code
9128 aol.com: spammer1 : spammer 2 : >*
9129 xyz.com: spammer3 : >*
9130 *:       ^\d{8}$
9131 .endd
9132 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9133 local parts for all domains, in addition to the specific local parts listed for
9134 each domain. Of course, using this feature costs another lookup each time a
9135 chain is followed, but the effort needed to maintain the data is reduced.
9136
9137 .cindex "loop" "in lookups"
9138 It is possible to construct loops using this facility, and in order to catch
9139 them, the chains may be no more than fifty items long.
9140
9141 .next
9142 The @@<&'lookup'&> style of item can also be used with a query-style
9143 lookup, but in this case, the chaining facility is not available. The lookup
9144 can only return a single list of local parts.
9145 .endlist
9146
9147 &*Warning*&: There is an important difference between the address list items
9148 in these two examples:
9149 .code
9150 senders = +my_list
9151 senders = *@+my_list
9152 .endd
9153 In the first one, &`my_list`& is a named address list, whereas in the second
9154 example it is a named domain list.
9155
9156
9157
9158
9159 .section "Case of letters in address lists" "SECTcasletadd"
9160 .cindex "case of local parts"
9161 .cindex "address list" "case forcing"
9162 .cindex "case forcing in address lists"
9163 Domains in email addresses are always handled caselessly, but for local parts
9164 case may be significant on some systems (see &%caseful_local_part%& for how
9165 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9166 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9167 blocking lists should be done in a case-independent manner. Since most address
9168 lists in Exim are used for this kind of control, Exim attempts to do this by
9169 default.
9170
9171 The domain portion of an address is always lowercased before matching it to an
9172 address list. The local part is lowercased by default, and any string
9173 comparisons that take place are done caselessly. This means that the data in
9174 the address list itself, in files included as plain filenames, and in any file
9175 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9176 keys in files that are looked up by a search type other than &(lsearch)& (which
9177 works caselessly) must be in lower case, because these lookups are not
9178 case-independent.
9179
9180 .cindex "&`+caseful`&"
9181 To allow for the possibility of caseful address list matching, if an item in
9182 an address list is the string &"+caseful"&, the original case of the local
9183 part is restored for any comparisons that follow, and string comparisons are no
9184 longer case-independent. This does not affect the domain, which remains in
9185 lower case. However, although independent matches on the domain alone are still
9186 performed caselessly, regular expressions that match against an entire address
9187 become case-sensitive after &"+caseful"& has been seen.
9188
9189
9190
9191 .section "Local part lists" "SECTlocparlis"
9192 .cindex "list" "local part list"
9193 .cindex "local part" "list"
9194 Case-sensitivity in local part lists is handled in the same way as for address
9195 lists, as just described. The &"+caseful"& item can be used if required. In a
9196 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9197 set false, the subject is lowercased and the matching is initially
9198 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9199 matching in the local part list, but not elsewhere in the router. If
9200 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9201 option is case-sensitive from the start.
9202
9203 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9204 comments are handled in the same way as address lists &-- they are recognized
9205 only if the # is preceded by white space or the start of the line.
9206 Otherwise, local part lists are matched in the same way as domain lists, except
9207 that the special items that refer to the local host (&`@`&, &`@[]`&,
9208 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9209 Refer to section &<<SECTdomainlist>>& for details of the other available item
9210 types.
9211 .ecindex IIDdohoadli
9212
9213
9214
9215
9216 . ////////////////////////////////////////////////////////////////////////////
9217 . ////////////////////////////////////////////////////////////////////////////
9218
9219 .chapter "String expansions" "CHAPexpand"
9220 .scindex IIDstrexp "expansion" "of strings"
9221 Many strings in Exim's runtime configuration are expanded before use. Some of
9222 them are expanded every time they are used; others are expanded only once.
9223
9224 When a string is being expanded it is copied verbatim from left to right except
9225 .cindex expansion "string concatenation"
9226 when a dollar or backslash character is encountered. A dollar specifies the
9227 start of a portion of the string that is interpreted and replaced as described
9228 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9229 escape character, as described in the following section.
9230
9231 Whether a string is expanded depends upon the context.  Usually this is solely
9232 dependent upon the option for which a value is sought; in this documentation,
9233 options for which string expansion is performed are marked with &dagger; after
9234 the data type.  ACL rules always expand strings.  A couple of expansion
9235 conditions do not expand some of the brace-delimited branches, for security
9236 reasons,
9237 .cindex "tainted data" expansion
9238 .cindex expansion "tainted data"
9239 and expansion of data deriving from the sender (&"tainted data"&)
9240 is not permitted.
9241
9242
9243
9244 .section "Literal text in expanded strings" "SECTlittext"
9245 .cindex "expansion" "including literal text"
9246 An uninterpreted dollar can be included in an expanded string by putting a
9247 backslash in front of it. A backslash can be used to prevent any special
9248 character being treated specially in an expansion, including backslash itself.
9249 If the string appears in quotes in the configuration file, two backslashes are
9250 required because the quotes themselves cause interpretation of backslashes when
9251 the string is read in (see section &<<SECTstrings>>&).
9252
9253 .cindex "expansion" "non-expandable substrings"
9254 A portion of the string can specified as non-expandable by placing it between
9255 two occurrences of &`\N`&. This is particularly useful for protecting regular
9256 expressions, which often contain backslashes and dollar signs. For example:
9257 .code
9258 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9259 .endd
9260 On encountering the first &`\N`&, the expander copies subsequent characters
9261 without interpretation until it reaches the next &`\N`& or the end of the
9262 string.
9263
9264
9265
9266 .section "Character escape sequences in expanded strings" "SECID82"
9267 .cindex "expansion" "escape sequences"
9268 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9269 expanded string is recognized as an escape sequence for the character newline,
9270 carriage return, or tab, respectively. A backslash followed by up to three
9271 octal digits is recognized as an octal encoding for a single character, and a
9272 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9273 encoding.
9274
9275 These escape sequences are also recognized in quoted strings when they are read
9276 in. Their interpretation in expansions as well is useful for unquoted strings,
9277 and for other cases such as looked-up strings that are then expanded.
9278
9279
9280 .section "Testing string expansions" "SECID83"
9281 .cindex "expansion" "testing"
9282 .cindex "testing" "string expansion"
9283 .oindex "&%-be%&"
9284 Many expansions can be tested by calling Exim with the &%-be%& option. This
9285 takes the command arguments, or lines from the standard input if there are no
9286 arguments, runs them through the string expansion code, and writes the results
9287 to the standard output. Variables based on configuration values are set up, but
9288 since no message is being processed, variables such as &$local_part$& have no
9289 value. Nevertheless the &%-be%& option can be useful for checking out file and
9290 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9291 and &%nhash%&.
9292
9293 Exim gives up its root privilege when it is called with the &%-be%& option, and
9294 instead runs under the uid and gid it was called with, to prevent users from
9295 using &%-be%& for reading files to which they do not have access.
9296
9297 .oindex "&%-bem%&"
9298 If you want to test expansions that include variables whose values are taken
9299 from a message, there are two other options that can be used. The &%-bem%&
9300 option is like &%-be%& except that it is followed by a filename. The file is
9301 read as a message before doing the test expansions. For example:
9302 .code
9303 exim -bem /tmp/test.message '$h_subject:'
9304 .endd
9305 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9306 Exim message identifier. For example:
9307 .code
9308 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9309 .endd
9310 This loads the message from Exim's spool before doing the test expansions, and
9311 is therefore restricted to admin users.
9312
9313
9314 .section "Forced expansion failure" "SECTforexpfai"
9315 .cindex "expansion" "forced failure"
9316 A number of expansions that are described in the following section have
9317 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9318 (which are sometimes called &"curly brackets"&). Which of the two strings is
9319 used depends on some condition that is evaluated as part of the expansion. If,
9320 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9321 the entire string expansion fails in a way that can be detected by the code
9322 that requested the expansion. This is called &"forced expansion failure"&, and
9323 its consequences depend on the circumstances. In some cases it is no different
9324 from any other expansion failure, but in others a different action may be
9325 taken. Such variations are mentioned in the documentation of the option that is
9326 being expanded.
9327
9328
9329
9330
9331 .section "Expansion items" "SECTexpansionitems"
9332 The following items are recognized in expanded strings. White space may be used
9333 between sub-items that are keywords or substrings enclosed in braces inside an
9334 outer set of braces, to improve readability. &*Warning*&: Within braces,
9335 white space is significant.
9336
9337 .vlist
9338 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9339 .cindex "expansion" "variables"
9340 Substitute the contents of the named variable, for example:
9341 .code
9342 $local_part
9343 ${domain}
9344 .endd
9345 The second form can be used to separate the name from subsequent alphanumeric
9346 characters. This form (using braces) is available only for variables; it does
9347 &'not'& apply to message headers. The names of the variables are given in
9348 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9349 given, the expansion fails.
9350
9351 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9352 .cindex "expansion" "operators"
9353 The string is first itself expanded, and then the operation specified by
9354 <&'op'&> is applied to it. For example:
9355 .code
9356 ${lc:$local_part}
9357 .endd
9358 The string starts with the first character after the colon, which may be
9359 leading white space. A list of operators is given in section &<<SECTexpop>>&
9360 below. The operator notation is used for simple expansion items that have just
9361 one argument, because it reduces the number of braces and therefore makes the
9362 string easier to understand.
9363
9364 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9365 This item inserts &"basic"& header lines. It is described with the &%header%&
9366 expansion item below.
9367
9368
9369 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9370 .cindex "expansion" "calling an acl"
9371 .cindex "&%acl%&" "call from expansion"
9372 The name and zero to nine argument strings are first expanded separately.  The expanded
9373 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9374 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9375 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9376 and may use the variables; if another acl expansion is used the values
9377 are restored after it returns.  If the ACL sets
9378 a value using a "message =" modifier and returns accept or deny, the value becomes
9379 the result of the expansion.
9380 If no message is set and the ACL returns accept or deny
9381 the expansion result is an empty string.
9382 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9383
9384
9385 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9386 .cindex authentication "results header"
9387 .cindex headers "authentication-results:"
9388 .cindex authentication "expansion item"
9389 This item returns a string suitable for insertion as an
9390 &'Authentication-Results:'&
9391 header line.
9392 The given <&'authserv-id'&> is included in the result; typically this
9393 will be a domain name identifying the system performing the authentications.
9394 Methods that might be present in the result include:
9395 .code
9396 none
9397 iprev
9398 auth
9399 spf
9400 dkim
9401 .endd
9402
9403 Example use (as an ACL modifier):
9404 .code
9405       add_header = :at_start:${authresults {$primary_hostname}}
9406 .endd
9407 This is safe even if no authentication results are available.
9408
9409
9410 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9411        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9412 .cindex "expansion" "extracting certificate fields"
9413 .cindex "&%certextract%&" "certificate fields"
9414 .cindex "certificate" "extracting fields"
9415 The <&'certificate'&> must be a variable of type certificate.
9416 The field name is expanded and used to retrieve the relevant field from
9417 the certificate.  Supported fields are:
9418 .display
9419 &`version        `&
9420 &`serial_number  `&
9421 &`subject        `& RFC4514 DN
9422 &`issuer         `& RFC4514 DN
9423 &`notbefore      `& time
9424 &`notafter       `& time
9425 &`sig_algorithm  `&
9426 &`signature      `&
9427 &`subj_altname   `& tagged list
9428 &`ocsp_uri       `& list
9429 &`crl_uri        `& list
9430 .endd
9431 If the field is found,
9432 <&'string2'&> is expanded, and replaces the whole item;
9433 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9434 variable &$value$& contains the value that has been extracted. Afterwards, it
9435 is restored to any previous value it might have had.
9436
9437 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9438 key is not found. If {<&'string2'&>} is also omitted, the value that was
9439 extracted is used.
9440
9441 Some field names take optional modifiers, appended and separated by commas.
9442
9443 The field selectors marked as "RFC4514" above
9444 output a Distinguished Name string which is
9445 not quite
9446 parseable by Exim as a comma-separated tagged list
9447 (the exceptions being elements containing commas).
9448 RDN elements of a single type may be selected by
9449 a modifier of the type label; if so the expansion
9450 result is a list (newline-separated by default).
9451 The separator may be changed by another modifier of
9452 a right angle-bracket followed immediately by the new separator.
9453 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9454
9455 The field selectors marked as "time" above
9456 take an optional modifier of "int"
9457 for which the result is the number of seconds since epoch.
9458 Otherwise the result is a human-readable string
9459 in the timezone selected by the main "timezone" option.
9460
9461 The field selectors marked as "list" above return a list,
9462 newline-separated by default,
9463 (embedded separator characters in elements are doubled).
9464 The separator may be changed by a modifier of
9465 a right angle-bracket followed immediately by the new separator.
9466
9467 The field selectors marked as "tagged" above
9468 prefix each list element with a type string and an equals sign.
9469 Elements of only one type may be selected by a modifier
9470 which is one of "dns", "uri" or "mail";
9471 if so the element tags are omitted.
9472
9473 If not otherwise noted field values are presented in human-readable form.
9474
9475 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9476        {*&<&'arg'&>&*}...}*&"
9477 .cindex &%dlfunc%&
9478 This expansion dynamically loads and then calls a locally-written C function.
9479 This functionality is available only if Exim is compiled with
9480 .code
9481 EXPAND_DLFUNC=yes
9482 .endd
9483 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9484 object so that it doesn't reload the same object file in the same Exim process
9485 (but of course Exim does start new processes frequently).
9486
9487 There may be from zero to eight arguments to the function.
9488
9489 When compiling
9490 a local function that is to be called in this way,
9491 first &_DLFUNC_IMPL_& should be defined,
9492 and second &_local_scan.h_& should be included.
9493 The Exim variables and functions that are defined by that API
9494 are also available for dynamically loaded functions. The function itself
9495 must have the following type:
9496 .code
9497 int dlfunction(uschar **yield, int argc, uschar *argv[])
9498 .endd
9499 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9500 function should return one of the following values:
9501
9502 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9503 into the expanded string that is being built.
9504
9505 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9506 from &'yield'&, if it is set.
9507
9508 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9509 taken from &'yield'& if it is set.
9510
9511 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9512
9513 When compiling a function that is to be used in this way with gcc,
9514 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9515 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9516
9517
9518 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9519 .cindex "expansion" "extracting value from environment"
9520 .cindex "environment" "values from"
9521 The key is first expanded separately, and leading and trailing white space
9522 removed.
9523 This is then searched for as a name in the environment.
9524 If a variable is found then its value is placed in &$value$&
9525 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9526
9527 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9528 appear, for example:
9529 .code
9530 ${env{USER}{$value} fail }
9531 .endd
9532 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9533 {<&'string1'&>} must be present for &"fail"& to be recognized.
9534
9535 If {<&'string2'&>} is omitted an empty string is substituted on
9536 search failure.
9537 If {<&'string1'&>} is omitted the search result is substituted on
9538 search success.
9539
9540 The environment is adjusted by the &%keep_environment%& and
9541 &%add_environment%& main section options.
9542
9543
9544 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9545        {*&<&'string3'&>&*}}*&"
9546 .cindex "expansion" "extracting substrings by key"
9547 .cindex "&%extract%&" "substrings by key"
9548 The key and <&'string1'&> are first expanded separately. Leading and trailing
9549 white space is removed from the key (but not from any of the strings). The key
9550 must not be empty and must not consist entirely of digits.
9551 The expanded <&'string1'&> must be of the form:
9552 .display
9553 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9554 .endd
9555 .vindex "&$value$&"
9556 where the equals signs and spaces (but not both) are optional. If any of the
9557 values contain white space, they must be enclosed in double quotes, and any
9558 values that are enclosed in double quotes are subject to escape processing as
9559 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9560 for the value that corresponds to the key. The search is case-insensitive. If
9561 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9562 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9563 variable &$value$& contains the value that has been extracted. Afterwards, it
9564 is restored to any previous value it might have had.
9565
9566 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9567 key is not found. If {<&'string2'&>} is also omitted, the value that was
9568 extracted is used. Thus, for example, these two expansions are identical, and
9569 yield &"2001"&:
9570 .code
9571 ${extract{gid}{uid=1984 gid=2001}}
9572 ${extract{gid}{uid=1984 gid=2001}{$value}}
9573 .endd
9574 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9575 appear, for example:
9576 .code
9577 ${extract{Z}{A=... B=...}{$value} fail }
9578 .endd
9579 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9580 {<&'string2'&>} must be present for &"fail"& to be recognized.
9581
9582 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9583        {*&<&'string3'&>&*}}*&" &&&
9584        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9585        {*&<&'string3'&>&*}}*&"
9586 .cindex "expansion" "extracting from JSON object"
9587 .cindex JSON expansions
9588 The key and <&'string1'&> are first expanded separately. Leading and trailing
9589 white space is removed from the key (but not from any of the strings). The key
9590 must not be empty and must not consist entirely of digits.
9591 The expanded <&'string1'&> must be of the form:
9592 .display
9593 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9594 .endd
9595 .vindex "&$value$&"
9596 The braces, commas and colons, and the quoting of the member name are required;
9597 the spaces are optional.
9598 Matching of the key against the member names is done case-sensitively.
9599 For the &"json"& variant,
9600 if a returned value is a JSON string, it retains its leading and
9601 trailing quotes.
9602 For the &"jsons"& variant, which is intended for use with JSON strings, the
9603 leading and trailing quotes are removed from the returned value.
9604 . XXX should be a UTF-8 compare
9605
9606 The results of matching are handled as above.
9607
9608
9609 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9610         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9611 .cindex "expansion" "extracting substrings by number"
9612 .cindex "&%extract%&" "substrings by number"
9613 The <&'number'&> argument must consist entirely of decimal digits,
9614 apart from leading and trailing white space, which is ignored.
9615 This is what distinguishes this form of &%extract%& from the previous kind. It
9616 behaves in the same way, except that, instead of extracting a named field, it
9617 extracts from <&'string1'&> the field whose number is given as the first
9618 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9619 <&'string3'&> as before.
9620
9621 The fields in the string are separated by any one of the characters in the
9622 separator string. These may include space or tab characters.
9623 The first field is numbered one. If the number is negative, the fields are
9624 counted from the end of the string, with the rightmost one numbered -1. If the
9625 number given is zero, the entire string is returned. If the modulus of the
9626 number is greater than the number of fields in the string, the result is the
9627 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9628 provided. For example:
9629 .code
9630 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9631 .endd
9632 yields &"42"&, and
9633 .code
9634 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9635 .endd
9636 yields &"99"&. Two successive separators mean that the field between them is
9637 empty (for example, the fifth field above).
9638
9639
9640 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9641         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9642        "&*${extract jsons{*&<&'number'&>&*}}&&&
9643         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9644 .cindex "expansion" "extracting from JSON array"
9645 .cindex JSON expansions
9646 The <&'number'&> argument must consist entirely of decimal digits,
9647 apart from leading and trailing white space, which is ignored.
9648
9649 Field selection and result handling is as above;
9650 there is no choice of field separator.
9651 For the &"json"& variant,
9652 if a returned value is a JSON string, it retains its leading and
9653 trailing quotes.
9654 For the &"jsons"& variant, which is intended for use with JSON strings, the
9655 leading and trailing quotes are removed from the returned value.
9656
9657
9658 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9659 .cindex "list" "selecting by condition"
9660 .cindex "expansion" "selecting from list by condition"
9661 .vindex "&$item$&"
9662 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9663 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9664 For each item
9665 in this list, its value is place in &$item$&, and then the condition is
9666 evaluated. If the condition is true, &$item$& is added to the output as an
9667 item in a new list; if the condition is false, the item is discarded. The
9668 separator used for the output list is the same as the one used for the
9669 input, but a separator setting is not included in the output. For example:
9670 .code
9671 ${filter{a:b:c}{!eq{$item}{b}}}
9672 .endd
9673 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9674 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9675
9676
9677 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9678 .cindex "hash function" "textual"
9679 .cindex "expansion" "textual hash"
9680 This is a textual hashing function, and was the first to be implemented in
9681 early versions of Exim. In current releases, there are other hashing functions
9682 (numeric, MD5, and SHA-1), which are described below.
9683
9684 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9685 <&'n'&>. If you are using fixed values for these numbers, that is, if
9686 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9687 use the simpler operator notation that avoids some of the braces:
9688 .code
9689 ${hash_<n>_<m>:<string>}
9690 .endd
9691 The second number is optional (in both notations). If <&'n'&> is greater than
9692 or equal to the length of the string, the expansion item returns the string.
9693 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9694 function to the string. The new string consists of characters taken from the
9695 first <&'m'&> characters of the string
9696 .code
9697 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9698 .endd
9699 If <&'m'&> is not present the value 26 is used, so that only lower case
9700 letters appear. For example:
9701 .display
9702 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9703 &`$hash{5}{monty}}           `&   yields  &`monty`&
9704 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9705 .endd
9706
9707 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9708         &*$h_*&<&'header&~name'&>&*:*&" &&&
9709        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9710         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9711        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9712         &*$lh_*&<&'header&~name'&>&*:*&"
9713        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9714         &*$rh_*&<&'header&~name'&>&*:*&"
9715 .cindex "expansion" "header insertion"
9716 .vindex "&$header_$&"
9717 .vindex "&$bheader_$&"
9718 .vindex "&$lheader_$&"
9719 .vindex "&$rheader_$&"
9720 .cindex "header lines" "in expansion strings"
9721 .cindex "header lines" "character sets"
9722 .cindex "header lines" "decoding"
9723 Substitute the contents of the named message header line, for example
9724 .code
9725 $header_reply-to:
9726 .endd
9727 The newline that terminates a header line is not included in the expansion, but
9728 internal newlines (caused by splitting the header line over several physical
9729 lines) may be present.
9730
9731 The difference between the four pairs of expansions is in the way
9732 the data in the header line is interpreted.
9733
9734 .ilist
9735 .cindex "white space" "in header lines"
9736 &%rheader%& gives the original &"raw"& content of the header line, with no
9737 processing at all, and without the removal of leading and trailing white space.
9738
9739 .next
9740 .cindex "list" "of header lines"
9741 &%lheader%& gives a colon-separated list, one element per header when there
9742 are multiple headers with a given name.
9743 Any embedded colon characters within an element are doubled, so normal Exim
9744 list-processing facilities can be used.
9745 The terminating newline of each element is removed; in other respects
9746 the content is &"raw"&.
9747
9748 .next
9749 .cindex "base64 encoding" "in header lines"
9750 &%bheader%& removes leading and trailing white space, and then decodes base64
9751 or quoted-printable MIME &"words"& within the header text, but does no
9752 character set translation. If decoding of what looks superficially like a MIME
9753 &"word"& fails, the raw string is returned. If decoding
9754 .cindex "binary zero" "in header line"
9755 produces a binary zero character, it is replaced by a question mark &-- this is
9756 what Exim does for binary zeros that are actually received in header lines.
9757
9758 .next
9759 &%header%& tries to translate the string as decoded by &%bheader%& to a
9760 standard character set. This is an attempt to produce the same string as would
9761 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9762 returned. Translation is attempted only on operating systems that support the
9763 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9764 a system Makefile or in &_Local/Makefile_&.
9765 .endlist ilist
9766
9767 In a filter file, the target character set for &%header%& can be specified by a
9768 command of the following form:
9769 .code
9770 headers charset "UTF-8"
9771 .endd
9772 This command affects all references to &$h_$& (or &$header_$&) expansions in
9773 subsequently obeyed filter commands. In the absence of this command, the target
9774 character set in a filter is taken from the setting of the &%headers_charset%&
9775 option in the runtime configuration. The value of this option defaults to the
9776 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9777 ISO-8859-1.
9778
9779 Header names follow the syntax of RFC 2822, which states that they may contain
9780 any printing characters except space and colon. Consequently, curly brackets
9781 &'do not'& terminate header names, and should not be used to enclose them as
9782 if they were variables. Attempting to do so causes a syntax error.
9783
9784 Only header lines that are common to all copies of a message are visible to
9785 this mechanism. These are the original header lines that are received with the
9786 message, and any that are added by an ACL statement or by a system
9787 filter. Header lines that are added to a particular copy of a message by a
9788 router or transport are not accessible.
9789
9790 For incoming SMTP messages, no header lines are visible in
9791 ACLs that are obeyed before the data phase completes,
9792 because the header structure is not set up until the message is received.
9793 They are visible in DKIM, PRDR and DATA ACLs.
9794 Header lines that are added in a RCPT ACL (for example)
9795 are saved until the message's incoming header lines are available, at which
9796 point they are added.
9797 When any of the above ACLs ar
9798 running, however, header lines added by earlier ACLs are visible.
9799
9800 Upper case and lower case letters are synonymous in header names. If the
9801 following character is white space, the terminating colon may be omitted, but
9802 this is not recommended, because you may then forget it when it is needed. When
9803 white space terminates the header name, this white space is included in the
9804 expanded string.  If the message does not contain the given header, the
9805 expansion item is replaced by an empty string. (See the &%def%& condition in
9806 section &<<SECTexpcond>>& for a means of testing for the existence of a
9807 header.)
9808
9809 If there is more than one header with the same name, they are all concatenated
9810 to form the substitution string, up to a maximum length of 64K. Unless
9811 &%rheader%& is being used, leading and trailing white space is removed from
9812 each header before concatenation, and a completely empty header is ignored. A
9813 newline character is then inserted between non-empty headers, but there is no
9814 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9815 those headers that contain lists of addresses, a comma is also inserted at the
9816 junctions between headers. This does not happen for the &%rheader%& expansion.
9817
9818
9819 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9820 .cindex "expansion" "hmac hashing"
9821 .cindex &%hmac%&
9822 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9823 shared secret and some text into a message authentication code, as specified in
9824 RFC 2104. This differs from &`${md5:secret_text...}`& or
9825 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9826 cryptographic hash, allowing for authentication that is not possible with MD5
9827 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9828 present. For example:
9829 .code
9830 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9831 .endd
9832 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9833 produces:
9834 .code
9835 dd97e3ba5d1a61b5006108f8c8252953
9836 .endd
9837 As an example of how this might be used, you might put in the main part of
9838 an Exim configuration:
9839 .code
9840 SPAMSCAN_SECRET=cohgheeLei2thahw
9841 .endd
9842 In a router or a transport you could then have:
9843 .code
9844 headers_add = \
9845   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9846   ${hmac{md5}{SPAMSCAN_SECRET}\
9847   {${primary_hostname},${message_exim_id},$h_message-id:}}
9848 .endd
9849 Then given a message, you can check where it was scanned by looking at the
9850 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9851 this header line is authentic by recomputing the authentication code from the
9852 host name, message ID and the &'Message-id:'& header line. This can be done
9853 using Exim's &%-be%& option, or by other means, for example, by using the
9854 &'hmac_md5_hex()'& function in Perl.
9855
9856
9857 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9858 .cindex "expansion" "conditional"
9859 .cindex "&%if%&, expansion item"
9860 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9861 item; otherwise <&'string2'&> is used. The available conditions are described
9862 in section &<<SECTexpcond>>& below. For example:
9863 .code
9864 ${if eq {$local_part}{postmaster} {yes}{no} }
9865 .endd
9866 The second string need not be present; if it is not and the condition is not
9867 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9868 be present instead of the second string (without any curly brackets). In this
9869 case, the expansion is forced to fail if the condition is not true (see section
9870 &<<SECTforexpfai>>&).
9871
9872 If both strings are omitted, the result is the string &`true`& if the condition
9873 is true, and the empty string if the condition is false. This makes it less
9874 cumbersome to write custom ACL and router conditions. For example, instead of
9875 .code
9876 condition = ${if >{$acl_m4}{3}{true}{false}}
9877 .endd
9878 you can use
9879 .code
9880 condition = ${if >{$acl_m4}{3}}
9881 .endd
9882
9883
9884
9885 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9886 .cindex expansion "imap folder"
9887 .cindex "&%imapfolder%& expansion item"
9888 This item converts a (possibly multilevel, or with non-ASCII characters)
9889 folder specification to a Maildir name for filesystem use.
9890 For information on internationalisation support see &<<SECTi18nMDA>>&.
9891
9892
9893
9894 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9895 .cindex "expansion" "string truncation"
9896 .cindex "&%length%& expansion item"
9897 The &%length%& item is used to extract the initial portion of a string. Both
9898 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9899 you are using a fixed value for the number, that is, if <&'string1'&> does not
9900 change when expanded, you can use the simpler operator notation that avoids
9901 some of the braces:
9902 .code
9903 ${length_<n>:<string>}
9904 .endd
9905 The result of this item is either the first <&'n'&> bytes or the whole
9906 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9907 &%strlen%&, which gives the length of a string.
9908 All measurement is done in bytes and is not UTF-8 aware.
9909
9910
9911 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9912         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9913 .cindex "expansion" "extracting list elements by number"
9914 .cindex "&%listextract%&" "extract list elements by number"
9915 .cindex "list" "extracting elements by number"
9916 The <&'number'&> argument must consist entirely of decimal digits,
9917 apart from an optional leading minus,
9918 and leading and trailing white space (which is ignored).
9919
9920 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9921 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9922
9923 The first field of the list is numbered one.
9924 If the number is negative, the fields are
9925 counted from the end of the list, with the rightmost one numbered -1.
9926 The numbered element of the list is extracted and placed in &$value$&,
9927 then <&'string2'&> is expanded as the result.
9928
9929 If the modulus of the
9930 number is zero or greater than the number of fields in the string,
9931 the result is the expansion of <&'string3'&>.
9932
9933 For example:
9934 .code
9935 ${listextract{2}{x:42:99}}
9936 .endd
9937 yields &"42"&, and
9938 .code
9939 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9940 .endd
9941 yields &"result: 42"&.
9942
9943 If {<&'string3'&>} is omitted, an empty string is used for string3.
9944 If {<&'string2'&>} is also omitted, the value that was
9945 extracted is used.
9946 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9947
9948
9949 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9950         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9951 This is the first of one of two different types of lookup item, which are both
9952 described in the next item.
9953
9954 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9955         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9956 .cindex "expansion" "lookup in"
9957 .cindex "file" "lookups"
9958 .cindex "lookup" "in expanded string"
9959 The two forms of lookup item specify data lookups in files and databases, as
9960 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9961 lookups, and the second is used for query-style lookups. The <&'key'&>,
9962 <&'file'&>, and <&'query'&> strings are expanded before use.
9963
9964 If there is any white space in a lookup item which is part of a filter command,
9965 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9966 other place where white space is significant, the lookup item must be enclosed
9967 in double quotes. The use of data lookups in users' filter files may be locked
9968 out by the system administrator.
9969
9970 .vindex "&$value$&"
9971 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9972 During its expansion, the variable &$value$& contains the data returned by the
9973 lookup. Afterwards it reverts to the value it had previously (at the outer
9974 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9975 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9976 string on failure. If <&'string2'&> is provided, it can itself be a nested
9977 lookup, thus providing a mechanism for looking up a default value when the
9978 original lookup fails.
9979
9980 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9981 data for the outer lookup while the parameters of the second lookup are
9982 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9983 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9984 appear, and in this case, if the lookup fails, the entire expansion is forced
9985 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9986 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9987 successful lookup, and nothing in the case of failure.
9988
9989 For single-key lookups, the string &"partial"& is permitted to precede the
9990 search type in order to do partial matching, and * or *@ may follow a search
9991 type to request default lookups if the key does not match (see sections
9992 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9993
9994 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9995 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9996 and non-wild parts of the key during the expansion of the replacement text.
9997 They return to their previous values at the end of the lookup item.
9998
9999 This example looks up the postmaster alias in the conventional alias file:
10000 .code
10001 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10002 .endd
10003 This example uses NIS+ to look up the full name of the user corresponding to
10004 the local part of an address, forcing the expansion to fail if it is not found:
10005 .code
10006 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10007   {$value}fail}
10008 .endd
10009
10010
10011 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10012 .cindex "expansion" "list creation"
10013 .vindex "&$item$&"
10014 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10015 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10016 For each item
10017 in this list, its value is place in &$item$&, and then <&'string2'&> is
10018 expanded and added to the output as an item in a new list. The separator used
10019 for the output list is the same as the one used for the input, but a separator
10020 setting is not included in the output. For example:
10021 .code
10022 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10023 .endd
10024 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10025 value of &$item$& is restored to what it was before. See also the &%filter%&
10026 and &%reduce%& expansion items.
10027
10028 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10029 .cindex "expansion" "numeric hash"
10030 .cindex "hash function" "numeric"
10031 The three strings are expanded; the first two must yield numbers. Call them
10032 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10033 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10034 can use the simpler operator notation that avoids some of the braces:
10035 .code
10036 ${nhash_<n>_<m>:<string>}
10037 .endd
10038 The second number is optional (in both notations). If there is only one number,
10039 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10040 processed by a div/mod hash function that returns two numbers, separated by a
10041 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10042 example,
10043 .code
10044 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10045 .endd
10046 returns the string &"6/33"&.
10047
10048
10049
10050 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10051 .cindex "Perl" "use in expanded string"
10052 .cindex "expansion" "calling Perl from"
10053 This item is available only if Exim has been built to include an embedded Perl
10054 interpreter. The subroutine name and the arguments are first separately
10055 expanded, and then the Perl subroutine is called with those arguments. No
10056 additional arguments need be given; the maximum number permitted, including the
10057 name of the subroutine, is nine.
10058
10059 The return value of the subroutine is inserted into the expanded string, unless
10060 the return value is &%undef%&. In that case, the expansion fails in the same
10061 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10062 Whatever you return is evaluated in a scalar context. For example, if you
10063 return the name of a Perl vector, the return value is the size of the vector,
10064 not its contents.
10065
10066 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10067 with the error message that was passed to &%die%&. More details of the embedded
10068 Perl facility are given in chapter &<<CHAPperl>>&.
10069
10070 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10071 out the use of this expansion item in filter files.
10072
10073
10074 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10075 .cindex "&%prvs%& expansion item"
10076 The first argument is a complete email address and the second is secret
10077 keystring. The third argument, specifying a key number, is optional. If absent,
10078 it defaults to 0. The result of the expansion is a prvs-signed email address,
10079 to be typically used with the &%return_path%& option on an &(smtp)& transport
10080 as part of a bounce address tag validation (BATV) scheme. For more discussion
10081 and an example, see section &<<SECTverifyPRVS>>&.
10082
10083 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10084         {*&<&'string'&>&*}}*&"
10085 .cindex "&%prvscheck%& expansion item"
10086 This expansion item is the complement of the &%prvs%& item. It is used for
10087 checking prvs-signed addresses. If the expansion of the first argument does not
10088 yield a syntactically valid prvs-signed address, the whole item expands to the
10089 empty string. When the first argument does expand to a syntactically valid
10090 prvs-signed address, the second argument is expanded, with the prvs-decoded
10091 version of the address and the key number extracted from the address in the
10092 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10093
10094 These two variables can be used in the expansion of the second argument to
10095 retrieve the secret. The validity of the prvs-signed address is then checked
10096 against the secret. The result is stored in the variable &$prvscheck_result$&,
10097 which is empty for failure or &"1"& for success.
10098
10099 The third argument is optional; if it is missing, it defaults to an empty
10100 string. This argument is now expanded. If the result is an empty string, the
10101 result of the expansion is the decoded version of the address. This is the case
10102 whether or not the signature was valid. Otherwise, the result of the expansion
10103 is the expansion of the third argument.
10104
10105 All three variables can be used in the expansion of the third argument.
10106 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10107 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10108
10109 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10110 .cindex "expansion" "inserting an entire file"
10111 .cindex "file" "inserting into expansion"
10112 .cindex "&%readfile%& expansion item"
10113 The filename and end-of-line string are first expanded separately. The file is
10114 then read, and its contents replace the entire item. All newline characters in
10115 the file are replaced by the end-of-line string if it is present. Otherwise,
10116 newlines are left in the string.
10117 String expansion is not applied to the contents of the file. If you want this,
10118 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10119 the string expansion fails.
10120
10121 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10122 locks out the use of this expansion item in filter files.
10123
10124
10125
10126 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10127         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10128 .cindex "expansion" "inserting from a socket"
10129 .cindex "socket, use of in expansion"
10130 .cindex "&%readsocket%& expansion item"
10131 This item inserts data from a Unix domain or TCP socket into the expanded
10132 string. The minimal way of using it uses just two arguments, as in these
10133 examples:
10134 .code
10135 ${readsocket{/socket/name}{request string}}
10136 ${readsocket{inet:some.host:1234}{request string}}
10137 .endd
10138 For a Unix domain socket, the first substring must be the path to the socket.
10139 For an Internet socket, the first substring must contain &`inet:`& followed by
10140 a host name or IP address, followed by a colon and a port, which can be a
10141 number or the name of a TCP port in &_/etc/services_&. An IP address may
10142 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10143 example:
10144 .code
10145 ${readsocket{inet:[::1]:1234}{request string}}
10146 .endd
10147 Only a single host name may be given, but if looking it up yields more than
10148 one IP address, they are each tried in turn until a connection is made. For
10149 both kinds of socket, Exim makes a connection, writes the request string
10150 unless it is an empty string; and no terminating NUL is ever sent)
10151 and reads from the socket until an end-of-file
10152 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10153 extend what can be done. Firstly, you can vary the timeout. For example:
10154 .code
10155 ${readsocket{/socket/name}{request string}{3s}}
10156 .endd
10157
10158 The third argument is a list of options, of which the first element is the timeout
10159 and must be present if the argument is given.
10160 Further elements are options of form &'name=value'&.
10161 Two option types is currently recognised: shutdown and tls.
10162 The first defines whether (the default)
10163 or not a shutdown is done on the connection after sending the request.
10164 Example, to not do so (preferred, eg. by some webservers):
10165 .code
10166 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10167 .endd
10168 The second, tls, controls the use of TLS on the connection.  Example:
10169 .code
10170 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10171 .endd
10172 The default is to not use TLS.
10173 If it is enabled, a shutdown as descripbed above is never done.
10174
10175 A fourth argument allows you to change any newlines that are in the data
10176 that is read, in the same way as for &%readfile%& (see above). This example
10177 turns them into spaces:
10178 .code
10179 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10180 .endd
10181 As with all expansions, the substrings are expanded before the processing
10182 happens. Errors in these sub-expansions cause the expansion to fail. In
10183 addition, the following errors can occur:
10184
10185 .ilist
10186 Failure to create a socket file descriptor;
10187 .next
10188 Failure to connect the socket;
10189 .next
10190 Failure to write the request string;
10191 .next
10192 Timeout on reading from the socket.
10193 .endlist
10194
10195 By default, any of these errors causes the expansion to fail. However, if
10196 you supply a fifth substring, it is expanded and used when any of the above
10197 errors occurs. For example:
10198 .code
10199 ${readsocket{/socket/name}{request string}{3s}{\n}\
10200   {socket failure}}
10201 .endd
10202 You can test for the existence of a Unix domain socket by wrapping this
10203 expansion in &`${if exists`&, but there is a race condition between that test
10204 and the actual opening of the socket, so it is safer to use the fifth argument
10205 if you want to be absolutely sure of avoiding an expansion error for a
10206 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10207
10208 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10209 locks out the use of this expansion item in filter files.
10210
10211
10212 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10213 .cindex "expansion" "reducing a list to a scalar"
10214 .cindex "list" "reducing to a scalar"
10215 .vindex "&$value$&"
10216 .vindex "&$item$&"
10217 This operation reduces a list to a single, scalar string. After expansion,
10218 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10219 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10220 Then <&'string2'&> is expanded and
10221 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10222 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10223 them. The result of that expansion is assigned to &$value$& before the next
10224 iteration. When the end of the list is reached, the final value of &$value$& is
10225 added to the expansion output. The &%reduce%& expansion item can be used in a
10226 number of ways. For example, to add up a list of numbers:
10227 .code
10228 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10229 .endd
10230 The result of that expansion would be &`6`&. The maximum of a list of numbers
10231 can be found:
10232 .code
10233 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10234 .endd
10235 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10236 restored to what they were before. See also the &%filter%& and &%map%&
10237 expansion items.
10238
10239 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10240 This item inserts &"raw"& header lines. It is described with the &%header%&
10241 expansion item in section &<<SECTexpansionitems>>& above.
10242
10243 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10244         {*&<&'string2'&>&*}}*&"
10245 .cindex "expansion" "running a command"
10246 .cindex "&%run%& expansion item"
10247 The command and its arguments are first expanded as one string. The string is
10248 split apart into individual arguments by spaces, and then the command is run
10249 in a separate process, but under the same uid and gid.  As in other command
10250 executions from Exim, a shell is not used by default. If the command requires
10251 a shell, you must explicitly code it.
10252
10253 Since the arguments are split by spaces, when there is a variable expansion
10254 which has an empty result, it will cause the situation that the argument will
10255 simply be omitted when the program is actually executed by Exim. If the
10256 script/program requires a specific number of arguments and the expanded
10257 variable could possibly result in this empty expansion, the variable must be
10258 quoted. This is more difficult if the expanded variable itself could result
10259 in a string containing quotes, because it would interfere with the quotes
10260 around the command arguments. A possible guard against this is to wrap the
10261 variable in the &%sg%& operator to change any quote marks to some other
10262 character.
10263
10264 The standard input for the command exists, but is empty. The standard output
10265 and standard error are set to the same file descriptor.
10266 .cindex "return code" "from &%run%& expansion"
10267 .vindex "&$value$&"
10268 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10269 and replaces the entire item; during this expansion, the standard output/error
10270 from the command is in the variable &$value$&. If the command fails,
10271 <&'string2'&>, if present, is expanded and used. Once again, during the
10272 expansion, the standard output/error from the command is in the variable
10273 &$value$&.
10274
10275 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10276 can be the word &"fail"& (not in braces) to force expansion failure if the
10277 command does not succeed. If both strings are omitted, the result is contents
10278 of the standard output/error on success, and nothing on failure.
10279
10280 .vindex "&$run_in_acl$&"
10281 The standard output/error of the command is put in the variable &$value$&.
10282 In this ACL example, the output of a command is logged for the admin to
10283 troubleshoot:
10284 .code
10285 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10286       log_message  = Output of id: $value
10287 .endd
10288 If the command requires shell idioms, such as the > redirect operator, the
10289 shell must be invoked directly, such as with:
10290 .code
10291 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10292 .endd
10293
10294 .vindex "&$runrc$&"
10295 The return code from the command is put in the variable &$runrc$&, and this
10296 remains set afterwards, so in a filter file you can do things like this:
10297 .code
10298 if "${run{x y z}{}}$runrc" is 1 then ...
10299   elif $runrc is 2 then ...
10300   ...
10301 endif
10302 .endd
10303 If execution of the command fails (for example, the command does not exist),
10304 the return code is 127 &-- the same code that shells use for non-existent
10305 commands.
10306
10307 &*Warning*&: In a router or transport, you cannot assume the order in which
10308 option values are expanded, except for those preconditions whose order of
10309 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10310 by the expansion of one option, and use it in another.
10311
10312 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10313 out the use of this expansion item in filter files.
10314
10315
10316 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10317 .cindex "expansion" "string substitution"
10318 .cindex "&%sg%& expansion item"
10319 This item works like Perl's substitution operator (s) with the global (/g)
10320 option; hence its name. However, unlike the Perl equivalent, Exim does not
10321 modify the subject string; instead it returns the modified string for insertion
10322 into the overall expansion. The item takes three arguments: the subject string,
10323 a regular expression, and a substitution string. For example:
10324 .code
10325 ${sg{abcdefabcdef}{abc}{xyz}}
10326 .endd
10327 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10328 if any $, } or \ characters are required in the regular expression or in the
10329 substitution string, they have to be escaped. For example:
10330 .code
10331 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10332 .endd
10333 yields &"defabc"&, and
10334 .code
10335 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10336 .endd
10337 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10338 the regular expression from string expansion.
10339
10340 The regular expression is compiled in 8-bit mode, working against bytes
10341 rather than any Unicode-aware character handling.
10342
10343
10344 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10345 .cindex sorting "a list"
10346 .cindex list sorting
10347 .cindex expansion "list sorting"
10348 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10349 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10350 The <&'comparator'&> argument is interpreted as the operator
10351 of a two-argument expansion condition.
10352 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10353 The comparison should return true when applied to two values
10354 if the first value should sort before the second value.
10355 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10356 the element being placed in &$item$&,
10357 to give values for comparison.
10358
10359 The item result is a sorted list,
10360 with the original list separator,
10361 of the list elements (in full) of the original.
10362
10363 Examples:
10364 .code
10365 ${sort{3:2:1:4}{<}{$item}}
10366 .endd
10367 sorts a list of numbers, and
10368 .code
10369 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10370 .endd
10371 will sort an MX lookup into priority order.
10372
10373
10374 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10375 .cindex "&%substr%& expansion item"
10376 .cindex "substring extraction"
10377 .cindex "expansion" "substring extraction"
10378 The three strings are expanded; the first two must yield numbers. Call them
10379 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10380 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10381 can use the simpler operator notation that avoids some of the braces:
10382 .code
10383 ${substr_<n>_<m>:<string>}
10384 .endd
10385 The second number is optional (in both notations).
10386 If it is absent in the simpler format, the preceding underscore must also be
10387 omitted.
10388
10389 The &%substr%& item can be used to extract more general substrings than
10390 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10391 length required. For example
10392 .code
10393 ${substr{3}{2}{$local_part}}
10394 .endd
10395 If the starting offset is greater than the string length the result is the
10396 null string; if the length plus starting offset is greater than the string
10397 length, the result is the right-hand part of the string, starting from the
10398 given offset. The first byte (character) in the string has offset zero.
10399
10400 The &%substr%& expansion item can take negative offset values to count
10401 from the right-hand end of its operand. The last byte (character) is offset -1,
10402 the second-last is offset -2, and so on. Thus, for example,
10403 .code
10404 ${substr{-5}{2}{1234567}}
10405 .endd
10406 yields &"34"&. If the absolute value of a negative offset is greater than the
10407 length of the string, the substring starts at the beginning of the string, and
10408 the length is reduced by the amount of overshoot. Thus, for example,
10409 .code
10410 ${substr{-5}{2}{12}}
10411 .endd
10412 yields an empty string, but
10413 .code
10414 ${substr{-3}{2}{12}}
10415 .endd
10416 yields &"1"&.
10417
10418 When the second number is omitted from &%substr%&, the remainder of the string
10419 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10420 string preceding the offset point are taken. For example, an offset of -1 and
10421 no length, as in these semantically identical examples:
10422 .code
10423 ${substr_-1:abcde}
10424 ${substr{-1}{abcde}}
10425 .endd
10426 yields all but the last character of the string, that is, &"abcd"&.
10427
10428 All measurement is done in bytes and is not UTF-8 aware.
10429
10430
10431
10432 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10433         {*&<&'replacements'&>&*}}*&"
10434 .cindex "expansion" "character translation"
10435 .cindex "&%tr%& expansion item"
10436 This item does single-character (in bytes) translation on its subject string. The second
10437 argument is a list of characters to be translated in the subject string. Each
10438 matching character is replaced by the corresponding character from the
10439 replacement list. For example
10440 .code
10441 ${tr{abcdea}{ac}{13}}
10442 .endd
10443 yields &`1b3de1`&. If there are duplicates in the second character string, the
10444 last occurrence is used. If the third string is shorter than the second, its
10445 last character is replicated. However, if it is empty, no translation takes
10446 place.
10447
10448 All character handling is done in bytes and is not UTF-8 aware.
10449
10450 .endlist
10451
10452
10453
10454 .section "Expansion operators" "SECTexpop"
10455 .cindex "expansion" "operators"
10456 For expansion items that perform transformations on a single argument string,
10457 the &"operator"& notation is used because it is simpler and uses fewer braces.
10458 The substring is first expanded before the operation is applied to it. The
10459 following operations can be performed:
10460
10461 .vlist
10462 .vitem &*${address:*&<&'string'&>&*}*&
10463 .cindex "expansion" "RFC 2822 address handling"
10464 .cindex "&%address%& expansion item"
10465 The string is interpreted as an RFC 2822 address, as it might appear in a
10466 header line, and the effective address is extracted from it. If the string does
10467 not parse successfully, the result is empty.
10468
10469 The parsing correctly handles SMTPUTF8 Unicode in the string.
10470
10471
10472 .vitem &*${addresses:*&<&'string'&>&*}*&
10473 .cindex "expansion" "RFC 2822 address handling"
10474 .cindex "&%addresses%& expansion item"
10475 The string (after expansion) is interpreted as a list of addresses in RFC
10476 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10477 operative address (&'local-part@domain'&) is extracted from each item, and the
10478 result of the expansion is a colon-separated list, with appropriate
10479 doubling of colons should any happen to be present in the email addresses.
10480 Syntactically invalid RFC2822 address items are omitted from the output.
10481
10482 It is possible to specify a character other than colon for the output
10483 separator by starting the string with > followed by the new separator
10484 character. For example:
10485 .code
10486 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10487 .endd
10488 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10489 first, so if the expanded string starts with >, it may change the output
10490 separator unintentionally. This can be avoided by setting the output
10491 separator explicitly:
10492 .code
10493 ${addresses:>:$h_from:}
10494 .endd
10495
10496 Compare the &%address%& (singular)
10497 expansion item, which extracts the working address from a single RFC2822
10498 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10499 processing lists.
10500
10501 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10502 a strict interpretation of header line formatting.  Exim parses the bare,
10503 unquoted portion of an email address and if it finds a comma, treats it as an
10504 email address separator. For the example header line:
10505 .code
10506 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10507 .endd
10508 The first example below demonstrates that Q-encoded email addresses are parsed
10509 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10510 It does not see the comma because it's still encoded as "=2C".  The second
10511 example below is passed the contents of &`$header_from:`&, meaning it gets
10512 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10513 The third example shows that the presence of a comma is skipped when it is
10514 quoted.  The fourth example shows SMTPUTF8 handling.
10515 .code
10516 # exim -be '${addresses:From: \
10517 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10518 user@example.com
10519 # exim -be '${addresses:From: Last, First <user@example.com>}'
10520 Last:user@example.com
10521 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10522 user@example.com
10523 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10524 フィリップ@example.jp
10525 .endd
10526
10527 .vitem &*${base32:*&<&'digits'&>&*}*&
10528 .cindex "&%base32%& expansion item"
10529 .cindex "expansion" "conversion to base 32"
10530 The string must consist entirely of decimal digits. The number is converted to
10531 base 32 and output as a (empty, for zero) string of characters.
10532 Only lowercase letters are used.
10533
10534 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10535 .cindex "&%base32d%& expansion item"
10536 .cindex "expansion" "conversion to base 32"
10537 The string must consist entirely of base-32 digits.
10538 The number is converted to decimal and output as a string.
10539
10540 .vitem &*${base62:*&<&'digits'&>&*}*&
10541 .cindex "&%base62%& expansion item"
10542 .cindex "expansion" "conversion to base 62"
10543 The string must consist entirely of decimal digits. The number is converted to
10544 base 62 and output as a string of six characters, including leading zeros. In
10545 the few operating environments where Exim uses base 36 instead of base 62 for
10546 its message identifiers (because those systems do not have case-sensitive
10547 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10548 to be absolutely clear: this is &'not'& base64 encoding.
10549
10550 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10551 .cindex "&%base62d%& expansion item"
10552 .cindex "expansion" "conversion to base 62"
10553 The string must consist entirely of base-62 digits, or, in operating
10554 environments where Exim uses base 36 instead of base 62 for its message
10555 identifiers, base-36 digits. The number is converted to decimal and output as a
10556 string.
10557
10558 .vitem &*${base64:*&<&'string'&>&*}*&
10559 .cindex "expansion" "base64 encoding"
10560 .cindex "base64 encoding" "in string expansion"
10561 .cindex "&%base64%& expansion item"
10562 .cindex certificate "base64 of DER"
10563 This operator converts a string into one that is base64 encoded.
10564
10565 If the string is a single variable of type certificate,
10566 returns the base64 encoding of the DER form of the certificate.
10567
10568
10569 .vitem &*${base64d:*&<&'string'&>&*}*&
10570 .cindex "expansion" "base64 decoding"
10571 .cindex "base64 decoding" "in string expansion"
10572 .cindex "&%base64d%& expansion item"
10573 This operator converts a base64-encoded string into the un-coded form.
10574
10575
10576 .vitem &*${domain:*&<&'string'&>&*}*&
10577 .cindex "domain" "extraction"
10578 .cindex "expansion" "domain extraction"
10579 The string is interpreted as an RFC 2822 address and the domain is extracted
10580 from it. If the string does not parse successfully, the result is empty.
10581
10582
10583 .vitem &*${escape:*&<&'string'&>&*}*&
10584 .cindex "expansion" "escaping non-printing characters"
10585 .cindex "&%escape%& expansion item"
10586 If the string contains any non-printing characters, they are converted to
10587 escape sequences starting with a backslash. Whether characters with the most
10588 significant bit set (so-called &"8-bit characters"&) count as printing or not
10589 is controlled by the &%print_topbitchars%& option.
10590
10591 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10592 .cindex "expansion" "escaping 8-bit characters"
10593 .cindex "&%escape8bit%& expansion item"
10594 If the string contains and characters with the most significant bit set,
10595 they are converted to escape sequences starting with a backslash.
10596 Backslashes and DEL characters are also converted.
10597
10598
10599 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10600 .cindex "expansion" "expression evaluation"
10601 .cindex "expansion" "arithmetic expression"
10602 .cindex "&%eval%& expansion item"
10603 These items supports simple arithmetic and bitwise logical operations in
10604 expansion strings. The string (after expansion) must be a conventional
10605 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10606 logical operators, and parentheses. All operations are carried out using
10607 integer arithmetic. The operator priorities are as follows (the same as in the
10608 C programming language):
10609 .table2 70pt 300pt
10610 .irow &'highest:'& "not (~), negate (-)"
10611 .irow ""   "multiply (*), divide (/), remainder (%)"
10612 .irow ""   "plus (+), minus (-)"
10613 .irow ""   "shift-left (<<), shift-right (>>)"
10614 .irow ""   "and (&&)"
10615 .irow ""   "xor (^)"
10616 .irow &'lowest:'&  "or (|)"
10617 .endtable
10618 Binary operators with the same priority are evaluated from left to right. White
10619 space is permitted before or after operators.
10620
10621 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10622 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10623 decimal, even if they start with a leading zero; hexadecimal numbers are not
10624 permitted. This can be useful when processing numbers extracted from dates or
10625 times, which often do have leading zeros.
10626
10627 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10628 or 1024*1024*1024,
10629 respectively. Negative numbers are supported. The result of the computation is
10630 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10631
10632 .display
10633 &`${eval:1+1}            `&  yields 2
10634 &`${eval:1+2*3}          `&  yields 7
10635 &`${eval:(1+2)*3}        `&  yields 9
10636 &`${eval:2+42%5}         `&  yields 4
10637 &`${eval:0xc&amp;5}          `&  yields 4
10638 &`${eval:0xc|5}          `&  yields 13
10639 &`${eval:0xc^5}          `&  yields 9
10640 &`${eval:0xc>>1}         `&  yields 6
10641 &`${eval:0xc<<1}         `&  yields 24
10642 &`${eval:~255&amp;0x1234}    `&  yields 4608
10643 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10644 .endd
10645
10646 As a more realistic example, in an ACL you might have
10647 .code
10648 deny   message = Too many bad recipients
10649        condition =                    \
10650          ${if and {                   \
10651            {>{$rcpt_count}{10}}       \
10652            {                          \
10653            <                          \
10654              {$recipients_count}      \
10655              {${eval:$rcpt_count/2}}  \
10656            }                          \
10657          }{yes}{no}}
10658 .endd
10659 The condition is true if there have been more than 10 RCPT commands and
10660 fewer than half of them have resulted in a valid recipient.
10661
10662
10663 .vitem &*${expand:*&<&'string'&>&*}*&
10664 .cindex "expansion" "re-expansion of substring"
10665 The &%expand%& operator causes a string to be expanded for a second time. For
10666 example,
10667 .code
10668 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10669 .endd
10670 first looks up a string in a file while expanding the operand for &%expand%&,
10671 and then re-expands what it has found.
10672
10673
10674 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10675 .cindex "Unicode"
10676 .cindex "UTF-8" "conversion from"
10677 .cindex "expansion" "UTF-8 conversion"
10678 .cindex "&%from_utf8%& expansion item"
10679 The world is slowly moving towards Unicode, although there are no standards for
10680 email yet. However, other applications (including some databases) are starting
10681 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10682 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10683 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10684 the result is an undefined sequence of bytes.
10685
10686 Unicode code points with values less than 256 are compatible with ASCII and
10687 ISO-8859-1 (also known as Latin-1).
10688 For example, character 169 is the copyright symbol in both cases, though the
10689 way it is encoded is different. In UTF-8, more than one byte is needed for
10690 characters with code values greater than 127, whereas ISO-8859-1 is a
10691 single-byte encoding (but thereby limited to 256 characters). This makes
10692 translation from UTF-8 to ISO-8859-1 straightforward.
10693
10694
10695 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10696 .cindex "hash function" "textual"
10697 .cindex "expansion" "textual hash"
10698 The &%hash%& operator is a simpler interface to the hashing function that can
10699 be used when the two parameters are fixed numbers (as opposed to strings that
10700 change when expanded). The effect is the same as
10701 .code
10702 ${hash{<n>}{<m>}{<string>}}
10703 .endd
10704 See the description of the general &%hash%& item above for details. The
10705 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10706
10707
10708
10709 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10710 .cindex "base64 encoding" "conversion from hex"
10711 .cindex "expansion" "hex to base64"
10712 .cindex "&%hex2b64%& expansion item"
10713 This operator converts a hex string into one that is base64 encoded. This can
10714 be useful for processing the output of the various hashing functions.
10715
10716
10717
10718 .vitem &*${hexquote:*&<&'string'&>&*}*&
10719 .cindex "quoting" "hex-encoded unprintable characters"
10720 .cindex "&%hexquote%& expansion item"
10721 This operator converts non-printable characters in a string into a hex
10722 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10723 as is, and other byte values are converted to &`\xNN`&, for example, a
10724 byte value 127 is converted to &`\x7f`&.
10725
10726
10727 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10728 .cindex "&%ipv6denorm%& expansion item"
10729 .cindex "IP address" normalisation
10730 This expands an IPv6 address to a full eight-element colon-separated set
10731 of hex digits including leading zeroes.
10732 A trailing ipv4-style dotted-decimal set is converted to hex.
10733 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10734
10735 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10736 .cindex "&%ipv6norm%& expansion item"
10737 .cindex "IP address" normalisation
10738 .cindex "IP address" "canonical form"
10739 This converts an IPv6 address to canonical form.
10740 Leading zeroes of groups are omitted, and the longest
10741 set of zero-valued groups is replaced with a double colon.
10742 A trailing ipv4-style dotted-decimal set is converted to hex.
10743 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10744
10745
10746 .vitem &*${lc:*&<&'string'&>&*}*&
10747 .cindex "case forcing in strings"
10748 .cindex "string" "case forcing"
10749 .cindex "lower casing"
10750 .cindex "expansion" "case forcing"
10751 .cindex "&%lc%& expansion item"
10752 This forces the letters in the string into lower-case, for example:
10753 .code
10754 ${lc:$local_part}
10755 .endd
10756 Case is defined per the system C locale.
10757
10758 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10759 .cindex "expansion" "string truncation"
10760 .cindex "&%length%& expansion item"
10761 The &%length%& operator is a simpler interface to the &%length%& function that
10762 can be used when the parameter is a fixed number (as opposed to a string that
10763 changes when expanded). The effect is the same as
10764 .code
10765 ${length{<number>}{<string>}}
10766 .endd
10767 See the description of the general &%length%& item above for details. Note that
10768 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10769 when &%length%& is used as an operator.
10770 All measurement is done in bytes and is not UTF-8 aware.
10771
10772
10773 .vitem &*${listcount:*&<&'string'&>&*}*&
10774 .cindex "expansion" "list item count"
10775 .cindex "list" "item count"
10776 .cindex "list" "count of items"
10777 .cindex "&%listcount%& expansion item"
10778 The string is interpreted as a list and the number of items is returned.
10779
10780
10781 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10782 .cindex "expansion" "named list"
10783 .cindex "&%listnamed%& expansion item"
10784 The name is interpreted as a named list and the content of the list is returned,
10785 expanding any referenced lists, re-quoting as needed for colon-separation.
10786 If the optional type is given it must be one of "a", "d", "h" or "l"
10787 and selects address-, domain-, host- or localpart- lists to search among respectively.
10788 Otherwise all types are searched in an undefined order and the first
10789 matching list is returned.
10790
10791
10792 .vitem &*${local_part:*&<&'string'&>&*}*&
10793 .cindex "expansion" "local part extraction"
10794 .cindex "&%local_part%& expansion item"
10795 The string is interpreted as an RFC 2822 address and the local part is
10796 extracted from it. If the string does not parse successfully, the result is
10797 empty.
10798 The parsing correctly handles SMTPUTF8 Unicode in the string.
10799
10800
10801 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10802 .cindex "masked IP address"
10803 .cindex "IP address" "masking"
10804 .cindex "CIDR notation"
10805 .cindex "expansion" "IP address masking"
10806 .cindex "&%mask%& expansion item"
10807 If the form of the string to be operated on is not an IP address followed by a
10808 slash and an integer (that is, a network address in CIDR notation), the
10809 expansion fails. Otherwise, this operator converts the IP address to binary,
10810 masks off the least significant bits according to the bit count, and converts
10811 the result back to text, with mask appended. For example,
10812 .code
10813 ${mask:10.111.131.206/28}
10814 .endd
10815 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10816 be mostly used for looking up masked addresses in files, the result for an IPv6
10817 address uses dots to separate components instead of colons, because colon
10818 terminates a key string in lsearch files. So, for example,
10819 .code
10820 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10821 .endd
10822 returns the string
10823 .code
10824 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10825 .endd
10826 Letters in IPv6 addresses are always output in lower case.
10827
10828
10829 .vitem &*${md5:*&<&'string'&>&*}*&
10830 .cindex "MD5 hash"
10831 .cindex "expansion" "MD5 hash"
10832 .cindex certificate fingerprint
10833 .cindex "&%md5%& expansion item"
10834 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10835 as a 32-digit hexadecimal number, in which any letters are in lower case.
10836
10837 If the string is a single variable of type certificate,
10838 returns the MD5 hash fingerprint of the certificate.
10839
10840
10841 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10842 .cindex "expansion" "numeric hash"
10843 .cindex "hash function" "numeric"
10844 The &%nhash%& operator is a simpler interface to the numeric hashing function
10845 that can be used when the two parameters are fixed numbers (as opposed to
10846 strings that change when expanded). The effect is the same as
10847 .code
10848 ${nhash{<n>}{<m>}{<string>}}
10849 .endd
10850 See the description of the general &%nhash%& item above for details.
10851
10852
10853 .vitem &*${quote:*&<&'string'&>&*}*&
10854 .cindex "quoting" "in string expansions"
10855 .cindex "expansion" "quoting"
10856 .cindex "&%quote%& expansion item"
10857 The &%quote%& operator puts its argument into double quotes if it
10858 is an empty string or
10859 contains anything other than letters, digits, underscores, dots, and hyphens.
10860 Any occurrences of double quotes and backslashes are escaped with a backslash.
10861 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10862 respectively For example,
10863 .code
10864 ${quote:ab"*"cd}
10865 .endd
10866 becomes
10867 .code
10868 "ab\"*\"cd"
10869 .endd
10870 The place where this is useful is when the argument is a substitution from a
10871 variable or a message header.
10872
10873 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10874 .cindex "&%quote_local_part%& expansion item"
10875 This operator is like &%quote%&, except that it quotes the string only if
10876 required to do so by the rules of RFC 2822 for quoting local parts. For
10877 example, a plus sign would not cause quoting (but it would for &%quote%&).
10878 If you are creating a new email address from the contents of &$local_part$&
10879 (or any other unknown data), you should always use this operator.
10880
10881 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10882 will likely use the quoting form.
10883 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10884
10885
10886 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10887 .cindex "quoting" "lookup-specific"
10888 This operator applies lookup-specific quoting rules to the string. Each
10889 query-style lookup type has its own quoting rules which are described with
10890 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10891 .code
10892 ${quote_ldap:two * two}
10893 .endd
10894 returns
10895 .code
10896 two%20%5C2A%20two
10897 .endd
10898 For single-key lookup types, no quoting is ever necessary and this operator
10899 yields an unchanged string.
10900
10901
10902 .vitem &*${randint:*&<&'n'&>&*}*&
10903 .cindex "random number"
10904 This operator returns a somewhat random number which is less than the
10905 supplied number and is at least 0.  The quality of this randomness depends
10906 on how Exim was built; the values are not suitable for keying material.
10907 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10908 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10909 for versions of GnuTLS with that function.
10910 Otherwise, the implementation may be arc4random(), random() seeded by
10911 srandomdev() or srandom(), or a custom implementation even weaker than
10912 random().
10913
10914
10915 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10916 .cindex "expansion" "IP address"
10917 This operator reverses an IP address; for IPv4 addresses, the result is in
10918 dotted-quad decimal form, while for IPv6 addresses the result is in
10919 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10920 for DNS.  For example,
10921 .code
10922 ${reverse_ip:192.0.2.4}
10923 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10924 .endd
10925 returns
10926 .code
10927 4.2.0.192
10928 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
10929 .endd
10930
10931
10932 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10933 .cindex "expansion" "RFC 2047"
10934 .cindex "RFC 2047" "expansion operator"
10935 .cindex "&%rfc2047%& expansion item"
10936 This operator encodes text according to the rules of RFC 2047. This is an
10937 encoding that is used in header lines to encode non-ASCII characters. It is
10938 assumed that the input string is in the encoding specified by the
10939 &%headers_charset%& option, which gets its default at build time. If the string
10940 contains only characters in the range 33&--126, and no instances of the
10941 characters
10942 .code
10943 ? = ( ) < > @ , ; : \ " . [ ] _
10944 .endd
10945 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10946 string, using as many &"encoded words"& as necessary to encode all the
10947 characters.
10948
10949
10950 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10951 .cindex "expansion" "RFC 2047"
10952 .cindex "RFC 2047" "decoding"
10953 .cindex "&%rfc2047d%& expansion item"
10954 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10955 bytes are replaced by question marks. Characters are converted into the
10956 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10957 not recognized unless &%check_rfc2047_length%& is set false.
10958
10959 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10960 access a header line, RFC 2047 decoding is done automatically. You do not need
10961 to use this operator as well.
10962
10963
10964
10965 .vitem &*${rxquote:*&<&'string'&>&*}*&
10966 .cindex "quoting" "in regular expressions"
10967 .cindex "regular expressions" "quoting"
10968 .cindex "&%rxquote%& expansion item"
10969 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10970 characters in its argument. This is useful when substituting the values of
10971 variables or headers inside regular expressions.
10972
10973
10974 .vitem &*${sha1:*&<&'string'&>&*}*&
10975 .cindex "SHA-1 hash"
10976 .cindex "expansion" "SHA-1 hashing"
10977 .cindex certificate fingerprint
10978 .cindex "&%sha1%& expansion item"
10979 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10980 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10981
10982 If the string is a single variable of type certificate,
10983 returns the SHA-1 hash fingerprint of the certificate.
10984
10985
10986 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
10987        &*${sha2:*&<&'string'&>&*}*& &&&
10988        &*${sha2_<n>:*&<&'string'&>&*}*&
10989 .cindex "SHA-256 hash"
10990 .cindex "SHA-2 hash"
10991 .cindex certificate fingerprint
10992 .cindex "expansion" "SHA-256 hashing"
10993 .cindex "&%sha256%& expansion item"
10994 .cindex "&%sha2%& expansion item"
10995 The &%sha256%& operator computes the SHA-256 hash value of the string
10996 and returns
10997 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10998
10999 If the string is a single variable of type certificate,
11000 returns the SHA-256 hash fingerprint of the certificate.
11001
11002 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11003 (except for certificates, which are not supported).
11004 Finally, if an underbar
11005 and a number is appended it specifies the output length, selecting a
11006 member of the SHA-2 family of hash functions.
11007 Values of 256, 384 and 512 are accepted, with 256 being the default.
11008
11009
11010 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11011        &*${sha3_<n>:*&<&'string'&>&*}*&
11012 .cindex "SHA3 hash"
11013 .cindex "expansion" "SHA3 hashing"
11014 .cindex "&%sha3%& expansion item"
11015 The &%sha3%& operator computes the SHA3-256 hash value of the string
11016 and returns
11017 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11018
11019 If a number is appended, separated by an underbar, it specifies
11020 the output length.  Values of 224, 256, 384 and 512 are accepted;
11021 with 256 being the default.
11022
11023 The &%sha3%& expansion item is only supported if Exim has been
11024 compiled with GnuTLS 3.5.0 or later,
11025 or OpenSSL 1.1.1 or later.
11026 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11027
11028
11029 .vitem &*${stat:*&<&'string'&>&*}*&
11030 .cindex "expansion" "statting a file"
11031 .cindex "file" "extracting characteristics"
11032 .cindex "&%stat%& expansion item"
11033 The string, after expansion, must be a file path. A call to the &[stat()]&
11034 function is made for this path. If &[stat()]& fails, an error occurs and the
11035 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11036 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11037 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11038 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11039 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11040 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11041 can extract individual fields using the &%extract%& expansion item.
11042
11043 The use of the &%stat%& expansion in users' filter files can be locked out by
11044 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11045 systems for files larger than 2GB.
11046
11047 .vitem &*${str2b64:*&<&'string'&>&*}*&
11048 .cindex "&%str2b64%& expansion item"
11049 Now deprecated, a synonym for the &%base64%& expansion operator.
11050
11051
11052
11053 .vitem &*${strlen:*&<&'string'&>&*}*&
11054 .cindex "expansion" "string length"
11055 .cindex "string" "length in expansion"
11056 .cindex "&%strlen%& expansion item"
11057 The item is replace by the length of the expanded string, expressed as a
11058 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11059 All measurement is done in bytes and is not UTF-8 aware.
11060
11061
11062 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11063 .cindex "&%substr%& expansion item"
11064 .cindex "substring extraction"
11065 .cindex "expansion" "substring expansion"
11066 The &%substr%& operator is a simpler interface to the &%substr%& function that
11067 can be used when the two parameters are fixed numbers (as opposed to strings
11068 that change when expanded). The effect is the same as
11069 .code
11070 ${substr{<start>}{<length>}{<string>}}
11071 .endd
11072 See the description of the general &%substr%& item above for details. The
11073 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11074 All measurement is done in bytes and is not UTF-8 aware.
11075
11076 .vitem &*${time_eval:*&<&'string'&>&*}*&
11077 .cindex "&%time_eval%& expansion item"
11078 .cindex "time interval" "decoding"
11079 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11080 seconds.
11081
11082 .vitem &*${time_interval:*&<&'string'&>&*}*&
11083 .cindex "&%time_interval%& expansion item"
11084 .cindex "time interval" "formatting"
11085 The argument (after sub-expansion) must be a sequence of decimal digits that
11086 represents an interval of time as a number of seconds. It is converted into a
11087 number of larger units and output in Exim's normal time format, for example,
11088 &`1w3d4h2m6s`&.
11089
11090 .vitem &*${uc:*&<&'string'&>&*}*&
11091 .cindex "case forcing in strings"
11092 .cindex "string" "case forcing"
11093 .cindex "upper casing"
11094 .cindex "expansion" "case forcing"
11095 .cindex "&%uc%& expansion item"
11096 This forces the letters in the string into upper-case.
11097 Case is defined per the system C locale.
11098
11099 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11100 .cindex "correction of invalid utf-8 sequences in strings"
11101 .cindex "utf-8" "utf-8 sequences"
11102 .cindex "incorrect utf-8"
11103 .cindex "expansion" "utf-8 forcing"
11104 .cindex "&%utf8clean%& expansion item"
11105 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11106 In versions of Exim before 4.92, this did not correctly do so for a truncated
11107 final codepoint's encoding, and the character would be silently dropped.
11108 If you must handle detection of this scenario across both sets of Exim behavior,
11109 the complexity will depend upon the task.
11110 For instance, to detect if the first character is multibyte and a 1-byte
11111 extraction can be successfully used as a path component (as is common for
11112 dividing up delivery folders), you might use:
11113 .code
11114 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11115 .endd
11116 (which will false-positive if the first character of the local part is a
11117 literal question mark).
11118
11119 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11120        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11121        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11122        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11123 .cindex expansion UTF-8
11124 .cindex UTF-8 expansion
11125 .cindex EAI
11126 .cindex internationalisation
11127 .cindex "&%utf8_domain_to_alabel%& expansion item"
11128 .cindex "&%utf8_domain_from_alabel%& expansion item"
11129 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11130 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11131 These convert EAI mail name components between UTF-8 and a-label forms.
11132 For information on internationalisation support see &<<SECTi18nMTA>>&.
11133 .endlist
11134
11135
11136
11137
11138
11139
11140 .section "Expansion conditions" "SECTexpcond"
11141 .scindex IIDexpcond "expansion" "conditions"
11142 The following conditions are available for testing by the &%${if%& construct
11143 while expanding strings:
11144
11145 .vlist
11146 .vitem &*!*&<&'condition'&>
11147 .cindex "expansion" "negating a condition"
11148 .cindex "negation" "in expansion condition"
11149 Preceding any condition with an exclamation mark negates the result of the
11150 condition.
11151
11152 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11153 .cindex "numeric comparison"
11154 .cindex "expansion" "numeric comparison"
11155 There are a number of symbolic operators for doing numeric comparisons. They
11156 are:
11157 .display
11158 &`=   `&   equal
11159 &`==  `&   equal
11160 &`>   `&   greater
11161 &`>=  `&   greater or equal
11162 &`<   `&   less
11163 &`<=  `&   less or equal
11164 .endd
11165 For example:
11166 .code
11167 ${if >{$message_size}{10M} ...
11168 .endd
11169 Note that the general negation operator provides for inequality testing. The
11170 two strings must take the form of optionally signed decimal integers,
11171 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11172 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11173 As a special case, the numerical value of an empty string is taken as
11174 zero.
11175
11176 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11177 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11178 10M, not if 10M is larger than &$message_size$&.
11179
11180
11181 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11182         {*&<&'arg2'&>&*}...}*&
11183 .cindex "expansion" "calling an acl"
11184 .cindex "&%acl%&" "expansion condition"
11185 The name and zero to nine argument strings are first expanded separately.  The expanded
11186 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11187 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11188 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11189 and may use the variables; if another acl expansion is used the values
11190 are restored after it returns.  If the ACL sets
11191 a value using a "message =" modifier the variable $value becomes
11192 the result of the expansion, otherwise it is empty.
11193 If the ACL returns accept the condition is true; if deny, false.
11194 If the ACL returns defer the result is a forced-fail.
11195
11196 .vitem &*bool&~{*&<&'string'&>&*}*&
11197 .cindex "expansion" "boolean parsing"
11198 .cindex "&%bool%& expansion condition"
11199 This condition turns a string holding a true or false representation into
11200 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11201 (case-insensitively); also integer numbers map to true if non-zero,
11202 false if zero.
11203 An empty string is treated as false.
11204 Leading and trailing whitespace is ignored;
11205 thus a string consisting only of whitespace is false.
11206 All other string values will result in expansion failure.
11207
11208 When combined with ACL variables, this expansion condition will let you
11209 make decisions in one place and act on those decisions in another place.
11210 For example:
11211 .code
11212 ${if bool{$acl_m_privileged_sender} ...
11213 .endd
11214
11215
11216 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11217 .cindex "expansion" "boolean parsing"
11218 .cindex "&%bool_lax%& expansion condition"
11219 Like &%bool%&, this condition turns a string into a boolean state.  But
11220 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11221 loose definition that the Router &%condition%& option uses.  The empty string
11222 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11223 true.  Leading and trailing whitespace is ignored.
11224
11225 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11226
11227 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11228 .cindex "expansion" "encrypted comparison"
11229 .cindex "encrypted strings, comparing"
11230 .cindex "&%crypteq%& expansion condition"
11231 This condition is included in the Exim binary if it is built to support any
11232 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11233 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11234 included in the binary.
11235
11236 The &%crypteq%& condition has two arguments. The first is encrypted and
11237 compared against the second, which is already encrypted. The second string may
11238 be in the LDAP form for storing encrypted strings, which starts with the
11239 encryption type in curly brackets, followed by the data. If the second string
11240 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11241 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11242 Typically this will be a field from a password file. An example of an encrypted
11243 string in LDAP form is:
11244 .code
11245 {md5}CY9rzUYh03PK3k6DJie09g==
11246 .endd
11247 If such a string appears directly in an expansion, the curly brackets have to
11248 be quoted, because they are part of the expansion syntax. For example:
11249 .code
11250 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11251 .endd
11252 The following encryption types (whose names are matched case-independently) are
11253 supported:
11254
11255 .ilist
11256 .cindex "MD5 hash"
11257 .cindex "base64 encoding" "in encrypted password"
11258 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11259 printable characters to compare with the remainder of the second string. If the
11260 length of the comparison string is 24, Exim assumes that it is base64 encoded
11261 (as in the above example). If the length is 32, Exim assumes that it is a
11262 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11263 comparison fails.
11264
11265 .next
11266 .cindex "SHA-1 hash"
11267 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11268 printable characters to compare with the remainder of the second string. If the
11269 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11270 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11271 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11272
11273 .next
11274 .cindex "&[crypt()]&"
11275 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11276 only the first eight characters of the password. However, in modern operating
11277 systems this is no longer true, and in many cases the entire password is used,
11278 whatever its length.
11279
11280 .next
11281 .cindex "&[crypt16()]&"
11282 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11283 use up to 16 characters of the password in some operating systems. Again, in
11284 modern operating systems, more characters may be used.
11285 .endlist
11286 Exim has its own version of &[crypt16()]&, which is just a double call to
11287 &[crypt()]&. For operating systems that have their own version, setting
11288 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11289 operating system version instead of its own. This option is set by default in
11290 the OS-dependent &_Makefile_& for those operating systems that are known to
11291 support &[crypt16()]&.
11292
11293 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11294 it was not using the same algorithm as some operating systems' versions. It
11295 turns out that as well as &[crypt16()]& there is a function called
11296 &[bigcrypt()]& in some operating systems. This may or may not use the same
11297 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11298
11299 However, since there is now a move away from the traditional &[crypt()]&
11300 functions towards using SHA1 and other algorithms, tidying up this area of
11301 Exim is seen as very low priority.
11302
11303 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11304 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11305 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11306 default is &`{crypt}`&. Whatever the default, you can always use either
11307 function by specifying it explicitly in curly brackets.
11308
11309 .vitem &*def:*&<&'variable&~name'&>
11310 .cindex "expansion" "checking for empty variable"
11311 .cindex "&%def%& expansion condition"
11312 The &%def%& condition must be followed by the name of one of the expansion
11313 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11314 variable does not contain the empty string. For example:
11315 .code
11316 ${if def:sender_ident {from $sender_ident}}
11317 .endd
11318 Note that the variable name is given without a leading &%$%& character. If the
11319 variable does not exist, the expansion fails.
11320
11321 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11322         &~&*def:h_*&<&'header&~name'&>&*:*&"
11323 .cindex "expansion" "checking header line existence"
11324 This condition is true if a message is being processed and the named header
11325 exists in the message. For example,
11326 .code
11327 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11328 .endd
11329 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11330 the header name must be terminated by a colon if white space does not follow.
11331
11332 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11333        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11334 .cindex "string" "comparison"
11335 .cindex "expansion" "string comparison"
11336 .cindex "&%eq%& expansion condition"
11337 .cindex "&%eqi%& expansion condition"
11338 The two substrings are first expanded. The condition is true if the two
11339 resulting strings are identical. For &%eq%& the comparison includes the case of
11340 letters, whereas for &%eqi%& the comparison is case-independent, where
11341 case is defined per the system C locale.
11342
11343 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11344 .cindex "expansion" "file existence test"
11345 .cindex "file" "existence test"
11346 .cindex "&%exists%&, expansion condition"
11347 The substring is first expanded and then interpreted as an absolute path. The
11348 condition is true if the named file (or directory) exists. The existence test
11349 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11350 users' filter files may be locked out by the system administrator.
11351
11352 .vitem &*first_delivery*&
11353 .cindex "delivery" "first"
11354 .cindex "first delivery"
11355 .cindex "expansion" "first delivery test"
11356 .cindex "&%first_delivery%& expansion condition"
11357 This condition, which has no data, is true during a message's first delivery
11358 attempt. It is false during any subsequent delivery attempts.
11359
11360
11361 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11362        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11363 .cindex "list" "iterative conditions"
11364 .cindex "expansion" "&*forall*& condition"
11365 .cindex "expansion" "&*forany*& condition"
11366 .vindex "&$item$&"
11367 These conditions iterate over a list. The first argument is expanded to form
11368 the list. By default, the list separator is a colon, but it can be changed by
11369 the normal method (&<<SECTlistsepchange>>&).
11370 The second argument is interpreted as a condition that is to
11371 be applied to each item in the list in turn. During the interpretation of the
11372 condition, the current list item is placed in a variable called &$item$&.
11373 .ilist
11374 For &*forany*&, interpretation stops if the condition is true for any item, and
11375 the result of the whole condition is true. If the condition is false for all
11376 items in the list, the overall condition is false.
11377 .next
11378 For &*forall*&, interpretation stops if the condition is false for any item,
11379 and the result of the whole condition is false. If the condition is true for
11380 all items in the list, the overall condition is true.
11381 .endlist
11382 Note that negation of &*forany*& means that the condition must be false for all
11383 items for the overall condition to succeed, and negation of &*forall*& means
11384 that the condition must be false for at least one item. In this example, the
11385 list separator is changed to a comma:
11386 .code
11387 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11388 .endd
11389 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11390 being processed, to enable these expansion items to be nested.
11391
11392 To scan a named list, expand it with the &*listnamed*& operator.
11393
11394 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11395        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11396        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11397        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11398 .cindex JSON "iterative conditions"
11399 .cindex JSON expansions
11400 .cindex expansion "&*forall_json*& condition"
11401 .cindex expansion "&*forany_json*& condition"
11402 .cindex expansion "&*forall_jsons*& condition"
11403 .cindex expansion "&*forany_jsons*& condition"
11404 As for the above, except that the first argument must, after expansion,
11405 be a JSON array.
11406 The array separator is not changeable.
11407 For the &"jsons"& variants the elements are expected to be JSON strings
11408 and have their quotes removed before the evaluation of the condition.
11409
11410
11411
11412 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11413        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11414 .cindex "string" "comparison"
11415 .cindex "expansion" "string comparison"
11416 .cindex "&%ge%& expansion condition"
11417 .cindex "&%gei%& expansion condition"
11418 The two substrings are first expanded. The condition is true if the first
11419 string is lexically greater than or equal to the second string. For &%ge%& the
11420 comparison includes the case of letters, whereas for &%gei%& the comparison is
11421 case-independent.
11422 Case and collation order are defined per the system C locale.
11423
11424 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11425        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11426 .cindex "string" "comparison"
11427 .cindex "expansion" "string comparison"
11428 .cindex "&%gt%& expansion condition"
11429 .cindex "&%gti%& expansion condition"
11430 The two substrings are first expanded. The condition is true if the first
11431 string is lexically greater than the second string. For &%gt%& the comparison
11432 includes the case of letters, whereas for &%gti%& the comparison is
11433 case-independent.
11434 Case and collation order are defined per the system C locale.
11435
11436 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11437        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11438 .cindex "string" "comparison"
11439 .cindex "list" "iterative conditions"
11440 Both strings are expanded; the second string is treated as a list of simple
11441 strings; if the first string is a member of the second, then the condition
11442 is true.
11443 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11444
11445 These are simpler to use versions of the more powerful &*forany*& condition.
11446 Examples, and the &*forany*& equivalents:
11447 .code
11448 ${if inlist{needle}{foo:needle:bar}}
11449   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11450 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11451   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11452 .endd
11453
11454 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11455        &*isip4&~{*&<&'string'&>&*}*& &&&
11456        &*isip6&~{*&<&'string'&>&*}*&
11457 .cindex "IP address" "testing string format"
11458 .cindex "string" "testing for IP address"
11459 .cindex "&%isip%& expansion condition"
11460 .cindex "&%isip4%& expansion condition"
11461 .cindex "&%isip6%& expansion condition"
11462 The substring is first expanded, and then tested to see if it has the form of
11463 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11464 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11465
11466 For an IPv4 address, the test is for four dot-separated components, each of
11467 which consists of from one to three digits. For an IPv6 address, up to eight
11468 colon-separated components are permitted, each containing from one to four
11469 hexadecimal digits. There may be fewer than eight components if an empty
11470 component (adjacent colons) is present. Only one empty component is permitted.
11471
11472 &*Note*&: The checks used to be just on the form of the address; actual numerical
11473 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11474 check.
11475 This is no longer the case.
11476
11477 The main use of these tests is to distinguish between IP addresses and
11478 host names, or between IPv4 and IPv6 addresses. For example, you could use
11479 .code
11480 ${if isip4{$sender_host_address}...
11481 .endd
11482 to test which IP version an incoming SMTP connection is using.
11483
11484 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11485 .cindex "LDAP" "use for authentication"
11486 .cindex "expansion" "LDAP authentication test"
11487 .cindex "&%ldapauth%& expansion condition"
11488 This condition supports user authentication using LDAP. See section
11489 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11490 queries. For this use, the query must contain a user name and password. The
11491 query itself is not used, and can be empty. The condition is true if the
11492 password is not empty, and the user name and password are accepted by the LDAP
11493 server. An empty password is rejected without calling LDAP because LDAP binds
11494 with an empty password are considered anonymous regardless of the username, and
11495 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11496 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11497 this can be used.
11498
11499
11500 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11501        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11502 .cindex "string" "comparison"
11503 .cindex "expansion" "string comparison"
11504 .cindex "&%le%& expansion condition"
11505 .cindex "&%lei%& expansion condition"
11506 The two substrings are first expanded. The condition is true if the first
11507 string is lexically less than or equal to the second string. For &%le%& the
11508 comparison includes the case of letters, whereas for &%lei%& the comparison is
11509 case-independent.
11510 Case and collation order are defined per the system C locale.
11511
11512 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11513        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11514 .cindex "string" "comparison"
11515 .cindex "expansion" "string comparison"
11516 .cindex "&%lt%& expansion condition"
11517 .cindex "&%lti%& expansion condition"
11518 The two substrings are first expanded. The condition is true if the first
11519 string is lexically less than the second string. For &%lt%& the comparison
11520 includes the case of letters, whereas for &%lti%& the comparison is
11521 case-independent.
11522 Case and collation order are defined per the system C locale.
11523
11524
11525 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11526 .cindex "expansion" "regular expression comparison"
11527 .cindex "regular expressions" "match in expanded string"
11528 .cindex "&%match%& expansion condition"
11529 The two substrings are first expanded. The second is then treated as a regular
11530 expression and applied to the first. Because of the pre-expansion, if the
11531 regular expression contains dollar, or backslash characters, they must be
11532 escaped. Care must also be taken if the regular expression contains braces
11533 (curly brackets). A closing brace must be escaped so that it is not taken as a
11534 premature termination of <&'string2'&>. The easiest approach is to use the
11535 &`\N`& feature to disable expansion of the regular expression.
11536 For example,
11537 .code
11538 ${if match {$local_part}{\N^\d{3}\N} ...
11539 .endd
11540 If the whole expansion string is in double quotes, further escaping of
11541 backslashes is also required.
11542
11543 The condition is true if the regular expression match succeeds.
11544 The regular expression is not required to begin with a circumflex
11545 metacharacter, but if there is no circumflex, the expression is not anchored,
11546 and it may match anywhere in the subject, not just at the start. If you want
11547 the pattern to match at the end of the subject, you must include the &`$`&
11548 metacharacter at an appropriate point.
11549 All character handling is done in bytes and is not UTF-8 aware,
11550 but we might change this in a future Exim release.
11551
11552 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11553 At the start of an &%if%& expansion the values of the numeric variable
11554 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11555 succeeds causes them to be reset to the substrings of that condition and they
11556 will have these values during the expansion of the success string. At the end
11557 of the &%if%& expansion, the previous values are restored. After testing a
11558 combination of conditions using &%or%&, the subsequent values of the numeric
11559 variables are those of the condition that succeeded.
11560
11561 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11562 .cindex "&%match_address%& expansion condition"
11563 See &*match_local_part*&.
11564
11565 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11566 .cindex "&%match_domain%& expansion condition"
11567 See &*match_local_part*&.
11568
11569 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11570 .cindex "&%match_ip%& expansion condition"
11571 This condition matches an IP address to a list of IP address patterns. It must
11572 be followed by two argument strings. The first (after expansion) must be an IP
11573 address or an empty string. The second (not expanded) is a restricted host
11574 list that can match only an IP address, not a host name. For example:
11575 .code
11576 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11577 .endd
11578 The specific types of host list item that are permitted in the list are:
11579
11580 .ilist
11581 An IP address, optionally with a CIDR mask.
11582 .next
11583 A single asterisk, which matches any IP address.
11584 .next
11585 An empty item, which matches only if the IP address is empty. This could be
11586 useful for testing for a locally submitted message or one from specific hosts
11587 in a single test such as
11588 . ==== As this is a nested list, any displays it contains must be indented
11589 . ==== as otherwise they are too far to the left. This comment applies to
11590 . ==== the use of xmlto plus fop. There's no problem when formatting with
11591 . ==== sdop, with or without the extra indent.
11592 .code
11593   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11594 .endd
11595 where the first item in the list is the empty string.
11596 .next
11597 The item @[] matches any of the local host's interface addresses.
11598 .next
11599 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11600 even if &`net-`& is not specified. There is never any attempt to turn the IP
11601 address into a host name. The most common type of linear search for
11602 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11603 masks. For example:
11604 .code
11605   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11606 .endd
11607 It is of course possible to use other kinds of lookup, and in such a case, you
11608 do need to specify the &`net-`& prefix if you want to specify a specific
11609 address mask, for example:
11610 .code
11611   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11612 .endd
11613 However, unless you are combining a &%match_ip%& condition with others, it is
11614 just as easy to use the fact that a lookup is itself a condition, and write:
11615 .code
11616   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11617 .endd
11618 .endlist ilist
11619
11620 Note that <&'string2'&> is not itself subject to string expansion, unless
11621 Exim was built with the EXPAND_LISTMATCH_RHS option.
11622
11623 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11624
11625 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11626 .cindex "domain list" "in expansion condition"
11627 .cindex "address list" "in expansion condition"
11628 .cindex "local part" "list, in expansion condition"
11629 .cindex "&%match_local_part%& expansion condition"
11630 This condition, together with &%match_address%& and &%match_domain%&, make it
11631 possible to test domain, address, and local part lists within expansions. Each
11632 condition requires two arguments: an item and a list to match. A trivial
11633 example is:
11634 .code
11635 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11636 .endd
11637 In each case, the second argument may contain any of the allowable items for a
11638 list of the appropriate type. Also, because the second argument
11639 is a standard form of list, it is possible to refer to a named list.
11640 Thus, you can use conditions like this:
11641 .code
11642 ${if match_domain{$domain}{+local_domains}{...
11643 .endd
11644 .cindex "&`+caseful`&"
11645 For address lists, the matching starts off caselessly, but the &`+caseful`&
11646 item can be used, as in all address lists, to cause subsequent items to
11647 have their local parts matched casefully. Domains are always matched
11648 caselessly.
11649
11650 Note that <&'string2'&> is not itself subject to string expansion, unless
11651 Exim was built with the EXPAND_LISTMATCH_RHS option.
11652
11653 &*Note*&: Host lists are &'not'& supported in this way. This is because
11654 hosts have two identities: a name and an IP address, and it is not clear
11655 how to specify cleanly how such a test would work. However, IP addresses can be
11656 matched using &%match_ip%&.
11657
11658 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11659 .cindex "PAM authentication"
11660 .cindex "AUTH" "with PAM"
11661 .cindex "Solaris" "PAM support"
11662 .cindex "expansion" "PAM authentication test"
11663 .cindex "&%pam%& expansion condition"
11664 &'Pluggable Authentication Modules'&
11665 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11666 available in the latest releases of Solaris and in some GNU/Linux
11667 distributions. The Exim support, which is intended for use in conjunction with
11668 the SMTP AUTH command, is available only if Exim is compiled with
11669 .code
11670 SUPPORT_PAM=yes
11671 .endd
11672 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11673 in some releases of GNU/Linux &%-ldl%& is also needed.
11674
11675 The argument string is first expanded, and the result must be a
11676 colon-separated list of strings. Leading and trailing white space is ignored.
11677 The PAM module is initialized with the service name &"exim"& and the user name
11678 taken from the first item in the colon-separated data string (<&'string1'&>).
11679 The remaining items in the data string are passed over in response to requests
11680 from the authentication function. In the simple case there will only be one
11681 request, for a password, so the data consists of just two strings.
11682
11683 There can be problems if any of the strings are permitted to contain colon
11684 characters. In the usual way, these have to be doubled to avoid being taken as
11685 separators. If the data is being inserted from a variable, the &%sg%& expansion
11686 item can be used to double any existing colons. For example, the configuration
11687 of a LOGIN authenticator might contain this setting:
11688 .code
11689 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11690 .endd
11691 For a PLAIN authenticator you could use:
11692 .code
11693 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11694 .endd
11695 In some operating systems, PAM authentication can be done only from a process
11696 running as root. Since Exim is running as the Exim user when receiving
11697 messages, this means that PAM cannot be used directly in those systems.
11698 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11699
11700
11701 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11702 .cindex "&'pwcheck'& daemon"
11703 .cindex "Cyrus"
11704 .cindex "expansion" "&'pwcheck'& authentication test"
11705 .cindex "&%pwcheck%& expansion condition"
11706 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11707 This is one way of making it possible for passwords to be checked by a process
11708 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11709 deprecated. Its replacement is &'saslauthd'& (see below).
11710
11711 The pwcheck support is not included in Exim by default. You need to specify
11712 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11713 building Exim. For example:
11714 .code
11715 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11716 .endd
11717 You do not need to install the full Cyrus software suite in order to use
11718 the pwcheck daemon. You can compile and install just the daemon alone
11719 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11720 access to the &_/var/pwcheck_& directory.
11721
11722 The &%pwcheck%& condition takes one argument, which must be the user name and
11723 password, separated by a colon. For example, in a LOGIN authenticator
11724 configuration, you might have this:
11725 .code
11726 server_condition = ${if pwcheck{$auth1:$auth2}}
11727 .endd
11728 Again, for a PLAIN authenticator configuration, this would be:
11729 .code
11730 server_condition = ${if pwcheck{$auth2:$auth3}}
11731 .endd
11732 .vitem &*queue_running*&
11733 .cindex "queue runner" "detecting when delivering from"
11734 .cindex "expansion" "queue runner test"
11735 .cindex "&%queue_running%& expansion condition"
11736 This condition, which has no data, is true during delivery attempts that are
11737 initiated by queue runner processes, and false otherwise.
11738
11739
11740 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11741 .cindex "Radius"
11742 .cindex "expansion" "Radius authentication"
11743 .cindex "&%radius%& expansion condition"
11744 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11745 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11746 the Radius client configuration file in order to build Exim with Radius
11747 support.
11748
11749 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11750 library, using the original API. If you are using release 0.4.0 or later of
11751 this library, you need to set
11752 .code
11753 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11754 .endd
11755 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11756 &%libradius%& library that comes with FreeBSD. To do this, set
11757 .code
11758 RADIUS_LIB_TYPE=RADLIB
11759 .endd
11760 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11761 You may also have to supply a suitable setting in EXTRALIBS so that the
11762 Radius library can be found when Exim is linked.
11763
11764 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11765 Radius client library, which calls the Radius server. The condition is true if
11766 the authentication is successful. For example:
11767 .code
11768 server_condition = ${if radius{<arguments>}}
11769 .endd
11770
11771
11772 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11773         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11774 .cindex "&'saslauthd'& daemon"
11775 .cindex "Cyrus"
11776 .cindex "expansion" "&'saslauthd'& authentication test"
11777 .cindex "&%saslauthd%& expansion condition"
11778 This condition supports user authentication using the Cyrus &'saslauthd'&
11779 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11780 Using this daemon is one way of making it possible for passwords to be checked
11781 by a process that is not running as root.
11782
11783 The saslauthd support is not included in Exim by default. You need to specify
11784 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11785 building Exim. For example:
11786 .code
11787 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11788 .endd
11789 You do not need to install the full Cyrus software suite in order to use
11790 the saslauthd daemon. You can compile and install just the daemon alone
11791 from the Cyrus SASL library.
11792
11793 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11794 two are mandatory. For example:
11795 .code
11796 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11797 .endd
11798 The service and the realm are optional (which is why the arguments are enclosed
11799 in their own set of braces). For details of the meaning of the service and
11800 realm, and how to run the daemon, consult the Cyrus documentation.
11801 .endlist vlist
11802
11803
11804
11805 .section "Combining expansion conditions" "SECID84"
11806 .cindex "expansion" "combining conditions"
11807 Several conditions can be tested at once by combining them using the &%and%&
11808 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11809 conditions on their own, and precede their lists of sub-conditions. Each
11810 sub-condition must be enclosed in braces within the overall braces that contain
11811 the list. No repetition of &%if%& is used.
11812
11813
11814 .vlist
11815 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11816 .cindex "&""or""& expansion condition"
11817 .cindex "expansion" "&""or""& of conditions"
11818 The sub-conditions are evaluated from left to right. The condition is true if
11819 any one of the sub-conditions is true.
11820 For example,
11821 .code
11822 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11823 .endd
11824 When a true sub-condition is found, the following ones are parsed but not
11825 evaluated. If there are several &"match"& sub-conditions the values of the
11826 numeric variables afterwards are taken from the first one that succeeds.
11827
11828 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11829 .cindex "&""and""& expansion condition"
11830 .cindex "expansion" "&""and""& of conditions"
11831 The sub-conditions are evaluated from left to right. The condition is true if
11832 all of the sub-conditions are true. If there are several &"match"&
11833 sub-conditions, the values of the numeric variables afterwards are taken from
11834 the last one. When a false sub-condition is found, the following ones are
11835 parsed but not evaluated.
11836 .endlist
11837 .ecindex IIDexpcond
11838
11839
11840
11841
11842 .section "Expansion variables" "SECTexpvar"
11843 .cindex "expansion" "variables, list of"
11844 This section contains an alphabetical list of all the expansion variables. Some
11845 of them are available only when Exim is compiled with specific options such as
11846 support for TLS or the content scanning extension.
11847
11848 .vlist
11849 .vitem "&$0$&, &$1$&, etc"
11850 .cindex "numerical variables (&$1$& &$2$& etc)"
11851 When a &%match%& expansion condition succeeds, these variables contain the
11852 captured substrings identified by the regular expression during subsequent
11853 processing of the success string of the containing &%if%& expansion item.
11854 In the expansion condition case
11855 they do not retain their values afterwards; in fact, their previous
11856 values are restored at the end of processing an &%if%& item. The numerical
11857 variables may also be set externally by some other matching process which
11858 precedes the expansion of the string. For example, the commands available in
11859 Exim filter files include an &%if%& command with its own regular expression
11860 matching condition.
11861
11862 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11863 Within an acl condition, expansion condition or expansion item
11864 any arguments are copied to these variables,
11865 any unused variables being made empty.
11866
11867 .vitem "&$acl_c...$&"
11868 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11869 can be given any name that starts with &$acl_c$& and is at least six characters
11870 long, but the sixth character must be either a digit or an underscore. For
11871 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11872 variables persist throughout the lifetime of an SMTP connection. They can be
11873 used to pass information between ACLs and between different invocations of the
11874 same ACL. When a message is received, the values of these variables are saved
11875 with the message, and can be accessed by filters, routers, and transports
11876 during subsequent delivery.
11877
11878 .vitem "&$acl_m...$&"
11879 These variables are like the &$acl_c...$& variables, except that their values
11880 are reset after a message has been received. Thus, if several messages are
11881 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11882 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11883 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11884 message is received, the values of these variables are saved with the message,
11885 and can be accessed by filters, routers, and transports during subsequent
11886 delivery.
11887
11888 .vitem &$acl_narg$&
11889 Within an acl condition, expansion condition or expansion item
11890 this variable has the number of arguments.
11891
11892 .vitem &$acl_verify_message$&
11893 .vindex "&$acl_verify_message$&"
11894 After an address verification has failed, this variable contains the failure
11895 message. It retains its value for use in subsequent modifiers. The message can
11896 be preserved by coding like this:
11897 .code
11898 warn !verify = sender
11899      set acl_m0 = $acl_verify_message
11900 .endd
11901 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11902 &%log_message%& modifiers, to include information about the verification
11903 failure.
11904
11905 .vitem &$address_data$&
11906 .vindex "&$address_data$&"
11907 This variable is set by means of the &%address_data%& option in routers. The
11908 value then remains with the address while it is processed by subsequent routers
11909 and eventually a transport. If the transport is handling multiple addresses,
11910 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11911 for more details. &*Note*&: The contents of &$address_data$& are visible in
11912 user filter files.
11913
11914 If &$address_data$& is set when the routers are called from an ACL to verify
11915 a recipient address, the final value is still in the variable for subsequent
11916 conditions and modifiers of the ACL statement. If routing the address caused it
11917 to be redirected to just one address, the child address is also routed as part
11918 of the verification, and in this case the final value of &$address_data$& is
11919 from the child's routing.
11920
11921 If &$address_data$& is set when the routers are called from an ACL to verify a
11922 sender address, the final value is also preserved, but this time in
11923 &$sender_address_data$&, to distinguish it from data from a recipient
11924 address.
11925
11926 In both cases (recipient and sender verification), the value does not persist
11927 after the end of the current ACL statement. If you want to preserve
11928 these values for longer, you can save them in ACL variables.
11929
11930 .vitem &$address_file$&
11931 .vindex "&$address_file$&"
11932 When, as a result of aliasing, forwarding, or filtering, a message is directed
11933 to a specific file, this variable holds the name of the file when the transport
11934 is running. At other times, the variable is empty. For example, using the
11935 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11936 .code
11937 /home/r2d2/savemail
11938 .endd
11939 then when the &(address_file)& transport is running, &$address_file$&
11940 contains the text string &`/home/r2d2/savemail`&.
11941 .cindex "Sieve filter" "value of &$address_file$&"
11942 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11943 then up to the transport configuration to generate an appropriate absolute path
11944 to the relevant file.
11945
11946 .vitem &$address_pipe$&
11947 .vindex "&$address_pipe$&"
11948 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11949 this variable holds the pipe command when the transport is running.
11950
11951 .vitem "&$auth1$& &-- &$auth3$&"
11952 .vindex "&$auth1$&, &$auth2$&, etc"
11953 These variables are used in SMTP authenticators (see chapters
11954 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11955
11956 .vitem &$authenticated_id$&
11957 .cindex "authentication" "id"
11958 .vindex "&$authenticated_id$&"
11959 When a server successfully authenticates a client it may be configured to
11960 preserve some of the authentication information in the variable
11961 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11962 user/password authenticator configuration might preserve the user name for use
11963 in the routers. Note that this is not the same information that is saved in
11964 &$sender_host_authenticated$&.
11965
11966 When a message is submitted locally (that is, not over a TCP connection)
11967 the value of &$authenticated_id$& is normally the login name of the calling
11968 process. However, a trusted user can override this by means of the &%-oMai%&
11969 command line option.
11970 This second case also sets up information used by the
11971 &$authresults$& expansion item.
11972
11973 .vitem &$authenticated_fail_id$&
11974 .cindex "authentication" "fail" "id"
11975 .vindex "&$authenticated_fail_id$&"
11976 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11977 will contain the failed authentication id. If more than one authentication
11978 id is attempted, it will contain only the last one. The variable is
11979 available for processing in the ACL's, generally the quit or notquit ACL.
11980 A message to a local recipient could still be accepted without requiring
11981 authentication, which means this variable could also be visible in all of
11982 the ACL's as well.
11983
11984
11985 .vitem &$authenticated_sender$&
11986 .cindex "sender" "authenticated"
11987 .cindex "authentication" "sender"
11988 .cindex "AUTH" "on MAIL command"
11989 .vindex "&$authenticated_sender$&"
11990 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11991 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11992 described in section &<<SECTauthparamail>>&. Unless the data is the string
11993 &"<>"&, it is set as the authenticated sender of the message, and the value is
11994 available during delivery in the &$authenticated_sender$& variable. If the
11995 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11996
11997 .vindex "&$qualify_domain$&"
11998 When a message is submitted locally (that is, not over a TCP connection), the
11999 value of &$authenticated_sender$& is an address constructed from the login
12000 name of the calling process and &$qualify_domain$&, except that a trusted user
12001 can override this by means of the &%-oMas%& command line option.
12002
12003
12004 .vitem &$authentication_failed$&
12005 .cindex "authentication" "failure"
12006 .vindex "&$authentication_failed$&"
12007 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12008 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12009 possible to distinguish between &"did not try to authenticate"&
12010 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12011 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12012 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12013 negative response to an AUTH command, including (for example) an attempt to use
12014 an undefined mechanism.
12015
12016 .vitem &$av_failed$&
12017 .cindex "content scanning" "AV scanner failure"
12018 This variable is available when Exim is compiled with the content-scanning
12019 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12020 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12021 the ACL malware condition.
12022
12023 .vitem &$body_linecount$&
12024 .cindex "message body" "line count"
12025 .cindex "body of message" "line count"
12026 .vindex "&$body_linecount$&"
12027 When a message is being received or delivered, this variable contains the
12028 number of lines in the message's body. See also &$message_linecount$&.
12029
12030 .vitem &$body_zerocount$&
12031 .cindex "message body" "binary zero count"
12032 .cindex "body of message" "binary zero count"
12033 .cindex "binary zero" "in message body"
12034 .vindex "&$body_zerocount$&"
12035 When a message is being received or delivered, this variable contains the
12036 number of binary zero bytes (ASCII NULs) in the message's body.
12037
12038 .vitem &$bounce_recipient$&
12039 .vindex "&$bounce_recipient$&"
12040 This is set to the recipient address of a bounce message while Exim is creating
12041 it. It is useful if a customized bounce message text file is in use (see
12042 chapter &<<CHAPemsgcust>>&).
12043
12044 .vitem &$bounce_return_size_limit$&
12045 .vindex "&$bounce_return_size_limit$&"
12046 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12047 up to a multiple of 1000. It is useful when a customized error message text
12048 file is in use (see chapter &<<CHAPemsgcust>>&).
12049
12050 .vitem &$caller_gid$&
12051 .cindex "gid (group id)" "caller"
12052 .vindex "&$caller_gid$&"
12053 The real group id under which the process that called Exim was running. This is
12054 not the same as the group id of the originator of a message (see
12055 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12056 incarnation normally contains the Exim gid.
12057
12058 .vitem &$caller_uid$&
12059 .cindex "uid (user id)" "caller"
12060 .vindex "&$caller_uid$&"
12061 The real user id under which the process that called Exim was running. This is
12062 not the same as the user id of the originator of a message (see
12063 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12064 incarnation normally contains the Exim uid.
12065
12066 .vitem &$callout_address$&
12067 .vindex "&$callout_address$&"
12068 After a callout for verification, spamd or malware daemon service, the
12069 address that was connected to.
12070
12071 .vitem &$compile_number$&
12072 .vindex "&$compile_number$&"
12073 The building process for Exim keeps a count of the number
12074 of times it has been compiled. This serves to distinguish different
12075 compilations of the same version of Exim.
12076
12077 .vitem &$config_dir$&
12078 .vindex "&$config_dir$&"
12079 The directory name of the main configuration file. That is, the content of
12080 &$config_file$& with the last component stripped. The value does not
12081 contain the trailing slash. If &$config_file$& does not contain a slash,
12082 &$config_dir$& is ".".
12083
12084 .vitem &$config_file$&
12085 .vindex "&$config_file$&"
12086 The name of the main configuration file Exim is using.
12087
12088 .vitem &$dmarc_domain_policy$& &&&
12089        &$dmarc_status$& &&&
12090        &$dmarc_status_text$& &&&
12091        &$dmarc_used_domains$&
12092 Results of DMARC verification.
12093 For details see section &<<SECDMARC>>&.
12094
12095 .vitem &$dkim_verify_status$&
12096 Results of DKIM verification.
12097 For details see section &<<SECDKIMVFY>>&.
12098
12099 .vitem &$dkim_cur_signer$& &&&
12100        &$dkim_verify_reason$& &&&
12101        &$dkim_domain$& &&&
12102        &$dkim_identity$& &&&
12103        &$dkim_selector$& &&&
12104        &$dkim_algo$& &&&
12105        &$dkim_canon_body$& &&&
12106        &$dkim_canon_headers$& &&&
12107        &$dkim_copiedheaders$& &&&
12108        &$dkim_bodylength$& &&&
12109        &$dkim_created$& &&&
12110        &$dkim_expires$& &&&
12111        &$dkim_headernames$& &&&
12112        &$dkim_key_testing$& &&&
12113        &$dkim_key_nosubdomains$& &&&
12114        &$dkim_key_srvtype$& &&&
12115        &$dkim_key_granularity$& &&&
12116        &$dkim_key_notes$& &&&
12117        &$dkim_key_length$&
12118 These variables are only available within the DKIM ACL.
12119 For details see section &<<SECDKIMVFY>>&.
12120
12121 .vitem &$dkim_signers$&
12122 .vindex &$dkim_signers$&
12123 When a message has been received this variable contains
12124 a colon-separated list of signer domains and identities for the message.
12125 For details see section &<<SECDKIMVFY>>&.
12126
12127 .vitem &$dnslist_domain$& &&&
12128        &$dnslist_matched$& &&&
12129        &$dnslist_text$& &&&
12130        &$dnslist_value$&
12131 .vindex "&$dnslist_domain$&"
12132 .vindex "&$dnslist_matched$&"
12133 .vindex "&$dnslist_text$&"
12134 .vindex "&$dnslist_value$&"
12135 .cindex "black list (DNS)"
12136 When a DNS (black) list lookup succeeds, these variables are set to contain
12137 the following data from the lookup: the list's domain name, the key that was
12138 looked up, the contents of any associated TXT record, and the value from the
12139 main A record. See section &<<SECID204>>& for more details.
12140
12141 .vitem &$domain$&
12142 .vindex "&$domain$&"
12143 When an address is being routed, or delivered on its own, this variable
12144 contains the domain. Uppercase letters in the domain are converted into lower
12145 case for &$domain$&.
12146
12147 Global address rewriting happens when a message is received, so the value of
12148 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12149 is set during user filtering, but not during system filtering, because a
12150 message may have many recipients and the system filter is called just once.
12151
12152 When more than one address is being delivered at once (for example, several
12153 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12154 have the same domain. Transports can be restricted to handling only one domain
12155 at a time if the value of &$domain$& is required at transport time &-- this is
12156 the default for local transports. For further details of the environment in
12157 which local transports are run, see chapter &<<CHAPenvironment>>&.
12158
12159 .oindex "&%delay_warning_condition%&"
12160 At the end of a delivery, if all deferred addresses have the same domain, it is
12161 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12162
12163 The &$domain$& variable is also used in some other circumstances:
12164
12165 .ilist
12166 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12167 the recipient address. The domain of the &'sender'& address is in
12168 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12169 normally set during the running of the MAIL ACL. However, if the sender address
12170 is verified with a callout during the MAIL ACL, the sender domain is placed in
12171 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12172 the &(smtp)& transport.
12173
12174 .next
12175 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12176 &$domain$& contains the domain portion of the address that is being rewritten;
12177 it can be used in the expansion of the replacement address, for example, to
12178 rewrite domains by file lookup.
12179
12180 .next
12181 With one important exception, whenever a domain list is being scanned,
12182 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12183 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12184 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12185 that, in a RCPT ACL, the sender domain list can be dependent on the
12186 recipient domain (which is what is in &$domain$& at this time).
12187
12188 .next
12189 .cindex "ETRN" "value of &$domain$&"
12190 .oindex "&%smtp_etrn_command%&"
12191 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12192 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12193 .endlist
12194
12195
12196 .vitem &$domain_data$&
12197 .vindex "&$domain_data$&"
12198 When the &%domains%& option on a router matches a domain by
12199 means of a lookup, the data read by the lookup is available during the running
12200 of the router as &$domain_data$&. In addition, if the driver routes the
12201 address to a transport, the value is available in that transport. If the
12202 transport is handling multiple addresses, the value from the first address is
12203 used.
12204
12205 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12206 domain by means of a lookup. The data read by the lookup is available during
12207 the rest of the ACL statement. In all other situations, this variable expands
12208 to nothing.
12209
12210 .vitem &$exim_gid$&
12211 .vindex "&$exim_gid$&"
12212 This variable contains the numerical value of the Exim group id.
12213
12214 .vitem &$exim_path$&
12215 .vindex "&$exim_path$&"
12216 This variable contains the path to the Exim binary.
12217
12218 .vitem &$exim_uid$&
12219 .vindex "&$exim_uid$&"
12220 This variable contains the numerical value of the Exim user id.
12221
12222 .vitem &$exim_version$&
12223 .vindex "&$exim_version$&"
12224 This variable contains the version string of the Exim build.
12225 The first character is a major version number, currently 4.
12226 Then after a dot, the next group of digits is a minor version number.
12227 There may be other characters following the minor version.
12228 This value may be overridden by the &%exim_version%& main config option.
12229
12230 .vitem &$header_$&<&'name'&>
12231 This is not strictly an expansion variable. It is expansion syntax for
12232 inserting the message header line with the given name. Note that the name must
12233 be terminated by colon or white space, because it may contain a wide variety of
12234 characters. Note also that braces must &'not'& be used.
12235 See the full description in section &<<SECTexpansionitems>>& above.
12236
12237 .vitem &$headers_added$&
12238 .vindex "&$headers_added$&"
12239 Within an ACL this variable contains the headers added so far by
12240 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12241 The headers are a newline-separated list.
12242
12243 .vitem &$home$&
12244 .vindex "&$home$&"
12245 When the &%check_local_user%& option is set for a router, the user's home
12246 directory is placed in &$home$& when the check succeeds. In particular, this
12247 means it is set during the running of users' filter files. A router may also
12248 explicitly set a home directory for use by a transport; this can be overridden
12249 by a setting on the transport itself.
12250
12251 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12252 of the environment variable HOME, which is subject to the
12253 &%keep_environment%& and &%add_environment%& main config options.
12254
12255 .vitem &$host$&
12256 .vindex "&$host$&"
12257 If a router assigns an address to a transport (any transport), and passes a
12258 list of hosts with the address, the value of &$host$& when the transport starts
12259 to run is the name of the first host on the list. Note that this applies both
12260 to local and remote transports.
12261
12262 .cindex "transport" "filter"
12263 .cindex "filter" "transport filter"
12264 For the &(smtp)& transport, if there is more than one host, the value of
12265 &$host$& changes as the transport works its way through the list. In
12266 particular, when the &(smtp)& transport is expanding its options for encryption
12267 using TLS, or for specifying a transport filter (see chapter
12268 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12269 is connected.
12270
12271 When used in the client part of an authenticator configuration (see chapter
12272 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12273 client is connected.
12274
12275
12276 .vitem &$host_address$&
12277 .vindex "&$host_address$&"
12278 This variable is set to the remote host's IP address whenever &$host$& is set
12279 for a remote connection. It is also set to the IP address that is being checked
12280 when the &%ignore_target_hosts%& option is being processed.
12281
12282 .vitem &$host_data$&
12283 .vindex "&$host_data$&"
12284 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12285 result of the lookup is made available in the &$host_data$& variable. This
12286 allows you, for example, to do things like this:
12287 .code
12288 deny  hosts = net-lsearch;/some/file
12289 message = $host_data
12290 .endd
12291 .vitem &$host_lookup_deferred$&
12292 .cindex "host name" "lookup, failure of"
12293 .vindex "&$host_lookup_deferred$&"
12294 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12295 message comes from a remote host and there is an attempt to look up the host's
12296 name from its IP address, and the attempt is not successful, one of these
12297 variables is set to &"1"&.
12298
12299 .ilist
12300 If the lookup receives a definite negative response (for example, a DNS lookup
12301 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12302
12303 .next
12304 If there is any kind of problem during the lookup, such that Exim cannot
12305 tell whether or not the host name is defined (for example, a timeout for a DNS
12306 lookup), &$host_lookup_deferred$& is set to &"1"&.
12307 .endlist ilist
12308
12309 Looking up a host's name from its IP address consists of more than just a
12310 single reverse lookup. Exim checks that a forward lookup of at least one of the
12311 names it receives from a reverse lookup yields the original IP address. If this
12312 is not the case, Exim does not accept the looked up name(s), and
12313 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12314 IP address (for example, the existence of a PTR record in the DNS) is not
12315 sufficient on its own for the success of a host name lookup. If the reverse
12316 lookup succeeds, but there is a lookup problem such as a timeout when checking
12317 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12318 &"1"&. See also &$sender_host_name$&.
12319
12320 .cindex authentication "expansion item"
12321 Performing these checks sets up information used by the
12322 &%authresults%& expansion item.
12323
12324
12325 .vitem &$host_lookup_failed$&
12326 .vindex "&$host_lookup_failed$&"
12327 See &$host_lookup_deferred$&.
12328
12329 .vitem &$host_port$&
12330 .vindex "&$host_port$&"
12331 This variable is set to the remote host's TCP port whenever &$host$& is set
12332 for an outbound connection.
12333
12334 .vitem &$initial_cwd$&
12335 .vindex "&$initial_cwd$&
12336 This variable contains the full path name of the initial working
12337 directory of the current Exim process. This may differ from the current
12338 working directory, as Exim changes this to "/" during early startup, and
12339 to &$spool_directory$& later.
12340
12341 .vitem &$inode$&
12342 .vindex "&$inode$&"
12343 The only time this variable is set is while expanding the &%directory_file%&
12344 option in the &(appendfile)& transport. The variable contains the inode number
12345 of the temporary file which is about to be renamed. It can be used to construct
12346 a unique name for the file.
12347
12348 .vitem &$interface_address$&
12349 .vindex "&$interface_address$&"
12350 This is an obsolete name for &$received_ip_address$&.
12351
12352 .vitem &$interface_port$&
12353 .vindex "&$interface_port$&"
12354 This is an obsolete name for &$received_port$&.
12355
12356 .vitem &$item$&
12357 .vindex "&$item$&"
12358 This variable is used during the expansion of &*forall*& and &*forany*&
12359 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12360 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12361 empty.
12362
12363 .vitem &$ldap_dn$&
12364 .vindex "&$ldap_dn$&"
12365 This variable, which is available only when Exim is compiled with LDAP support,
12366 contains the DN from the last entry in the most recently successful LDAP
12367 lookup.
12368
12369 .vitem &$load_average$&
12370 .vindex "&$load_average$&"
12371 This variable contains the system load average, multiplied by 1000 so that it
12372 is an integer. For example, if the load average is 0.21, the value of the
12373 variable is 210. The value is recomputed every time the variable is referenced.
12374
12375 .vitem &$local_part$&
12376 .vindex "&$local_part$&"
12377 When an address is being routed, or delivered on its own, this
12378 variable contains the local part. When a number of addresses are being
12379 delivered together (for example, multiple RCPT commands in an SMTP
12380 session), &$local_part$& is not set.
12381
12382 Global address rewriting happens when a message is received, so the value of
12383 &$local_part$& during routing and delivery is the value after rewriting.
12384 &$local_part$& is set during user filtering, but not during system filtering,
12385 because a message may have many recipients and the system filter is called just
12386 once.
12387
12388 .vindex "&$local_part_prefix$&"
12389 .vindex "&$local_part_suffix$&"
12390 .cindex affix variables
12391 If a local part prefix or suffix has been recognized, it is not included in the
12392 value of &$local_part$& during routing and subsequent delivery. The values of
12393 any prefix or suffix are in &$local_part_prefix$& and
12394 &$local_part_suffix$&, respectively.
12395
12396 When a message is being delivered to a file, pipe, or autoreply transport as a
12397 result of aliasing or forwarding, &$local_part$& is set to the local part of
12398 the parent address, not to the filename or command (see &$address_file$& and
12399 &$address_pipe$&).
12400
12401 When an ACL is running for a RCPT command, &$local_part$& contains the
12402 local part of the recipient address.
12403
12404 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12405 &$local_part$& contains the local part of the address that is being rewritten;
12406 it can be used in the expansion of the replacement address, for example.
12407
12408 In all cases, all quoting is removed from the local part. For example, for both
12409 the addresses
12410 .code
12411 "abc:xyz"@test.example
12412 abc\:xyz@test.example
12413 .endd
12414 the value of &$local_part$& is
12415 .code
12416 abc:xyz
12417 .endd
12418 If you use &$local_part$& to create another address, you should always wrap it
12419 inside a quoting operator. For example, in a &(redirect)& router you could
12420 have:
12421 .code
12422 data = ${quote_local_part:$local_part}@new.domain.example
12423 .endd
12424 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12425 to process local parts in a case-dependent manner in a router, you can set the
12426 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12427
12428 .vitem &$local_part_data$&
12429 .vindex "&$local_part_data$&"
12430 When the &%local_parts%& option on a router matches a local part by means of a
12431 lookup, the data read by the lookup is available during the running of the
12432 router as &$local_part_data$&. In addition, if the driver routes the address
12433 to a transport, the value is available in that transport. If the transport is
12434 handling multiple addresses, the value from the first address is used.
12435
12436 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12437 matches a local part by means of a lookup. The data read by the lookup is
12438 available during the rest of the ACL statement. In all other situations, this
12439 variable expands to nothing.
12440
12441 .vitem &$local_part_prefix$&
12442 .vindex "&$local_part_prefix$&"
12443 .cindex affix variables
12444 When an address is being routed or delivered, and a
12445 specific prefix for the local part was recognized, it is available in this
12446 variable, having been removed from &$local_part$&.
12447
12448 .vitem &$local_part_suffix$&
12449 .vindex "&$local_part_suffix$&"
12450 When an address is being routed or delivered, and a
12451 specific suffix for the local part was recognized, it is available in this
12452 variable, having been removed from &$local_part$&.
12453
12454 .vitem &$local_scan_data$&
12455 .vindex "&$local_scan_data$&"
12456 This variable contains the text returned by the &[local_scan()]& function when
12457 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12458
12459 .vitem &$local_user_gid$&
12460 .vindex "&$local_user_gid$&"
12461 See &$local_user_uid$&.
12462
12463 .vitem &$local_user_uid$&
12464 .vindex "&$local_user_uid$&"
12465 This variable and &$local_user_gid$& are set to the uid and gid after the
12466 &%check_local_user%& router precondition succeeds. This means that their values
12467 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12468 and &%condition%&), for the &%address_data%& expansion, and for any
12469 router-specific expansions. At all other times, the values in these variables
12470 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12471
12472 .vitem &$localhost_number$&
12473 .vindex "&$localhost_number$&"
12474 This contains the expanded value of the
12475 &%localhost_number%& option. The expansion happens after the main options have
12476 been read.
12477
12478 .vitem &$log_inodes$&
12479 .vindex "&$log_inodes$&"
12480 The number of free inodes in the disk partition where Exim's
12481 log files are being written. The value is recalculated whenever the variable is
12482 referenced. If the relevant file system does not have the concept of inodes,
12483 the value of is -1. See also the &%check_log_inodes%& option.
12484
12485 .vitem &$log_space$&
12486 .vindex "&$log_space$&"
12487 The amount of free space (as a number of kilobytes) in the disk
12488 partition where Exim's log files are being written. The value is recalculated
12489 whenever the variable is referenced. If the operating system does not have the
12490 ability to find the amount of free space (only true for experimental systems),
12491 the space value is -1. See also the &%check_log_space%& option.
12492
12493
12494 .vitem &$lookup_dnssec_authenticated$&
12495 .vindex "&$lookup_dnssec_authenticated$&"
12496 This variable is set after a DNS lookup done by
12497 a dnsdb lookup expansion, dnslookup router or smtp transport.
12498 .cindex "DNS" "DNSSEC"
12499 It will be empty if &(DNSSEC)& was not requested,
12500 &"no"& if the result was not labelled as authenticated data
12501 and &"yes"& if it was.
12502 Results that are labelled as authoritative answer that match
12503 the &%dns_trust_aa%& configuration variable count also
12504 as authenticated data.
12505
12506 .vitem &$mailstore_basename$&
12507 .vindex "&$mailstore_basename$&"
12508 This variable is set only when doing deliveries in &"mailstore"& format in the
12509 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12510 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12511 contains the basename of the files that are being written, that is, the name
12512 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12513 variable is empty.
12514
12515 .vitem &$malware_name$&
12516 .vindex "&$malware_name$&"
12517 This variable is available when Exim is compiled with the
12518 content-scanning extension. It is set to the name of the virus that was found
12519 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12520
12521 .vitem &$max_received_linelength$&
12522 .vindex "&$max_received_linelength$&"
12523 .cindex "maximum" "line length"
12524 .cindex "line length" "maximum"
12525 This variable contains the number of bytes in the longest line that was
12526 received as part of the message, not counting the line termination
12527 character(s).
12528 It is not valid if the &%spool_files_wireformat%& option is used.
12529
12530 .vitem &$message_age$&
12531 .cindex "message" "age of"
12532 .vindex "&$message_age$&"
12533 This variable is set at the start of a delivery attempt to contain the number
12534 of seconds since the message was received. It does not change during a single
12535 delivery attempt.
12536
12537 .vitem &$message_body$&
12538 .cindex "body of message" "expansion variable"
12539 .cindex "message body" "in expansion"
12540 .cindex "binary zero" "in message body"
12541 .vindex "&$message_body$&"
12542 .oindex "&%message_body_visible%&"
12543 This variable contains the initial portion of a message's body while it is
12544 being delivered, and is intended mainly for use in filter files. The maximum
12545 number of characters of the body that are put into the variable is set by the
12546 &%message_body_visible%& configuration option; the default is 500.
12547
12548 .oindex "&%message_body_newlines%&"
12549 By default, newlines are converted into spaces in &$message_body$&, to make it
12550 easier to search for phrases that might be split over a line break. However,
12551 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12552 zeros are always converted into spaces.
12553
12554 .vitem &$message_body_end$&
12555 .cindex "body of message" "expansion variable"
12556 .cindex "message body" "in expansion"
12557 .vindex "&$message_body_end$&"
12558 This variable contains the final portion of a message's
12559 body while it is being delivered. The format and maximum size are as for
12560 &$message_body$&.
12561
12562 .vitem &$message_body_size$&
12563 .cindex "body of message" "size"
12564 .cindex "message body" "size"
12565 .vindex "&$message_body_size$&"
12566 When a message is being delivered, this variable contains the size of the body
12567 in bytes. The count starts from the character after the blank line that
12568 separates the body from the header. Newlines are included in the count. See
12569 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12570
12571 If the spool file is wireformat
12572 (see the &%spool_files_wireformat%& main option)
12573 the CRLF line-terminators are included in the count.
12574
12575 .vitem &$message_exim_id$&
12576 .vindex "&$message_exim_id$&"
12577 When a message is being received or delivered, this variable contains the
12578 unique message id that is generated and used by Exim to identify the message.
12579 An id is not created for a message until after its header has been successfully
12580 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12581 line; it is the local id that Exim assigns to the message, for example:
12582 &`1BXTIK-0001yO-VA`&.
12583
12584 .vitem &$message_headers$&
12585 .vindex &$message_headers$&
12586 This variable contains a concatenation of all the header lines when a message
12587 is being processed, except for lines added by routers or transports. The header
12588 lines are separated by newline characters. Their contents are decoded in the
12589 same way as a header line that is inserted by &%bheader%&.
12590
12591 .vitem &$message_headers_raw$&
12592 .vindex &$message_headers_raw$&
12593 This variable is like &$message_headers$& except that no processing of the
12594 contents of header lines is done.
12595
12596 .vitem &$message_id$&
12597 This is an old name for &$message_exim_id$&. It is now deprecated.
12598
12599 .vitem &$message_linecount$&
12600 .vindex "&$message_linecount$&"
12601 This variable contains the total number of lines in the header and body of the
12602 message. Compare &$body_linecount$&, which is the count for the body only.
12603 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12604 number of lines received. Before delivery happens (that is, before filters,
12605 routers, and transports run) the count is increased to include the
12606 &'Received:'& header line that Exim standardly adds, and also any other header
12607 lines that are added by ACLs. The blank line that separates the message header
12608 from the body is not counted.
12609
12610 As with the special case of &$message_size$&, during the expansion of the
12611 appendfile transport's maildir_tag option in maildir format, the value of
12612 &$message_linecount$& is the precise size of the number of newlines in the
12613 file that has been written (minus one for the blank line between the
12614 header and the body).
12615
12616 Here is an example of the use of this variable in a DATA ACL:
12617 .code
12618 deny message   = Too many lines in message header
12619      condition = \
12620       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12621 .endd
12622 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12623 message has not yet been received.
12624
12625 This variable is not valid if the &%spool_files_wireformat%& option is used.
12626
12627 .vitem &$message_size$&
12628 .cindex "size" "of message"
12629 .cindex "message" "size"
12630 .vindex "&$message_size$&"
12631 When a message is being processed, this variable contains its size in bytes. In
12632 most cases, the size includes those headers that were received with the
12633 message, but not those (such as &'Envelope-to:'&) that are added to individual
12634 deliveries as they are written. However, there is one special case: during the
12635 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12636 doing a delivery in maildir format, the value of &$message_size$& is the
12637 precise size of the file that has been written. See also
12638 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12639
12640 .cindex "RCPT" "value of &$message_size$&"
12641 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12642 contains the size supplied on the MAIL command, or -1 if no size was given. The
12643 value may not, of course, be truthful.
12644
12645 .vitem &$mime_$&&'xxx'&
12646 A number of variables whose names start with &$mime$& are
12647 available when Exim is compiled with the content-scanning extension. For
12648 details, see section &<<SECTscanmimepart>>&.
12649
12650 .vitem "&$n0$& &-- &$n9$&"
12651 These variables are counters that can be incremented by means
12652 of the &%add%& command in filter files.
12653
12654 .vitem &$original_domain$&
12655 .vindex "&$domain$&"
12656 .vindex "&$original_domain$&"
12657 When a top-level address is being processed for delivery, this contains the
12658 same value as &$domain$&. However, if a &"child"& address (for example,
12659 generated by an alias, forward, or filter file) is being processed, this
12660 variable contains the domain of the original address (lower cased). This
12661 differs from &$parent_domain$& only when there is more than one level of
12662 aliasing or forwarding. When more than one address is being delivered in a
12663 single transport run, &$original_domain$& is not set.
12664
12665 If a new address is created by means of a &%deliver%& command in a system
12666 filter, it is set up with an artificial &"parent"& address. This has the local
12667 part &'system-filter'& and the default qualify domain.
12668
12669 .vitem &$original_local_part$&
12670 .vindex "&$local_part$&"
12671 .vindex "&$original_local_part$&"
12672 When a top-level address is being processed for delivery, this contains the
12673 same value as &$local_part$&, unless a prefix or suffix was removed from the
12674 local part, because &$original_local_part$& always contains the full local
12675 part. When a &"child"& address (for example, generated by an alias, forward, or
12676 filter file) is being processed, this variable contains the full local part of
12677 the original address.
12678
12679 If the router that did the redirection processed the local part
12680 case-insensitively, the value in &$original_local_part$& is in lower case.
12681 This variable differs from &$parent_local_part$& only when there is more than
12682 one level of aliasing or forwarding. When more than one address is being
12683 delivered in a single transport run, &$original_local_part$& is not set.
12684
12685 If a new address is created by means of a &%deliver%& command in a system
12686 filter, it is set up with an artificial &"parent"& address. This has the local
12687 part &'system-filter'& and the default qualify domain.
12688
12689 .vitem &$originator_gid$&
12690 .cindex "gid (group id)" "of originating user"
12691 .cindex "sender" "gid"
12692 .vindex "&$caller_gid$&"
12693 .vindex "&$originator_gid$&"
12694 This variable contains the value of &$caller_gid$& that was set when the
12695 message was received. For messages received via the command line, this is the
12696 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12697 normally the gid of the Exim user.
12698
12699 .vitem &$originator_uid$&
12700 .cindex "uid (user id)" "of originating user"
12701 .cindex "sender" "uid"
12702 .vindex "&$caller_uid$&"
12703 .vindex "&$originator_uid$&"
12704 The value of &$caller_uid$& that was set when the message was received. For
12705 messages received via the command line, this is the uid of the sending user.
12706 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12707 user.
12708
12709 .vitem &$parent_domain$&
12710 .vindex "&$parent_domain$&"
12711 This variable is similar to &$original_domain$& (see
12712 above), except that it refers to the immediately preceding parent address.
12713
12714 .vitem &$parent_local_part$&
12715 .vindex "&$parent_local_part$&"
12716 This variable is similar to &$original_local_part$&
12717 (see above), except that it refers to the immediately preceding parent address.
12718
12719 .vitem &$pid$&
12720 .cindex "pid (process id)" "of current process"
12721 .vindex "&$pid$&"
12722 This variable contains the current process id.
12723
12724 .vitem &$pipe_addresses$&
12725 .cindex "filter" "transport filter"
12726 .cindex "transport" "filter"
12727 .vindex "&$pipe_addresses$&"
12728 This is not an expansion variable, but is mentioned here because the string
12729 &`$pipe_addresses`& is handled specially in the command specification for the
12730 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12731 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12732 It cannot be used in general expansion strings, and provokes an &"unknown
12733 variable"& error if encountered.
12734
12735 .vitem &$primary_hostname$&
12736 .vindex "&$primary_hostname$&"
12737 This variable contains the value set by &%primary_hostname%& in the
12738 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12739 a single-component name, Exim calls &[gethostbyname()]& (or
12740 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12741 qualified host name. See also &$smtp_active_hostname$&.
12742
12743
12744 .vitem &$proxy_external_address$& &&&
12745        &$proxy_external_port$& &&&
12746        &$proxy_local_address$& &&&
12747        &$proxy_local_port$& &&&
12748        &$proxy_session$&
12749 These variables are only available when built with Proxy Protocol
12750 or SOCKS5 support.
12751 For details see chapter &<<SECTproxyInbound>>&.
12752
12753 .vitem &$prdr_requested$&
12754 .cindex "PRDR" "variable for"
12755 This variable is set to &"yes"& if PRDR was requested by the client for the
12756 current message, otherwise &"no"&.
12757
12758 .vitem &$prvscheck_address$&
12759 This variable is used in conjunction with the &%prvscheck%& expansion item,
12760 which is described in sections &<<SECTexpansionitems>>& and
12761 &<<SECTverifyPRVS>>&.
12762
12763 .vitem &$prvscheck_keynum$&
12764 This variable is used in conjunction with the &%prvscheck%& expansion item,
12765 which is described in sections &<<SECTexpansionitems>>& and
12766 &<<SECTverifyPRVS>>&.
12767
12768 .vitem &$prvscheck_result$&
12769 This variable is used in conjunction with the &%prvscheck%& expansion item,
12770 which is described in sections &<<SECTexpansionitems>>& and
12771 &<<SECTverifyPRVS>>&.
12772
12773 .vitem &$qualify_domain$&
12774 .vindex "&$qualify_domain$&"
12775 The value set for the &%qualify_domain%& option in the configuration file.
12776
12777 .vitem &$qualify_recipient$&
12778 .vindex "&$qualify_recipient$&"
12779 The value set for the &%qualify_recipient%& option in the configuration file,
12780 or if not set, the value of &$qualify_domain$&.
12781
12782 .vitem &$queue_name$&
12783 .vindex &$queue_name$&
12784 .cindex "named queues"
12785 .cindex queues named
12786 The name of the spool queue in use; empty for the default queue.
12787
12788 .vitem &$r_...$&
12789 .vindex &$r_...$&
12790 .cindex router variables
12791 Values can be placed in these variables by the &%set%& option of a router.
12792 They can be given any name that starts with &$r_$&.
12793 The values persist for the address being handled through subsequent routers
12794 and the eventual transport.
12795
12796 .vitem &$rcpt_count$&
12797 .vindex "&$rcpt_count$&"
12798 When a message is being received by SMTP, this variable contains the number of
12799 RCPT commands received for the current message. If this variable is used in a
12800 RCPT ACL, its value includes the current command.
12801
12802 .vitem &$rcpt_defer_count$&
12803 .vindex "&$rcpt_defer_count$&"
12804 .cindex "4&'xx'& responses" "count of"
12805 When a message is being received by SMTP, this variable contains the number of
12806 RCPT commands in the current message that have previously been rejected with a
12807 temporary (4&'xx'&) response.
12808
12809 .vitem &$rcpt_fail_count$&
12810 .vindex "&$rcpt_fail_count$&"
12811 When a message is being received by SMTP, this variable contains the number of
12812 RCPT commands in the current message that have previously been rejected with a
12813 permanent (5&'xx'&) response.
12814
12815 .vitem &$received_count$&
12816 .vindex "&$received_count$&"
12817 This variable contains the number of &'Received:'& header lines in the message,
12818 including the one added by Exim (so its value is always greater than zero). It
12819 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12820 delivering.
12821
12822 .vitem &$received_for$&
12823 .vindex "&$received_for$&"
12824 If there is only a single recipient address in an incoming message, this
12825 variable contains that address when the &'Received:'& header line is being
12826 built. The value is copied after recipient rewriting has happened, but before
12827 the &[local_scan()]& function is run.
12828
12829 .vitem &$received_ip_address$&
12830 .vindex "&$received_ip_address$&"
12831 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12832 variable is set to the address of the local IP interface, and &$received_port$&
12833 is set to the local port number. (The remote IP address and port are in
12834 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12835 the port value is -1 unless it has been set using the &%-oMi%& command line
12836 option.
12837
12838 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12839 could be used, for example, to make the filename for a TLS certificate depend
12840 on which interface and/or port is being used for the incoming connection. The
12841 values of &$received_ip_address$& and &$received_port$& are saved with any
12842 messages that are received, thus making these variables available at delivery
12843 time.
12844 For outbound connections see &$sending_ip_address$&.
12845
12846 .vitem &$received_port$&
12847 .vindex "&$received_port$&"
12848 See &$received_ip_address$&.
12849
12850 .vitem &$received_protocol$&
12851 .vindex "&$received_protocol$&"
12852 When a message is being processed, this variable contains the name of the
12853 protocol by which it was received. Most of the names used by Exim are defined
12854 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12855 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12856 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12857 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12858 connection and the client was successfully authenticated.
12859
12860 Exim uses the protocol name &"smtps"& for the case when encryption is
12861 automatically set up on connection without the use of STARTTLS (see
12862 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12863 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12864 where the client initially uses EHLO, sets up an encrypted connection using
12865 STARTTLS, and then uses HELO afterwards.
12866
12867 The &%-oMr%& option provides a way of specifying a custom protocol name for
12868 messages that are injected locally by trusted callers. This is commonly used to
12869 identify messages that are being re-injected after some kind of scanning.
12870
12871 .vitem &$received_time$&
12872 .vindex "&$received_time$&"
12873 This variable contains the date and time when the current message was received,
12874 as a number of seconds since the start of the Unix epoch.
12875
12876 .vitem &$recipient_data$&
12877 .vindex "&$recipient_data$&"
12878 This variable is set after an indexing lookup success in an ACL &%recipients%&
12879 condition. It contains the data from the lookup, and the value remains set
12880 until the next &%recipients%& test. Thus, you can do things like this:
12881 .display
12882 &`require recipients  = cdb*@;/some/file`&
12883 &`deny    `&&'some further test involving'& &`$recipient_data`&
12884 .endd
12885 &*Warning*&: This variable is set only when a lookup is used as an indexing
12886 method in the address list, using the semicolon syntax as in the example above.
12887 The variable is not set for a lookup that is used as part of the string
12888 expansion that all such lists undergo before being interpreted.
12889
12890 .vitem &$recipient_verify_failure$&
12891 .vindex "&$recipient_verify_failure$&"
12892 In an ACL, when a recipient verification fails, this variable contains
12893 information about the failure. It is set to one of the following words:
12894
12895 .ilist
12896 &"qualify"&: The address was unqualified (no domain), and the message
12897 was neither local nor came from an exempted host.
12898
12899 .next
12900 &"route"&: Routing failed.
12901
12902 .next
12903 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12904 or before the MAIL command (that is, on initial connection, HELO, or
12905 MAIL).
12906
12907 .next
12908 &"recipient"&: The RCPT command in a callout was rejected.
12909 .next
12910
12911 &"postmaster"&: The postmaster check in a callout was rejected.
12912 .endlist
12913
12914 The main use of this variable is expected to be to distinguish between
12915 rejections of MAIL and rejections of RCPT.
12916
12917 .vitem &$recipients$&
12918 .vindex "&$recipients$&"
12919 This variable contains a list of envelope recipients for a message. A comma and
12920 a space separate the addresses in the replacement text. However, the variable
12921 is not generally available, to prevent exposure of Bcc recipients in
12922 unprivileged users' filter files. You can use &$recipients$& only in these
12923 cases:
12924
12925 .olist
12926 In a system filter file.
12927 .next
12928 In the ACLs associated with the DATA command and with non-SMTP messages, that
12929 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12930 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12931 &%acl_not_smtp_mime%&.
12932 .next
12933 From within a &[local_scan()]& function.
12934 .endlist
12935
12936
12937 .vitem &$recipients_count$&
12938 .vindex "&$recipients_count$&"
12939 When a message is being processed, this variable contains the number of
12940 envelope recipients that came with the message. Duplicates are not excluded
12941 from the count. While a message is being received over SMTP, the number
12942 increases for each accepted recipient. It can be referenced in an ACL.
12943
12944
12945 .vitem &$regex_match_string$&
12946 .vindex "&$regex_match_string$&"
12947 This variable is set to contain the matching regular expression after a
12948 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12949
12950 .vitem "&$regex1$&, &$regex2$&, etc"
12951 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12952 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12953 these variables contain the
12954 captured substrings identified by the regular expression.
12955
12956
12957 .vitem &$reply_address$&
12958 .vindex "&$reply_address$&"
12959 When a message is being processed, this variable contains the contents of the
12960 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12961 contents of the &'From:'& header line. Apart from the removal of leading
12962 white space, the value is not processed in any way. In particular, no RFC 2047
12963 decoding or character code translation takes place.
12964
12965 .vitem &$return_path$&
12966 .vindex "&$return_path$&"
12967 When a message is being delivered, this variable contains the return path &--
12968 the sender field that will be sent as part of the envelope. It is not enclosed
12969 in <> characters. At the start of routing an address, &$return_path$& has the
12970 same value as &$sender_address$&, but if, for example, an incoming message to a
12971 mailing list has been expanded by a router which specifies a different address
12972 for bounce messages, &$return_path$& subsequently contains the new bounce
12973 address, whereas &$sender_address$& always contains the original sender address
12974 that was received with the message. In other words, &$sender_address$& contains
12975 the incoming envelope sender, and &$return_path$& contains the outgoing
12976 envelope sender.
12977
12978 .vitem &$return_size_limit$&
12979 .vindex "&$return_size_limit$&"
12980 This is an obsolete name for &$bounce_return_size_limit$&.
12981
12982 .vitem &$router_name$&
12983 .cindex "router" "name"
12984 .cindex "name" "of router"
12985 .vindex "&$router_name$&"
12986 During the running of a router this variable contains its name.
12987
12988 .vitem &$runrc$&
12989 .cindex "return code" "from &%run%& expansion"
12990 .vindex "&$runrc$&"
12991 This variable contains the return code from a command that is run by the
12992 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12993 assume the order in which option values are expanded, except for those
12994 preconditions whose order of testing is documented. Therefore, you cannot
12995 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12996 another.
12997
12998 .vitem &$self_hostname$&
12999 .oindex "&%self%&" "value of host name"
13000 .vindex "&$self_hostname$&"
13001 When an address is routed to a supposedly remote host that turns out to be the
13002 local host, what happens is controlled by the &%self%& generic router option.
13003 One of its values causes the address to be passed to another router. When this
13004 happens, &$self_hostname$& is set to the name of the local host that the
13005 original router encountered. In other circumstances its contents are null.
13006
13007 .vitem &$sender_address$&
13008 .vindex "&$sender_address$&"
13009 When a message is being processed, this variable contains the sender's address
13010 that was received in the message's envelope. The case of letters in the address
13011 is retained, in both the local part and the domain. For bounce messages, the
13012 value of this variable is the empty string. See also &$return_path$&.
13013
13014 .vitem &$sender_address_data$&
13015 .vindex "&$address_data$&"
13016 .vindex "&$sender_address_data$&"
13017 If &$address_data$& is set when the routers are called from an ACL to verify a
13018 sender address, the final value is preserved in &$sender_address_data$&, to
13019 distinguish it from data from a recipient address. The value does not persist
13020 after the end of the current ACL statement. If you want to preserve it for
13021 longer, you can save it in an ACL variable.
13022
13023 .vitem &$sender_address_domain$&
13024 .vindex "&$sender_address_domain$&"
13025 The domain portion of &$sender_address$&.
13026
13027 .vitem &$sender_address_local_part$&
13028 .vindex "&$sender_address_local_part$&"
13029 The local part portion of &$sender_address$&.
13030
13031 .vitem &$sender_data$&
13032 .vindex "&$sender_data$&"
13033 This variable is set after a lookup success in an ACL &%senders%& condition or
13034 in a router &%senders%& option. It contains the data from the lookup, and the
13035 value remains set until the next &%senders%& test. Thus, you can do things like
13036 this:
13037 .display
13038 &`require senders      = cdb*@;/some/file`&
13039 &`deny    `&&'some further test involving'& &`$sender_data`&
13040 .endd
13041 &*Warning*&: This variable is set only when a lookup is used as an indexing
13042 method in the address list, using the semicolon syntax as in the example above.
13043 The variable is not set for a lookup that is used as part of the string
13044 expansion that all such lists undergo before being interpreted.
13045
13046 .vitem &$sender_fullhost$&
13047 .vindex "&$sender_fullhost$&"
13048 When a message is received from a remote host, this variable contains the host
13049 name and IP address in a single string. It ends with the IP address in square
13050 brackets, followed by a colon and a port number if the logging of ports is
13051 enabled. The format of the rest of the string depends on whether the host
13052 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13053 looking up its IP address. (Looking up the IP address can be forced by the
13054 &%host_lookup%& option, independent of verification.) A plain host name at the
13055 start of the string is a verified host name; if this is not present,
13056 verification either failed or was not requested. A host name in parentheses is
13057 the argument of a HELO or EHLO command. This is omitted if it is identical to
13058 the verified host name or to the host's IP address in square brackets.
13059
13060 .vitem &$sender_helo_dnssec$&
13061 .vindex "&$sender_helo_dnssec$&"
13062 This boolean variable is true if a successful HELO verification was
13063 .cindex "DNS" "DNSSEC"
13064 done using DNS information the resolver library stated was authenticated data.
13065
13066 .vitem &$sender_helo_name$&
13067 .vindex "&$sender_helo_name$&"
13068 When a message is received from a remote host that has issued a HELO or EHLO
13069 command, the argument of that command is placed in this variable. It is also
13070 set if HELO or EHLO is used when a message is received using SMTP locally via
13071 the &%-bs%& or &%-bS%& options.
13072
13073 .vitem &$sender_host_address$&
13074 .vindex "&$sender_host_address$&"
13075 When a message is received from a remote host using SMTP,
13076 this variable contains that
13077 host's IP address. For locally non-SMTP submitted messages, it is empty.
13078
13079 .vitem &$sender_host_authenticated$&
13080 .vindex "&$sender_host_authenticated$&"
13081 This variable contains the name (not the public name) of the authenticator
13082 driver that successfully authenticated the client from which the message was
13083 received. It is empty if there was no successful authentication. See also
13084 &$authenticated_id$&.
13085
13086 .vitem &$sender_host_dnssec$&
13087 .vindex "&$sender_host_dnssec$&"
13088 If an attempt to populate &$sender_host_name$& has been made
13089 (by reference, &%hosts_lookup%& or
13090 otherwise) then this boolean will have been set true if, and only if, the
13091 resolver library states that both
13092 the reverse and forward DNS were authenticated data.  At all
13093 other times, this variable is false.
13094
13095 .cindex "DNS" "DNSSEC"
13096 It is likely that you will need to coerce DNSSEC support on in the resolver
13097 library, by setting:
13098 .code
13099 dns_dnssec_ok = 1
13100 .endd
13101
13102 Exim does not perform DNSSEC validation itself, instead leaving that to a
13103 validating resolver (e.g. unbound, or bind with suitable configuration).
13104
13105 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13106 mechanism in the list, then this variable will be false.
13107
13108 This requires that your system resolver library support EDNS0 (and that
13109 DNSSEC flags exist in the system headers).  If the resolver silently drops
13110 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13111 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13112
13113
13114 .vitem &$sender_host_name$&
13115 .vindex "&$sender_host_name$&"
13116 When a message is received from a remote host, this variable contains the
13117 host's name as obtained by looking up its IP address. For messages received by
13118 other means, this variable is empty.
13119
13120 .vindex "&$host_lookup_failed$&"
13121 If the host name has not previously been looked up, a reference to
13122 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13123 A looked up name is accepted only if it leads back to the original IP address
13124 via a forward lookup. If either the reverse or the forward lookup fails to find
13125 any data, or if the forward lookup does not yield the original IP address,
13126 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13127
13128 .vindex "&$host_lookup_deferred$&"
13129 However, if either of the lookups cannot be completed (for example, there is a
13130 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13131 &$host_lookup_failed$& remains set to &"0"&.
13132
13133 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13134 host name again if there is a subsequent reference to &$sender_host_name$&
13135 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13136 is set to &"1"&.
13137
13138 Exim does not automatically look up every calling host's name. If you want
13139 maximum efficiency, you should arrange your configuration so that it avoids
13140 these lookups altogether. The lookup happens only if one or more of the
13141 following are true:
13142
13143 .ilist
13144 A string containing &$sender_host_name$& is expanded.
13145 .next
13146 The calling host matches the list in &%host_lookup%&. In the default
13147 configuration, this option is set to *, so it must be changed if lookups are
13148 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13149 .next
13150 Exim needs the host name in order to test an item in a host list. The items
13151 that require this are described in sections &<<SECThoslispatnam>>& and
13152 &<<SECThoslispatnamsk>>&.
13153 .next
13154 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13155 In this case, the host name is required to compare with the name quoted in any
13156 EHLO or HELO commands that the client issues.
13157 .next
13158 The remote host issues a EHLO or HELO command that quotes one of the
13159 domains in &%helo_lookup_domains%&. The default value of this option is
13160 . ==== As this is a nested list, any displays it contains must be indented
13161 . ==== as otherwise they are too far to the left.
13162 .code
13163   helo_lookup_domains = @ : @[]
13164 .endd
13165 which causes a lookup if a remote host (incorrectly) gives the server's name or
13166 IP address in an EHLO or HELO command.
13167 .endlist
13168
13169
13170 .vitem &$sender_host_port$&
13171 .vindex "&$sender_host_port$&"
13172 When a message is received from a remote host, this variable contains the port
13173 number that was used on the remote host.
13174
13175 .vitem &$sender_ident$&
13176 .vindex "&$sender_ident$&"
13177 When a message is received from a remote host, this variable contains the
13178 identification received in response to an RFC 1413 request. When a message has
13179 been received locally, this variable contains the login name of the user that
13180 called Exim.
13181
13182 .vitem &$sender_rate_$&&'xxx'&
13183 A number of variables whose names begin &$sender_rate_$& are set as part of the
13184 &%ratelimit%& ACL condition. Details are given in section
13185 &<<SECTratelimiting>>&.
13186
13187 .vitem &$sender_rcvhost$&
13188 .cindex "DNS" "reverse lookup"
13189 .cindex "reverse DNS lookup"
13190 .vindex "&$sender_rcvhost$&"
13191 This is provided specifically for use in &'Received:'& headers. It starts with
13192 either the verified host name (as obtained from a reverse DNS lookup) or, if
13193 there is no verified host name, the IP address in square brackets. After that
13194 there may be text in parentheses. When the first item is a verified host name,
13195 the first thing in the parentheses is the IP address in square brackets,
13196 followed by a colon and a port number if port logging is enabled. When the
13197 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13198 the parentheses.
13199
13200 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13201 was used and its argument was not identical to the real host name or IP
13202 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13203 all three items are present in the parentheses, a newline and tab are inserted
13204 into the string, to improve the formatting of the &'Received:'& header.
13205
13206 .vitem &$sender_verify_failure$&
13207 .vindex "&$sender_verify_failure$&"
13208 In an ACL, when a sender verification fails, this variable contains information
13209 about the failure. The details are the same as for
13210 &$recipient_verify_failure$&.
13211
13212 .vitem &$sending_ip_address$&
13213 .vindex "&$sending_ip_address$&"
13214 This variable is set whenever an outgoing SMTP connection to another host has
13215 been set up. It contains the IP address of the local interface that is being
13216 used. This is useful if a host that has more than one IP address wants to take
13217 on different personalities depending on which one is being used. For incoming
13218 connections, see &$received_ip_address$&.
13219
13220 .vitem &$sending_port$&
13221 .vindex "&$sending_port$&"
13222 This variable is set whenever an outgoing SMTP connection to another host has
13223 been set up. It contains the local port that is being used. For incoming
13224 connections, see &$received_port$&.
13225
13226 .vitem &$smtp_active_hostname$&
13227 .vindex "&$smtp_active_hostname$&"
13228 During an incoming SMTP session, this variable contains the value of the active
13229 host name, as specified by the &%smtp_active_hostname%& option. The value of
13230 &$smtp_active_hostname$& is saved with any message that is received, so its
13231 value can be consulted during routing and delivery.
13232
13233 .vitem &$smtp_command$&
13234 .vindex "&$smtp_command$&"
13235 During the processing of an incoming SMTP command, this variable contains the
13236 entire command. This makes it possible to distinguish between HELO and EHLO in
13237 the HELO ACL, and also to distinguish between commands such as these:
13238 .code
13239 MAIL FROM:<>
13240 MAIL FROM: <>
13241 .endd
13242 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13243 command, the address in &$smtp_command$& is the original address before any
13244 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13245 the address after SMTP-time rewriting.
13246
13247 .vitem &$smtp_command_argument$&
13248 .cindex "SMTP" "command, argument for"
13249 .vindex "&$smtp_command_argument$&"
13250 While an ACL is running to check an SMTP command, this variable contains the
13251 argument, that is, the text that follows the command name, with leading white
13252 space removed. Following the introduction of &$smtp_command$&, this variable is
13253 somewhat redundant, but is retained for backwards compatibility.
13254
13255 .vitem &$smtp_command_history$&
13256 .cindex SMTP "command history"
13257 .vindex "&$smtp_command_history$&"
13258 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13259 received, in time-order left to right.  Only a limited number of commands
13260 are remembered.
13261
13262 .vitem &$smtp_count_at_connection_start$&
13263 .vindex "&$smtp_count_at_connection_start$&"
13264 This variable is set greater than zero only in processes spawned by the Exim
13265 daemon for handling incoming SMTP connections. The name is deliberately long,
13266 in order to emphasize what the contents are. When the daemon accepts a new
13267 connection, it increments this variable. A copy of the variable is passed to
13268 the child process that handles the connection, but its value is fixed, and
13269 never changes. It is only an approximation of how many incoming connections
13270 there actually are, because many other connections may come and go while a
13271 single connection is being processed. When a child process terminates, the
13272 daemon decrements its copy of the variable.
13273
13274 .vitem "&$sn0$& &-- &$sn9$&"
13275 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13276 that were current at the end of the system filter file. This allows a system
13277 filter file to set values that can be tested in users' filter files. For
13278 example, a system filter could set a value indicating how likely it is that a
13279 message is junk mail.
13280
13281 .vitem &$spam_$&&'xxx'&
13282 A number of variables whose names start with &$spam$& are available when Exim
13283 is compiled with the content-scanning extension. For details, see section
13284 &<<SECTscanspamass>>&.
13285
13286 .vitem &$spf_header_comment$& &&&
13287        &$spf_received$& &&&
13288        &$spf_result$& &&&
13289        &$spf_result_guessed$& &&&
13290        &$spf_smtp_comment$&
13291 These variables are only available if Exim is built with SPF support.
13292 For details see section &<<SECSPF>>&.
13293
13294 .vitem &$spool_directory$&
13295 .vindex "&$spool_directory$&"
13296 The name of Exim's spool directory.
13297
13298 .vitem &$spool_inodes$&
13299 .vindex "&$spool_inodes$&"
13300 The number of free inodes in the disk partition where Exim's spool files are
13301 being written. The value is recalculated whenever the variable is referenced.
13302 If the relevant file system does not have the concept of inodes, the value of
13303 is -1. See also the &%check_spool_inodes%& option.
13304
13305 .vitem &$spool_space$&
13306 .vindex "&$spool_space$&"
13307 The amount of free space (as a number of kilobytes) in the disk partition where
13308 Exim's spool files are being written. The value is recalculated whenever the
13309 variable is referenced. If the operating system does not have the ability to
13310 find the amount of free space (only true for experimental systems), the space
13311 value is -1. For example, to check in an ACL that there is at least 50
13312 megabytes free on the spool, you could write:
13313 .code
13314 condition = ${if > {$spool_space}{50000}}
13315 .endd
13316 See also the &%check_spool_space%& option.
13317
13318
13319 .vitem &$thisaddress$&
13320 .vindex "&$thisaddress$&"
13321 This variable is set only during the processing of the &%foranyaddress%&
13322 command in a filter file. Its use is explained in the description of that
13323 command, which can be found in the separate document entitled &'Exim's
13324 interfaces to mail filtering'&.
13325
13326 .vitem &$tls_in_bits$&
13327 .vindex "&$tls_in_bits$&"
13328 Contains an approximation of the TLS cipher's bit-strength
13329 on the inbound connection; the meaning of
13330 this depends upon the TLS implementation used.
13331 If TLS has not been negotiated, the value will be 0.
13332 The value of this is automatically fed into the Cyrus SASL authenticator
13333 when acting as a server, to specify the "external SSF" (a SASL term).
13334
13335 The deprecated &$tls_bits$& variable refers to the inbound side
13336 except when used in the context of an outbound SMTP delivery, when it refers to
13337 the outbound.
13338
13339 .vitem &$tls_out_bits$&
13340 .vindex "&$tls_out_bits$&"
13341 Contains an approximation of the TLS cipher's bit-strength
13342 on an outbound SMTP connection; the meaning of
13343 this depends upon the TLS implementation used.
13344 If TLS has not been negotiated, the value will be 0.
13345
13346 .vitem &$tls_in_ourcert$&
13347 .vindex "&$tls_in_ourcert$&"
13348 .cindex certificate variables
13349 This variable refers to the certificate presented to the peer of an
13350 inbound connection when the message was received.
13351 It is only useful as the argument of a
13352 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13353 or a &%def%& condition.
13354
13355 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13356 when a list of more than one
13357 file is used for &%tls_certificate%&, this variable is not reliable.
13358 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13359
13360 .vitem &$tls_in_peercert$&
13361 .vindex "&$tls_in_peercert$&"
13362 This variable refers to the certificate presented by the peer of an
13363 inbound connection when the message was received.
13364 It is only useful as the argument of a
13365 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13366 or a &%def%& condition.
13367 If certificate verification fails it may refer to a failing chain element
13368 which is not the leaf.
13369
13370 .vitem &$tls_out_ourcert$&
13371 .vindex "&$tls_out_ourcert$&"
13372 This variable refers to the certificate presented to the peer of an
13373 outbound connection.  It is only useful as the argument of a
13374 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13375 or a &%def%& condition.
13376
13377 .vitem &$tls_out_peercert$&
13378 .vindex "&$tls_out_peercert$&"
13379 This variable refers to the certificate presented by the peer of an
13380 outbound connection.  It is only useful as the argument of a
13381 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13382 or a &%def%& condition.
13383 If certificate verification fails it may refer to a failing chain element
13384 which is not the leaf.
13385
13386 .vitem &$tls_in_certificate_verified$&
13387 .vindex "&$tls_in_certificate_verified$&"
13388 This variable is set to &"1"& if a TLS certificate was verified when the
13389 message was received, and &"0"& otherwise.
13390
13391 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13392 except when used in the context of an outbound SMTP delivery, when it refers to
13393 the outbound.
13394
13395 .vitem &$tls_out_certificate_verified$&
13396 .vindex "&$tls_out_certificate_verified$&"
13397 This variable is set to &"1"& if a TLS certificate was verified when an
13398 outbound SMTP connection was made,
13399 and &"0"& otherwise.
13400
13401 .vitem &$tls_in_cipher$&
13402 .vindex "&$tls_in_cipher$&"
13403 .vindex "&$tls_cipher$&"
13404 When a message is received from a remote host over an encrypted SMTP
13405 connection, this variable is set to the cipher suite that was negotiated, for
13406 example DES-CBC3-SHA. In other circumstances, in particular, for message
13407 received over unencrypted connections, the variable is empty. Testing
13408 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13409 non-encrypted connections during ACL processing.
13410
13411 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13412 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13413 becomes the same as &$tls_out_cipher$&.
13414
13415 .vitem &$tls_in_cipher_std$&
13416 .vindex "&$tls_in_cipher_std$&"
13417 As above, but returning the RFC standard name for the cipher suite.
13418
13419 .vitem &$tls_out_cipher$&
13420 .vindex "&$tls_out_cipher$&"
13421 This variable is
13422 cleared before any outgoing SMTP connection is made,
13423 and then set to the outgoing cipher suite if one is negotiated. See chapter
13424 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13425 details of the &(smtp)& transport.
13426
13427 .vitem &$tls_out_cipher_std$&
13428 .vindex "&$tls_out_cipher_std$&"
13429 As above, but returning the RFC standard name for the cipher suite.
13430
13431 .vitem &$tls_out_dane$&
13432 .vindex &$tls_out_dane$&
13433 DANE active status.  See section &<<SECDANE>>&.
13434
13435 .vitem &$tls_in_ocsp$&
13436 .vindex "&$tls_in_ocsp$&"
13437 When a message is received from a remote client connection
13438 the result of any OCSP request from the client is encoded in this variable:
13439 .code
13440 0 OCSP proof was not requested (default value)
13441 1 No response to request
13442 2 Response not verified
13443 3 Verification failed
13444 4 Verification succeeded
13445 .endd
13446
13447 .vitem &$tls_out_ocsp$&
13448 .vindex "&$tls_out_ocsp$&"
13449 When a message is sent to a remote host connection
13450 the result of any OCSP request made is encoded in this variable.
13451 See &$tls_in_ocsp$& for values.
13452
13453 .vitem &$tls_in_peerdn$&
13454 .vindex "&$tls_in_peerdn$&"
13455 .vindex "&$tls_peerdn$&"
13456 .cindex certificate "extracting fields"
13457 When a message is received from a remote host over an encrypted SMTP
13458 connection, and Exim is configured to request a certificate from the client,
13459 the value of the Distinguished Name of the certificate is made available in the
13460 &$tls_in_peerdn$& during subsequent processing.
13461 If certificate verification fails it may refer to a failing chain element
13462 which is not the leaf.
13463
13464 The deprecated &$tls_peerdn$& variable refers to the inbound side
13465 except when used in the context of an outbound SMTP delivery, when it refers to
13466 the outbound.
13467
13468 .vitem &$tls_out_peerdn$&
13469 .vindex "&$tls_out_peerdn$&"
13470 When a message is being delivered to a remote host over an encrypted SMTP
13471 connection, and Exim is configured to request a certificate from the server,
13472 the value of the Distinguished Name of the certificate is made available in the
13473 &$tls_out_peerdn$& during subsequent processing.
13474 If certificate verification fails it may refer to a failing chain element
13475 which is not the leaf.
13476
13477 .vitem &$tls_in_sni$&
13478 .vindex "&$tls_in_sni$&"
13479 .vindex "&$tls_sni$&"
13480 .cindex "TLS" "Server Name Indication"
13481 When a TLS session is being established, if the client sends the Server
13482 Name Indication extension, the value will be placed in this variable.
13483 If the variable appears in &%tls_certificate%& then this option and
13484 some others, described in &<<SECTtlssni>>&,
13485 will be re-expanded early in the TLS session, to permit
13486 a different certificate to be presented (and optionally a different key to be
13487 used) to the client, based upon the value of the SNI extension.
13488
13489 The deprecated &$tls_sni$& 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_sni$&
13494 .vindex "&$tls_out_sni$&"
13495 .cindex "TLS" "Server Name Indication"
13496 During outbound
13497 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13498 the transport.
13499
13500 .vitem &$tls_out_tlsa_usage$&
13501 .vindex &$tls_out_tlsa_usage$&
13502 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13503
13504 .vitem &$tls_in_ver$&
13505 .vindex "&$tls_in_ver$&"
13506 When a message is received from a remote host over an encrypted SMTP connection
13507 this variable is set to the protocol version, eg &'TLS1.2'&.
13508
13509 .vitem &$tls_out_ver$&
13510 .vindex "&$tls_out_ver$&"
13511 When a message is being delivered to a remote host over an encrypted SMTP connection
13512 this variable is set to the protocol version.
13513
13514
13515 .vitem &$tod_bsdinbox$&
13516 .vindex "&$tod_bsdinbox$&"
13517 The time of day and the date, in the format required for BSD-style mailbox
13518 files, for example: Thu Oct 17 17:14:09 1995.
13519
13520 .vitem &$tod_epoch$&
13521 .vindex "&$tod_epoch$&"
13522 The time and date as a number of seconds since the start of the Unix epoch.
13523
13524 .vitem &$tod_epoch_l$&
13525 .vindex "&$tod_epoch_l$&"
13526 The time and date as a number of microseconds since the start of the Unix epoch.
13527
13528 .vitem &$tod_full$&
13529 .vindex "&$tod_full$&"
13530 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13531 +0100. The timezone is always given as a numerical offset from UTC, with
13532 positive values used for timezones that are ahead (east) of UTC, and negative
13533 values for those that are behind (west).
13534
13535 .vitem &$tod_log$&
13536 .vindex "&$tod_log$&"
13537 The time and date in the format used for writing Exim's log files, for example:
13538 1995-10-12 15:32:29, but without a timezone.
13539
13540 .vitem &$tod_logfile$&
13541 .vindex "&$tod_logfile$&"
13542 This variable contains the date in the format yyyymmdd. This is the format that
13543 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13544 flag.
13545
13546 .vitem &$tod_zone$&
13547 .vindex "&$tod_zone$&"
13548 This variable contains the numerical value of the local timezone, for example:
13549 -0500.
13550
13551 .vitem &$tod_zulu$&
13552 .vindex "&$tod_zulu$&"
13553 This variable contains the UTC date and time in &"Zulu"& format, as specified
13554 by ISO 8601, for example: 20030221154023Z.
13555
13556 .vitem &$transport_name$&
13557 .cindex "transport" "name"
13558 .cindex "name" "of transport"
13559 .vindex "&$transport_name$&"
13560 During the running of a transport, this variable contains its name.
13561
13562 .vitem &$value$&
13563 .vindex "&$value$&"
13564 This variable contains the result of an expansion lookup, extraction operation,
13565 or external command, as described above. It is also used during a
13566 &*reduce*& expansion.
13567
13568 .vitem &$verify_mode$&
13569 .vindex "&$verify_mode$&"
13570 While a router or transport is being run in verify mode or for cutthrough delivery,
13571 contains "S" for sender-verification or "R" for recipient-verification.
13572 Otherwise, empty.
13573
13574 .vitem &$version_number$&
13575 .vindex "&$version_number$&"
13576 The version number of Exim. Same as &$exim_version$&, may be overridden
13577 by the &%exim_version%& main config option.
13578
13579 .vitem &$warn_message_delay$&
13580 .vindex "&$warn_message_delay$&"
13581 This variable is set only during the creation of a message warning about a
13582 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13583
13584 .vitem &$warn_message_recipients$&
13585 .vindex "&$warn_message_recipients$&"
13586 This variable is set only during the creation of a message warning about a
13587 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13588 .endlist
13589 .ecindex IIDstrexp
13590
13591
13592
13593 . ////////////////////////////////////////////////////////////////////////////
13594 . ////////////////////////////////////////////////////////////////////////////
13595
13596 .chapter "Embedded Perl" "CHAPperl"
13597 .scindex IIDperl "Perl" "calling from Exim"
13598 Exim can be built to include an embedded Perl interpreter. When this is done,
13599 Perl subroutines can be called as part of the string expansion process. To make
13600 use of the Perl support, you need version 5.004 or later of Perl installed on
13601 your system. To include the embedded interpreter in the Exim binary, include
13602 the line
13603 .code
13604 EXIM_PERL = perl.o
13605 .endd
13606 in your &_Local/Makefile_& and then build Exim in the normal way.
13607
13608
13609 .section "Setting up so Perl can be used" "SECID85"
13610 .oindex "&%perl_startup%&"
13611 Access to Perl subroutines is via a global configuration option called
13612 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13613 no &%perl_startup%& option in the Exim configuration file then no Perl
13614 interpreter is started and there is almost no overhead for Exim (since none of
13615 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13616 option then the associated value is taken to be Perl code which is executed in
13617 a newly created Perl interpreter.
13618
13619 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13620 need backslashes before any characters to escape special meanings. The option
13621 should usually be something like
13622 .code
13623 perl_startup = do '/etc/exim.pl'
13624 .endd
13625 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13626 use from Exim. Exim can be configured either to start up a Perl interpreter as
13627 soon as it is entered, or to wait until the first time it is needed. Starting
13628 the interpreter at the beginning ensures that it is done while Exim still has
13629 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13630 fact used in a particular run. Also, note that this does not mean that Exim is
13631 necessarily running as root when Perl is called at a later time. By default,
13632 the interpreter is started only when it is needed, but this can be changed in
13633 two ways:
13634
13635 .ilist
13636 .oindex "&%perl_at_start%&"
13637 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13638 a startup when Exim is entered.
13639 .next
13640 The command line option &%-ps%& also requests a startup when Exim is entered,
13641 overriding the setting of &%perl_at_start%&.
13642 .endlist
13643
13644 There is also a command line option &%-pd%& (for delay) which suppresses the
13645 initial startup, even if &%perl_at_start%& is set.
13646
13647 .ilist
13648 .oindex "&%perl_taintmode%&"
13649 .cindex "Perl" "taintmode"
13650 To provide more security executing Perl code via the embedded Perl
13651 interpreter, the &%perl_taintmode%& option can be set. This enables the
13652 taint mode of the Perl interpreter. You are encouraged to set this
13653 option to a true value. To avoid breaking existing installations, it
13654 defaults to false.
13655
13656
13657 .section "Calling Perl subroutines" "SECID86"
13658 When the configuration file includes a &%perl_startup%& option you can make use
13659 of the string expansion item to call the Perl subroutines that are defined
13660 by the &%perl_startup%& code. The operator is used in any of the following
13661 forms:
13662 .code
13663 ${perl{foo}}
13664 ${perl{foo}{argument}}
13665 ${perl{foo}{argument1}{argument2} ... }
13666 .endd
13667 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13668 arguments may be passed. Passing more than this results in an expansion failure
13669 with an error message of the form
13670 .code
13671 Too many arguments passed to Perl subroutine "foo" (max is 8)
13672 .endd
13673 The return value of the Perl subroutine is evaluated in a scalar context before
13674 it is passed back to Exim to be inserted into the expanded string. If the
13675 return value is &'undef'&, the expansion is forced to fail in the same way as
13676 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13677 by obeying Perl's &%die%& function, the expansion fails with the error message
13678 that was passed to &%die%&.
13679
13680
13681 .section "Calling Exim functions from Perl" "SECID87"
13682 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13683 is available to call back into Exim's string expansion function. For example,
13684 the Perl code
13685 .code
13686 my $lp = Exim::expand_string('$local_part');
13687 .endd
13688 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13689 Note those are single quotes and not double quotes to protect against
13690 &$local_part$& being interpolated as a Perl variable.
13691
13692 If the string expansion is forced to fail by a &"fail"& item, the result of
13693 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13694 expansion string, the Perl call from the original expansion string fails with
13695 an appropriate error message, in the same way as if &%die%& were used.
13696
13697 .cindex "debugging" "from embedded Perl"
13698 .cindex "log" "writing from embedded Perl"
13699 Two other Exim functions are available for use from within Perl code.
13700 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13701 debugging is enabled. If you want a newline at the end, you must supply it.
13702 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13703 timestamp. In this case, you should not supply a terminating newline.
13704
13705
13706 .section "Use of standard output and error by Perl" "SECID88"
13707 .cindex "Perl" "standard output and error"
13708 You should not write to the standard error or output streams from within your
13709 Perl code, as it is not defined how these are set up. In versions of Exim
13710 before 4.50, it is possible for the standard output or error to refer to the
13711 SMTP connection during message reception via the daemon. Writing to this stream
13712 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13713 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13714 avoided, but the output is lost.
13715
13716 .cindex "Perl" "use of &%warn%&"
13717 The Perl &%warn%& statement writes to the standard error stream by default.
13718 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13719 you have no control. When Exim starts up the Perl interpreter, it arranges for
13720 output from the &%warn%& statement to be written to the Exim main log. You can
13721 change this by including appropriate Perl magic somewhere in your Perl code.
13722 For example, to discard &%warn%& output completely, you need this:
13723 .code
13724 $SIG{__WARN__} = sub { };
13725 .endd
13726 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13727 example, the code for the subroutine is empty, so it does nothing, but you can
13728 include any Perl code that you like. The text of the &%warn%& message is passed
13729 as the first subroutine argument.
13730 .ecindex IIDperl
13731
13732
13733 . ////////////////////////////////////////////////////////////////////////////
13734 . ////////////////////////////////////////////////////////////////////////////
13735
13736 .chapter "Starting the daemon and the use of network interfaces" &&&
13737          "CHAPinterfaces" &&&
13738          "Starting the daemon"
13739 .cindex "daemon" "starting"
13740 .cindex "interface" "listening"
13741 .cindex "network interface"
13742 .cindex "interface" "network"
13743 .cindex "IP address" "for listening"
13744 .cindex "daemon" "listening IP addresses"
13745 .cindex "TCP/IP" "setting listening interfaces"
13746 .cindex "TCP/IP" "setting listening ports"
13747 A host that is connected to a TCP/IP network may have one or more physical
13748 hardware network interfaces. Each of these interfaces may be configured as one
13749 or more &"logical"& interfaces, which are the entities that a program actually
13750 works with. Each of these logical interfaces is associated with an IP address.
13751 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13752 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13753 knowledge about the host's interfaces for use in three different circumstances:
13754
13755 .olist
13756 When a listening daemon is started, Exim needs to know which interfaces
13757 and ports to listen on.
13758 .next
13759 When Exim is routing an address, it needs to know which IP addresses
13760 are associated with local interfaces. This is required for the correct
13761 processing of MX lists by removing the local host and others with the
13762 same or higher priority values. Also, Exim needs to detect cases
13763 when an address is routed to an IP address that in fact belongs to the
13764 local host. Unless the &%self%& router option or the &%allow_localhost%&
13765 option of the smtp transport is set (as appropriate), this is treated
13766 as an error situation.
13767 .next
13768 When Exim connects to a remote host, it may need to know which interface to use
13769 for the outgoing connection.
13770 .endlist
13771
13772
13773 Exim's default behaviour is likely to be appropriate in the vast majority
13774 of cases. If your host has only one interface, and you want all its IP
13775 addresses to be treated in the same way, and you are using only the
13776 standard SMTP port, you should not need to take any special action. The
13777 rest of this chapter does not apply to you.
13778
13779 In a more complicated situation you may want to listen only on certain
13780 interfaces, or on different ports, and for this reason there are a number of
13781 options that can be used to influence Exim's behaviour. The rest of this
13782 chapter describes how they operate.
13783
13784 When a message is received over TCP/IP, the interface and port that were
13785 actually used are set in &$received_ip_address$& and &$received_port$&.
13786
13787
13788
13789 .section "Starting a listening daemon" "SECID89"
13790 When a listening daemon is started (by means of the &%-bd%& command line
13791 option), the interfaces and ports on which it listens are controlled by the
13792 following options:
13793
13794 .ilist
13795 &%daemon_smtp_ports%& contains a list of default ports
13796 or service names.
13797 (For backward compatibility, this option can also be specified in the singular.)
13798 .next
13799 &%local_interfaces%& contains list of interface IP addresses on which to
13800 listen. Each item may optionally also specify a port.
13801 .endlist
13802
13803 The default list separator in both cases is a colon, but this can be changed as
13804 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13805 it is usually best to change the separator to avoid having to double all the
13806 colons. For example:
13807 .code
13808 local_interfaces = <; 127.0.0.1 ; \
13809                       192.168.23.65 ; \
13810                       ::1 ; \
13811                       3ffe:ffff:836f::fe86:a061
13812 .endd
13813 There are two different formats for specifying a port along with an IP address
13814 in &%local_interfaces%&:
13815
13816 .olist
13817 The port is added onto the address with a dot separator. For example, to listen
13818 on port 1234 on two different IP addresses:
13819 .code
13820 local_interfaces = <; 192.168.23.65.1234 ; \
13821                       3ffe:ffff:836f::fe86:a061.1234
13822 .endd
13823 .next
13824 The IP address is enclosed in square brackets, and the port is added
13825 with a colon separator, for example:
13826 .code
13827 local_interfaces = <; [192.168.23.65]:1234 ; \
13828                       [3ffe:ffff:836f::fe86:a061]:1234
13829 .endd
13830 .endlist
13831
13832 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13833 default setting contains just one port:
13834 .code
13835 daemon_smtp_ports = smtp
13836 .endd
13837 If more than one port is listed, each interface that does not have its own port
13838 specified listens on all of them. Ports that are listed in
13839 &%daemon_smtp_ports%& can be identified either by name (defined in
13840 &_/etc/services_&) or by number. However, when ports are given with individual
13841 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13842
13843
13844
13845 .section "Special IP listening addresses" "SECID90"
13846 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13847 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13848 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13849 instead of setting up separate listening sockets for each interface. The
13850 default value of &%local_interfaces%& is
13851 .code
13852 local_interfaces = 0.0.0.0
13853 .endd
13854 when Exim is built without IPv6 support; otherwise it is:
13855 .code
13856 local_interfaces = <; ::0 ; 0.0.0.0
13857 .endd
13858 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13859
13860
13861
13862 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13863 The &%-oX%& command line option can be used to override the values of
13864 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13865 instance. Another way of doing this would be to use macros and the &%-D%&
13866 option. However, &%-oX%& can be used by any admin user, whereas modification of
13867 the runtime configuration by &%-D%& is allowed only when the caller is root or
13868 exim.
13869
13870 The value of &%-oX%& is a list of items. The default colon separator can be
13871 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13872 If there are any items that do not
13873 contain dots or colons (that is, are not IP addresses), the value of
13874 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13875 items that do contain dots or colons, the value of &%local_interfaces%& is
13876 replaced by those items. Thus, for example,
13877 .code
13878 -oX 1225
13879 .endd
13880 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13881 whereas
13882 .code
13883 -oX 192.168.34.5.1125
13884 .endd
13885 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13886 (However, since &%local_interfaces%& now contains no items without ports, the
13887 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13888
13889
13890
13891 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13892 .cindex "submissions protocol"
13893 .cindex "ssmtp protocol"
13894 .cindex "smtps protocol"
13895 .cindex "SMTP" "ssmtp protocol"
13896 .cindex "SMTP" "smtps protocol"
13897 Exim supports the use of TLS-on-connect, used by mail clients in the
13898 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13899 For some years, IETF Standards Track documents only blessed the
13900 STARTTLS-based Submission service (port 587) while common practice was to support
13901 the same feature set on port 465, but using TLS-on-connect.
13902 If your installation needs to provide service to mail clients
13903 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13904 the 465 TCP ports.
13905
13906 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13907 service names, connections to those ports must first establish TLS, before
13908 proceeding to the application layer use of the SMTP protocol.
13909
13910 The common use of this option is expected to be
13911 .code
13912 tls_on_connect_ports = 465
13913 .endd
13914 per RFC 8314.
13915 There is also a command line option &%-tls-on-connect%&, which forces all ports
13916 to behave in this way when a daemon is started.
13917
13918 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13919 daemon to listen on those ports. You must still specify them in
13920 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13921 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13922 connections via the daemon.)
13923
13924
13925
13926
13927 .section "IPv6 address scopes" "SECID92"
13928 .cindex "IPv6" "address scopes"
13929 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13930 can, in principle, have the same link-local IPv6 address on different
13931 interfaces. Thus, additional information is needed, over and above the IP
13932 address, to distinguish individual interfaces. A convention of using a
13933 percent sign followed by something (often the interface name) has been
13934 adopted in some cases, leading to addresses like this:
13935 .code
13936 fe80::202:b3ff:fe03:45c1%eth0
13937 .endd
13938 To accommodate this usage, a percent sign followed by an arbitrary string is
13939 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13940 to convert a textual IPv6 address for actual use. This function recognizes the
13941 percent convention in operating systems that support it, and it processes the
13942 address appropriately. Unfortunately, some older libraries have problems with
13943 &[getaddrinfo()]&. If
13944 .code
13945 IPV6_USE_INET_PTON=yes
13946 .endd
13947 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13948 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13949 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13950 function.) Of course, this means that the additional functionality of
13951 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13952
13953 .section "Disabling IPv6" "SECID93"
13954 .cindex "IPv6" "disabling"
13955 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13956 run on a host whose kernel does not support IPv6. The binary will fall back to
13957 using IPv4, but it may waste resources looking up AAAA records, and trying to
13958 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13959 .oindex "&%disable_ipv6%&"
13960 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13961 activities take place. AAAA records are never looked up, and any IPv6 addresses
13962 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13963 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13964 to handle IPv6 literal addresses.
13965
13966 On the other hand, when IPv6 is in use, there may be times when you want to
13967 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13968 option to globally suppress the lookup of AAAA records for specified domains,
13969 and you can use the &%ignore_target_hosts%& generic router option to ignore
13970 IPv6 addresses in an individual router.
13971
13972
13973
13974 .section "Examples of starting a listening daemon" "SECID94"
13975 The default case in an IPv6 environment is
13976 .code
13977 daemon_smtp_ports = smtp
13978 local_interfaces = <; ::0 ; 0.0.0.0
13979 .endd
13980 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13981 Either one or two sockets may be used, depending on the characteristics of
13982 the TCP/IP stack. (This is complicated and messy; for more information,
13983 read the comments in the &_daemon.c_& source file.)
13984
13985 To specify listening on ports 25 and 26 on all interfaces:
13986 .code
13987 daemon_smtp_ports = 25 : 26
13988 .endd
13989 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13990 .code
13991 local_interfaces = <; ::0.25     ; ::0.26 \
13992                       0.0.0.0.25 ; 0.0.0.0.26
13993 .endd
13994 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13995 IPv4 loopback address only:
13996 .code
13997 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13998 .endd
13999 To specify listening on the default port on specific interfaces only:
14000 .code
14001 local_interfaces = 10.0.0.67 : 192.168.34.67
14002 .endd
14003 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14004
14005
14006
14007 .section "Recognizing the local host" "SECTreclocipadd"
14008 The &%local_interfaces%& option is also used when Exim needs to determine
14009 whether or not an IP address refers to the local host. That is, the IP
14010 addresses of all the interfaces on which a daemon is listening are always
14011 treated as local.
14012
14013 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14014 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14015 available interfaces from the operating system, and extracts the relevant
14016 (that is, IPv4 or IPv6) addresses to use for checking.
14017
14018 Some systems set up large numbers of virtual interfaces in order to provide
14019 many virtual web servers. In this situation, you may want to listen for
14020 email on only a few of the available interfaces, but nevertheless treat all
14021 interfaces as local when routing. You can do this by setting
14022 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14023 &"all"& wildcard values. These addresses are recognized as local, but are not
14024 used for listening. Consider this example:
14025 .code
14026 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14027                       192.168.53.235 ; \
14028                       3ffe:2101:12:1:a00:20ff:fe86:a061
14029
14030 extra_local_interfaces = <; ::0 ; 0.0.0.0
14031 .endd
14032 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14033 address, but all available interface addresses are treated as local when
14034 Exim is routing.
14035
14036 In some environments the local host name may be in an MX list, but with an IP
14037 address that is not assigned to any local interface. In other cases it may be
14038 desirable to treat other host names as if they referred to the local host. Both
14039 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14040 This contains host names rather than IP addresses. When a host is referenced
14041 during routing, either via an MX record or directly, it is treated as the local
14042 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14043 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14044
14045
14046
14047 .section "Delivering to a remote host" "SECID95"
14048 Delivery to a remote host is handled by the smtp transport. By default, it
14049 allows the system's TCP/IP functions to choose which interface to use (if
14050 there is more than one) when connecting to a remote host. However, the
14051 &%interface%& option can be set to specify which interface is used. See the
14052 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14053 details.
14054
14055
14056
14057
14058 . ////////////////////////////////////////////////////////////////////////////
14059 . ////////////////////////////////////////////////////////////////////////////
14060
14061 .chapter "Main configuration" "CHAPmainconfig"
14062 .scindex IIDconfima "configuration file" "main section"
14063 .scindex IIDmaiconf "main configuration"
14064 The first part of the runtime configuration file contains three types of item:
14065
14066 .ilist
14067 Macro definitions: These lines start with an upper case letter. See section
14068 &<<SECTmacrodefs>>& for details of macro processing.
14069 .next
14070 Named list definitions: These lines start with one of the words &"domainlist"&,
14071 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14072 section &<<SECTnamedlists>>&.
14073 .next
14074 Main configuration settings: Each setting occupies one line of the file
14075 (with possible continuations). If any setting is preceded by the word
14076 &"hide"&, the &%-bP%& command line option displays its value to admin users
14077 only. See section &<<SECTcos>>& for a description of the syntax of these option
14078 settings.
14079 .endlist
14080
14081 This chapter specifies all the main configuration options, along with their
14082 types and default values. For ease of finding a particular option, they appear
14083 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14084 are now so many options, they are first listed briefly in functional groups, as
14085 an aid to finding the name of the option you are looking for. Some options are
14086 listed in more than one group.
14087
14088 .section "Miscellaneous" "SECID96"
14089 .table2
14090 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14091 .row &%debug_store%&                 "do extra internal checks"
14092 .row &%disable_ipv6%&                "do no IPv6 processing"
14093 .row &%keep_malformed%&              "for broken files &-- should not happen"
14094 .row &%localhost_number%&            "for unique message ids in clusters"
14095 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14096 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14097 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14098 .row &%print_topbitchars%&           "top-bit characters are printing"
14099 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14100 .row &%timezone%&                    "force time zone"
14101 .endtable
14102
14103
14104 .section "Exim parameters" "SECID97"
14105 .table2
14106 .row &%exim_group%&                  "override compiled-in value"
14107 .row &%exim_path%&                   "override compiled-in value"
14108 .row &%exim_user%&                   "override compiled-in value"
14109 .row &%primary_hostname%&            "default from &[uname()]&"
14110 .row &%split_spool_directory%&       "use multiple directories"
14111 .row &%spool_directory%&             "override compiled-in value"
14112 .endtable
14113
14114
14115
14116 .section "Privilege controls" "SECID98"
14117 .table2
14118 .row &%admin_groups%&                "groups that are Exim admin users"
14119 .row &%commandline_checks_require_admin%& "require admin for various checks"
14120 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14121 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14122 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14123 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14124 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14125 .row &%never_users%&                 "do not run deliveries as these"
14126 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14127 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14128 .row &%trusted_groups%&              "groups that are trusted"
14129 .row &%trusted_users%&               "users that are trusted"
14130 .endtable
14131
14132
14133
14134 .section "Logging" "SECID99"
14135 .table2
14136 .row &%event_action%&                "custom logging"
14137 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14138 .row &%log_file_path%&               "override compiled-in value"
14139 .row &%log_selector%&                "set/unset optional logging"
14140 .row &%log_timezone%&                "add timezone to log lines"
14141 .row &%message_logs%&                "create per-message logs"
14142 .row &%preserve_message_logs%&       "after message completion"
14143 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14144 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14145 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14146 .row &%syslog_facility%&             "set syslog &""facility""& field"
14147 .row &%syslog_pid%&                  "pid in syslog lines"
14148 .row &%syslog_processname%&          "set syslog &""ident""& field"
14149 .row &%syslog_timestamp%&            "timestamp syslog lines"
14150 .row &%write_rejectlog%&             "control use of message log"
14151 .endtable
14152
14153
14154
14155 .section "Frozen messages" "SECID100"
14156 .table2
14157 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14158 .row &%freeze_tell%&                 "send message when freezing"
14159 .row &%move_frozen_messages%&        "to another directory"
14160 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14161 .endtable
14162
14163
14164
14165 .section "Data lookups" "SECID101"
14166 .table2
14167 .row &%ibase_servers%&               "InterBase servers"
14168 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14169 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14170 .row &%ldap_cert_file%&              "client cert file for LDAP"
14171 .row &%ldap_cert_key%&               "client key file for LDAP"
14172 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14173 .row &%ldap_default_servers%&        "used if no server in query"
14174 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14175 .row &%ldap_start_tls%&              "require TLS within LDAP"
14176 .row &%ldap_version%&                "set protocol version"
14177 .row &%lookup_open_max%&             "lookup files held open"
14178 .row &%mysql_servers%&               "default MySQL servers"
14179 .row &%oracle_servers%&              "Oracle servers"
14180 .row &%pgsql_servers%&               "default PostgreSQL servers"
14181 .row &%sqlite_lock_timeout%&         "as it says"
14182 .endtable
14183
14184
14185
14186 .section "Message ids" "SECID102"
14187 .table2
14188 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14189 .row &%message_id_header_text%&      "ditto"
14190 .endtable
14191
14192
14193
14194 .section "Embedded Perl Startup" "SECID103"
14195 .table2
14196 .row &%perl_at_start%&               "always start the interpreter"
14197 .row &%perl_startup%&                "code to obey when starting Perl"
14198 .row &%perl_taintmode%&              "enable taint mode in Perl"
14199 .endtable
14200
14201
14202
14203 .section "Daemon" "SECID104"
14204 .table2
14205 .row &%daemon_smtp_ports%&           "default ports"
14206 .row &%daemon_startup_retries%&      "number of times to retry"
14207 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14208 .row &%extra_local_interfaces%&      "not necessarily listened on"
14209 .row &%local_interfaces%&            "on which to listen, with optional ports"
14210 .row &%pid_file_path%&               "override compiled-in value"
14211 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14212 .endtable
14213
14214
14215
14216 .section "Resource control" "SECID105"
14217 .table2
14218 .row &%check_log_inodes%&            "before accepting a message"
14219 .row &%check_log_space%&             "before accepting a message"
14220 .row &%check_spool_inodes%&          "before accepting a message"
14221 .row &%check_spool_space%&           "before accepting a message"
14222 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14223 .row &%queue_only_load%&             "queue incoming if load high"
14224 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14225 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14226 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14227 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14228 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14229 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14230 .row &%smtp_accept_max_per_connection%& "messages per connection"
14231 .row &%smtp_accept_max_per_host%&    "connections from one host"
14232 .row &%smtp_accept_queue%&           "queue mail if more connections"
14233 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14234                                            connection"
14235 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14236 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14237 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14238 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14239 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14240 .endtable
14241
14242
14243
14244 .section "Policy controls" "SECID106"
14245 .table2
14246 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14247 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14248 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14249 .row &%acl_smtp_auth%&               "ACL for AUTH"
14250 .row &%acl_smtp_connect%&            "ACL for connection"
14251 .row &%acl_smtp_data%&               "ACL for DATA"
14252 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14253 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14254 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14255 .row &%acl_smtp_expn%&               "ACL for EXPN"
14256 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14257 .row &%acl_smtp_mail%&               "ACL for MAIL"
14258 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14259 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14260 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14261 .row &%acl_smtp_predata%&            "ACL for start of data"
14262 .row &%acl_smtp_quit%&               "ACL for QUIT"
14263 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14264 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14265 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14266 .row &%av_scanner%&                  "specify virus scanner"
14267 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14268                                       words""&"
14269 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14270 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14271 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14272 .row &%header_maxsize%&              "total size of message header"
14273 .row &%header_line_maxsize%&         "individual header line limit"
14274 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14275 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14276 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14277 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14278 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14279 .row &%host_lookup%&                 "host name looked up for these hosts"
14280 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14281 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14282 .row &%host_reject_connection%&      "reject connection from these hosts"
14283 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14284 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14285 .row &%message_size_limit%&          "for all messages"
14286 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14287 .row &%spamd_address%&               "set interface to SpamAssassin"
14288 .row &%strict_acl_vars%&             "object to unset ACL variables"
14289 .endtable
14290
14291
14292
14293 .section "Callout cache" "SECID107"
14294 .table2
14295 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14296                                          item"
14297 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14298                                          item"
14299 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14300 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14301 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14302 .endtable
14303
14304
14305
14306 .section "TLS" "SECID108"
14307 .table2
14308 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14309 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14310 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14311 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14312 .row &%tls_certificate%&             "location of server certificate"
14313 .row &%tls_crl%&                     "certificate revocation list"
14314 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14315 .row &%tls_dhparam%&                 "DH parameters for server"
14316 .row &%tls_eccurve%&                 "EC curve selection for server"
14317 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14318 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14319 .row &%tls_privatekey%&              "location of server private key"
14320 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14321 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14322 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14323 .row &%tls_verify_certificates%&     "expected client certificates"
14324 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14325 .endtable
14326
14327
14328
14329 .section "Local user handling" "SECID109"
14330 .table2
14331 .row &%finduser_retries%&            "useful in NIS environments"
14332 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14333 .row &%gecos_pattern%&               "ditto"
14334 .row &%max_username_length%&         "for systems that truncate"
14335 .row &%unknown_login%&               "used when no login name found"
14336 .row &%unknown_username%&            "ditto"
14337 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14338 .row &%uucp_from_sender%&            "ditto"
14339 .endtable
14340
14341
14342
14343 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14344 .table2
14345 .row &%header_maxsize%&              "total size of message header"
14346 .row &%header_line_maxsize%&         "individual header line limit"
14347 .row &%message_size_limit%&          "applies to all messages"
14348 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14349 .row &%received_header_text%&        "expanded to make &'Received:'&"
14350 .row &%received_headers_max%&        "for mail loop detection"
14351 .row &%recipients_max%&              "limit per message"
14352 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14353 .endtable
14354
14355
14356
14357
14358 .section "Non-SMTP incoming messages" "SECID111"
14359 .table2
14360 .row &%receive_timeout%&             "for non-SMTP messages"
14361 .endtable
14362
14363
14364
14365
14366
14367 .section "Incoming SMTP messages" "SECID112"
14368 See also the &'Policy controls'& section above.
14369
14370 .table2
14371 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14372 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14373 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14374 .row &%host_lookup%&                 "host name looked up for these hosts"
14375 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14376 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14377 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14378 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14379 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14380 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14381 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14382 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14383 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14384 .row &%smtp_accept_max_per_connection%& "messages per connection"
14385 .row &%smtp_accept_max_per_host%&    "connections from one host"
14386 .row &%smtp_accept_queue%&           "queue mail if more connections"
14387 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14388                                            connection"
14389 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14390 .row &%smtp_active_hostname%&        "host name to use in messages"
14391 .row &%smtp_banner%&                 "text for welcome banner"
14392 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14393 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14394 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14395 .row &%smtp_etrn_command%&           "what to run for ETRN"
14396 .row &%smtp_etrn_serialize%&         "only one at once"
14397 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14398 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14399 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14400 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14401 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14402 .row &%smtp_receive_timeout%&        "per command or data line"
14403 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14404 .row &%smtp_return_error_details%&   "give detail on rejections"
14405 .endtable
14406
14407
14408
14409 .section "SMTP extensions" "SECID113"
14410 .table2
14411 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14412 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14413 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14414 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14415 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14416 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14417 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14418 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14419 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14420 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14421 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14422 .endtable
14423
14424
14425
14426 .section "Processing messages" "SECID114"
14427 .table2
14428 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14429 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14430 .row &%allow_utf8_domains%&          "in addresses"
14431 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14432                                       words""&"
14433 .row &%delivery_date_remove%&        "from incoming messages"
14434 .row &%envelope_to_remove%&          "from incoming messages"
14435 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14436 .row &%headers_charset%&             "default for translations"
14437 .row &%qualify_domain%&              "default for senders"
14438 .row &%qualify_recipient%&           "default for recipients"
14439 .row &%return_path_remove%&          "from incoming messages"
14440 .row &%strip_excess_angle_brackets%& "in addresses"
14441 .row &%strip_trailing_dot%&          "at end of addresses"
14442 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14443 .endtable
14444
14445
14446
14447 .section "System filter" "SECID115"
14448 .table2
14449 .row &%system_filter%&               "locate system filter"
14450 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14451                                             directory"
14452 .row &%system_filter_file_transport%& "transport for delivery to a file"
14453 .row &%system_filter_group%&         "group for filter running"
14454 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14455 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14456 .row &%system_filter_user%&          "user for filter running"
14457 .endtable
14458
14459
14460
14461 .section "Routing and delivery" "SECID116"
14462 .table2
14463 .row &%disable_ipv6%&                "do no IPv6 processing"
14464 .row &%dns_again_means_nonexist%&    "for broken domains"
14465 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14466 .row &%dns_dnssec_ok%&               "parameter for resolver"
14467 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14468 .row &%dns_retrans%&                 "parameter for resolver"
14469 .row &%dns_retry%&                   "parameter for resolver"
14470 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14471 .row &%dns_use_edns0%&               "parameter for resolver"
14472 .row &%hold_domains%&                "hold delivery for these domains"
14473 .row &%local_interfaces%&            "for routing checks"
14474 .row &%queue_domains%&               "no immediate delivery for these"
14475 .row &%queue_only%&                  "no immediate delivery at all"
14476 .row &%queue_only_file%&             "no immediate delivery if file exists"
14477 .row &%queue_only_load%&             "no immediate delivery if load is high"
14478 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14479 .row &%queue_only_override%&         "allow command line to override"
14480 .row &%queue_run_in_order%&          "order of arrival"
14481 .row &%queue_run_max%&               "of simultaneous queue runners"
14482 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14483 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14484 .row &%remote_sort_domains%&         "order of remote deliveries"
14485 .row &%retry_data_expire%&           "timeout for retry data"
14486 .row &%retry_interval_max%&          "safety net for retry rules"
14487 .endtable
14488
14489
14490
14491 .section "Bounce and warning messages" "SECID117"
14492 .table2
14493 .row &%bounce_message_file%&         "content of bounce"
14494 .row &%bounce_message_text%&         "content of bounce"
14495 .row &%bounce_return_body%&          "include body if returning message"
14496 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14497 .row &%bounce_return_message%&       "include original message in bounce"
14498 .row &%bounce_return_size_limit%&    "limit on returned message"
14499 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14500 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14501 .row &%errors_copy%&                 "copy bounce messages"
14502 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14503 .row &%delay_warning%&               "time schedule"
14504 .row &%delay_warning_condition%&     "condition for warning messages"
14505 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14506 .row &%smtp_return_error_details%&   "give detail on rejections"
14507 .row &%warn_message_file%&           "content of warning message"
14508 .endtable
14509
14510
14511
14512 .section "Alphabetical list of main options" "SECTalomo"
14513 Those options that undergo string expansion before use are marked with
14514 &dagger;.
14515
14516 .option accept_8bitmime main boolean true
14517 .cindex "8BITMIME"
14518 .cindex "8-bit characters"
14519 .cindex "log" "selectors"
14520 .cindex "log" "8BITMIME"
14521 This option causes Exim to send 8BITMIME in its response to an SMTP
14522 EHLO command, and to accept the BODY= parameter on MAIL commands.
14523 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14524 takes no steps to do anything special with messages received by this route.
14525
14526 Historically Exim kept this option off by default, but the maintainers
14527 feel that in today's Internet, this causes more problems than it solves.
14528 It now defaults to true.
14529 A more detailed analysis of the issues is provided by Dan Bernstein:
14530 .display
14531 &url(https://cr.yp.to/smtp/8bitmime.html)
14532 .endd
14533
14534 To log received 8BITMIME status use
14535 .code
14536 log_selector = +8bitmime
14537 .endd
14538
14539 .option acl_not_smtp main string&!! unset
14540 .cindex "&ACL;" "for non-SMTP messages"
14541 .cindex "non-SMTP messages" "ACLs for"
14542 This option defines the ACL that is run when a non-SMTP message has been
14543 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14544 further details.
14545
14546 .option acl_not_smtp_mime main string&!! unset
14547 This option defines the ACL that is run for individual MIME parts of non-SMTP
14548 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14549 SMTP messages.
14550
14551 .option acl_not_smtp_start main string&!! unset
14552 .cindex "&ACL;" "at start of non-SMTP message"
14553 .cindex "non-SMTP messages" "ACLs for"
14554 This option defines the ACL that is run before Exim starts reading a
14555 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14556
14557 .option acl_smtp_auth main string&!! unset
14558 .cindex "&ACL;" "setting up for SMTP commands"
14559 .cindex "AUTH" "ACL for"
14560 This option defines the ACL that is run when an SMTP AUTH command is
14561 received. See chapter &<<CHAPACL>>& for further details.
14562
14563 .option acl_smtp_connect main string&!! unset
14564 .cindex "&ACL;" "on SMTP connection"
14565 This option defines the ACL that is run when an SMTP connection is received.
14566 See chapter &<<CHAPACL>>& for further details.
14567
14568 .option acl_smtp_data main string&!! unset
14569 .cindex "DATA" "ACL for"
14570 This option defines the ACL that is run after an SMTP DATA command has been
14571 processed and the message itself has been received, but before the final
14572 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14573
14574 .option acl_smtp_data_prdr main string&!! accept
14575 .cindex "PRDR" "ACL for"
14576 .cindex "DATA" "PRDR ACL for"
14577 .cindex "&ACL;" "PRDR-related"
14578 .cindex "&ACL;" "per-user data processing"
14579 This option defines the ACL that,
14580 if the PRDR feature has been negotiated,
14581 is run for each recipient after an SMTP DATA command has been
14582 processed and the message itself has been received, but before the
14583 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14584
14585 .option acl_smtp_dkim main string&!! unset
14586 .cindex DKIM "ACL for"
14587 This option defines the ACL that is run for each DKIM signature
14588 (by default, or as specified in the dkim_verify_signers option)
14589 of a received message.
14590 See section &<<SECDKIMVFY>>& for further details.
14591
14592 .option acl_smtp_etrn main string&!! unset
14593 .cindex "ETRN" "ACL for"
14594 This option defines the ACL that is run when an SMTP ETRN command is
14595 received. See chapter &<<CHAPACL>>& for further details.
14596
14597 .option acl_smtp_expn main string&!! unset
14598 .cindex "EXPN" "ACL for"
14599 This option defines the ACL that is run when an SMTP EXPN command is
14600 received. See chapter &<<CHAPACL>>& for further details.
14601
14602 .option acl_smtp_helo main string&!! unset
14603 .cindex "EHLO" "ACL for"
14604 .cindex "HELO" "ACL for"
14605 This option defines the ACL that is run when an SMTP EHLO or HELO
14606 command is received. See chapter &<<CHAPACL>>& for further details.
14607
14608
14609 .option acl_smtp_mail main string&!! unset
14610 .cindex "MAIL" "ACL for"
14611 This option defines the ACL that is run when an SMTP MAIL command is
14612 received. See chapter &<<CHAPACL>>& for further details.
14613
14614 .option acl_smtp_mailauth main string&!! unset
14615 .cindex "AUTH" "on MAIL command"
14616 This option defines the ACL that is run when there is an AUTH parameter on
14617 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14618 &<<CHAPSMTPAUTH>>& for details of authentication.
14619
14620 .option acl_smtp_mime main string&!! unset
14621 .cindex "MIME content scanning" "ACL for"
14622 This option is available when Exim is built with the content-scanning
14623 extension. It defines the ACL that is run for each MIME part in a message. See
14624 section &<<SECTscanmimepart>>& for details.
14625
14626 .option acl_smtp_notquit main string&!! unset
14627 .cindex "not-QUIT, ACL for"
14628 This option defines the ACL that is run when an SMTP session
14629 ends without a QUIT command being received.
14630 See chapter &<<CHAPACL>>& for further details.
14631
14632 .option acl_smtp_predata main string&!! unset
14633 This option defines the ACL that is run when an SMTP DATA command is
14634 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14635 further details.
14636
14637 .option acl_smtp_quit main string&!! unset
14638 .cindex "QUIT, ACL for"
14639 This option defines the ACL that is run when an SMTP QUIT command is
14640 received. See chapter &<<CHAPACL>>& for further details.
14641
14642 .option acl_smtp_rcpt main string&!! unset
14643 .cindex "RCPT" "ACL for"
14644 This option defines the ACL that is run when an SMTP RCPT command is
14645 received. See chapter &<<CHAPACL>>& for further details.
14646
14647 .option acl_smtp_starttls main string&!! unset
14648 .cindex "STARTTLS, ACL for"
14649 This option defines the ACL that is run when an SMTP STARTTLS command is
14650 received. See chapter &<<CHAPACL>>& for further details.
14651
14652 .option acl_smtp_vrfy main string&!! unset
14653 .cindex "VRFY" "ACL for"
14654 This option defines the ACL that is run when an SMTP VRFY command is
14655 received. See chapter &<<CHAPACL>>& for further details.
14656
14657 .option add_environment main "string list" empty
14658 .cindex "environment" "set values"
14659 This option adds individual environment variables that the
14660 currently linked libraries and programs in child processes may use.
14661 Each list element should be of the form &"name=value"&.
14662
14663 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14664
14665 .option admin_groups main "string list&!!" unset
14666 .cindex "admin user"
14667 This option is expanded just once, at the start of Exim's processing. If the
14668 current group or any of the supplementary groups of an Exim caller is in this
14669 colon-separated list, the caller has admin privileges. If all your system
14670 programmers are in a specific group, for example, you can give them all Exim
14671 admin privileges by putting that group in &%admin_groups%&. However, this does
14672 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14673 To permit this, you have to add individuals to the Exim group.
14674
14675 .option allow_domain_literals main boolean false
14676 .cindex "domain literal"
14677 If this option is set, the RFC 2822 domain literal format is permitted in
14678 email addresses. The option is not set by default, because the domain literal
14679 format is not normally required these days, and few people know about it. It
14680 has, however, been exploited by mail abusers.
14681
14682 Unfortunately, it seems that some DNS black list maintainers are using this
14683 format to report black listing to postmasters. If you want to accept messages
14684 addressed to your hosts by IP address, you need to set
14685 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14686 domains (defined in the named domain list &%local_domains%& in the default
14687 configuration). This &"magic string"& matches the domain literal form of all
14688 the local host's IP addresses.
14689
14690
14691 .option allow_mx_to_ip main boolean false
14692 .cindex "MX record" "pointing to IP address"
14693 It appears that more and more DNS zone administrators are breaking the rules
14694 and putting domain names that look like IP addresses on the right hand side of
14695 MX records. Exim follows the rules and rejects this, giving an error message
14696 that explains the misconfiguration. However, some other MTAs support this
14697 practice, so to avoid &"Why can't Exim do this?"& complaints,
14698 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14699 recommended, except when you have no other choice.
14700
14701 .option allow_utf8_domains main boolean false
14702 .cindex "domain" "UTF-8 characters in"
14703 .cindex "UTF-8" "in domain name"
14704 Lots of discussion is going on about internationalized domain names. One
14705 camp is strongly in favour of just using UTF-8 characters, and it seems
14706 that at least two other MTAs permit this.
14707 This option allows Exim users to experiment if they wish.
14708
14709 If it is set true, Exim's domain parsing function allows valid
14710 UTF-8 multicharacters to appear in domain name components, in addition to
14711 letters, digits, and hyphens.
14712
14713 If Exim is built with internationalization support
14714 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14715 this option can be left as default.
14716 Without that,
14717 if you want to look up such domain names in the DNS, you must also
14718 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14719 suitable setting is:
14720 .code
14721 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14722   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14723 .endd
14724 Alternatively, you can just disable this feature by setting
14725 .code
14726 dns_check_names_pattern =
14727 .endd
14728 That is, set the option to an empty string so that no check is done.
14729
14730
14731 .option auth_advertise_hosts main "host list&!!" *
14732 .cindex "authentication" "advertising"
14733 .cindex "AUTH" "advertising"
14734 If any server authentication mechanisms are configured, Exim advertises them in
14735 response to an EHLO command only if the calling host matches this list.
14736 Otherwise, Exim does not advertise AUTH.
14737 Exim does not accept AUTH commands from clients to which it has not
14738 advertised the availability of AUTH. The advertising of individual
14739 authentication mechanisms can be controlled by the use of the
14740 &%server_advertise_condition%& generic authenticator option on the individual
14741 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14742
14743 Certain mail clients (for example, Netscape) require the user to provide a name
14744 and password for authentication if AUTH is advertised, even though it may
14745 not be needed (the host may accept messages from hosts on its local LAN without
14746 authentication, for example). The &%auth_advertise_hosts%& option can be used
14747 to make these clients more friendly by excluding them from the set of hosts to
14748 which Exim advertises AUTH.
14749
14750 .cindex "AUTH" "advertising when encrypted"
14751 If you want to advertise the availability of AUTH only when the connection
14752 is encrypted using TLS, you can make use of the fact that the value of this
14753 option is expanded, with a setting like this:
14754 .code
14755 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14756 .endd
14757 .vindex "&$tls_in_cipher$&"
14758 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14759 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14760 expansion is *, which matches all hosts.
14761
14762
14763 .option auto_thaw main time 0s
14764 .cindex "thawing messages"
14765 .cindex "unfreezing messages"
14766 If this option is set to a time greater than zero, a queue runner will try a
14767 new delivery attempt on any frozen message, other than a bounce message, if
14768 this much time has passed since it was frozen. This may result in the message
14769 being re-frozen if nothing has changed since the last attempt. It is a way of
14770 saying &"keep on trying, even though there are big problems"&.
14771
14772 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14773 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14774 thought to be very useful any more, and its use should probably be avoided.
14775
14776
14777 .option av_scanner main string "see below"
14778 This option is available if Exim is built with the content-scanning extension.
14779 It specifies which anti-virus scanner to use. The default value is:
14780 .code
14781 sophie:/var/run/sophie
14782 .endd
14783 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14784 before use. See section &<<SECTscanvirus>>& for further details.
14785
14786
14787 .option bi_command main string unset
14788 .oindex "&%-bi%&"
14789 This option supplies the name of a command that is run when Exim is called with
14790 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14791 just the command name, it is not a complete command line. If an argument is
14792 required, it must come from the &%-oA%& command line option.
14793
14794
14795 .option bounce_message_file main string unset
14796 .cindex "bounce message" "customizing"
14797 .cindex "customizing" "bounce message"
14798 This option defines a template file containing paragraphs of text to be used
14799 for constructing bounce messages.  Details of the file's contents are given in
14800 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14801
14802
14803 .option bounce_message_text main string unset
14804 When this option is set, its contents are included in the default bounce
14805 message immediately after &"This message was created automatically by mail
14806 delivery software."& It is not used if &%bounce_message_file%& is set.
14807
14808 .option bounce_return_body main boolean true
14809 .cindex "bounce message" "including body"
14810 This option controls whether the body of an incoming message is included in a
14811 bounce message when &%bounce_return_message%& is true. The default setting
14812 causes the entire message, both header and body, to be returned (subject to the
14813 value of &%bounce_return_size_limit%&). If this option is false, only the
14814 message header is included. In the case of a non-SMTP message containing an
14815 error that is detected during reception, only those header lines preceding the
14816 point at which the error was detected are returned.
14817 .cindex "bounce message" "including original"
14818
14819 .option bounce_return_linesize_limit main integer 998
14820 .cindex "size" "of bounce lines, limit"
14821 .cindex "bounce message" "line length limit"
14822 .cindex "limit" "bounce message line length"
14823 This option sets a limit in bytes on the line length of messages
14824 that are returned to senders due to delivery problems,
14825 when &%bounce_return_message%& is true.
14826 The default value corresponds to RFC limits.
14827 If the message being returned has lines longer than this value it is
14828 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14829
14830 The option also applies to bounces returned when an error is detected
14831 during reception of a message.
14832 In this case lines from the original are truncated.
14833
14834 The option does not apply to messages generated by an &(autoreply)& transport.
14835
14836
14837 .option bounce_return_message main boolean true
14838 If this option is set false, none of the original message is included in
14839 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14840 &%bounce_return_body%&.
14841
14842
14843 .option bounce_return_size_limit main integer 100K
14844 .cindex "size" "of bounce, limit"
14845 .cindex "bounce message" "size limit"
14846 .cindex "limit" "bounce message size"
14847 This option sets a limit in bytes on the size of messages that are returned to
14848 senders as part of bounce messages when &%bounce_return_message%& is true. The
14849 limit should be less than the value of the global &%message_size_limit%& and of
14850 any &%message_size_limit%& settings on transports, to allow for the bounce text
14851 that Exim generates. If this option is set to zero there is no limit.
14852
14853 When the body of any message that is to be included in a bounce message is
14854 greater than the limit, it is truncated, and a comment pointing this out is
14855 added at the top. The actual cutoff may be greater than the value given, owing
14856 to the use of buffering for transferring the message in chunks (typically 8K in
14857 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14858 messages.
14859
14860 .option bounce_sender_authentication main string unset
14861 .cindex "bounce message" "sender authentication"
14862 .cindex "authentication" "bounce message"
14863 .cindex "AUTH" "on bounce message"
14864 This option provides an authenticated sender address that is sent with any
14865 bounce messages generated by Exim that are sent over an authenticated SMTP
14866 connection. A typical setting might be:
14867 .code
14868 bounce_sender_authentication = mailer-daemon@my.domain.example
14869 .endd
14870 which would cause bounce messages to be sent using the SMTP command:
14871 .code
14872 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14873 .endd
14874 The value of &%bounce_sender_authentication%& must always be a complete email
14875 address.
14876
14877 .option callout_domain_negative_expire main time 3h
14878 .cindex "caching" "callout timeouts"
14879 .cindex "callout" "caching timeouts"
14880 This option specifies the expiry time for negative callout cache data for a
14881 domain. See section &<<SECTcallver>>& for details of callout verification, and
14882 section &<<SECTcallvercache>>& for details of the caching.
14883
14884
14885 .option callout_domain_positive_expire main time 7d
14886 This option specifies the expiry time for positive callout cache data for a
14887 domain. See section &<<SECTcallver>>& for details of callout verification, and
14888 section &<<SECTcallvercache>>& for details of the caching.
14889
14890
14891 .option callout_negative_expire main time 2h
14892 This option specifies the expiry time for negative callout cache data for an
14893 address. See section &<<SECTcallver>>& for details of callout verification, and
14894 section &<<SECTcallvercache>>& for details of the caching.
14895
14896
14897 .option callout_positive_expire main time 24h
14898 This option specifies the expiry time for positive callout cache data for an
14899 address. See section &<<SECTcallver>>& for details of callout verification, and
14900 section &<<SECTcallvercache>>& for details of the caching.
14901
14902
14903 .option callout_random_local_part main string&!! "see below"
14904 This option defines the &"random"& local part that can be used as part of
14905 callout verification. The default value is
14906 .code
14907 $primary_hostname-$tod_epoch-testing
14908 .endd
14909 See section &<<CALLaddparcall>>& for details of how this value is used.
14910
14911
14912 .option check_log_inodes main integer 100
14913 See &%check_spool_space%& below.
14914
14915
14916 .option check_log_space main integer 10M
14917 See &%check_spool_space%& below.
14918
14919 .oindex "&%check_rfc2047_length%&"
14920 .cindex "RFC 2047" "disabling length check"
14921 .option check_rfc2047_length main boolean true
14922 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14923 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14924 word; strings to be encoded that exceed this length are supposed to use
14925 multiple encoded words. By default, Exim does not recognize encoded words that
14926 exceed the maximum length. However, it seems that some software, in violation
14927 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14928 set false, Exim recognizes encoded words of any length.
14929
14930
14931 .option check_spool_inodes main integer 100
14932 See &%check_spool_space%& below.
14933
14934
14935 .option check_spool_space main integer 10M
14936 .cindex "checking disk space"
14937 .cindex "disk space, checking"
14938 .cindex "spool directory" "checking space"
14939 The four &%check_...%& options allow for checking of disk resources before a
14940 message is accepted.
14941
14942 .vindex "&$log_inodes$&"
14943 .vindex "&$log_space$&"
14944 .vindex "&$spool_inodes$&"
14945 .vindex "&$spool_space$&"
14946 When any of these options are nonzero, they apply to all incoming messages. If you
14947 want to apply different checks to different kinds of message, you can do so by
14948 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14949 &$spool_space$& in an ACL with appropriate additional conditions.
14950
14951
14952 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14953 either value is greater than zero, for example:
14954 .code
14955 check_spool_space = 100M
14956 check_spool_inodes = 100
14957 .endd
14958 The spool partition is the one that contains the directory defined by
14959 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14960 transit.
14961
14962 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14963 files are written if either is greater than zero. These should be set only if
14964 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14965
14966 If there is less space or fewer inodes than requested, Exim refuses to accept
14967 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14968 error response to the MAIL command. If ESMTP is in use and there was a
14969 SIZE parameter on the MAIL command, its value is added to the
14970 &%check_spool_space%& value, and the check is performed even if
14971 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14972
14973 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14974 number of kilobytes (though specified in bytes).
14975 If a non-multiple of 1024 is specified, it is rounded up.
14976
14977 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14978 failure a message is written to stderr and Exim exits with a non-zero code, as
14979 it obviously cannot send an error message of any kind.
14980
14981 There is a slight performance penalty for these checks.
14982 Versions of Exim preceding 4.88 had these disabled by default;
14983 high-rate installations confident they will never run out of resources
14984 may wish to deliberately disable them.
14985
14986 .option chunking_advertise_hosts main "host list&!!" *
14987 .cindex CHUNKING advertisement
14988 .cindex "RFC 3030" "CHUNKING"
14989 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14990 these hosts.
14991 Hosts may use the BDAT command as an alternate to DATA.
14992
14993 .option commandline_checks_require_admin main boolean &`false`&
14994 .cindex "restricting access to features"
14995 This option restricts various basic checking features to require an
14996 administrative user.
14997 This affects most of the &%-b*%& options, such as &%-be%&.
14998
14999 .option debug_store main boolean &`false`&
15000 .cindex debugging "memory corruption"
15001 .cindex memory debugging
15002 This option, when true, enables extra checking in Exim's internal memory
15003 management.  For use when a memory corruption issue is being investigated,
15004 it should normally be left as default.
15005
15006 .option daemon_smtp_ports main string &`smtp`&
15007 .cindex "port" "for daemon"
15008 .cindex "TCP/IP" "setting listening ports"
15009 This option specifies one or more default SMTP ports on which the Exim daemon
15010 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15011 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15012
15013 .option daemon_startup_retries main integer 9
15014 .cindex "daemon startup, retrying"
15015 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15016 the daemon at startup when it cannot immediately bind a listening socket
15017 (typically because the socket is already in use): &%daemon_startup_retries%&
15018 defines the number of retries after the first failure, and
15019 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15020
15021 .option daemon_startup_sleep main time 30s
15022 See &%daemon_startup_retries%&.
15023
15024 .option delay_warning main "time list" 24h
15025 .cindex "warning of delay"
15026 .cindex "delay warning, specifying"
15027 .cindex "queue" "delay warning"
15028 When a message is delayed, Exim sends a warning message to the sender at
15029 intervals specified by this option. The data is a colon-separated list of times
15030 after which to send warning messages. If the value of the option is an empty
15031 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15032 message has been in the queue for longer than the last time, the last interval
15033 between the times is used to compute subsequent warning times. For example,
15034 with
15035 .code
15036 delay_warning = 4h:8h:24h
15037 .endd
15038 the first message is sent after 4 hours, the second after 8 hours, and
15039 the third one after 24 hours. After that, messages are sent every 16 hours,
15040 because that is the interval between the last two times on the list. If you set
15041 just one time, it specifies the repeat interval. For example, with:
15042 .code
15043 delay_warning = 6h
15044 .endd
15045 messages are repeated every six hours. To stop warnings after a given time, set
15046 a very large time at the end of the list. For example:
15047 .code
15048 delay_warning = 2h:12h:99d
15049 .endd
15050 Note that the option is only evaluated at the time a delivery attempt fails,
15051 which depends on retry and queue-runner configuration.
15052 Typically retries will be configured more frequently than warning messages.
15053
15054 .option delay_warning_condition main string&!! "see below"
15055 .vindex "&$domain$&"
15056 The string is expanded at the time a warning message might be sent. If all the
15057 deferred addresses have the same domain, it is set in &$domain$& during the
15058 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15059 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15060 &"false"& (the comparison being done caselessly) then the warning message is
15061 not sent. The default is:
15062 .code
15063 delay_warning_condition = ${if or {\
15064   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15065   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15066   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15067   } {no}{yes}}
15068 .endd
15069 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15070 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15071 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15072 &"auto-replied"& in an &'Auto-Submitted:'& header.
15073
15074 .option deliver_drop_privilege main boolean false
15075 .cindex "unprivileged delivery"
15076 .cindex "delivery" "unprivileged"
15077 If this option is set true, Exim drops its root privilege at the start of a
15078 delivery process, and runs as the Exim user throughout. This severely restricts
15079 the kinds of local delivery that are possible, but is viable in certain types
15080 of configuration. There is a discussion about the use of root privilege in
15081 chapter &<<CHAPsecurity>>&.
15082
15083 .option deliver_queue_load_max main fixed-point unset
15084 .cindex "load average"
15085 .cindex "queue runner" "abandoning"
15086 When this option is set, a queue run is abandoned if the system load average
15087 becomes greater than the value of the option. The option has no effect on
15088 ancient operating systems on which Exim cannot determine the load average.
15089 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15090
15091
15092 .option delivery_date_remove main boolean true
15093 .cindex "&'Delivery-date:'& header line"
15094 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15095 message when it is delivered, in exactly the same way as &'Return-path:'& is
15096 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15097 should not be present in incoming messages, and this option causes them to be
15098 removed at the time the message is received, to avoid any problems that might
15099 occur when a delivered message is subsequently sent on to some other recipient.
15100
15101 .option disable_fsync main boolean false
15102 .cindex "&[fsync()]&, disabling"
15103 This option is available only if Exim was built with the compile-time option
15104 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15105 a runtime configuration generates an &"unknown option"& error. You should not
15106 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15107 really, really, really understand what you are doing. &'No pre-compiled
15108 distributions of Exim should ever make this option available.'&
15109
15110 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15111 updated files' data to be written to disc before continuing. Unexpected events
15112 such as crashes and power outages may cause data to be lost or scrambled.
15113 Here be Dragons. &*Beware.*&
15114
15115
15116 .option disable_ipv6 main boolean false
15117 .cindex "IPv6" "disabling"
15118 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15119 activities take place. AAAA records are never looked up, and any IPv6 addresses
15120 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15121 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15122 to handle IPv6 literal addresses.
15123
15124
15125 .new
15126 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15127 .cindex DKIM "selecting signature algorithms"
15128 This option gives a list of hash types which are acceptable in signatures,
15129 .wen
15130 and an order of processing.
15131 Signatures with algorithms not in the list will be ignored.
15132
15133 Acceptable values include:
15134 .code
15135 sha1
15136 sha256
15137 sha512
15138 .endd
15139
15140 Note that the acceptance of sha1 violates RFC 8301.
15141
15142 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15143 This option gives a list of key types which are acceptable in signatures,
15144 and an order of processing.
15145 Signatures with algorithms not in the list will be ignored.
15146
15147 .option dkim_verify_minimal main boolean false
15148 If set to true, verification of signatures will terminate after the
15149 first success.
15150
15151 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15152 .cindex DKIM "controlling calls to the ACL"
15153 This option gives a list of DKIM domains for which the DKIM ACL is run.
15154 It is expanded after the message is received; by default it runs
15155 the ACL once for each signature in the message.
15156 See section &<<SECDKIMVFY>>&.
15157
15158
15159 .option dns_again_means_nonexist main "domain list&!!" unset
15160 .cindex "DNS" "&""try again""& response; overriding"
15161 DNS lookups give a &"try again"& response for the DNS errors
15162 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15163 keep trying to deliver a message, or to give repeated temporary errors to
15164 incoming mail. Sometimes the effect is caused by a badly set up name server and
15165 may persist for a long time. If a domain which exhibits this problem matches
15166 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15167 This option should be used with care. You can make it apply to reverse lookups
15168 by a setting such as this:
15169 .code
15170 dns_again_means_nonexist = *.in-addr.arpa
15171 .endd
15172 This option applies to all DNS lookups that Exim does. It also applies when the
15173 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15174 since these are most likely to be caused by DNS lookup problems. The
15175 &(dnslookup)& router has some options of its own for controlling what happens
15176 when lookups for MX or SRV records give temporary errors. These more specific
15177 options are applied after this global option.
15178
15179 .option dns_check_names_pattern main string "see below"
15180 .cindex "DNS" "pre-check of name syntax"
15181 When this option is set to a non-empty string, it causes Exim to check domain
15182 names for characters that are not allowed in host names before handing them to
15183 the DNS resolver, because some resolvers give temporary errors for names that
15184 contain unusual characters. If a domain name contains any unwanted characters,
15185 a &"not found"& result is forced, and the resolver is not called. The check is
15186 done by matching the domain name against a regular expression, which is the
15187 value of this option. The default pattern is
15188 .code
15189 dns_check_names_pattern = \
15190   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15191 .endd
15192 which permits only letters, digits, slashes, and hyphens in components, but
15193 they must start and end with a letter or digit. Slashes are not, in fact,
15194 permitted in host names, but they are found in certain NS records (which can be
15195 accessed in Exim by using a &%dnsdb%& lookup). If you set
15196 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15197 empty string.
15198
15199 .option dns_csa_search_limit main integer 5
15200 This option controls the depth of parental searching for CSA SRV records in the
15201 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15202
15203 .option dns_csa_use_reverse main boolean true
15204 This option controls whether or not an IP address, given as a CSA domain, is
15205 reversed and looked up in the reverse DNS, as described in more detail in
15206 section &<<SECTverifyCSA>>&.
15207
15208 .option dns_cname_loops main integer 1
15209 .cindex DNS "CNAME following"
15210 This option controls the following of CNAME chains, needed if the resolver does
15211 not do it internally.
15212 As of 2018 most should, and the default can be left.
15213 If you have an ancient one, a value of 10 is likely needed.
15214
15215 The default value of one CNAME-follow is needed
15216 thanks to the observed return for an MX request,
15217 given no MX presence but a CNAME to an A, of the CNAME.
15218
15219
15220 .option dns_dnssec_ok main integer -1
15221 .cindex "DNS" "resolver options"
15222 .cindex "DNS" "DNSSEC"
15223 If this option is set to a non-negative number then Exim will initialise the
15224 DNS resolver library to either use or not use DNSSEC, overriding the system
15225 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15226
15227 If the resolver library does not support DNSSEC then this option has no effect.
15228
15229
15230 .option dns_ipv4_lookup main "domain list&!!" unset
15231 .cindex "IPv6" "DNS lookup for AAAA records"
15232 .cindex "DNS" "IPv6 lookup for AAAA records"
15233 .cindex DNS "IPv6 disabling"
15234 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15235 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15236 (A records) when trying to find IP addresses for hosts, unless the host's
15237 domain matches this list.
15238
15239 This is a fudge to help with name servers that give big delays or otherwise do
15240 not work for the AAAA record type. In due course, when the world's name
15241 servers have all been upgraded, there should be no need for this option.
15242 Note that all lookups, including those done for verification, are affected;
15243 this will result in verify failure for IPv6 connections or ones using names
15244 only valid for IPv6 addresses.
15245
15246
15247 .option dns_retrans main time 0s
15248 .cindex "DNS" "resolver options"
15249 .cindex timeout "dns lookup"
15250 .cindex "DNS" timeout
15251 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15252 retransmission and retry parameters for DNS lookups. Values of zero (the
15253 defaults) leave the system default settings unchanged. The first value is the
15254 time between retries, and the second is the number of retries. It isn't
15255 totally clear exactly how these settings affect the total time a DNS lookup may
15256 take. I haven't found any documentation about timeouts on DNS lookups; these
15257 parameter values are available in the external resolver interface structure,
15258 but nowhere does it seem to describe how they are used or what you might want
15259 to set in them.
15260 See also the &%slow_lookup_log%& option.
15261
15262
15263 .option dns_retry main integer 0
15264 See &%dns_retrans%& above.
15265
15266
15267 .option dns_trust_aa main "domain list&!!" unset
15268 .cindex "DNS" "resolver options"
15269 .cindex "DNS" "DNSSEC"
15270 If this option is set then lookup results marked with the AA bit
15271 (Authoritative Answer) are trusted the same way as if they were
15272 DNSSEC-verified. The authority section's name of the answer must
15273 match with this expanded domain list.
15274
15275 Use this option only if you talk directly to a resolver that is
15276 authoritative for some zones and does not set the AD (Authentic Data)
15277 bit in the answer. Some DNS servers may have an configuration option to
15278 mark the answers from their own zones as verified (they set the AD bit).
15279 Others do not have this option. It is considered as poor practice using
15280 a resolver that is an authoritative server for some zones.
15281
15282 Use this option only if you really have to (e.g. if you want
15283 to use DANE for remote delivery to a server that is listed in the DNS
15284 zones that your resolver is authoritative for).
15285
15286 If the DNS answer packet has the AA bit set and contains resource record
15287 in the answer section, the name of the first NS record appearing in the
15288 authority section is compared against the list. If the answer packet is
15289 authoritative but the answer section is empty, the name of the first SOA
15290 record in the authoritative section is used instead.
15291
15292 .cindex "DNS" "resolver options"
15293 .option dns_use_edns0 main integer -1
15294 .cindex "DNS" "resolver options"
15295 .cindex "DNS" "EDNS0"
15296 .cindex "DNS" "OpenBSD
15297 If this option is set to a non-negative number then Exim will initialise the
15298 DNS resolver library to either use or not use EDNS0 extensions, overriding
15299 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15300 on.
15301
15302 If the resolver library does not support EDNS0 then this option has no effect.
15303
15304 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15305 means that DNSSEC will not work with Exim on that platform either, unless Exim
15306 is linked against an alternative DNS client library.
15307
15308
15309 .option drop_cr main boolean false
15310 This is an obsolete option that is now a no-op. It used to affect the way Exim
15311 handled CR and LF characters in incoming messages. What happens now is
15312 described in section &<<SECTlineendings>>&.
15313
15314 .option dsn_advertise_hosts main "host list&!!" unset
15315 .cindex "bounce messages" "success"
15316 .cindex "DSN" "success"
15317 .cindex "Delivery Status Notification" "success"
15318 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15319 and accepted from, these hosts.
15320 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15321 and RET and ORCPT options on MAIL FROM commands.
15322 A NOTIFY=SUCCESS option requests success-DSN messages.
15323 A NOTIFY= option with no argument requests that no delay or failure DSNs
15324 are sent.
15325
15326 .option dsn_from main "string&!!" "see below"
15327 .cindex "&'From:'& header line" "in bounces"
15328 .cindex "bounce messages" "&'From:'& line, specifying"
15329 This option can be used to vary the contents of &'From:'& header lines in
15330 bounces and other automatically generated messages (&"Delivery Status
15331 Notifications"& &-- hence the name of the option). The default setting is:
15332 .code
15333 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15334 .endd
15335 The value is expanded every time it is needed. If the expansion fails, a
15336 panic is logged, and the default value is used.
15337
15338 .option envelope_to_remove main boolean true
15339 .cindex "&'Envelope-to:'& header line"
15340 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15341 message when it is delivered, in exactly the same way as &'Return-path:'& is
15342 handled. &'Envelope-to:'& records the original recipient address from the
15343 message's envelope that caused the delivery to happen. Such headers should not
15344 be present in incoming messages, and this option causes them to be removed at
15345 the time the message is received, to avoid any problems that might occur when a
15346 delivered message is subsequently sent on to some other recipient.
15347
15348
15349 .option errors_copy main "string list&!!" unset
15350 .cindex "bounce message" "copy to other address"
15351 .cindex "copy of bounce message"
15352 Setting this option causes Exim to send bcc copies of bounce messages that it
15353 generates to other addresses. &*Note*&: This does not apply to bounce messages
15354 coming from elsewhere. The value of the option is a colon-separated list of
15355 items. Each item consists of a pattern, terminated by white space, followed by
15356 a comma-separated list of email addresses. If a pattern contains spaces, it
15357 must be enclosed in double quotes.
15358
15359 Each pattern is processed in the same way as a single item in an address list
15360 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15361 the bounce message, the message is copied to the addresses on the list. The
15362 items are scanned in order, and once a matching one is found, no further items
15363 are examined. For example:
15364 .code
15365 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15366               rqps@mydomain   hostmaster@mydomain.example,\
15367                               postmaster@mydomain.example
15368 .endd
15369 .vindex "&$domain$&"
15370 .vindex "&$local_part$&"
15371 The address list is expanded before use. The expansion variables &$local_part$&
15372 and &$domain$& are set from the original recipient of the error message, and if
15373 there was any wildcard matching in the pattern, the expansion
15374 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15375 variables &$0$&, &$1$&, etc. are set in the normal way.
15376
15377
15378 .option errors_reply_to main string unset
15379 .cindex "bounce message" "&'Reply-to:'& in"
15380 By default, Exim's bounce and delivery warning messages contain the header line
15381 .display
15382 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15383 .endd
15384 .oindex &%quota_warn_message%&
15385 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15386 A warning message that is generated by the &%quota_warn_message%& option in an
15387 &(appendfile)& transport may contain its own &'From:'& header line that
15388 overrides the default.
15389
15390 Experience shows that people reply to bounce messages. If the
15391 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15392 and warning messages. For example:
15393 .code
15394 errors_reply_to = postmaster@my.domain.example
15395 .endd
15396 The value of the option is not expanded. It must specify a valid RFC 2822
15397 address. However, if a warning message that is generated by the
15398 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15399 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15400 not used.
15401
15402
15403 .option event_action main string&!! unset
15404 .cindex events
15405 This option declares a string to be expanded for Exim's events mechanism.
15406 For details see chapter &<<CHAPevents>>&.
15407
15408
15409 .option exim_group main string "compile-time configured"
15410 .cindex "gid (group id)" "Exim's own"
15411 .cindex "Exim group"
15412 This option changes the gid under which Exim runs when it gives up root
15413 privilege. The default value is compiled into the binary. The value of this
15414 option is used only when &%exim_user%& is also set. Unless it consists entirely
15415 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15416 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15417 security issues.
15418
15419
15420 .option exim_path main string "see below"
15421 .cindex "Exim binary, path name"
15422 This option specifies the path name of the Exim binary, which is used when Exim
15423 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15424 the directory configured at compile time by the BIN_DIRECTORY setting. It
15425 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15426 other place.
15427 &*Warning*&: Do not use a macro to define the value of this option, because
15428 you will break those Exim utilities that scan the configuration file to find
15429 where the binary is. (They then use the &%-bP%& option to extract option
15430 settings such as the value of &%spool_directory%&.)
15431
15432
15433 .option exim_user main string "compile-time configured"
15434 .cindex "uid (user id)" "Exim's own"
15435 .cindex "Exim user"
15436 This option changes the uid under which Exim runs when it gives up root
15437 privilege. The default value is compiled into the binary. Ownership of the run
15438 time configuration file and the use of the &%-C%& and &%-D%& command line
15439 options is checked against the values in the binary, not what is set here.
15440
15441 Unless it consists entirely of digits, the string is looked up using
15442 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15443 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15444 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15445
15446
15447 .option exim_version main string "current version"
15448 .cindex "Exim version"
15449 .cindex customizing "version number"
15450 .cindex "version number of Exim" override
15451 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15452 various places.  Use with care; this may fool stupid security scanners.
15453
15454
15455 .option extra_local_interfaces main "string list" unset
15456 This option defines network interfaces that are to be considered local when
15457 routing, but which are not used for listening by the daemon. See section
15458 &<<SECTreclocipadd>>& for details.
15459
15460
15461 . Allow this long option name to split; give it unsplit as a fifth argument
15462 . for the automatic .oindex that is generated by .option.
15463
15464 .option "extract_addresses_remove_arguments" main boolean true &&&
15465          extract_addresses_remove_arguments
15466 .oindex "&%-t%&"
15467 .cindex "command line" "addresses with &%-t%&"
15468 .cindex "Sendmail compatibility" "&%-t%& option"
15469 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15470 are present on the command line when the &%-t%& option is used to build an
15471 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15472 line addresses are removed from the recipients list. This is also how Smail
15473 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15474 command line addresses are added to those obtained from the header lines. When
15475 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15476 argument headers. If it is set false, Exim adds rather than removes argument
15477 addresses.
15478
15479
15480 .option finduser_retries main integer 0
15481 .cindex "NIS, retrying user lookups"
15482 On systems running NIS or other schemes in which user and group information is
15483 distributed from a remote system, there can be times when &[getpwnam()]& and
15484 related functions fail, even when given valid data, because things time out.
15485 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15486 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15487 many extra times to find a user or a group, waiting for one second between
15488 retries.
15489
15490 .cindex "&_/etc/passwd_&" "multiple reading of"
15491 You should not set this option greater than zero if your user information is in
15492 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15493 search the file multiple times for non-existent users, and also cause delay.
15494
15495
15496
15497 .option freeze_tell main "string list, comma separated" unset
15498 .cindex "freezing messages" "sending a message when freezing"
15499 On encountering certain errors, or when configured to do so in a system filter,
15500 ACL, or special router, Exim freezes a message. This means that no further
15501 delivery attempts take place until an administrator thaws the message, or the
15502 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15503 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15504 warning message whenever it freezes something, unless the message it is
15505 freezing is a locally-generated bounce message. (Without this exception there
15506 is the possibility of looping.) The warning message is sent to the addresses
15507 supplied as the comma-separated value of this option. If several of the
15508 message's addresses cause freezing, only a single message is sent. If the
15509 freezing was automatic, the reason(s) for freezing can be found in the message
15510 log. If you configure freezing in a filter or ACL, you must arrange for any
15511 logging that you require.
15512
15513
15514 .option gecos_name main string&!! unset
15515 .cindex "HP-UX"
15516 .cindex "&""gecos""& field, parsing"
15517 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15518 password file to hold other information in addition to users' real names. Exim
15519 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15520 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15521 of the field are used unchanged, except that, if an ampersand is encountered,
15522 it is replaced by the user's login name with the first character forced to
15523 upper case, since this is a convention that is observed on many systems.
15524
15525 When these options are set, &%gecos_pattern%& is treated as a regular
15526 expression that is to be applied to the field (again with && replaced by the
15527 login name), and if it matches, &%gecos_name%& is expanded and used as the
15528 user's name.
15529
15530 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15531 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15532 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15533 name terminates at the first comma, the following can be used:
15534 .code
15535 gecos_pattern = ([^,]*)
15536 gecos_name = $1
15537 .endd
15538
15539 .option gecos_pattern main string unset
15540 See &%gecos_name%& above.
15541
15542
15543 .option gnutls_compat_mode main boolean unset
15544 This option controls whether GnuTLS is used in compatibility mode in an Exim
15545 server. This reduces security slightly, but improves interworking with older
15546 implementations of TLS.
15547
15548
15549 .option gnutls_allow_auto_pkcs11 main boolean unset
15550 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15551 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15552
15553 See
15554 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15555 for documentation.
15556
15557
15558
15559 .option headers_charset main string "see below"
15560 This option sets a default character set for translating from encoded MIME
15561 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15562 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15563 ultimate default is ISO-8859-1. For more details see the description of header
15564 insertions in section &<<SECTexpansionitems>>&.
15565
15566
15567
15568 .option header_maxsize main integer "see below"
15569 .cindex "header section" "maximum size of"
15570 .cindex "limit" "size of message header section"
15571 This option controls the overall maximum size of a message's header
15572 section. The default is the value of HEADER_MAXSIZE in
15573 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15574 sections are rejected.
15575
15576
15577 .option header_line_maxsize main integer 0
15578 .cindex "header lines" "maximum size of"
15579 .cindex "limit" "size of one header line"
15580 This option limits the length of any individual header line in a message, after
15581 all the continuations have been joined together. Messages with individual
15582 header lines that are longer than the limit are rejected. The default value of
15583 zero means &"no limit"&.
15584
15585
15586
15587
15588 .option helo_accept_junk_hosts main "host list&!!" unset
15589 .cindex "HELO" "accepting junk data"
15590 .cindex "EHLO" "accepting junk data"
15591 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15592 mail, and gives an error response for invalid data. Unfortunately, there are
15593 some SMTP clients that send syntactic junk. They can be accommodated by setting
15594 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15595 if you want to do semantic checking.
15596 See also &%helo_allow_chars%& for a way of extending the permitted character
15597 set.
15598
15599
15600 .option helo_allow_chars main string unset
15601 .cindex "HELO" "underscores in"
15602 .cindex "EHLO" "underscores in"
15603 .cindex "underscore in EHLO/HELO"
15604 This option can be set to a string of rogue characters that are permitted in
15605 all EHLO and HELO names in addition to the standard letters, digits,
15606 hyphens, and dots. If you really must allow underscores, you can set
15607 .code
15608 helo_allow_chars = _
15609 .endd
15610 Note that the value is one string, not a list.
15611
15612
15613 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15614 .cindex "HELO" "forcing reverse lookup"
15615 .cindex "EHLO" "forcing reverse lookup"
15616 If the domain given by a client in a HELO or EHLO command matches this
15617 list, a reverse lookup is done in order to establish the host's true name. The
15618 default forces a lookup if the client host gives the server's name or any of
15619 its IP addresses (in brackets), something that broken clients have been seen to
15620 do.
15621
15622
15623 .option helo_try_verify_hosts main "host list&!!" unset
15624 .cindex "HELO verifying" "optional"
15625 .cindex "EHLO" "verifying, optional"
15626 By default, Exim just checks the syntax of HELO and EHLO commands (see
15627 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15628 to do more extensive checking of the data supplied by these commands. The ACL
15629 condition &`verify = helo`& is provided to make this possible.
15630 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15631 to force the check to occur. From release 4.53 onwards, this is no longer
15632 necessary. If the check has not been done before &`verify = helo`& is
15633 encountered, it is done at that time. Consequently, this option is obsolete.
15634 Its specification is retained here for backwards compatibility.
15635
15636 When an EHLO or HELO command is received, if the calling host matches
15637 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15638 EHLO command either:
15639
15640 .ilist
15641 is an IP literal matching the calling address of the host, or
15642 .next
15643 .cindex "DNS" "reverse lookup"
15644 .cindex "reverse DNS lookup"
15645 matches the host name that Exim obtains by doing a reverse lookup of the
15646 calling host address, or
15647 .next
15648 when looked up in DNS yields the calling host address.
15649 .endlist
15650
15651 However, the EHLO or HELO command is not rejected if any of the checks
15652 fail. Processing continues, but the result of the check is remembered, and can
15653 be detected later in an ACL by the &`verify = helo`& condition.
15654
15655 If DNS was used for successful verification, the variable
15656 .cindex "DNS" "DNSSEC"
15657 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15658
15659 .option helo_verify_hosts main "host list&!!" unset
15660 .cindex "HELO verifying" "mandatory"
15661 .cindex "EHLO" "verifying, mandatory"
15662 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15663 backwards compatibility. For hosts that match this option, Exim checks the host
15664 name given in the HELO or EHLO in the same way as for
15665 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15666 rejected with a 550 error, and entries are written to the main and reject logs.
15667 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15668 error.
15669
15670 .option hold_domains main "domain list&!!" unset
15671 .cindex "domain" "delaying delivery"
15672 .cindex "delivery" "delaying certain domains"
15673 This option allows mail for particular domains to be held in the queue
15674 manually. The option is overridden if a message delivery is forced with the
15675 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15676 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15677 item in &%hold_domains%&, no routing or delivery for that address is done, and
15678 it is deferred every time the message is looked at.
15679
15680 This option is intended as a temporary operational measure for delaying the
15681 delivery of mail while some problem is being sorted out, or some new
15682 configuration tested. If you just want to delay the processing of some
15683 domains until a queue run occurs, you should use &%queue_domains%& or
15684 &%queue_smtp_domains%&, not &%hold_domains%&.
15685
15686 A setting of &%hold_domains%& does not override Exim's code for removing
15687 messages from the queue if they have been there longer than the longest retry
15688 time in any retry rule. If you want to hold messages for longer than the normal
15689 retry times, insert a dummy retry rule with a long retry time.
15690
15691
15692 .option host_lookup main "host list&!!" unset
15693 .cindex "host name" "lookup, forcing"
15694 Exim does not look up the name of a calling host from its IP address unless it
15695 is required to compare against some host list, or the host matches
15696 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15697 option (which normally contains IP addresses rather than host names). The
15698 default configuration file contains
15699 .code
15700 host_lookup = *
15701 .endd
15702 which causes a lookup to happen for all hosts. If the expense of these lookups
15703 is felt to be too great, the setting can be changed or removed.
15704
15705 After a successful reverse lookup, Exim does a forward lookup on the name it
15706 has obtained, to verify that it yields the IP address that it started with. If
15707 this check fails, Exim behaves as if the name lookup failed.
15708
15709 .vindex "&$host_lookup_failed$&"
15710 .vindex "&$sender_host_name$&"
15711 After any kind of failure, the host name (in &$sender_host_name$&) remains
15712 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15713 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15714 &`verify = reverse_host_lookup`& in ACLs.
15715
15716
15717 .option host_lookup_order main "string list" &`bydns:byaddr`&
15718 This option specifies the order of different lookup methods when Exim is trying
15719 to find a host name from an IP address. The default is to do a DNS lookup
15720 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15721 if that fails. You can change the order of these lookups, or omit one entirely,
15722 if you want.
15723
15724 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15725 multiple PTR records in the DNS and the IP address is not listed in
15726 &_/etc/hosts_&. Different operating systems give different results in this
15727 case. That is why the default tries a DNS lookup first.
15728
15729
15730
15731 .option host_reject_connection main "host list&!!" unset
15732 .cindex "host" "rejecting connections from"
15733 If this option is set, incoming SMTP calls from the hosts listed are rejected
15734 as soon as the connection is made.
15735 This option is obsolete, and retained only for backward compatibility, because
15736 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15737 connections immediately.
15738
15739 The ability to give an immediate rejection (either by this option or using an
15740 ACL) is provided for use in unusual cases. Many hosts will just try again,
15741 sometimes without much delay. Normally, it is better to use an ACL to reject
15742 incoming messages at a later stage, such as after RCPT commands. See
15743 chapter &<<CHAPACL>>&.
15744
15745
15746 .option hosts_connection_nolog main "host list&!!" unset
15747 .cindex "host" "not logging connections from"
15748 This option defines a list of hosts for which connection logging does not
15749 happen, even though the &%smtp_connection%& log selector is set. For example,
15750 you might want not to log SMTP connections from local processes, or from
15751 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15752 the daemon; you should therefore strive to restrict its value to a short inline
15753 list of IP addresses and networks. To disable logging SMTP connections from
15754 local processes, you must create a host list with an empty item. For example:
15755 .code
15756 hosts_connection_nolog = :
15757 .endd
15758 If the &%smtp_connection%& log selector is not set, this option has no effect.
15759
15760
15761
15762 .option hosts_proxy main "host list&!!" unset
15763 .cindex proxy "proxy protocol"
15764 This option enables use of Proxy Protocol proxies for incoming
15765 connections.  For details see section &<<SECTproxyInbound>>&.
15766
15767
15768 .option hosts_treat_as_local main "domain list&!!" unset
15769 .cindex "local host" "domains treated as"
15770 .cindex "host" "treated as local"
15771 If this option is set, any host names that match the domain list are treated as
15772 if they were the local host when Exim is scanning host lists obtained from MX
15773 records
15774 or other sources. Note that the value of this option is a domain list, not a
15775 host list, because it is always used to check host names, not IP addresses.
15776
15777 This option also applies when Exim is matching the special items
15778 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15779 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15780 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15781 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15782 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15783 interfaces and recognizing the local host.
15784
15785
15786 .option ibase_servers main "string list" unset
15787 .cindex "InterBase" "server list"
15788 This option provides a list of InterBase servers and associated connection data,
15789 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15790 The option is available only if Exim has been built with InterBase support.
15791
15792
15793
15794 .option ignore_bounce_errors_after main time 10w
15795 .cindex "bounce message" "discarding"
15796 .cindex "discarding bounce message"
15797 This option affects the processing of bounce messages that cannot be delivered,
15798 that is, those that suffer a permanent delivery failure. (Bounce messages that
15799 suffer temporary delivery failures are of course retried in the usual way.)
15800
15801 After a permanent delivery failure, bounce messages are frozen,
15802 because there is no sender to whom they can be returned. When a frozen bounce
15803 message has been in the queue for more than the given time, it is unfrozen at
15804 the next queue run, and a further delivery is attempted. If delivery fails
15805 again, the bounce message is discarded. This makes it possible to keep failed
15806 bounce messages around for a shorter time than the normal maximum retry time
15807 for frozen messages. For example,
15808 .code
15809 ignore_bounce_errors_after = 12h
15810 .endd
15811 retries failed bounce message deliveries after 12 hours, discarding any further
15812 failures. If the value of this option is set to a zero time period, bounce
15813 failures are discarded immediately. Setting a very long time (as in the default
15814 value) has the effect of disabling this option. For ways of automatically
15815 dealing with other kinds of frozen message, see &%auto_thaw%& and
15816 &%timeout_frozen_after%&.
15817
15818
15819 .option ignore_fromline_hosts main "host list&!!" unset
15820 .cindex "&""From""& line"
15821 .cindex "UUCP" "&""From""& line"
15822 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15823 the headers of a message. By default this is treated as the start of the
15824 message's body, which means that any following headers are not recognized as
15825 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15826 match those hosts that insist on sending it. If the sender is actually a local
15827 process rather than a remote host, and is using &%-bs%& to inject the messages,
15828 &%ignore_fromline_local%& must be set to achieve this effect.
15829
15830
15831 .option ignore_fromline_local main boolean false
15832 See &%ignore_fromline_hosts%& above.
15833
15834 .option keep_environment main "string list" unset
15835 .cindex "environment" "values from"
15836 This option contains a string list of environment variables to keep.
15837 You have to trust these variables or you have to be sure that
15838 these variables do not impose any security risk. Keep in mind that
15839 during the startup phase Exim is running with an effective UID 0 in most
15840 installations. As the default value is an empty list, the default
15841 environment for using libraries, running embedded Perl code, or running
15842 external binaries is empty, and does not not even contain PATH or HOME.
15843
15844 Actually the list is interpreted as a list of patterns
15845 (&<<SECTlistexpand>>&), except that it is not expanded first.
15846
15847 WARNING: Macro substitution is still done first, so having a macro
15848 FOO and having FOO_HOME in your &%keep_environment%& option may have
15849 unexpected results. You may work around this using a regular expression
15850 that does not match the macro name: ^[F]OO_HOME$.
15851
15852 Current versions of Exim issue a warning during startup if you do not mention
15853 &%keep_environment%& in your runtime configuration file and if your
15854 current environment is not empty. Future versions may not issue that warning
15855 anymore.
15856
15857 See the &%add_environment%& main config option for a way to set
15858 environment variables to a fixed value.  The environment for &(pipe)&
15859 transports is handled separately, see section &<<SECTpipeenv>>& for
15860 details.
15861
15862
15863 .option keep_malformed main time 4d
15864 This option specifies the length of time to keep messages whose spool files
15865 have been corrupted in some way. This should, of course, never happen. At the
15866 next attempt to deliver such a message, it gets removed. The incident is
15867 logged.
15868
15869
15870 .option ldap_ca_cert_dir main string unset
15871 .cindex "LDAP", "TLS CA certificate directory"
15872 .cindex certificate "directory for LDAP"
15873 This option indicates which directory contains CA certificates for verifying
15874 a TLS certificate presented by an LDAP server.
15875 While Exim does not provide a default value, your SSL library may.
15876 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15877 and constrained to be a directory.
15878
15879
15880 .option ldap_ca_cert_file main string unset
15881 .cindex "LDAP", "TLS CA certificate file"
15882 .cindex certificate "file for LDAP"
15883 This option indicates which file contains CA certificates for verifying
15884 a TLS certificate presented by an LDAP server.
15885 While Exim does not provide a default value, your SSL library may.
15886 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15887 and constrained to be a file.
15888
15889
15890 .option ldap_cert_file main string unset
15891 .cindex "LDAP" "TLS client certificate file"
15892 .cindex certificate "file for LDAP"
15893 This option indicates which file contains an TLS client certificate which
15894 Exim should present to the LDAP server during TLS negotiation.
15895 Should be used together with &%ldap_cert_key%&.
15896
15897
15898 .option ldap_cert_key main string unset
15899 .cindex "LDAP" "TLS client key file"
15900 .cindex certificate "key for LDAP"
15901 This option indicates which file contains the secret/private key to use
15902 to prove identity to the LDAP server during TLS negotiation.
15903 Should be used together with &%ldap_cert_file%&, which contains the
15904 identity to be proven.
15905
15906
15907 .option ldap_cipher_suite main string unset
15908 .cindex "LDAP" "TLS cipher suite"
15909 This controls the TLS cipher-suite negotiation during TLS negotiation with
15910 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15911 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15912
15913
15914 .option ldap_default_servers main "string list" unset
15915 .cindex "LDAP" "default servers"
15916 This option provides a list of LDAP servers which are tried in turn when an
15917 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15918 details of LDAP queries. This option is available only when Exim has been built
15919 with LDAP support.
15920
15921
15922 .option ldap_require_cert main string unset.
15923 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15924 This should be one of the values "hard", "demand", "allow", "try" or "never".
15925 A value other than one of these is interpreted as "never".
15926 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15927 Although Exim does not set a default, the LDAP library probably defaults
15928 to hard/demand.
15929
15930
15931 .option ldap_start_tls main boolean false
15932 .cindex "LDAP" "whether or not to negotiate TLS"
15933 If set, Exim will attempt to negotiate TLS with the LDAP server when
15934 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15935 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15936 of SSL-on-connect.
15937 In the event of failure to negotiate TLS, the action taken is controlled
15938 by &%ldap_require_cert%&.
15939 This option is ignored for &`ldapi`& connections.
15940
15941
15942 .option ldap_version main integer unset
15943 .cindex "LDAP" "protocol version, forcing"
15944 This option can be used to force Exim to set a specific protocol version for
15945 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15946 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15947 the LDAP headers; otherwise it is 2. This option is available only when Exim
15948 has been built with LDAP support.
15949
15950
15951
15952 .option local_from_check main boolean true
15953 .cindex "&'Sender:'& header line" "disabling addition of"
15954 .cindex "&'From:'& header line" "disabling checking of"
15955 When a message is submitted locally (that is, not over a TCP/IP connection) by
15956 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15957 checks that the &'From:'& header line matches the login of the calling user and
15958 the domain specified by &%qualify_domain%&.
15959
15960 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15961 locally submitted message is automatically qualified by Exim, unless the
15962 &%-bnq%& command line option is used.
15963
15964 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15965 on the local part. If the &'From:'& header line does not match, Exim adds a
15966 &'Sender:'& header with an address constructed from the calling user's login
15967 and the default qualify domain.
15968
15969 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15970 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15971 &'Sender:'& header lines supplied by untrusted users, you must also set
15972 &%local_sender_retain%& to be true.
15973
15974 .cindex "envelope from"
15975 .cindex "envelope sender"
15976 These options affect only the header lines in the message. The envelope sender
15977 is still forced to be the login id at the qualify domain unless
15978 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15979
15980 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15981 request similar header line checking. See section &<<SECTthesenhea>>&, which
15982 has more details about &'Sender:'& processing.
15983
15984
15985
15986
15987 .option local_from_prefix main string unset
15988 When Exim checks the &'From:'& header line of locally submitted messages for
15989 matching the login id (see &%local_from_check%& above), it can be configured to
15990 ignore certain prefixes and suffixes in the local part of the address. This is
15991 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15992 appropriate lists, in the same form as the &%local_part_prefix%& and
15993 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15994 example, if
15995 .code
15996 local_from_prefix = *-
15997 .endd
15998 is set, a &'From:'& line containing
15999 .code
16000 From: anything-user@your.domain.example
16001 .endd
16002 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16003 matches the actual sender address that is constructed from the login name and
16004 qualify domain.
16005
16006
16007 .option local_from_suffix main string unset
16008 See &%local_from_prefix%& above.
16009
16010
16011 .option local_interfaces main "string list" "see below"
16012 This option controls which network interfaces are used by the daemon for
16013 listening; they are also used to identify the local host when routing. Chapter
16014 &<<CHAPinterfaces>>& contains a full description of this option and the related
16015 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16016 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16017 &%local_interfaces%& is
16018 .code
16019 local_interfaces = 0.0.0.0
16020 .endd
16021 when Exim is built without IPv6 support; otherwise it is
16022 .code
16023 local_interfaces = <; ::0 ; 0.0.0.0
16024 .endd
16025
16026 .option local_scan_timeout main time 5m
16027 .cindex "timeout" "for &[local_scan()]& function"
16028 .cindex "&[local_scan()]& function" "timeout"
16029 This timeout applies to the &[local_scan()]& function (see chapter
16030 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16031 the incoming message is rejected with a temporary error if it is an SMTP
16032 message. For a non-SMTP message, the message is dropped and Exim ends with a
16033 non-zero code. The incident is logged on the main and reject logs.
16034
16035
16036
16037 .option local_sender_retain main boolean false
16038 .cindex "&'Sender:'& header line" "retaining from local submission"
16039 When a message is submitted locally (that is, not over a TCP/IP connection) by
16040 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16041 do not want this to happen, you must set &%local_sender_retain%&, and you must
16042 also set &%local_from_check%& to be false (Exim will complain if you do not).
16043 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16044 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16045
16046
16047
16048
16049 .option localhost_number main string&!! unset
16050 .cindex "host" "locally unique number for"
16051 .cindex "message ids" "with multiple hosts"
16052 .vindex "&$localhost_number$&"
16053 Exim's message ids are normally unique only within the local host. If
16054 uniqueness among a set of hosts is required, each host must set a different
16055 value for the &%localhost_number%& option. The string is expanded immediately
16056 after reading the configuration file (so that a number can be computed from the
16057 host name, for example) and the result of the expansion must be a number in the
16058 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16059 systems). This is available in subsequent string expansions via the variable
16060 &$localhost_number$&. When &%localhost_number is set%&, the final two
16061 characters of the message id, instead of just being a fractional part of the
16062 time, are computed from the time and the local host number as described in
16063 section &<<SECTmessiden>>&.
16064
16065
16066
16067 .option log_file_path main "string list&!!" "set at compile time"
16068 .cindex "log" "file path for"
16069 This option sets the path which is used to determine the names of Exim's log
16070 files, or indicates that logging is to be to syslog, or both. It is expanded
16071 when Exim is entered, so it can, for example, contain a reference to the host
16072 name. If no specific path is set for the log files at compile or runtime,
16073 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16074 they are written in a sub-directory called &_log_& in Exim's spool directory.
16075 A path must start with a slash.
16076 To send to syslog, use the word &"syslog"&.
16077 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16078 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16079 used. If this string is fixed at your installation (contains no expansion
16080 variables) it is recommended that you do not set this option in the
16081 configuration file, but instead supply the path using LOG_FILE_PATH in
16082 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16083 early on &-- in particular, failure to read the configuration file.
16084
16085
16086 .option log_selector main string unset
16087 .cindex "log" "selectors"
16088 This option can be used to reduce or increase the number of things that Exim
16089 writes to its log files. Its argument is made up of names preceded by plus or
16090 minus characters. For example:
16091 .code
16092 log_selector = +arguments -retry_defer
16093 .endd
16094 A list of possible names and what they control is given in the chapter on
16095 logging, in section &<<SECTlogselector>>&.
16096
16097
16098 .option log_timezone main boolean false
16099 .cindex "log" "timezone for entries"
16100 .vindex "&$tod_log$&"
16101 .vindex "&$tod_zone$&"
16102 By default, the timestamps on log lines are in local time without the
16103 timezone. This means that if your timezone changes twice a year, the timestamps
16104 in log lines are ambiguous for an hour when the clocks go back. One way of
16105 avoiding this problem is to set the timezone to UTC. An alternative is to set
16106 &%log_timezone%& true. This turns on the addition of the timezone offset to
16107 timestamps in log lines. Turning on this option can add quite a lot to the size
16108 of log files because each line is extended by 6 characters. Note that the
16109 &$tod_log$& variable contains the log timestamp without the zone, but there is
16110 another variable called &$tod_zone$& that contains just the timezone offset.
16111
16112
16113 .option lookup_open_max main integer 25
16114 .cindex "too many open files"
16115 .cindex "open files, too many"
16116 .cindex "file" "too many open"
16117 .cindex "lookup" "maximum open files"
16118 .cindex "limit" "open files for lookups"
16119 This option limits the number of simultaneously open files for single-key
16120 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16121 Exim normally keeps these files open during routing, because often the same
16122 file is required several times. If the limit is reached, Exim closes the least
16123 recently used file. Note that if you are using the &'ndbm'& library, it
16124 actually opens two files for each logical DBM database, though it still counts
16125 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16126 open files"& errors with NDBM, you need to reduce the value of
16127 &%lookup_open_max%&.
16128
16129
16130 .option max_username_length main integer 0
16131 .cindex "length of login name"
16132 .cindex "user name" "maximum length"
16133 .cindex "limit" "user name length"
16134 Some operating systems are broken in that they truncate long arguments to
16135 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16136 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16137 an argument that is longer behaves as if &[getpwnam()]& failed.
16138
16139
16140 .option message_body_newlines main bool false
16141 .cindex "message body" "newlines in variables"
16142 .cindex "newline" "in message body variables"
16143 .vindex "&$message_body$&"
16144 .vindex "&$message_body_end$&"
16145 By default, newlines in the message body are replaced by spaces when setting
16146 the &$message_body$& and &$message_body_end$& expansion variables. If this
16147 option is set true, this no longer happens.
16148
16149
16150 .option message_body_visible main integer 500
16151 .cindex "body of message" "visible size"
16152 .cindex "message body" "visible size"
16153 .vindex "&$message_body$&"
16154 .vindex "&$message_body_end$&"
16155 This option specifies how much of a message's body is to be included in the
16156 &$message_body$& and &$message_body_end$& expansion variables.
16157
16158
16159 .option message_id_header_domain main string&!! unset
16160 .cindex "&'Message-ID:'& header line"
16161 If this option is set, the string is expanded and used as the right hand side
16162 (domain) of the &'Message-ID:'& header that Exim creates if a
16163 locally-originated incoming message does not have one. &"Locally-originated"&
16164 means &"not received over TCP/IP."&
16165 Otherwise, the primary host name is used.
16166 Only letters, digits, dot and hyphen are accepted; any other characters are
16167 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16168 empty string, the option is ignored.
16169
16170
16171 .option message_id_header_text main string&!! unset
16172 If this variable is set, the string is expanded and used to augment the text of
16173 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16174 message does not have one. The text of this header is required by RFC 2822 to
16175 take the form of an address. By default, Exim uses its internal message id as
16176 the local part, and the primary host name as the domain. If this option is set,
16177 it is expanded, and provided the expansion is not forced to fail, and does not
16178 yield an empty string, the result is inserted into the header immediately
16179 before the @, separated from the internal message id by a dot. Any characters
16180 that are illegal in an address are automatically converted into hyphens. This
16181 means that variables such as &$tod_log$& can be used, because the spaces and
16182 colons will become hyphens.
16183
16184
16185 .option message_logs main boolean true
16186 .cindex "message logs" "disabling"
16187 .cindex "log" "message log; disabling"
16188 If this option is turned off, per-message log files are not created in the
16189 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16190 Exim, by reducing the number of files involved in handling a message from a
16191 minimum of four (header spool file, body spool file, delivery journal, and
16192 per-message log) to three. The other major I/O activity is Exim's main log,
16193 which is not affected by this option.
16194
16195
16196 .option message_size_limit main string&!! 50M
16197 .cindex "message" "size limit"
16198 .cindex "limit" "message size"
16199 .cindex "size" "of message, limit"
16200 This option limits the maximum size of message that Exim will process. The
16201 value is expanded for each incoming connection so, for example, it can be made
16202 to depend on the IP address of the remote host for messages arriving via
16203 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16204 optionally followed by K or M.
16205
16206 &*Note*&: This limit cannot be made to depend on a message's sender or any
16207 other properties of an individual message, because it has to be advertised in
16208 the server's response to EHLO. String expansion failure causes a temporary
16209 error. A value of zero means no limit, but its use is not recommended. See also
16210 &%bounce_return_size_limit%&.
16211
16212 Incoming SMTP messages are failed with a 552 error if the limit is
16213 exceeded; locally-generated messages either get a stderr message or a delivery
16214 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16215 an oversized message is logged in both the main and the reject logs. See also
16216 the generic transport option &%message_size_limit%&, which limits the size of
16217 message that an individual transport can process.
16218
16219 If you use a virus-scanner and set this option to to a value larger than the
16220 maximum size that your virus-scanner is configured to support, you may get
16221 failures triggered by large mails.  The right size to configure for the
16222 virus-scanner depends upon what data is passed and the options in use but it's
16223 probably safest to just set it to a little larger than this value.  E.g., with a
16224 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16225 some problems may result.
16226
16227 A value of 0 will disable size limit checking; Exim will still advertise the
16228 SIZE extension in an EHLO response, but without a limit, so as to permit
16229 SMTP clients to still indicate the message size along with the MAIL verb.
16230
16231
16232 .option move_frozen_messages main boolean false
16233 .cindex "frozen messages" "moving"
16234 This option, which is available only if Exim has been built with the setting
16235 .code
16236 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16237 .endd
16238 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16239 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16240 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16241 standard utilities for handling such moved messages, and they do not show up in
16242 lists generated by &%-bp%& or by the Exim monitor.
16243
16244
16245 .option mua_wrapper main boolean false
16246 Setting this option true causes Exim to run in a very restrictive mode in which
16247 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16248 contains a full description of this facility.
16249
16250
16251
16252 .option mysql_servers main "string list" unset
16253 .cindex "MySQL" "server list"
16254 This option provides a list of MySQL servers and associated connection data, to
16255 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16256 option is available only if Exim has been built with MySQL support.
16257
16258
16259 .option never_users main "string list&!!" unset
16260 This option is expanded just once, at the start of Exim's processing. Local
16261 message deliveries are normally run in processes that are setuid to the
16262 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16263 It is usually desirable to prevent any deliveries from running as root, as a
16264 safety precaution.
16265
16266 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16267 list of users that must not be used for local deliveries. This list is fixed in
16268 the binary and cannot be overridden by the configuration file. By default, it
16269 contains just the single user name &"root"&. The &%never_users%& runtime option
16270 can be used to add more users to the fixed list.
16271
16272 If a message is to be delivered as one of the users on the fixed list or the
16273 &%never_users%& list, an error occurs, and delivery is deferred. A common
16274 example is
16275 .code
16276 never_users = root:daemon:bin
16277 .endd
16278 Including root is redundant if it is also on the fixed list, but it does no
16279 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16280 transport driver.
16281
16282
16283 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16284 .cindex "OpenSSL "compatibility options"
16285 This option allows an administrator to adjust the SSL options applied
16286 by OpenSSL to connections.  It is given as a space-separated list of items,
16287 each one to be +added or -subtracted from the current value.
16288
16289 This option is only available if Exim is built against OpenSSL.  The values
16290 available for this option vary according to the age of your OpenSSL install.
16291 The &"all"& value controls a subset of flags which are available, typically
16292 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16293 list the values known on your system and Exim should support all the
16294 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16295 names lose the leading &"SSL_OP_"& and are lower-cased.
16296
16297 Note that adjusting the options can have severe impact upon the security of
16298 SSL as used by Exim.  It is possible to disable safety checks and shoot
16299 yourself in the foot in various unpleasant ways.  This option should not be
16300 adjusted lightly.  An unrecognised item will be detected at startup, by
16301 invoking Exim with the &%-bV%& flag.
16302
16303 The option affects Exim operating both as a server and as a client.
16304
16305 Historical note: prior to release 4.80, Exim defaulted this value to
16306 "+dont_insert_empty_fragments", which may still be needed for compatibility
16307 with some clients, but which lowers security by increasing exposure to
16308 some now infamous attacks.
16309
16310 Examples:
16311 .code
16312 # Make both old MS and old Eudora happy:
16313 openssl_options = -all +microsoft_big_sslv3_buffer \
16314                        +dont_insert_empty_fragments
16315
16316 # Disable older protocol versions:
16317 openssl_options = +no_sslv2 +no_sslv3
16318 .endd
16319
16320 Possible options may include:
16321 .ilist
16322 &`all`&
16323 .next
16324 &`allow_unsafe_legacy_renegotiation`&
16325 .next
16326 &`cipher_server_preference`&
16327 .next
16328 &`dont_insert_empty_fragments`&
16329 .next
16330 &`ephemeral_rsa`&
16331 .next
16332 &`legacy_server_connect`&
16333 .next
16334 &`microsoft_big_sslv3_buffer`&
16335 .next
16336 &`microsoft_sess_id_bug`&
16337 .next
16338 &`msie_sslv2_rsa_padding`&
16339 .next
16340 &`netscape_challenge_bug`&
16341 .next
16342 &`netscape_reuse_cipher_change_bug`&
16343 .next
16344 &`no_compression`&
16345 .next
16346 &`no_session_resumption_on_renegotiation`&
16347 .next
16348 &`no_sslv2`&
16349 .next
16350 &`no_sslv3`&
16351 .next
16352 &`no_ticket`&
16353 .next
16354 &`no_tlsv1`&
16355 .next
16356 &`no_tlsv1_1`&
16357 .next
16358 &`no_tlsv1_2`&
16359 .next
16360 &`safari_ecdhe_ecdsa_bug`&
16361 .next
16362 &`single_dh_use`&
16363 .next
16364 &`single_ecdh_use`&
16365 .next
16366 &`ssleay_080_client_dh_bug`&
16367 .next
16368 &`sslref2_reuse_cert_type_bug`&
16369 .next
16370 &`tls_block_padding_bug`&
16371 .next
16372 &`tls_d5_bug`&
16373 .next
16374 &`tls_rollback_bug`&
16375 .endlist
16376
16377 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16378 all clients connecting using the MacOS SecureTransport TLS facility prior
16379 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16380 to negotiate TLS then this option value might help, provided that your OpenSSL
16381 release is new enough to contain this work-around.  This may be a situation
16382 where you have to upgrade OpenSSL to get buggy clients working.
16383
16384
16385 .option oracle_servers main "string list" unset
16386 .cindex "Oracle" "server list"
16387 This option provides a list of Oracle servers and associated connection data,
16388 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16389 The option is available only if Exim has been built with Oracle support.
16390
16391
16392 .option percent_hack_domains main "domain list&!!" unset
16393 .cindex "&""percent hack""&"
16394 .cindex "source routing" "in email address"
16395 .cindex "address" "source-routed"
16396 The &"percent hack"& is the convention whereby a local part containing a
16397 percent sign is re-interpreted as a new email address, with the percent
16398 replaced by @. This is sometimes called &"source routing"&, though that term is
16399 also applied to RFC 2822 addresses that begin with an @ character. If this
16400 option is set, Exim implements the percent facility for those domains listed,
16401 but no others. This happens before an incoming SMTP address is tested against
16402 an ACL.
16403
16404 &*Warning*&: The &"percent hack"& has often been abused by people who are
16405 trying to get round relaying restrictions. For this reason, it is best avoided
16406 if at all possible. Unfortunately, a number of less security-conscious MTAs
16407 implement it unconditionally. If you are running Exim on a gateway host, and
16408 routing mail through to internal MTAs without processing the local parts, it is
16409 a good idea to reject recipient addresses with percent characters in their
16410 local parts. Exim's default configuration does this.
16411
16412
16413 .option perl_at_start main boolean false
16414 .cindex "Perl"
16415 This option is available only when Exim is built with an embedded Perl
16416 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16417
16418
16419 .option perl_startup main string unset
16420 .cindex "Perl"
16421 This option is available only when Exim is built with an embedded Perl
16422 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16423
16424 .option perl_taintmode main boolean false
16425 .cindex "Perl"
16426 This option enables the taint mode of the embedded Perl interpreter.
16427
16428
16429 .option pgsql_servers main "string list" unset
16430 .cindex "PostgreSQL lookup type" "server list"
16431 This option provides a list of PostgreSQL servers and associated connection
16432 data, to be used in conjunction with &(pgsql)& lookups (see section
16433 &<<SECID72>>&). The option is available only if Exim has been built with
16434 PostgreSQL support.
16435
16436
16437 .option pid_file_path main string&!! "set at compile time"
16438 .cindex "daemon" "pid file path"
16439 .cindex "pid file, path for"
16440 This option sets the name of the file to which the Exim daemon writes its
16441 process id. The string is expanded, so it can contain, for example, references
16442 to the host name:
16443 .code
16444 pid_file_path = /var/log/$primary_hostname/exim.pid
16445 .endd
16446 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16447 spool directory.
16448 The value set by the option can be overridden by the &%-oP%& command line
16449 option. A pid file is not written if a &"non-standard"& daemon is run by means
16450 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16451
16452
16453 .option pipelining_advertise_hosts main "host list&!!" *
16454 .cindex "PIPELINING" "suppressing advertising"
16455 This option can be used to suppress the advertisement of the SMTP
16456 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16457 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16458 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16459 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16460 that clients will use it; &"out of order"& commands that are &"expected"& do
16461 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16462
16463 .option pipelining_connect_advertise_hosts main "host list&!!" *
16464 .cindex "pipelining" "early connection"
16465 .cindex "pipelining" PIPE_CONNECT
16466 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16467 this option controls which hosts the facility is advertised to
16468 and from which pipeline early-connection (before MAIL) SMTP
16469 commands are acceptable.
16470 When used, the pipelining saves on roundtrip times.
16471
16472 See also the &%hosts_pipe_connect%& smtp transport option.
16473
16474 Currently the option name &"X_PIPE_CONNECT"& is used.
16475
16476
16477 .option prdr_enable main boolean false
16478 .cindex "PRDR" "enabling on server"
16479 This option can be used to enable the Per-Recipient Data Response extension
16480 to SMTP, defined by Eric Hall.
16481 If the option is set, PRDR is advertised by Exim when operating as a server.
16482 If the client requests PRDR, and more than one recipient, for a message
16483 an additional ACL is called for each recipient after the message content
16484 is received.  See section &<<SECTPRDRACL>>&.
16485
16486 .option preserve_message_logs main boolean false
16487 .cindex "message logs" "preserving"
16488 If this option is set, message log files are not deleted when messages are
16489 completed. Instead, they are moved to a sub-directory of the spool directory
16490 called &_msglog.OLD_&, where they remain available for statistical or debugging
16491 purposes. This is a dangerous option to set on systems with any appreciable
16492 volume of mail. Use with care!
16493
16494
16495 .option primary_hostname main string "see below"
16496 .cindex "name" "of local host"
16497 .cindex "host" "name of local"
16498 .cindex "local host" "name of"
16499 .vindex "&$primary_hostname$&"
16500 This specifies the name of the current host. It is used in the default EHLO or
16501 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16502 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16503 The value is also used by default in some SMTP response messages from an Exim
16504 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16505
16506 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16507 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16508 contains only one component, Exim passes it to &[gethostbyname()]& (or
16509 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16510 version. The variable &$primary_hostname$& contains the host name, whether set
16511 explicitly by this option, or defaulted.
16512
16513
16514 .option print_topbitchars main boolean false
16515 .cindex "printing characters"
16516 .cindex "8-bit characters"
16517 By default, Exim considers only those characters whose codes lie in the range
16518 32&--126 to be printing characters. In a number of circumstances (for example,
16519 when writing log entries) non-printing characters are converted into escape
16520 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16521 is set, code values of 128 and above are also considered to be printing
16522 characters.
16523
16524 This option also affects the header syntax checks performed by the
16525 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16526 the user's full name when constructing From: and Sender: addresses (as
16527 described in section &<<SECTconstr>>&). Setting this option can cause
16528 Exim to generate eight bit message headers that do not conform to the
16529 standards.
16530
16531
16532 .option process_log_path main string unset
16533 .cindex "process log path"
16534 .cindex "log" "process log"
16535 .cindex "&'exiwhat'&"
16536 This option sets the name of the file to which an Exim process writes its
16537 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16538 utility script. If this option is unset, the file called &_exim-process.info_&
16539 in Exim's spool directory is used. The ability to specify the name explicitly
16540 can be useful in environments where two different Exims are running, using
16541 different spool directories.
16542
16543
16544 .option prod_requires_admin main boolean true
16545 .cindex "restricting access to features"
16546 .oindex "&%-M%&"
16547 .oindex "&%-R%&"
16548 .oindex "&%-q%&"
16549 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16550 admin user unless &%prod_requires_admin%& is set false. See also
16551 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16552
16553
16554 .option qualify_domain main string "see below"
16555 .cindex "domain" "for qualifying addresses"
16556 .cindex "address" "qualification"
16557 This option specifies the domain name that is added to any envelope sender
16558 addresses that do not have a domain qualification. It also applies to
16559 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16560 are accepted by default only for locally-generated messages. Qualification is
16561 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16562 locally-generated messages, unless the &%-bnq%& command line option is used.
16563
16564 Messages from external sources must always contain fully qualified addresses,
16565 unless the sending host matches &%sender_unqualified_hosts%& or
16566 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16567 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16568 necessary. Internally, Exim always works with fully qualified envelope
16569 addresses. If &%qualify_domain%& is not set, it defaults to the
16570 &%primary_hostname%& value.
16571
16572
16573 .option qualify_recipient main string "see below"
16574 This option allows you to specify a different domain for qualifying recipient
16575 addresses to the one that is used for senders. See &%qualify_domain%& above.
16576
16577
16578
16579 .option queue_domains main "domain list&!!" unset
16580 .cindex "domain" "specifying non-immediate delivery"
16581 .cindex "queueing incoming messages"
16582 .cindex "message" "queueing certain domains"
16583 This option lists domains for which immediate delivery is not required.
16584 A delivery process is started whenever a message is received, but only those
16585 domains that do not match are processed. All other deliveries wait until the
16586 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16587
16588
16589 .option queue_list_requires_admin main boolean true
16590 .cindex "restricting access to features"
16591 .oindex "&%-bp%&"
16592 The &%-bp%& command-line option, which lists the messages that are on the
16593 queue, requires the caller to be an admin user unless
16594 &%queue_list_requires_admin%& is set false.
16595 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16596
16597
16598 .option queue_only main boolean false
16599 .cindex "queueing incoming messages"
16600 .cindex "message" "queueing unconditionally"
16601 If &%queue_only%& is set, a delivery process is not automatically started
16602 whenever a message is received. Instead, the message waits in the queue for the
16603 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16604 delivered immediately when certain conditions (such as heavy load) occur.
16605
16606 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16607 and &%-odi%& command line options override &%queue_only%& unless
16608 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16609 &%queue_only_load%&, and &%smtp_accept_queue%&.
16610
16611
16612 .option queue_only_file main string unset
16613 .cindex "queueing incoming messages"
16614 .cindex "message" "queueing by file existence"
16615 This option can be set to a colon-separated list of absolute path names, each
16616 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16617 it tests for the existence of each listed path using a call to &[stat()]&. For
16618 each path that exists, the corresponding queueing option is set.
16619 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16620 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16621 .code
16622 queue_only_file = smtp/some/file
16623 .endd
16624 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16625 &_/some/file_& exists.
16626
16627
16628 .option queue_only_load main fixed-point unset
16629 .cindex "load average"
16630 .cindex "queueing incoming messages"
16631 .cindex "message" "queueing by load"
16632 If the system load average is higher than this value, incoming messages from
16633 all sources are queued, and no automatic deliveries are started. If this
16634 happens during local or remote SMTP input, all subsequent messages received on
16635 the same SMTP connection are queued by default, whatever happens to the load in
16636 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16637 false.
16638
16639 Deliveries will subsequently be performed by queue runner processes. This
16640 option has no effect on ancient operating systems on which Exim cannot
16641 determine the load average. See also &%deliver_queue_load_max%& and
16642 &%smtp_load_reserve%&.
16643
16644
16645 .option queue_only_load_latch main boolean true
16646 .cindex "load average" "re-evaluating per message"
16647 When this option is true (the default), once one message has been queued
16648 because the load average is higher than the value set by &%queue_only_load%&,
16649 all subsequent messages received on the same SMTP connection are also queued.
16650 This is a deliberate choice; even though the load average may fall below the
16651 threshold, it doesn't seem right to deliver later messages on the same
16652 connection when not delivering earlier ones. However, there are special
16653 circumstances such as very long-lived connections from scanning appliances
16654 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16655 should be set false. This causes the value of the load average to be
16656 re-evaluated for each message.
16657
16658
16659 .option queue_only_override main boolean true
16660 .cindex "queueing incoming messages"
16661 When this option is true, the &%-od%&&'x'& command line options override the
16662 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16663 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16664 to override; they are accepted, but ignored.
16665
16666
16667 .option queue_run_in_order main boolean false
16668 .cindex "queue runner" "processing messages in order"
16669 If this option is set, queue runs happen in order of message arrival instead of
16670 in an arbitrary order. For this to happen, a complete list of the entire queue
16671 must be set up before the deliveries start. When the queue is all held in a
16672 single directory (the default), a single list is created for both the ordered
16673 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16674 single list is not created when &%queue_run_in_order%& is false. In this case,
16675 the sub-directories are processed one at a time (in a random order), and this
16676 avoids setting up one huge list for the whole queue. Thus, setting
16677 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16678 when the queue is large, because of the extra work in setting up the single,
16679 large list. In most situations, &%queue_run_in_order%& should not be set.
16680
16681
16682
16683 .option queue_run_max main integer&!! 5
16684 .cindex "queue runner" "maximum number of"
16685 This controls the maximum number of queue runner processes that an Exim daemon
16686 can run simultaneously. This does not mean that it starts them all at once,
16687 but rather that if the maximum number are still running when the time comes to
16688 start another one, it refrains from starting another one. This can happen with
16689 very large queues and/or very sluggish deliveries. This option does not,
16690 however, interlock with other processes, so additional queue runners can be
16691 started by other means, or by killing and restarting the daemon.
16692
16693 Setting this option to zero does not suppress queue runs; rather, it disables
16694 the limit, allowing any number of simultaneous queue runner processes to be
16695 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16696 the daemon's command line.
16697
16698 .cindex queues named
16699 .cindex "named queues"
16700 To set limits for different named queues use
16701 an expansion depending on the &$queue_name$& variable.
16702
16703 .option queue_smtp_domains main "domain list&!!" unset
16704 .cindex "queueing incoming messages"
16705 .cindex "message" "queueing remote deliveries"
16706 When this option is set, a delivery process is started whenever a message is
16707 received, routing is performed, and local deliveries take place.
16708 However, if any SMTP deliveries are required for domains that match
16709 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16710 message waits in the queue for the next queue run. Since routing of the message
16711 has taken place, Exim knows to which remote hosts it must be delivered, and so
16712 when the queue run happens, multiple messages for the same host are delivered
16713 over a single SMTP connection. The &%-odqs%& command line option causes all
16714 SMTP deliveries to be queued in this way, and is equivalent to setting
16715 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16716 &%queue_domains%&.
16717
16718
16719 .option receive_timeout main time 0s
16720 .cindex "timeout" "for non-SMTP input"
16721 This option sets the timeout for accepting a non-SMTP message, that is, the
16722 maximum time that Exim waits when reading a message on the standard input. If
16723 the value is zero, it will wait forever. This setting is overridden by the
16724 &%-or%& command line option. The timeout for incoming SMTP messages is
16725 controlled by &%smtp_receive_timeout%&.
16726
16727 .option received_header_text main string&!! "see below"
16728 .cindex "customizing" "&'Received:'& header"
16729 .cindex "&'Received:'& header line" "customizing"
16730 This string defines the contents of the &'Received:'& message header that is
16731 added to each message, except for the timestamp, which is automatically added
16732 on at the end (preceded by a semicolon). The string is expanded each time it is
16733 used. If the expansion yields an empty string, no &'Received:'& header line is
16734 added to the message. Otherwise, the string should start with the text
16735 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16736 header lines.
16737 The default setting is:
16738
16739 .code
16740 received_header_text = Received: \
16741   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16742     {${if def:sender_ident \
16743       {from ${quote_local_part:$sender_ident} }}\
16744         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16745   by $primary_hostname \
16746   ${if def:received_protocol {with $received_protocol }}\
16747   ${if def:tls_ver           { ($tls_ver)}}\
16748   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16749   (Exim $version_number)\n\t\
16750   ${if def:sender_address \
16751   {(envelope-from <$sender_address>)\n\t}}\
16752   id $message_exim_id\
16753   ${if def:received_for {\n\tfor $received_for}}
16754 .endd
16755
16756 The reference to the TLS cipher is omitted when Exim is built without TLS
16757 support. The use of conditional expansions ensures that this works for both
16758 locally generated messages and messages received from remote hosts, giving
16759 header lines such as the following:
16760 .code
16761 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16762 by marley.carol.example with esmtp (Exim 4.00)
16763 (envelope-from <bob@carol.example>)
16764 id 16IOWa-00019l-00
16765 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16766 Received: by scrooge.carol.example with local (Exim 4.00)
16767 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16768 .endd
16769 Until the body of the message has been received, the timestamp is the time when
16770 the message started to be received. Once the body has arrived, and all policy
16771 checks have taken place, the timestamp is updated to the time at which the
16772 message was accepted.
16773
16774
16775 .option received_headers_max main integer 30
16776 .cindex "loop" "prevention"
16777 .cindex "mail loop prevention"
16778 .cindex "&'Received:'& header line" "counting"
16779 When a message is to be delivered, the number of &'Received:'& headers is
16780 counted, and if it is greater than this parameter, a mail loop is assumed to
16781 have occurred, the delivery is abandoned, and an error message is generated.
16782 This applies to both local and remote deliveries.
16783
16784
16785 .option recipient_unqualified_hosts main "host list&!!" unset
16786 .cindex "unqualified addresses"
16787 .cindex "host" "unqualified addresses from"
16788 This option lists those hosts from which Exim is prepared to accept unqualified
16789 recipient addresses in message envelopes. The addresses are made fully
16790 qualified by the addition of the &%qualify_recipient%& value. This option also
16791 affects message header lines. Exim does not reject unqualified recipient
16792 addresses in headers, but it qualifies them only if the message came from a
16793 host that matches &%recipient_unqualified_hosts%&,
16794 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16795 option was not set.
16796
16797
16798 .option recipients_max main integer 0
16799 .cindex "limit" "number of recipients"
16800 .cindex "recipient" "maximum number"
16801 If this option is set greater than zero, it specifies the maximum number of
16802 original recipients for any message. Additional recipients that are generated
16803 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16804 all recipients over the limit; earlier recipients are delivered as normal.
16805 Non-SMTP messages with too many recipients are failed, and no deliveries are
16806 done.
16807
16808 .cindex "RCPT" "maximum number of incoming"
16809 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16810 RCPT commands in a single message.
16811
16812
16813 .option recipients_max_reject main boolean false
16814 If this option is set true, Exim rejects SMTP messages containing too many
16815 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16816 error to the eventual DATA command. Otherwise (the default) it gives a 452
16817 error to the surplus RCPT commands and accepts the message on behalf of the
16818 initial set of recipients. The remote server should then re-send the message
16819 for the remaining recipients at a later time.
16820
16821
16822 .option remote_max_parallel main integer 2
16823 .cindex "delivery" "parallelism for remote"
16824 This option controls parallel delivery of one message to a number of remote
16825 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16826 does all the remote deliveries for a message one by one. Otherwise, if a single
16827 message has to be delivered to more than one remote host, or if several copies
16828 have to be sent to the same remote host, up to &%remote_max_parallel%&
16829 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16830 deliveries are required, the maximum number of processes are started, and as
16831 each one finishes, another is begun. The order of starting processes is the
16832 same as if sequential delivery were being done, and can be controlled by the
16833 &%remote_sort_domains%& option. If parallel delivery takes place while running
16834 with debugging turned on, the debugging output from each delivery process is
16835 tagged with its process id.
16836
16837 This option controls only the maximum number of parallel deliveries for one
16838 message in one Exim delivery process. Because Exim has no central queue
16839 manager, there is no way of controlling the total number of simultaneous
16840 deliveries if the configuration allows a delivery attempt as soon as a message
16841 is received.
16842
16843 .cindex "number of deliveries"
16844 .cindex "delivery" "maximum number of"
16845 If you want to control the total number of deliveries on the system, you
16846 need to set the &%queue_only%& option. This ensures that all incoming messages
16847 are added to the queue without starting a delivery process. Then set up an Exim
16848 daemon to start queue runner processes at appropriate intervals (probably
16849 fairly often, for example, every minute), and limit the total number of queue
16850 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16851 delivers only one message at a time, the maximum number of deliveries that can
16852 then take place at once is &%queue_run_max%& multiplied by
16853 &%remote_max_parallel%&.
16854
16855 If it is purely remote deliveries you want to control, use
16856 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16857 doing the SMTP routing before queueing, so that several messages for the same
16858 host will eventually get delivered down the same connection.
16859
16860
16861 .option remote_sort_domains main "domain list&!!" unset
16862 .cindex "sorting remote deliveries"
16863 .cindex "delivery" "sorting remote"
16864 When there are a number of remote deliveries for a message, they are sorted by
16865 domain into the order given by this list. For example,
16866 .code
16867 remote_sort_domains = *.cam.ac.uk:*.uk
16868 .endd
16869 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16870 then to those in the &%uk%& domain, then to any others.
16871
16872
16873 .option retry_data_expire main time 7d
16874 .cindex "hints database" "data expiry"
16875 This option sets a &"use before"& time on retry information in Exim's hints
16876 database. Any older retry data is ignored. This means that, for example, once a
16877 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16878 past failures.
16879
16880
16881 .option retry_interval_max main time 24h
16882 .cindex "retry" "limit on interval"
16883 .cindex "limit" "on retry interval"
16884 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16885 intervals between delivery attempts for messages that cannot be delivered
16886 straight away. This option sets an overall limit to the length of time between
16887 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16888 the default value.
16889
16890
16891 .option return_path_remove main boolean true
16892 .cindex "&'Return-path:'& header line" "removing"
16893 RFC 2821, section 4.4, states that an SMTP server must insert a
16894 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16895 The &'Return-path:'& header preserves the sender address as received in the
16896 MAIL command. This description implies that this header should not be present
16897 in an incoming message. If &%return_path_remove%& is true, any existing
16898 &'Return-path:'& headers are removed from messages at the time they are
16899 received. Exim's transports have options for adding &'Return-path:'& headers at
16900 the time of delivery. They are normally used only for final local deliveries.
16901
16902
16903 .option return_size_limit main integer 100K
16904 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16905
16906
16907 .option rfc1413_hosts main "host list&!!" @[]
16908 .cindex "RFC 1413"
16909 .cindex "host" "for RFC 1413 calls"
16910 RFC 1413 identification calls are made to any client host which matches
16911 an item in the list.
16912 The default value specifies just this host, being any local interface
16913 for the system.
16914
16915 .option rfc1413_query_timeout main time 0s
16916 .cindex "RFC 1413" "query timeout"
16917 .cindex "timeout" "for RFC 1413 call"
16918 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16919 no RFC 1413 calls are ever made.
16920
16921
16922 .option sender_unqualified_hosts main "host list&!!" unset
16923 .cindex "unqualified addresses"
16924 .cindex "host" "unqualified addresses from"
16925 This option lists those hosts from which Exim is prepared to accept unqualified
16926 sender addresses. The addresses are made fully qualified by the addition of
16927 &%qualify_domain%&. This option also affects message header lines. Exim does
16928 not reject unqualified addresses in headers that contain sender addresses, but
16929 it qualifies them only if the message came from a host that matches
16930 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16931 using TCP/IP), and the &%-bnq%& option was not set.
16932
16933
16934 .option slow_lookup_log main integer 0
16935 .cindex "logging" "slow lookups"
16936 .cindex "dns" "logging slow lookups"
16937 This option controls logging of slow lookups.
16938 If the value is nonzero it is taken as a number of milliseconds
16939 and lookups taking longer than this are logged.
16940 Currently this applies only to DNS lookups.
16941
16942
16943
16944 .option smtp_accept_keepalive main boolean true
16945 .cindex "keepalive" "on incoming connection"
16946 This option controls the setting of the SO_KEEPALIVE option on incoming
16947 TCP/IP socket connections. When set, it causes the kernel to probe idle
16948 connections periodically, by sending packets with &"old"& sequence numbers. The
16949 other end of the connection should send an acknowledgment if the connection is
16950 still okay or a reset if the connection has been aborted. The reason for doing
16951 this is that it has the beneficial effect of freeing up certain types of
16952 connection that can get stuck when the remote host is disconnected without
16953 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16954 hours to detect unreachable hosts.
16955
16956
16957
16958 .option smtp_accept_max main integer 20
16959 .cindex "limit" "incoming SMTP connections"
16960 .cindex "SMTP" "incoming connection count"
16961 .cindex "inetd"
16962 This option specifies the maximum number of simultaneous incoming SMTP calls
16963 that Exim will accept. It applies only to the listening daemon; there is no
16964 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16965 value is set to zero, no limit is applied. However, it is required to be
16966 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16967 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16968
16969 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16970 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16971 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16972 and &%smtp_load_reserve%& are then checked before accepting the connection.
16973
16974
16975 .option smtp_accept_max_nonmail main integer 10
16976 .cindex "limit" "non-mail SMTP commands"
16977 .cindex "SMTP" "limiting non-mail commands"
16978 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16979 the connection if there are too many. This option defines &"too many"&. The
16980 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16981 client looping sending EHLO, for example. The check is applied only if the
16982 client host matches &%smtp_accept_max_nonmail_hosts%&.
16983
16984 When a new message is expected, one occurrence of RSET is not counted. This
16985 allows a client to send one RSET between messages (this is not necessary,
16986 but some clients do it). Exim also allows one uncounted occurrence of HELO
16987 or EHLO, and one occurrence of STARTTLS between messages. After
16988 starting up a TLS session, another EHLO is expected, and so it too is not
16989 counted. The first occurrence of AUTH in a connection, or immediately
16990 following STARTTLS is not counted. Otherwise, all commands other than
16991 MAIL, RCPT, DATA, and QUIT are counted.
16992
16993
16994 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16995 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16996 check by setting this option. The default value makes it apply to all hosts. By
16997 changing the value, you can exclude any badly-behaved hosts that you have to
16998 live with.
16999
17000
17001 . Allow this long option name to split; give it unsplit as a fifth argument
17002 . for the automatic .oindex that is generated by .option.
17003 . We insert " &~&~" which is both pretty nasty visually and results in
17004 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17005 . zero-width-space, which would be nicer visually and results in (at least)
17006 . html that Firefox will split on when it's forced to reflow (rather than
17007 . inserting a horizontal scrollbar).  However, the text is still not
17008 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17009 . the option name to split.
17010
17011 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17012          smtp_accept_max_per_connection
17013 .cindex "SMTP" "limiting incoming message count"
17014 .cindex "limit" "messages per SMTP connection"
17015 The value of this option limits the number of MAIL commands that Exim is
17016 prepared to accept over a single SMTP connection, whether or not each command
17017 results in the transfer of a message. After the limit is reached, a 421
17018 response is given to subsequent MAIL commands. This limit is a safety
17019 precaution against a client that goes mad (incidents of this type have been
17020 seen).
17021
17022
17023 .option smtp_accept_max_per_host main string&!! unset
17024 .cindex "limit" "SMTP connections from one host"
17025 .cindex "host" "limiting SMTP connections from"
17026 This option restricts the number of simultaneous IP connections from a single
17027 host (strictly, from a single IP address) to the Exim daemon. The option is
17028 expanded, to enable different limits to be applied to different hosts by
17029 reference to &$sender_host_address$&. Once the limit is reached, additional
17030 connection attempts from the same host are rejected with error code 421. This
17031 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17032 of zero imposes no limit. If this option is set greater than zero, it is
17033 required that &%smtp_accept_max%& be non-zero.
17034
17035 &*Warning*&: When setting this option you should not use any expansion
17036 constructions that take an appreciable amount of time. The expansion and test
17037 happen in the main daemon loop, in order to reject additional connections
17038 without forking additional processes (otherwise a denial-of-service attack
17039 could cause a vast number or processes to be created). While the daemon is
17040 doing this processing, it cannot accept any other incoming connections.
17041
17042
17043
17044 .option smtp_accept_queue main integer 0
17045 .cindex "SMTP" "incoming connection count"
17046 .cindex "queueing incoming messages"
17047 .cindex "message" "queueing by SMTP connection count"
17048 If the number of simultaneous incoming SMTP connections being handled via the
17049 listening daemon exceeds this value, messages received by SMTP are just placed
17050 in the queue; no delivery processes are started automatically. The count is
17051 fixed at the start of an SMTP connection. It cannot be updated in the
17052 subprocess that receives messages, and so the queueing or not queueing applies
17053 to all messages received in the same connection.
17054
17055 A value of zero implies no limit, and clearly any non-zero value is useful only
17056 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17057 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17058 various &%-od%&&'x'& command line options.
17059
17060
17061 . See the comment on smtp_accept_max_per_connection
17062
17063 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17064          smtp_accept_queue_per_connection
17065 .cindex "queueing incoming messages"
17066 .cindex "message" "queueing by message count"
17067 This option limits the number of delivery processes that Exim starts
17068 automatically when receiving messages via SMTP, whether via the daemon or by
17069 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17070 and the number of messages received in a single SMTP session exceeds this
17071 number, subsequent messages are placed in the queue, but no delivery processes
17072 are started. This helps to limit the number of Exim processes when a server
17073 restarts after downtime and there is a lot of mail waiting for it on other
17074 systems. On large systems, the default should probably be increased, and on
17075 dial-in client systems it should probably be set to zero (that is, disabled).
17076
17077
17078 .option smtp_accept_reserve main integer 0
17079 .cindex "SMTP" "incoming call count"
17080 .cindex "host" "reserved"
17081 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17082 number of SMTP connections that are reserved for connections from the hosts
17083 that are specified in &%smtp_reserve_hosts%&. The value set in
17084 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17085 restricted to this number of connections; the option specifies a minimum number
17086 of connection slots for them, not a maximum. It is a guarantee that this group
17087 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17088 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17089 individual host.
17090
17091 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17092 set to 5, once there are 45 active connections (from any hosts), new
17093 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17094 provided the other criteria for acceptance are met.
17095
17096
17097 .option smtp_active_hostname main string&!! unset
17098 .cindex "host" "name in SMTP responses"
17099 .cindex "SMTP" "host name in responses"
17100 .vindex "&$primary_hostname$&"
17101 This option is provided for multi-homed servers that want to masquerade as
17102 several different hosts. At the start of an incoming SMTP connection, its value
17103 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17104 responses. For example, it is used as domain name in the response to an
17105 incoming HELO or EHLO command.
17106
17107 .vindex "&$smtp_active_hostname$&"
17108 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17109 is saved with any messages that are received. It is therefore available for use
17110 in routers and transports when the message is later delivered.
17111
17112 If this option is unset, or if its expansion is forced to fail, or if the
17113 expansion results in an empty string, the value of &$primary_hostname$& is
17114 used. Other expansion failures cause a message to be written to the main and
17115 panic logs, and the SMTP command receives a temporary error. Typically, the
17116 value of &%smtp_active_hostname%& depends on the incoming interface address.
17117 For example:
17118 .code
17119 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17120   {cox.mydomain}{box.mydomain}}
17121 .endd
17122
17123 Although &$smtp_active_hostname$& is primarily concerned with incoming
17124 messages, it is also used as the default for HELO commands in callout
17125 verification if there is no remote transport from which to obtain a
17126 &%helo_data%& value.
17127
17128 .option smtp_banner main string&!! "see below"
17129 .cindex "SMTP" "welcome banner"
17130 .cindex "banner for SMTP"
17131 .cindex "welcome banner for SMTP"
17132 .cindex "customizing" "SMTP banner"
17133 This string, which is expanded every time it is used, is output as the initial
17134 positive response to an SMTP connection. The default setting is:
17135 .code
17136 smtp_banner = $smtp_active_hostname ESMTP Exim \
17137   $version_number $tod_full
17138 .endd
17139 Failure to expand the string causes a panic error. If you want to create a
17140 multiline response to the initial SMTP connection, use &"\n"& in the string at
17141 appropriate points, but not at the end. Note that the 220 code is not included
17142 in this string. Exim adds it automatically (several times in the case of a
17143 multiline response).
17144
17145
17146 .option smtp_check_spool_space main boolean true
17147 .cindex "checking disk space"
17148 .cindex "disk space, checking"
17149 .cindex "spool directory" "checking space"
17150 When this option is set, if an incoming SMTP session encounters the SIZE
17151 option on a MAIL command, it checks that there is enough space in the
17152 spool directory's partition to accept a message of that size, while still
17153 leaving free the amount specified by &%check_spool_space%& (even if that value
17154 is zero). If there isn't enough space, a temporary error code is returned.
17155
17156
17157 .option smtp_connect_backlog main integer 20
17158 .cindex "connection backlog"
17159 .cindex "SMTP" "connection backlog"
17160 .cindex "backlog of connections"
17161 This option specifies a maximum number of waiting SMTP connections. Exim passes
17162 this value to the TCP/IP system when it sets up its listener. Once this number
17163 of connections are waiting for the daemon's attention, subsequent connection
17164 attempts are refused at the TCP/IP level. At least, that is what the manuals
17165 say; in some circumstances such connection attempts have been observed to time
17166 out instead. For large systems it is probably a good idea to increase the
17167 value (to 50, say). It also gives some protection against denial-of-service
17168 attacks by SYN flooding.
17169
17170
17171 .option smtp_enforce_sync main boolean true
17172 .cindex "SMTP" "synchronization checking"
17173 .cindex "synchronization checking in SMTP"
17174 The SMTP protocol specification requires the client to wait for a response from
17175 the server at certain points in the dialogue. Without PIPELINING these
17176 synchronization points are after every command; with PIPELINING they are
17177 fewer, but they still exist.
17178
17179 Some spamming sites send out a complete set of SMTP commands without waiting
17180 for any response. Exim protects against this by rejecting a message if the
17181 client has sent further input when it should not have. The error response &"554
17182 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17183 for this error cannot be perfect because of transmission delays (unexpected
17184 input may be on its way but not yet received when Exim checks). However, it
17185 does detect many instances.
17186
17187 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17188 If you want to disable the check selectively (for example, only for certain
17189 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17190 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17191
17192
17193
17194 .option smtp_etrn_command main string&!! unset
17195 .cindex "ETRN" "command to be run"
17196 .vindex "&$domain$&"
17197 If this option is set, the given command is run whenever an SMTP ETRN
17198 command is received from a host that is permitted to issue such commands (see
17199 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17200 are independently expanded. The expansion variable &$domain$& is set to the
17201 argument of the ETRN command, and no syntax checking is done on it. For
17202 example:
17203 .code
17204 smtp_etrn_command = /etc/etrn_command $domain \
17205                     $sender_host_address
17206 .endd
17207 A new process is created to run the command, but Exim does not wait for it to
17208 complete. Consequently, its status cannot be checked. If the command cannot be
17209 run, a line is written to the panic log, but the ETRN caller still receives
17210 a 250 success response. Exim is normally running under its own uid when
17211 receiving SMTP, so it is not possible for it to change the uid before running
17212 the command.
17213
17214
17215 .option smtp_etrn_serialize main boolean true
17216 .cindex "ETRN" "serializing"
17217 When this option is set, it prevents the simultaneous execution of more than
17218 one identical command as a result of ETRN in an SMTP connection. See
17219 section &<<SECTETRN>>& for details.
17220
17221
17222 .option smtp_load_reserve main fixed-point unset
17223 .cindex "load average"
17224 If the system load average ever gets higher than this, incoming SMTP calls are
17225 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17226 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17227 the load is over the limit. The option has no effect on ancient operating
17228 systems on which Exim cannot determine the load average. See also
17229 &%deliver_queue_load_max%& and &%queue_only_load%&.
17230
17231
17232
17233 .option smtp_max_synprot_errors main integer 3
17234 .cindex "SMTP" "limiting syntax and protocol errors"
17235 .cindex "limit" "SMTP syntax and protocol errors"
17236 Exim rejects SMTP commands that contain syntax or protocol errors. In
17237 particular, a syntactically invalid email address, as in this command:
17238 .code
17239 RCPT TO:<abc xyz@a.b.c>
17240 .endd
17241 causes immediate rejection of the command, before any other tests are done.
17242 (The ACL cannot be run if there is no valid address to set up for it.) An
17243 example of a protocol error is receiving RCPT before MAIL. If there are
17244 too many syntax or protocol errors in one SMTP session, the connection is
17245 dropped. The limit is set by this option.
17246
17247 .cindex "PIPELINING" "expected errors"
17248 When the PIPELINING extension to SMTP is in use, some protocol errors are
17249 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17250 Exim assumes that PIPELINING will be used if it advertises it (see
17251 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17252 not count towards the limit.
17253
17254
17255
17256 .option smtp_max_unknown_commands main integer 3
17257 .cindex "SMTP" "limiting unknown commands"
17258 .cindex "limit" "unknown SMTP commands"
17259 If there are too many unrecognized commands in an incoming SMTP session, an
17260 Exim server drops the connection. This is a defence against some kinds of abuse
17261 that subvert web
17262 clients
17263 into making connections to SMTP ports; in these circumstances, a number of
17264 non-SMTP command lines are sent first.
17265
17266
17267
17268 .option smtp_ratelimit_hosts main "host list&!!" unset
17269 .cindex "SMTP" "rate limiting"
17270 .cindex "limit" "rate of message arrival"
17271 .cindex "RCPT" "rate limiting"
17272 Some sites find it helpful to be able to limit the rate at which certain hosts
17273 can send them messages, and the rate at which an individual message can specify
17274 recipients.
17275
17276 Exim has two rate-limiting facilities. This section describes the older
17277 facility, which can limit rates within a single connection. The newer
17278 &%ratelimit%& ACL condition can limit rates across all connections. See section
17279 &<<SECTratelimiting>>& for details of the newer facility.
17280
17281 When a host matches &%smtp_ratelimit_hosts%&, the values of
17282 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17283 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17284 respectively. Each option, if set, must contain a set of four comma-separated
17285 values:
17286
17287 .ilist
17288 A threshold, before which there is no rate limiting.
17289 .next
17290 An initial time delay. Unlike other times in Exim, numbers with decimal
17291 fractional parts are allowed here.
17292 .next
17293 A factor by which to increase the delay each time.
17294 .next
17295 A maximum value for the delay. This should normally be less than 5 minutes,
17296 because after that time, the client is liable to timeout the SMTP command.
17297 .endlist
17298
17299 For example, these settings have been used successfully at the site which
17300 first suggested this feature, for controlling mail from their customers:
17301 .code
17302 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17303 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17304 .endd
17305 The first setting specifies delays that are applied to MAIL commands after
17306 two have been received over a single connection. The initial delay is 0.5
17307 seconds, increasing by a factor of 1.05 each time. The second setting applies
17308 delays to RCPT commands when more than four occur in a single message.
17309
17310
17311 .option smtp_ratelimit_mail main string unset
17312 See &%smtp_ratelimit_hosts%& above.
17313
17314
17315 .option smtp_ratelimit_rcpt main string unset
17316 See &%smtp_ratelimit_hosts%& above.
17317
17318
17319 .option smtp_receive_timeout main time&!! 5m
17320 .cindex "timeout" "for SMTP input"
17321 .cindex "SMTP" "input timeout"
17322 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17323 input, including batch SMTP. If a line of input (either an SMTP command or a
17324 data line) is not received within this time, the SMTP connection is dropped and
17325 the message is abandoned.
17326 A line is written to the log containing one of the following messages:
17327 .code
17328 SMTP command timeout on connection from...
17329 SMTP data timeout on connection from...
17330 .endd
17331 The former means that Exim was expecting to read an SMTP command; the latter
17332 means that it was in the DATA phase, reading the contents of a message.
17333
17334 If the first character of the option is a &"$"& the option is
17335 expanded before use and may depend on
17336 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17337
17338
17339 .oindex "&%-os%&"
17340 The value set by this option can be overridden by the
17341 &%-os%& command-line option. A setting of zero time disables the timeout, but
17342 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17343 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17344 timeout is controlled by &%receive_timeout%& and &%-or%&.
17345
17346
17347 .option smtp_reserve_hosts main "host list&!!" unset
17348 This option defines hosts for which SMTP connections are reserved; see
17349 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17350
17351
17352 .option smtp_return_error_details main boolean false
17353 .cindex "SMTP" "details policy failures"
17354 .cindex "policy control" "rejection, returning details"
17355 In the default state, Exim uses bland messages such as
17356 &"Administrative prohibition"& when it rejects SMTP commands for policy
17357 reasons. Many sysadmins like this because it gives away little information
17358 to spammers. However, some other sysadmins who are applying strict checking
17359 policies want to give out much fuller information about failures. Setting
17360 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17361 example, instead of &"Administrative prohibition"&, it might give:
17362 .code
17363 550-Rejected after DATA: '>' missing at end of address:
17364 550 failing address in "From" header is: <user@dom.ain
17365 .endd
17366
17367
17368 .option smtputf8_advertise_hosts main "host list&!!" *
17369 .cindex "SMTPUTF8" "advertising"
17370 When Exim is built with support for internationalised mail names,
17371 the availability thereof is advertised in
17372 response to EHLO only to those client hosts that match this option. See
17373 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17374
17375
17376 .option spamd_address main string "127.0.0.1 783"
17377 This option is available when Exim is compiled with the content-scanning
17378 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17379 See section &<<SECTscanspamass>>& for more details.
17380
17381
17382
17383 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17384 This option is available when Exim is compiled with SPF support.
17385 See section &<<SECSPF>>& for more details.
17386
17387
17388
17389 .option split_spool_directory main boolean false
17390 .cindex "multiple spool directories"
17391 .cindex "spool directory" "split"
17392 .cindex "directories, multiple"
17393 If this option is set, it causes Exim to split its input directory into 62
17394 subdirectories, each with a single alphanumeric character as its name. The
17395 sixth character of the message id is used to allocate messages to
17396 subdirectories; this is the least significant base-62 digit of the time of
17397 arrival of the message.
17398
17399 Splitting up the spool in this way may provide better performance on systems
17400 where there are long mail queues, by reducing the number of files in any one
17401 directory. The msglog directory is also split up in a similar way to the input
17402 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17403 are still placed in the single directory &_msglog.OLD_&.
17404
17405 It is not necessary to take any special action for existing messages when
17406 changing &%split_spool_directory%&. Exim notices messages that are in the
17407 &"wrong"& place, and continues to process them. If the option is turned off
17408 after a period of being on, the subdirectories will eventually empty and be
17409 automatically deleted.
17410
17411 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17412 changes. Instead of creating a list of all messages in the queue, and then
17413 trying to deliver each one, in turn, it constructs a list of those in one
17414 sub-directory and tries to deliver them, before moving on to the next
17415 sub-directory. The sub-directories are processed in a random order. This
17416 spreads out the scanning of the input directories, and uses less memory. It is
17417 particularly beneficial when there are lots of messages in the queue. However,
17418 if &%queue_run_in_order%& is set, none of this new processing happens. The
17419 entire queue has to be scanned and sorted before any deliveries can start.
17420
17421
17422 .option spool_directory main string&!! "set at compile time"
17423 .cindex "spool directory" "path to"
17424 This defines the directory in which Exim keeps its spool, that is, the messages
17425 it is waiting to deliver. The default value is taken from the compile-time
17426 configuration setting, if there is one. If not, this option must be set. The
17427 string is expanded, so it can contain, for example, a reference to
17428 &$primary_hostname$&.
17429
17430 If the spool directory name is fixed on your installation, it is recommended
17431 that you set it at build time rather than from this option, particularly if the
17432 log files are being written to the spool directory (see &%log_file_path%&).
17433 Otherwise log files cannot be used for errors that are detected early on, such
17434 as failures in the configuration file.
17435
17436 By using this option to override the compiled-in path, it is possible to run
17437 tests of Exim without using the standard spool.
17438
17439 .option spool_wireformat main boolean false
17440 .cindex "spool directory" "file formats"
17441 If this option is set, Exim may for some messages use an alternative format
17442 for data-files in the spool which matches the wire format.
17443 Doing this permits more efficient message reception and transmission.
17444 Currently it is only done for messages received using the ESMTP CHUNKING
17445 option.
17446
17447 The following variables will not have useful values:
17448 .code
17449 $max_received_linelength
17450 $body_linecount
17451 $body_zerocount
17452 .endd
17453
17454 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17455 and any external programs which are passed a reference to a message data file
17456 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17457 will need to be aware of the different formats potentially available.
17458
17459 Using any of the ACL conditions noted will negate the reception benefit
17460 (as a Unix-mbox-format file is constructed for them).
17461 The transmission benefit is maintained.
17462
17463 .option sqlite_lock_timeout main time 5s
17464 .cindex "sqlite lookup type" "lock timeout"
17465 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17466 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17467
17468 .option strict_acl_vars main boolean false
17469 .cindex "&ACL;" "variables, handling unset"
17470 This option controls what happens if a syntactically valid but undefined ACL
17471 variable is referenced. If it is false (the default), an empty string
17472 is substituted; if it is true, an error is generated. See section
17473 &<<SECTaclvariables>>& for details of ACL variables.
17474
17475 .option strip_excess_angle_brackets main boolean false
17476 .cindex "angle brackets, excess"
17477 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17478 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17479 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17480 passed on to another MTA, the excess angle brackets are not passed on. If this
17481 option is not set, multiple pairs of angle brackets cause a syntax error.
17482
17483
17484 .option strip_trailing_dot main boolean false
17485 .cindex "trailing dot on domain"
17486 .cindex "dot" "trailing on domain"
17487 If this option is set, a trailing dot at the end of a domain in an address is
17488 ignored. If this is in the envelope and the message is passed on to another
17489 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17490 domain causes a syntax error.
17491 However, addresses in header lines are checked only when an ACL requests header
17492 syntax checking.
17493
17494
17495 .option syslog_duplication main boolean true
17496 .cindex "syslog" "duplicate log lines; suppressing"
17497 When Exim is logging to syslog, it writes the log lines for its three
17498 separate logs at different syslog priorities so that they can in principle
17499 be separated on the logging hosts. Some installations do not require this
17500 separation, and in those cases, the duplication of certain log lines is a
17501 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17502 particular log line is written to syslog. For lines that normally go to
17503 both the main log and the reject log, the reject log version (possibly
17504 containing message header lines) is written, at LOG_NOTICE priority.
17505 Lines that normally go to both the main and the panic log are written at
17506 the LOG_ALERT priority.
17507
17508
17509 .option syslog_facility main string unset
17510 .cindex "syslog" "facility; setting"
17511 This option sets the syslog &"facility"& name, used when Exim is logging to
17512 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17513 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17514 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17515 details of Exim's logging.
17516
17517
17518 .option syslog_pid main boolean true
17519 .cindex "syslog" "pid"
17520 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17521 omitted when these lines are sent to syslog. (Syslog normally prefixes
17522 the log lines with the PID of the logging process automatically.) You need
17523 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17524 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17525
17526
17527
17528 .option syslog_processname main string &`exim`&
17529 .cindex "syslog" "process name; setting"
17530 This option sets the syslog &"ident"& name, used when Exim is logging to
17531 syslog. The value must be no longer than 32 characters. See chapter
17532 &<<CHAPlog>>& for details of Exim's logging.
17533
17534
17535
17536 .option syslog_timestamp main boolean true
17537 .cindex "syslog" "timestamps"
17538 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17539 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17540 details of Exim's logging.
17541
17542
17543 .option system_filter main string&!! unset
17544 .cindex "filter" "system filter"
17545 .cindex "system filter" "specifying"
17546 .cindex "Sieve filter" "not available for system filter"
17547 This option specifies an Exim filter file that is applied to all messages at
17548 the start of each delivery attempt, before any routing is done. System filters
17549 must be Exim filters; they cannot be Sieve filters. If the system filter
17550 generates any deliveries to files or pipes, or any new mail messages, the
17551 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17552 which transports are to be used. Details of this facility are given in chapter
17553 &<<CHAPsystemfilter>>&.
17554 A forced expansion failure results in no filter operation.
17555
17556
17557 .option system_filter_directory_transport main string&!! unset
17558 .vindex "&$address_file$&"
17559 This sets the name of the transport driver that is to be used when the
17560 &%save%& command in a system message filter specifies a path ending in &"/"&,
17561 implying delivery of each message into a separate file in some directory.
17562 During the delivery, the variable &$address_file$& contains the path name.
17563
17564
17565 .option system_filter_file_transport main string&!! unset
17566 .cindex "file" "transport for system filter"
17567 This sets the name of the transport driver that is to be used when the &%save%&
17568 command in a system message filter specifies a path not ending in &"/"&. During
17569 the delivery, the variable &$address_file$& contains the path name.
17570
17571 .option system_filter_group main string unset
17572 .cindex "gid (group id)" "system filter"
17573 This option is used only when &%system_filter_user%& is also set. It sets the
17574 gid under which the system filter is run, overriding any gid that is associated
17575 with the user. The value may be numerical or symbolic.
17576
17577 .option system_filter_pipe_transport main string&!! unset
17578 .cindex "&(pipe)& transport" "for system filter"
17579 .vindex "&$address_pipe$&"
17580 This specifies the transport driver that is to be used when a &%pipe%& command
17581 is used in a system filter. During the delivery, the variable &$address_pipe$&
17582 contains the pipe command.
17583
17584
17585 .option system_filter_reply_transport main string&!! unset
17586 .cindex "&(autoreply)& transport" "for system filter"
17587 This specifies the transport driver that is to be used when a &%mail%& command
17588 is used in a system filter.
17589
17590
17591 .option system_filter_user main string unset
17592 .cindex "uid (user id)" "system filter"
17593 If this option is set to root, the system filter is run in the main Exim
17594 delivery process, as root.  Otherwise, the system filter runs in a separate
17595 process, as the given user, defaulting to the Exim run-time user.
17596 Unless the string consists entirely of digits, it
17597 is looked up in the password data. Failure to find the named user causes a
17598 configuration error. The gid is either taken from the password data, or
17599 specified by &%system_filter_group%&. When the uid is specified numerically,
17600 &%system_filter_group%& is required to be set.
17601
17602 If the system filter generates any pipe, file, or reply deliveries, the uid
17603 under which the filter is run is used when transporting them, unless a
17604 transport option overrides.
17605
17606
17607 .option tcp_nodelay main boolean true
17608 .cindex "daemon" "TCP_NODELAY on sockets"
17609 .cindex "Nagle algorithm"
17610 .cindex "TCP_NODELAY on listening sockets"
17611 If this option is set false, it stops the Exim daemon setting the
17612 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17613 turns off the &"Nagle algorithm"&, which is a way of improving network
17614 performance in interactive (character-by-character) situations. Turning it off
17615 should improve Exim's performance a bit, so that is what happens by default.
17616 However, it appears that some broken clients cannot cope, and time out. Hence
17617 this option. It affects only those sockets that are set up for listening by the
17618 daemon. Sockets created by the smtp transport for delivering mail always set
17619 TCP_NODELAY.
17620
17621
17622 .option timeout_frozen_after main time 0s
17623 .cindex "frozen messages" "timing out"
17624 .cindex "timeout" "frozen messages"
17625 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17626 message of any kind that has been in the queue for longer than the given time
17627 is automatically cancelled at the next queue run. If the frozen message is a
17628 bounce message, it is just discarded; otherwise, a bounce is sent to the
17629 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17630 If you want to timeout frozen bounce messages earlier than other kinds of
17631 frozen message, see &%ignore_bounce_errors_after%&.
17632
17633 &*Note:*& the default value of zero means no timeouts; with this setting,
17634 frozen messages remain in the queue forever (except for any frozen bounce
17635 messages that are released by &%ignore_bounce_errors_after%&).
17636
17637
17638 .option timezone main string unset
17639 .cindex "timezone, setting"
17640 .cindex "environment" "values from"
17641 The value of &%timezone%& is used to set the environment variable TZ while
17642 running Exim (if it is different on entry). This ensures that all timestamps
17643 created by Exim are in the required timezone. If you want all your timestamps
17644 to be in UTC (aka GMT) you should set
17645 .code
17646 timezone = UTC
17647 .endd
17648 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17649 or, if that is not set, from the value of the TZ environment variable when Exim
17650 is built. If &%timezone%& is set to the empty string, either at build or run
17651 time, any existing TZ variable is removed from the environment when Exim
17652 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17653 unfortunately not all, operating systems.
17654
17655
17656 .option tls_advertise_hosts main "host list&!!" *
17657 .cindex "TLS" "advertising"
17658 .cindex "encryption" "on SMTP connection"
17659 .cindex "SMTP" "encrypted connection"
17660 When Exim is built with support for TLS encrypted connections, the availability
17661 of the STARTTLS command to set up an encrypted session is advertised in
17662 response to EHLO only to those client hosts that match this option. See
17663 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17664 Note that the default value requires that a certificate be supplied
17665 using the &%tls_certificate%& option.  If TLS support for incoming connections
17666 is not required the &%tls_advertise_hosts%& option should be set empty.
17667
17668
17669 .option tls_certificate main string list&!! unset
17670 .cindex "TLS" "server certificate; location of"
17671 .cindex "certificate" "server, location of"
17672 The value of this option is expanded, and must then be a list of absolute paths to
17673 files which contain the server's certificates (in PEM format).
17674 Commonly only one file is needed.
17675 The server's private key is also
17676 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17677 &<<CHAPTLS>>& for further details.
17678
17679 &*Note*&: The certificates defined by this option are used only when Exim is
17680 receiving incoming messages as a server. If you want to supply certificates for
17681 use when sending messages as a client, you must set the &%tls_certificate%&
17682 option in the relevant &(smtp)& transport.
17683
17684 &*Note*&: If you use filenames based on IP addresses, change the list
17685 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17686
17687 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17688 when a list of more than one
17689 file is used, the &$tls_in_ourcert$& variable is unreliable.
17690 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17691
17692 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17693 if the OpenSSL build supports TLS extensions and the TLS client sends the
17694 Server Name Indication extension, then this option and others documented in
17695 &<<SECTtlssni>>& will be re-expanded.
17696
17697 If this option is unset or empty a fresh self-signed certificate will be
17698 generated for every connection.
17699
17700 .option tls_crl main string&!! unset
17701 .cindex "TLS" "server certificate revocation list"
17702 .cindex "certificate" "revocation list for server"
17703 This option specifies a certificate revocation list. The expanded value must
17704 be the name of a file that contains CRLs in PEM format.
17705
17706 Under OpenSSL the option can specify a directory with CRL files.
17707
17708 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17709 for each signing element of the certificate chain (i.e. all but the leaf).
17710 For the file variant this can be multiple PEM blocks in the one file.
17711
17712 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17713
17714
17715 .option tls_dh_max_bits main integer 2236
17716 .cindex "TLS" "D-H bit count"
17717 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17718 the chosen TLS library.  That value might prove to be too high for
17719 interoperability.  This option provides a maximum clamp on the value
17720 suggested, trading off security for interoperability.
17721
17722 The value must be at least 1024.
17723
17724 The value 2236 was chosen because, at time of adding the option, it was the
17725 hard-coded maximum value supported by the NSS cryptographic library, as used
17726 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17727
17728 If you prefer more security and are willing to break some clients, raise this
17729 number.
17730
17731 Note that the value passed to GnuTLS for *generating* a new prime may be a
17732 little less than this figure, because GnuTLS is inexact and may produce a
17733 larger prime than requested.
17734
17735
17736 .option tls_dhparam main string&!! unset
17737 .cindex "TLS" "D-H parameters for server"
17738 The value of this option is expanded and indicates the source of DH parameters
17739 to be used by Exim.
17740
17741 This option is ignored for GnuTLS version 3.6.0 and later.
17742 The library manages parameter negotiation internally.
17743
17744 &*Note: The Exim Maintainers strongly recommend,
17745 for other TLS library versions,
17746 using a filename with site-generated
17747 local DH parameters*&, which has been supported across all versions of Exim.  The
17748 other specific constants available are a fallback so that even when
17749 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17750
17751 If &%tls_dhparam%& is a filename starting with a &`/`&,
17752 then it names a file from which DH
17753 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17754 PKCS#3 representation of the DH prime.  If the file does not exist, for
17755 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17756 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17757 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17758 and treated as though the &%tls_dhparam%& were set to "none".
17759
17760 If this option expands to the string "none", then no DH parameters will be
17761 loaded by Exim.
17762
17763 If this option expands to the string "historic" and Exim is using GnuTLS, then
17764 Exim will attempt to load a file from inside the spool directory.  If the file
17765 does not exist, Exim will attempt to create it.
17766 See section &<<SECTgnutlsparam>>& for further details.
17767
17768 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17769 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17770
17771 In older versions of Exim the default was the 2048 bit prime described in section
17772 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17773 in IKE is assigned number 23.
17774
17775 Otherwise, the option must expand to the name used by Exim for any of a number
17776 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17777 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17778 the number used by IKE, or "default" which corresponds to
17779 &`exim.dev.20160529.3`&.
17780
17781 The available standard primes are:
17782 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17783 &`ike1`&, &`ike2`&, &`ike5`&,
17784 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17785 &`ike22`&, &`ike23`& and &`ike24`&.
17786
17787 The available additional primes are:
17788 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17789
17790 Some of these will be too small to be accepted by clients.
17791 Some may be too large to be accepted by clients.
17792 The open cryptographic community has suspicions about the integrity of some
17793 of the later IKE values, which led into RFC7919 providing new fixed constants
17794 (the "ffdhe" identifiers).
17795
17796 At this point, all of the "ike" values should be considered obsolete;
17797 they're still in Exim to avoid breaking unusual configurations, but are
17798 candidates for removal the next time we have backwards-incompatible changes.
17799
17800 The TLS protocol does not negotiate an acceptable size for this; clients tend
17801 to hard-drop connections if what is offered by the server is unacceptable,
17802 whether too large or too small, and there's no provision for the client to
17803 tell the server what these constraints are.  Thus, as a server operator, you
17804 need to make an educated guess as to what is most likely to work for your
17805 userbase.
17806
17807 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17808 is most likely to maximise interoperability.  The upper bound comes from
17809 applications using the Mozilla Network Security Services (NSS) library, which
17810 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17811 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17812 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17813 acceptable bound from 1024 to 2048.
17814
17815
17816 .option tls_eccurve main string&!! &`auto`&
17817 .cindex TLS "EC cryptography"
17818 This option selects a EC curve for use by Exim when used with OpenSSL.
17819 It has no effect when Exim is used with GnuTLS.
17820
17821 After expansion it must contain a valid EC curve parameter, such as
17822 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17823 for valid selections.
17824
17825 For OpenSSL versions before (and not including) 1.0.2, the string
17826 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17827 &`auto`& tells the library to choose.
17828
17829 If the option expands to an empty string, no EC curves will be enabled.
17830
17831
17832 .option tls_ocsp_file main string&!! unset
17833 .cindex TLS "certificate status"
17834 .cindex TLS "OCSP proof file"
17835 This option
17836 must if set expand to the absolute path to a file which contains a current
17837 status proof for the server's certificate, as obtained from the
17838 Certificate Authority.
17839
17840 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17841 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
17842
17843 For OpenSSL 1.1.0 or later, and
17844 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17845 of files, to match a list given for the &%tls_certificate%& option.
17846 The ordering of the two lists must match.
17847 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
17848
17849 The file(s) should be in DER format,
17850 except for GnuTLS 3.6.3 or later
17851 or for OpenSSL,
17852 when an optional filetype prefix can be used.
17853 The prefix must be one of "DER" or "PEM", followed by
17854 a single space.  If one is used it sets the format for subsequent
17855 files in the list; the initial format is DER.
17856 If multiple proofs are wanted, for multiple chain elements
17857 (this only works under TLS1.3)
17858 they must be coded as a combined OCSP response.
17859
17860 Although GnuTLS will accept PEM files with multiple separate
17861 PEM blobs (ie. separate OCSP responses), it sends them in the
17862 TLS Certificate record interleaved with the certificates of the chain;
17863 although a GnuTLS client is happy with that, an OpenSSL client is not.
17864
17865 .option tls_on_connect_ports main "string list" unset
17866 .cindex SSMTP
17867 .cindex SMTPS
17868 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17869 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17870 set up without waiting for the client to issue a STARTTLS command. For
17871 further details, see section &<<SECTsupobssmt>>&.
17872
17873
17874
17875 .option tls_privatekey main string list&!! unset
17876 .cindex "TLS" "server private key; location of"
17877 The value of this option is expanded, and must then be a list of absolute paths to
17878 files which contains the server's private keys.
17879 If this option is unset, or if
17880 the expansion is forced to fail, or the result is an empty string, the private
17881 key is assumed to be in the same file as the server's certificates. See chapter
17882 &<<CHAPTLS>>& for further details.
17883
17884 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17885
17886
17887 .option tls_remember_esmtp main boolean false
17888 .cindex "TLS" "esmtp state; remembering"
17889 .cindex "TLS" "broken clients"
17890 If this option is set true, Exim violates the RFCs by remembering that it is in
17891 &"esmtp"& state after successfully negotiating a TLS session. This provides
17892 support for broken clients that fail to send a new EHLO after starting a
17893 TLS session.
17894
17895
17896 .option tls_require_ciphers main string&!! unset
17897 .cindex "TLS" "requiring specific ciphers"
17898 .cindex "cipher" "requiring specific"
17899 This option controls which ciphers can be used for incoming TLS connections.
17900 The &(smtp)& transport has an option of the same name for controlling outgoing
17901 connections. This option is expanded for each connection, so can be varied for
17902 different clients if required. The value of this option must be a list of
17903 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17904 in somewhat different ways. If GnuTLS is being used, the client controls the
17905 preference order of the available ciphers. Details are given in sections
17906 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17907
17908
17909 .option tls_try_verify_hosts main "host list&!!" unset
17910 .cindex "TLS" "client certificate verification"
17911 .cindex "certificate" "verification of client"
17912 See &%tls_verify_hosts%& below.
17913
17914
17915 .option tls_verify_certificates main string&!! system
17916 .cindex "TLS" "client certificate verification"
17917 .cindex "certificate" "verification of client"
17918 The value of this option is expanded, and must then be either the
17919 word "system"
17920 or the absolute path to
17921 a file or directory containing permitted certificates for clients that
17922 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17923
17924 The "system" value for the option will use a
17925 system default location compiled into the SSL library.
17926 This is not available for GnuTLS versions preceding 3.0.20,
17927 and will be taken as empty; an explicit location
17928 must be specified.
17929
17930 The use of a directory for the option value is not available for GnuTLS versions
17931 preceding 3.3.6 and a single file must be used.
17932
17933 With OpenSSL the certificates specified
17934 explicitly
17935 either by file or directory
17936 are added to those given by the system default location.
17937
17938 These certificates should be for the certificate authorities trusted, rather
17939 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17940 the value is a file then the certificates are sent by Exim as a server to
17941 connecting clients, defining the list of accepted certificate authorities.
17942 Thus the values defined should be considered public data.  To avoid this,
17943 use the explicit directory version.
17944
17945 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17946
17947 A forced expansion failure or setting to an empty string is equivalent to
17948 being unset.
17949
17950
17951 .option tls_verify_hosts main "host list&!!" unset
17952 .cindex "TLS" "client certificate verification"
17953 .cindex "certificate" "verification of client"
17954 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17955 certificates from clients. The expected certificates are defined by
17956 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17957 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17958 &%tls_verify_certificates%& is not set.
17959
17960 Any client that matches &%tls_verify_hosts%& is constrained by
17961 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17962 present one of the listed certificates. If it does not, the connection is
17963 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17964 the host to use TLS. It can still send SMTP commands through unencrypted
17965 connections. Forcing a client to use TLS has to be done separately using an
17966 ACL to reject inappropriate commands when the connection is not encrypted.
17967
17968 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17969 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17970 certificate and checks it against &%tls_verify_certificates%&, but does not
17971 abort the connection if there is no certificate or if it does not match. This
17972 state can be detected in an ACL, which makes it possible to implement policies
17973 such as &"accept for relay only if a verified certificate has been received,
17974 but accept for local delivery if encrypted, even without a verified
17975 certificate"&.
17976
17977 Client hosts that match neither of these lists are not asked to present
17978 certificates.
17979
17980
17981 .option trusted_groups main "string list&!!" unset
17982 .cindex "trusted groups"
17983 .cindex "groups" "trusted"
17984 This option is expanded just once, at the start of Exim's processing. If this
17985 option is set, any process that is running in one of the listed groups, or
17986 which has one of them as a supplementary group, is trusted. The groups can be
17987 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17988 details of what trusted callers are permitted to do. If neither
17989 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17990 are trusted.
17991
17992 .option trusted_users main "string list&!!" unset
17993 .cindex "trusted users"
17994 .cindex "user" "trusted"
17995 This option is expanded just once, at the start of Exim's processing. If this
17996 option is set, any process that is running as one of the listed users is
17997 trusted. The users can be specified numerically or by name. See section
17998 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17999 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18000 Exim user are trusted.
18001
18002 .option unknown_login main string&!! unset
18003 .cindex "uid (user id)" "unknown caller"
18004 .vindex "&$caller_uid$&"
18005 This is a specialized feature for use in unusual configurations. By default, if
18006 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18007 gives up. The &%unknown_login%& option can be used to set a login name to be
18008 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18009 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18010 is used for the user's real name (gecos field), unless this has been set by the
18011 &%-F%& option.
18012
18013 .option unknown_username main string unset
18014 See &%unknown_login%&.
18015
18016 .option untrusted_set_sender main "address list&!!" unset
18017 .cindex "trusted users"
18018 .cindex "sender" "setting by untrusted user"
18019 .cindex "untrusted user setting sender"
18020 .cindex "user" "untrusted setting sender"
18021 .cindex "envelope from"
18022 .cindex "envelope sender"
18023 When an untrusted user submits a message to Exim using the standard input, Exim
18024 normally creates an envelope sender address from the user's login and the
18025 default qualification domain. Data from the &%-f%& option (for setting envelope
18026 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18027 is used) is ignored.
18028
18029 However, untrusted users are permitted to set an empty envelope sender address,
18030 to declare that a message should never generate any bounces. For example:
18031 .code
18032 exim -f '<>' user@domain.example
18033 .endd
18034 .vindex "&$sender_ident$&"
18035 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18036 other envelope sender addresses in a controlled way. When it is set, untrusted
18037 users are allowed to set envelope sender addresses that match any of the
18038 patterns in the list. Like all address lists, the string is expanded. The
18039 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18040 users to setting senders that start with their login ids
18041 followed by a hyphen
18042 by a setting like this:
18043 .code
18044 untrusted_set_sender = ^$sender_ident-
18045 .endd
18046 If you want to allow untrusted users to set envelope sender addresses without
18047 restriction, you can use
18048 .code
18049 untrusted_set_sender = *
18050 .endd
18051 The &%untrusted_set_sender%& option applies to all forms of local input, but
18052 only to the setting of the envelope sender. It does not permit untrusted users
18053 to use the other options which trusted user can use to override message
18054 parameters. Furthermore, it does not stop Exim from removing an existing
18055 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18056 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18057 overriding these actions. The handling of the &'Sender:'& header is also
18058 described in section &<<SECTthesenhea>>&.
18059
18060 The log line for a message's arrival shows the envelope sender following
18061 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18062 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18063 envelope sender address, the user's login is shown in parentheses after the
18064 sender address.
18065
18066
18067 .option uucp_from_pattern main string "see below"
18068 .cindex "&""From""& line"
18069 .cindex "UUCP" "&""From""& line"
18070 Some applications that pass messages to an MTA via a command line interface use
18071 an initial line starting with &"From&~"& to pass the envelope sender. In
18072 particular, this is used by UUCP software. Exim recognizes such a line by means
18073 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18074 matches, the sender address is constructed by expanding the contents of
18075 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18076 default pattern recognizes lines in the following two forms:
18077 .code
18078 From ph10 Fri Jan  5 12:35 GMT 1996
18079 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18080 .endd
18081 The pattern can be seen by running
18082 .code
18083 exim -bP uucp_from_pattern
18084 .endd
18085 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18086 year in the second case. The first word after &"From&~"& is matched in the
18087 regular expression by a parenthesized subpattern. The default value for
18088 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18089 (&"ph10"& in the example above) as the message's sender. See also
18090 &%ignore_fromline_hosts%&.
18091
18092
18093 .option uucp_from_sender main string&!! &`$1`&
18094 See &%uucp_from_pattern%& above.
18095
18096
18097 .option warn_message_file main string unset
18098 .cindex "warning of delay" "customizing the message"
18099 .cindex "customizing" "warning message"
18100 This option defines a template file containing paragraphs of text to be used
18101 for constructing the warning message which is sent by Exim when a message has
18102 been in the queue for a specified amount of time, as specified by
18103 &%delay_warning%&. Details of the file's contents are given in chapter
18104 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18105
18106
18107 .option write_rejectlog main boolean true
18108 .cindex "reject log" "disabling"
18109 If this option is set false, Exim no longer writes anything to the reject log.
18110 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18111 .ecindex IIDconfima
18112 .ecindex IIDmaiconf
18113
18114
18115
18116
18117 . ////////////////////////////////////////////////////////////////////////////
18118 . ////////////////////////////////////////////////////////////////////////////
18119
18120 .chapter "Generic options for routers" "CHAProutergeneric"
18121 .scindex IIDgenoprou1 "options" "generic; for routers"
18122 .scindex IIDgenoprou2 "generic options" "router"
18123 This chapter describes the generic options that apply to all routers.
18124 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18125
18126 For a general description of how a router operates, see sections
18127 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18128 which the preconditions are tested. The order of expansion of the options that
18129 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18130 &%headers_remove%&, &%transport%&.
18131
18132
18133
18134 .option address_data routers string&!! unset
18135 .cindex "router" "data attached to address"
18136 The string is expanded just before the router is run, that is, after all the
18137 precondition tests have succeeded. If the expansion is forced to fail, the
18138 router declines, the value of &%address_data%& remains unchanged, and the
18139 &%more%& option controls what happens next. Other expansion failures cause
18140 delivery of the address to be deferred.
18141
18142 .vindex "&$address_data$&"
18143 When the expansion succeeds, the value is retained with the address, and can be
18144 accessed using the variable &$address_data$& in the current router, subsequent
18145 routers, and the eventual transport.
18146
18147 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18148 that runs a user's filter file, the contents of &$address_data$& are accessible
18149 in the filter. This is not normally a problem, because such data is usually
18150 either not confidential or it &"belongs"& to the current user, but if you do
18151 put confidential data into &$address_data$& you need to remember this point.
18152
18153 Even if the router declines or passes, the value of &$address_data$& remains
18154 with the address, though it can be changed by another &%address_data%& setting
18155 on a subsequent router. If a router generates child addresses, the value of
18156 &$address_data$& propagates to them. This also applies to the special kind of
18157 &"child"& that is generated by a router with the &%unseen%& option.
18158
18159 The idea of &%address_data%& is that you can use it to look up a lot of data
18160 for the address once, and then pick out parts of the data later. For example,
18161 you could use a single LDAP lookup to return a string of the form
18162 .code
18163 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18164 .endd
18165 In the transport you could pick out the mailbox by a setting such as
18166 .code
18167 file = ${extract{mailbox}{$address_data}}
18168 .endd
18169 This makes the configuration file less messy, and also reduces the number of
18170 lookups (though Exim does cache lookups).
18171
18172 See also the &%set%& option below.
18173
18174 .vindex "&$sender_address_data$&"
18175 .vindex "&$address_data$&"
18176 The &%address_data%& facility is also useful as a means of passing information
18177 from one router to another, and from a router to a transport. In addition, if
18178 &$address_data$& is set by a router when verifying a recipient address from an
18179 ACL, it remains available for use in the rest of the ACL statement. After
18180 verifying a sender, the value is transferred to &$sender_address_data$&.
18181
18182
18183
18184 .option address_test routers&!? boolean true
18185 .oindex "&%-bt%&"
18186 .cindex "router" "skipping when address testing"
18187 If this option is set false, the router is skipped when routing is being tested
18188 by means of the &%-bt%& command line option. This can be a convenience when
18189 your first router sends messages to an external scanner, because it saves you
18190 having to set the &"already scanned"& indicator when testing real address
18191 routing.
18192
18193
18194
18195 .option cannot_route_message routers string&!! unset
18196 .cindex "router" "customizing &""cannot route""& message"
18197 .cindex "customizing" "&""cannot route""& message"
18198 This option specifies a text message that is used when an address cannot be
18199 routed because Exim has run out of routers. The default message is
18200 &"Unrouteable address"&. This option is useful only on routers that have
18201 &%more%& set false, or on the very last router in a configuration, because the
18202 value that is used is taken from the last router that is considered. This
18203 includes a router that is skipped because its preconditions are not met, as
18204 well as a router that declines. For example, using the default configuration,
18205 you could put:
18206 .code
18207 cannot_route_message = Remote domain not found in DNS
18208 .endd
18209 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18210 and
18211 .code
18212 cannot_route_message = Unknown local user
18213 .endd
18214 on the final router that checks for local users. If string expansion fails for
18215 this option, the default message is used. Unless the expansion failure was
18216 explicitly forced, a message about the failure is written to the main and panic
18217 logs, in addition to the normal message about the routing failure.
18218
18219
18220 .option caseful_local_part routers boolean false
18221 .cindex "case of local parts"
18222 .cindex "router" "case of local parts"
18223 By default, routers handle the local parts of addresses in a case-insensitive
18224 manner, though the actual case is preserved for transmission with the message.
18225 If you want the case of letters to be significant in a router, you must set
18226 this option true. For individual router options that contain address or local
18227 part lists (for example, &%local_parts%&), case-sensitive matching can be
18228 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18229 more details.
18230
18231 .vindex "&$local_part$&"
18232 .vindex "&$original_local_part$&"
18233 .vindex "&$parent_local_part$&"
18234 The value of the &$local_part$& variable is forced to lower case while a
18235 router is running unless &%caseful_local_part%& is set. When a router assigns
18236 an address to a transport, the value of &$local_part$& when the transport runs
18237 is the same as it was in the router. Similarly, when a router generates child
18238 addresses by aliasing or forwarding, the values of &$original_local_part$&
18239 and &$parent_local_part$& are those that were used by the redirecting router.
18240
18241 This option applies to the processing of an address by a router. When a
18242 recipient address is being processed in an ACL, there is a separate &%control%&
18243 modifier that can be used to specify case-sensitive processing within the ACL
18244 (see section &<<SECTcontrols>>&).
18245
18246
18247
18248 .option check_local_user routers&!? boolean false
18249 .cindex "local user, checking in router"
18250 .cindex "router" "checking for local user"
18251 .cindex "&_/etc/passwd_&"
18252 .vindex "&$home$&"
18253 When this option is true, Exim checks that the local part of the recipient
18254 address (with affixes removed if relevant) is the name of an account on the
18255 local system. The check is done by calling the &[getpwnam()]& function rather
18256 than trying to read &_/etc/passwd_& directly. This means that other methods of
18257 holding password data (such as NIS) are supported. If the local part is a local
18258 user, &$home$& is set from the password data, and can be tested in other
18259 preconditions that are evaluated after this one (the order of evaluation is
18260 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18261 overridden by &%router_home_directory%&. If the local part is not a local user,
18262 the router is skipped.
18263
18264 If you want to check that the local part is either the name of a local user
18265 or matches something else, you cannot combine &%check_local_user%& with a
18266 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18267 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18268 setting to achieve this. For example:
18269 .code
18270 local_parts = passwd;$local_part : lsearch;/etc/other/users
18271 .endd
18272 Note, however, that the side effects of &%check_local_user%& (such as setting
18273 up a home directory) do not occur when a &(passwd)& lookup is used in a
18274 &%local_parts%& (or any other) precondition.
18275
18276
18277
18278 .option condition routers&!? string&!! unset
18279 .cindex "router" "customized precondition"
18280 This option specifies a general precondition test that has to succeed for the
18281 router to be called. The &%condition%& option is the last precondition to be
18282 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18283 result is a forced failure, or an empty string, or one of the strings &"0"& or
18284 &"no"& or &"false"& (checked without regard to the case of the letters), the
18285 router is skipped, and the address is offered to the next one.
18286
18287 If the result is any other value, the router is run (as this is the last
18288 precondition to be evaluated, all the other preconditions must be true).
18289
18290 This option is unusual in that multiple &%condition%& options may be present.
18291 All &%condition%& options must succeed.
18292
18293 The &%condition%& option provides a means of applying custom conditions to the
18294 running of routers. Note that in the case of a simple conditional expansion,
18295 the default expansion values are exactly what is wanted. For example:
18296 .code
18297 condition = ${if >{$message_age}{600}}
18298 .endd
18299 Because of the default behaviour of the string expansion, this is equivalent to
18300 .code
18301 condition = ${if >{$message_age}{600}{true}{}}
18302 .endd
18303
18304 A multiple condition example, which succeeds:
18305 .code
18306 condition = ${if >{$message_age}{600}}
18307 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18308 condition = foobar
18309 .endd
18310
18311 If the expansion fails (other than forced failure) delivery is deferred. Some
18312 of the other precondition options are common special cases that could in fact
18313 be specified using &%condition%&.
18314
18315 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18316 are far older, and use one set of semantics.  ACLs are newer and when
18317 they were created, the ACL &%condition%& process was given far stricter
18318 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18319 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18320 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18321 Router rules processing behavior.
18322
18323 This is best illustrated in an example:
18324 .code
18325 # If used in an ACL condition will fail with a syntax error, but
18326 # in a router condition any extra characters are treated as a string
18327
18328 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18329 true {yes} {no}}
18330
18331 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18332  {yes} {no}}
18333 .endd
18334 In each example above, the &%if%& statement actually ends after
18335 &"{google.com}}"&.  Since no true or false braces were defined, the
18336 default &%if%& behavior is to return a boolean true or a null answer
18337 (which evaluates to false). The rest of the line is then treated as a
18338 string. So the first example resulted in the boolean answer &"true"&
18339 with the string &" {yes} {no}}"& appended to it. The second example
18340 resulted in the null output (indicating false) with the string
18341 &" {yes} {no}}"& appended to it.
18342
18343 In fact you can put excess forward braces in too.  In the router
18344 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18345 mean something, like after a &"$"& or when required as part of a
18346 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18347 string characters.
18348
18349 Thus, in a Router, the above expansion strings will both always evaluate
18350 true, as the result of expansion is a non-empty string which doesn't
18351 match an explicit false value.  This can be tricky to debug.  By
18352 contrast, in an ACL either of those strings will always result in an
18353 expansion error because the result doesn't look sufficiently boolean.
18354
18355
18356 .option debug_print routers string&!! unset
18357 .cindex "testing" "variables in drivers"
18358 If this option is set and debugging is enabled (see the &%-d%& command line
18359 option) or in address-testing mode (see the &%-bt%& command line option),
18360 the string is expanded and included in the debugging output.
18361 If expansion of the string fails, the error message is written to the debugging
18362 output, and Exim carries on processing.
18363 This option is provided to help with checking out the values of variables and
18364 so on when debugging router configurations. For example, if a &%condition%&
18365 option appears not to be working, &%debug_print%& can be used to output the
18366 variables it references. The output happens after checks for &%domains%&,
18367 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18368 are tested. A newline is added to the text if it does not end with one.
18369 The variable &$router_name$& contains the name of the router.
18370
18371
18372
18373 .option disable_logging routers boolean false
18374 If this option is set true, nothing is logged for any routing errors
18375 or for any deliveries caused by this router. You should not set this option
18376 unless you really, really know what you are doing. See also the generic
18377 transport option of the same name.
18378
18379 .option dnssec_request_domains routers "domain list&!!" *
18380 .cindex "MX record" "security"
18381 .cindex "DNSSEC" "MX lookup"
18382 .cindex "security" "MX lookup"
18383 .cindex "DNS" "DNSSEC"
18384 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18385 the dnssec request bit set.
18386 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18387
18388 .option dnssec_require_domains routers "domain list&!!" unset
18389 .cindex "MX record" "security"
18390 .cindex "DNSSEC" "MX lookup"
18391 .cindex "security" "MX lookup"
18392 .cindex "DNS" "DNSSEC"
18393 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18394 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18395 (AD bit) set will be ignored and logged as a host-lookup failure.
18396 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18397
18398
18399 .option domains routers&!? "domain list&!!" unset
18400 .cindex "router" "restricting to specific domains"
18401 .vindex "&$domain_data$&"
18402 If this option is set, the router is skipped unless the current domain matches
18403 the list. If the match is achieved by means of a file lookup, the data that the
18404 lookup returned for the domain is placed in &$domain_data$& for use in string
18405 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18406 a list of the order in which preconditions are evaluated.
18407
18408
18409
18410 .option driver routers string unset
18411 This option must always be set. It specifies which of the available routers is
18412 to be used.
18413
18414
18415 .option dsn_lasthop routers boolean false
18416 .cindex "DSN" "success"
18417 .cindex "Delivery Status Notification" "success"
18418 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18419 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18420 instead send a success DSN as if the next hop does not support DSN.
18421 Not effective on redirect routers.
18422
18423
18424
18425 .option errors_to routers string&!! unset
18426 .cindex "envelope from"
18427 .cindex "envelope sender"
18428 .cindex "router" "changing address for errors"
18429 If a router successfully handles an address, it may assign the address to a
18430 transport for delivery or it may generate child addresses. In both cases, if
18431 there is a delivery problem during later processing, the resulting bounce
18432 message is sent to the address that results from expanding this string,
18433 provided that the address verifies successfully. The &%errors_to%& option is
18434 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18435
18436 The &%errors_to%& setting associated with an address can be overridden if it
18437 subsequently passes through other routers that have their own &%errors_to%&
18438 settings, or if the message is delivered by a transport with a &%return_path%&
18439 setting.
18440
18441 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18442 the expansion fails to verify, the errors address associated with the incoming
18443 address is used. At top level, this is the envelope sender. A non-forced
18444 expansion failure causes delivery to be deferred.
18445
18446 If an address for which &%errors_to%& has been set ends up being delivered over
18447 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18448 any bounces that are generated by other MTAs on the delivery route are also
18449 sent there. You can set &%errors_to%& to the empty string by either of these
18450 settings:
18451 .code
18452 errors_to =
18453 errors_to = ""
18454 .endd
18455 An expansion item that yields an empty string has the same effect. If you do
18456 this, a locally detected delivery error for addresses processed by this router
18457 no longer gives rise to a bounce message; the error is discarded. If the
18458 address is delivered to a remote host, the return path is set to &`<>`&, unless
18459 overridden by the &%return_path%& option on the transport.
18460
18461 .vindex "&$address_data$&"
18462 If for some reason you want to discard local errors, but use a non-empty
18463 MAIL command for remote delivery, you can preserve the original return
18464 path in &$address_data$& in the router, and reinstate it in the transport by
18465 setting &%return_path%&.
18466
18467 The most common use of &%errors_to%& is to direct mailing list bounces to the
18468 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18469 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18470
18471
18472
18473 .option expn routers&!? boolean true
18474 .cindex "address" "testing"
18475 .cindex "testing" "addresses"
18476 .cindex "EXPN" "router skipping"
18477 .cindex "router" "skipping for EXPN"
18478 If this option is turned off, the router is skipped when testing an address
18479 as a result of processing an SMTP EXPN command. You might, for example,
18480 want to turn it off on a router for users' &_.forward_& files, while leaving it
18481 on for the system alias file.
18482 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18483 are evaluated.
18484
18485 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18486 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18487 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18488
18489
18490
18491 .option fail_verify routers boolean false
18492 .cindex "router" "forcing verification failure"
18493 Setting this option has the effect of setting both &%fail_verify_sender%& and
18494 &%fail_verify_recipient%& to the same value.
18495
18496
18497
18498 .option fail_verify_recipient routers boolean false
18499 If this option is true and an address is accepted by this router when
18500 verifying a recipient, verification fails.
18501
18502
18503
18504 .option fail_verify_sender routers boolean false
18505 If this option is true and an address is accepted by this router when
18506 verifying a sender, verification fails.
18507
18508
18509
18510 .option fallback_hosts routers "string list" unset
18511 .cindex "router" "fallback hosts"
18512 .cindex "fallback" "hosts specified on router"
18513 String expansion is not applied to this option. The argument must be a
18514 colon-separated list of host names or IP addresses. The list separator can be
18515 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18516 each name or address. In fact, the format of each item is exactly the same as
18517 defined for the list of hosts in a &(manualroute)& router (see section
18518 &<<SECTformatonehostitem>>&).
18519
18520 If a router queues an address for a remote transport, this host list is
18521 associated with the address, and used instead of the transport's fallback host
18522 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18523 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18524 transport for further details.
18525
18526
18527 .option group routers string&!! "see below"
18528 .cindex "gid (group id)" "local delivery"
18529 .cindex "local transports" "uid and gid"
18530 .cindex "transport" "local"
18531 .cindex "router" "setting group"
18532 When a router queues an address for a transport, and the transport does not
18533 specify a group, the group given here is used when running the delivery
18534 process.
18535 The group may be specified numerically or by name. If expansion fails, the
18536 error is logged and delivery is deferred.
18537 The default is unset, unless &%check_local_user%& is set, when the default
18538 is taken from the password information. See also &%initgroups%& and &%user%&
18539 and the discussion in chapter &<<CHAPenvironment>>&.
18540
18541
18542
18543 .option headers_add routers list&!! unset
18544 .cindex "header lines" "adding"
18545 .cindex "router" "adding header lines"
18546 This option specifies a list of text headers,
18547 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18548 that is associated with any addresses that are accepted by the router.
18549 Each item is separately expanded, at routing time.  However, this
18550 option has no effect when an address is just being verified. The way in which
18551 the text is used to add header lines at transport time is described in section
18552 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18553 message is in the process of being transported. This means that references to
18554 header lines in string expansions in the transport's configuration do not
18555 &"see"& the added header lines.
18556
18557 The &%headers_add%& option is expanded after &%errors_to%&, but before
18558 &%headers_remove%& and &%transport%&. If an item is empty, or if
18559 an item expansion is forced to fail, the item has no effect. Other expansion
18560 failures are treated as configuration errors.
18561
18562 Unlike most options, &%headers_add%& can be specified multiple times
18563 for a router; all listed headers are added.
18564
18565 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18566 router that has the &%one_time%& option set.
18567
18568 .cindex "duplicate addresses"
18569 .oindex "&%unseen%&"
18570 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18571 additions are deleted when the address is passed on to subsequent routers.
18572 For a &%redirect%& router, if a generated address is the same as the incoming
18573 address, this can lead to duplicate addresses with different header
18574 modifications. Exim does not do duplicate deliveries (except, in certain
18575 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18576 which of the duplicates is discarded, so this ambiguous situation should be
18577 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18578
18579
18580
18581 .option headers_remove routers list&!! unset
18582 .cindex "header lines" "removing"
18583 .cindex "router" "removing header lines"
18584 This option specifies a list of text headers,
18585 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18586 that is associated with any addresses that are accepted by the router.
18587 Each item is separately expanded, at routing time.  However, this
18588 option has no effect when an address is just being verified. The way in which
18589 the text is used to remove header lines at transport time is described in
18590 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18591 the message is in the process of being transported. This means that references
18592 to header lines in string expansions in the transport's configuration still
18593 &"see"& the original header lines.
18594
18595 The &%headers_remove%& option is expanded after &%errors_to%& and
18596 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18597 the item has no effect. Other expansion failures are treated as configuration
18598 errors.
18599
18600 Unlike most options, &%headers_remove%& can be specified multiple times
18601 for a router; all listed headers are removed.
18602
18603 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18604 router that has the &%one_time%& option set.
18605
18606 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18607 removal requests are deleted when the address is passed on to subsequent
18608 routers, and this can lead to problems with duplicates -- see the similar
18609 warning for &%headers_add%& above.
18610
18611 &*Warning 3*&: Because of the separate expansion of the list items,
18612 items that contain a list separator must have it doubled.
18613 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18614
18615
18616
18617 .option ignore_target_hosts routers "host list&!!" unset
18618 .cindex "IP address" "discarding"
18619 .cindex "router" "discarding IP addresses"
18620 Although this option is a host list, it should normally contain IP address
18621 entries rather than names. If any host that is looked up by the router has an
18622 IP address that matches an item in this list, Exim behaves as if that IP
18623 address did not exist. This option allows you to cope with rogue DNS entries
18624 like
18625 .code
18626 remote.domain.example.  A  127.0.0.1
18627 .endd
18628 by setting
18629 .code
18630 ignore_target_hosts = 127.0.0.1
18631 .endd
18632 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18633 discarded in this way, the router declines. In a conventional configuration, an
18634 attempt to mail to such a domain would normally provoke the &"unrouteable
18635 domain"& error, and an attempt to verify an address in the domain would fail.
18636 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18637 router declines if presented with one of the listed addresses.
18638
18639 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18640 means of the first or the second of the following settings, respectively:
18641 .code
18642 ignore_target_hosts = 0.0.0.0/0
18643 ignore_target_hosts = <; 0::0/0
18644 .endd
18645 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18646 in the second line matches all IPv6 addresses.
18647
18648 This option may also be useful for ignoring link-local and site-local IPv6
18649 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18650 is expanded before use as a list, it is possible to make it dependent on the
18651 domain that is being routed.
18652
18653 .vindex "&$host_address$&"
18654 During its expansion, &$host_address$& is set to the IP address that is being
18655 checked.
18656
18657 .option initgroups routers boolean false
18658 .cindex "additional groups"
18659 .cindex "groups" "additional"
18660 .cindex "local transports" "uid and gid"
18661 .cindex "transport" "local"
18662 If the router queues an address for a transport, and this option is true, and
18663 the uid supplied by the router is not overridden by the transport, the
18664 &[initgroups()]& function is called when running the transport to ensure that
18665 any additional groups associated with the uid are set up. See also &%group%&
18666 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18667
18668
18669
18670 .option local_part_prefix routers&!? "string list" unset
18671 .cindex affix "router precondition"
18672 .cindex "router" "prefix for local part"
18673 .cindex "prefix" "for local part, used in router"
18674 If this option is set, the router is skipped unless the local part starts with
18675 one of the given strings, or &%local_part_prefix_optional%& is true. See
18676 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18677 evaluated.
18678
18679 The list is scanned from left to right, and the first prefix that matches is
18680 used. A limited form of wildcard is available; if the prefix begins with an
18681 asterisk, it matches the longest possible sequence of arbitrary characters at
18682 the start of the local part. An asterisk should therefore always be followed by
18683 some character that does not occur in normal local parts.
18684 .cindex "multiple mailboxes"
18685 .cindex "mailbox" "multiple"
18686 Wildcarding can be used to set up multiple user mailboxes, as described in
18687 section &<<SECTmulbox>>&.
18688
18689 .vindex "&$local_part$&"
18690 .vindex "&$local_part_prefix$&"
18691 During the testing of the &%local_parts%& option, and while the router is
18692 running, the prefix is removed from the local part, and is available in the
18693 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18694 the router accepts the address, this remains true during subsequent delivery by
18695 a transport. In particular, the local part that is transmitted in the RCPT
18696 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18697 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18698 the relevant transport.
18699
18700 When an address is being verified, &%local_part_prefix%& affects only the
18701 behaviour of the router. If the callout feature of verification is in use, this
18702 means that the full address, including the prefix, will be used during the
18703 callout.
18704
18705 The prefix facility is commonly used to handle local parts of the form
18706 &%owner-something%&. Another common use is to support local parts of the form
18707 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18708 to tell a user their forwarding is broken &-- by placing a router like this one
18709 immediately before the router that handles &_.forward_& files:
18710 .code
18711 real_localuser:
18712   driver = accept
18713   local_part_prefix = real-
18714   check_local_user
18715   transport = local_delivery
18716 .endd
18717 For security, it would probably be a good idea to restrict the use of this
18718 router to locally-generated messages, using a condition such as this:
18719 .code
18720   condition = ${if match {$sender_host_address}\
18721                          {\N^(|127\.0\.0\.1)$\N}}
18722 .endd
18723
18724 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18725 both conditions must be met if not optional. Care must be taken if wildcards
18726 are used in both a prefix and a suffix on the same router. Different
18727 separator characters must be used to avoid ambiguity.
18728
18729
18730 .option local_part_prefix_optional routers boolean false
18731 See &%local_part_prefix%& above.
18732
18733
18734
18735 .option local_part_suffix routers&!? "string list" unset
18736 .cindex "router" "suffix for local part"
18737 .cindex "suffix for local part" "used in router"
18738 This option operates in the same way as &%local_part_prefix%&, except that the
18739 local part must end (rather than start) with the given string, the
18740 &%local_part_suffix_optional%& option determines whether the suffix is
18741 mandatory, and the wildcard * character, if present, must be the last
18742 character of the suffix. This option facility is commonly used to handle local
18743 parts of the form &%something-request%& and multiple user mailboxes of the form
18744 &%username-foo%&.
18745
18746
18747 .option local_part_suffix_optional routers boolean false
18748 See &%local_part_suffix%& above.
18749
18750
18751
18752 .option local_parts routers&!? "local part list&!!" unset
18753 .cindex "router" "restricting to specific local parts"
18754 .cindex "local part" "checking in router"
18755 The router is run only if the local part of the address matches the list.
18756 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18757 are evaluated, and
18758 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18759 string is expanded, it is possible to make it depend on the domain, for
18760 example:
18761 .code
18762 local_parts = dbm;/usr/local/specials/$domain
18763 .endd
18764 .vindex "&$local_part_data$&"
18765 If the match is achieved by a lookup, the data that the lookup returned
18766 for the local part is placed in the variable &$local_part_data$& for use in
18767 expansions of the router's private options. You might use this option, for
18768 example, if you have a large number of local virtual domains, and you want to
18769 send all postmaster mail to the same place without having to set up an alias in
18770 each virtual domain:
18771 .code
18772 postmaster:
18773   driver = redirect
18774   local_parts = postmaster
18775   data = postmaster@real.domain.example
18776 .endd
18777
18778
18779 .option log_as_local routers boolean "see below"
18780 .cindex "log" "delivery line"
18781 .cindex "delivery" "log line format"
18782 Exim has two logging styles for delivery, the idea being to make local
18783 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18784 recipient address is given just as the local part, without a domain. The use of
18785 this style is controlled by this option. It defaults to true for the &(accept)&
18786 router, and false for all the others. This option applies only when a
18787 router assigns an address to a transport. It has no effect on routers that
18788 redirect addresses.
18789
18790
18791
18792 .option more routers boolean&!! true
18793 The result of string expansion for this option must be a valid boolean value,
18794 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18795 result causes an error, and delivery is deferred. If the expansion is forced to
18796 fail, the default value for the option (true) is used. Other failures cause
18797 delivery to be deferred.
18798
18799 If this option is set false, and the router declines to handle the address, no
18800 further routers are tried, routing fails, and the address is bounced.
18801 .oindex "&%self%&"
18802 However, if the router explicitly passes an address to the following router by
18803 means of the setting
18804 .code
18805 self = pass
18806 .endd
18807 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18808 does not affect the behaviour if one of the precondition tests fails. In that
18809 case, the address is always passed to the next router.
18810
18811 Note that &%address_data%& is not considered to be a precondition. If its
18812 expansion is forced to fail, the router declines, and the value of &%more%&
18813 controls what happens next.
18814
18815
18816 .option pass_on_timeout routers boolean false
18817 .cindex "timeout" "of router"
18818 .cindex "router" "timeout"
18819 If a router times out during a host lookup, it normally causes deferral of the
18820 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18821 router, overriding &%no_more%&. This may be helpful for systems that are
18822 intermittently connected to the Internet, or those that want to pass to a smart
18823 host any messages that cannot immediately be delivered.
18824
18825 There are occasional other temporary errors that can occur while doing DNS
18826 lookups. They are treated in the same way as a timeout, and this option
18827 applies to all of them.
18828
18829
18830
18831 .option pass_router routers string unset
18832 .cindex "router" "go to after &""pass""&"
18833 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18834 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18835 routing to continue, and overriding a false setting of &%more%&. When one of
18836 these routers returns &"pass"&, the address is normally handed on to the next
18837 router in sequence. This can be changed by setting &%pass_router%& to the name
18838 of another router. However (unlike &%redirect_router%&) the named router must
18839 be below the current router, to avoid loops. Note that this option applies only
18840 to the special case of &"pass"&. It does not apply when a router returns
18841 &"decline"& because it cannot handle an address.
18842
18843
18844
18845 .option redirect_router routers string unset
18846 .cindex "router" "start at after redirection"
18847 Sometimes an administrator knows that it is pointless to reprocess addresses
18848 generated from alias or forward files with the same router again. For
18849 example, if an alias file translates real names into login ids there is no
18850 point searching the alias file a second time, especially if it is a large file.
18851
18852 The &%redirect_router%& option can be set to the name of any router instance.
18853 It causes the routing of any generated addresses to start at the named router
18854 instead of at the first router. This option has no effect if the router in
18855 which it is set does not generate new addresses.
18856
18857
18858
18859 .option require_files routers&!? "string list&!!" unset
18860 .cindex "file" "requiring for router"
18861 .cindex "router" "requiring file existence"
18862 This option provides a general mechanism for predicating the running of a
18863 router on the existence or non-existence of certain files or directories.
18864 Before running a router, as one of its precondition tests, Exim works its way
18865 through the &%require_files%& list, expanding each item separately.
18866
18867 Because the list is split before expansion, any colons in expansion items must
18868 be doubled, or the facility for using a different list separator must be used
18869 (&<<SECTlistsepchange>>&).
18870 If any expansion is forced to fail, the item is ignored. Other expansion
18871 failures cause routing of the address to be deferred.
18872
18873 If any expanded string is empty, it is ignored. Otherwise, except as described
18874 below, each string must be a fully qualified file path, optionally preceded by
18875 &"!"&. The paths are passed to the &[stat()]& function to test for the
18876 existence of the files or directories. The router is skipped if any paths not
18877 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18878
18879 .cindex "NFS"
18880 If &[stat()]& cannot determine whether a file exists or not, delivery of
18881 the message is deferred. This can happen when NFS-mounted filesystems are
18882 unavailable.
18883
18884 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18885 options, so you cannot use it to check for the existence of a file in which to
18886 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18887 full list of the order in which preconditions are evaluated.) However, as
18888 these options are all expanded, you can use the &%exists%& expansion condition
18889 to make such tests. The &%require_files%& option is intended for checking files
18890 that the router may be going to use internally, or which are needed by a
18891 transport (e.g., &_.procmailrc_&).
18892
18893 During delivery, the &[stat()]& function is run as root, but there is a
18894 facility for some checking of the accessibility of a file by another user.
18895 This is not a proper permissions check, but just a &"rough"& check that
18896 operates as follows:
18897
18898 If an item in a &%require_files%& list does not contain any forward slash
18899 characters, it is taken to be the user (and optional group, separated by a
18900 comma) to be checked for subsequent files in the list. If no group is specified
18901 but the user is specified symbolically, the gid associated with the uid is
18902 used. For example:
18903 .code
18904 require_files = mail:/some/file
18905 require_files = $local_part:$home/.procmailrc
18906 .endd
18907 If a user or group name in a &%require_files%& list does not exist, the
18908 &%require_files%& condition fails.
18909
18910 Exim performs the check by scanning along the components of the file path, and
18911 checking the access for the given uid and gid. It checks for &"x"& access on
18912 directories, and &"r"& access on the final file. Note that this means that file
18913 access control lists, if the operating system has them, are ignored.
18914
18915 &*Warning 1*&: When the router is being run to verify addresses for an
18916 incoming SMTP message, Exim is not running as root, but under its own uid. This
18917 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18918 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18919 user is not permitted to read one of the directories on the file's path.
18920
18921 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18922 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18923 without root access. In this case, if a check for access by a particular user
18924 is requested, Exim creates a subprocess that runs as that user, and tries the
18925 check again in that process.
18926
18927 The default action for handling an unresolved EACCES is to consider it to
18928 be caused by a configuration error, and routing is deferred because the
18929 existence or non-existence of the file cannot be determined. However, in some
18930 circumstances it may be desirable to treat this condition as if the file did
18931 not exist. If the filename (or the exclamation mark that precedes the filename
18932 for non-existence) is preceded by a plus sign, the EACCES error is treated
18933 as if the file did not exist. For example:
18934 .code
18935 require_files = +/some/file
18936 .endd
18937 If the router is not an essential part of verification (for example, it
18938 handles users' &_.forward_& files), another solution is to set the &%verify%&
18939 option false so that the router is skipped when verifying.
18940
18941
18942
18943 .option retry_use_local_part routers boolean "see below"
18944 .cindex "hints database" "retry keys"
18945 .cindex "local part" "in retry keys"
18946 When a delivery suffers a temporary routing failure, a retry record is created
18947 in Exim's hints database. For addresses whose routing depends only on the
18948 domain, the key for the retry record should not involve the local part, but for
18949 other addresses, both the domain and the local part should be included.
18950 Usually, remote routing is of the former kind, and local routing is of the
18951 latter kind.
18952
18953 This option controls whether the local part is used to form the key for retry
18954 hints for addresses that suffer temporary errors while being handled by this
18955 router. The default value is true for any router that has any of
18956 &%check_local_user%&,
18957 &%local_parts%&,
18958 &%condition%&,
18959 &%local_part_prefix%&,
18960 &%local_part_suffix%&,
18961 &%senders%& or
18962 &%require_files%&
18963 set, and false otherwise. Note that this option does not apply to hints keys
18964 for transport delays; they are controlled by a generic transport option of the
18965 same name.
18966
18967 Failing to set this option when it is needed
18968 (because a remote router handles only some of the local-parts for a domain)
18969 can result in incorrect error messages being generated.
18970
18971 The setting of &%retry_use_local_part%& applies only to the router on which it
18972 appears. If the router generates child addresses, they are routed
18973 independently; this setting does not become attached to them.
18974
18975
18976
18977 .option router_home_directory routers string&!! unset
18978 .cindex "router" "home directory for"
18979 .cindex "home directory" "for router"
18980 .vindex "&$home$&"
18981 This option sets a home directory for use while the router is running. (Compare
18982 &%transport_home_directory%&, which sets a home directory for later
18983 transporting.) In particular, if used on a &(redirect)& router, this option
18984 sets a value for &$home$& while a filter is running. The value is expanded;
18985 forced expansion failure causes the option to be ignored &-- other failures
18986 cause the router to defer.
18987
18988 Expansion of &%router_home_directory%& happens immediately after the
18989 &%check_local_user%& test (if configured), before any further expansions take
18990 place.
18991 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18992 are evaluated.)
18993 While the router is running, &%router_home_directory%& overrides the value of
18994 &$home$& that came from &%check_local_user%&.
18995
18996 When a router accepts an address and assigns it to a local transport (including
18997 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18998 delivery), the home directory setting for the transport is taken from the first
18999 of these values that is set:
19000
19001 .ilist
19002 The &%home_directory%& option on the transport;
19003 .next
19004 The &%transport_home_directory%& option on the router;
19005 .next
19006 The password data if &%check_local_user%& is set on the router;
19007 .next
19008 The &%router_home_directory%& option on the router.
19009 .endlist
19010
19011 In other words, &%router_home_directory%& overrides the password data for the
19012 router, but not for the transport.
19013
19014
19015
19016 .option self routers string freeze
19017 .cindex "MX record" "pointing to local host"
19018 .cindex "local host" "MX pointing to"
19019 This option applies to those routers that use a recipient address to find a
19020 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19021 and &(manualroute)& routers.
19022 Certain configurations of the &(queryprogram)& router can also specify a list
19023 of remote hosts.
19024 Usually such routers are configured to send the message to a remote host via an
19025 &(smtp)& transport. The &%self%& option specifies what happens when the first
19026 host on the list turns out to be the local host.
19027 The way in which Exim checks for the local host is described in section
19028 &<<SECTreclocipadd>>&.
19029
19030 Normally this situation indicates either an error in Exim's configuration (for
19031 example, the router should be configured not to process this domain), or an
19032 error in the DNS (for example, the MX should not point to this host). For this
19033 reason, the default action is to log the incident, defer the address, and
19034 freeze the message. The following alternatives are provided for use in special
19035 cases:
19036
19037 .vlist
19038 .vitem &%defer%&
19039 Delivery of the message is tried again later, but the message is not frozen.
19040
19041 .vitem "&%reroute%&: <&'domain'&>"
19042 The domain is changed to the given domain, and the address is passed back to
19043 be reprocessed by the routers. No rewriting of headers takes place. This
19044 behaviour is essentially a redirection.
19045
19046 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19047 The domain is changed to the given domain, and the address is passed back to be
19048 reprocessed by the routers. Any headers that contain the original domain are
19049 rewritten.
19050
19051 .vitem &%pass%&
19052 .oindex "&%more%&"
19053 .vindex "&$self_hostname$&"
19054 The router passes the address to the next router, or to the router named in the
19055 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19056 subsequent routing and delivery, the variable &$self_hostname$& contains the
19057 name of the local host that the router encountered. This can be used to
19058 distinguish between different cases for hosts with multiple names. The
19059 combination
19060 .code
19061 self = pass
19062 no_more
19063 .endd
19064 ensures that only those addresses that routed to the local host are passed on.
19065 Without &%no_more%&, addresses that were declined for other reasons would also
19066 be passed to the next router.
19067
19068 .vitem &%fail%&
19069 Delivery fails and an error report is generated.
19070
19071 .vitem &%send%&
19072 .cindex "local host" "sending to"
19073 The anomaly is ignored and the address is queued for the transport. This
19074 setting should be used with extreme caution. For an &(smtp)& transport, it
19075 makes sense only in cases where the program that is listening on the SMTP port
19076 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19077 different configuration file that handles the domain in another way.
19078 .endlist
19079
19080
19081
19082 .option senders routers&!? "address list&!!" unset
19083 .cindex "router" "checking senders"
19084 If this option is set, the router is skipped unless the message's sender
19085 address matches something on the list.
19086 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19087 are evaluated.
19088
19089 There are issues concerning verification when the running of routers is
19090 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19091 setting, it sets the sender to the null string. When using the &%-bt%& option
19092 to check a configuration file, it is necessary also to use the &%-f%& option to
19093 set an appropriate sender. For incoming mail, the sender is unset when
19094 verifying the sender, but is available when verifying any recipients. If the
19095 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19096 matters.
19097
19098
19099 .option set routers "string list" unset
19100 .cindex router variables
19101 This option may be used multiple times on a router;
19102 because of this the list aspect is mostly irrelevant.
19103 The list separator is a semicolon but can be changed in the
19104 usual way.
19105
19106 Each list-element given must be of the form &"name = value"&
19107 and the names used must start with the string &"r_"&.
19108 Values containing a list-separator should have them doubled.
19109 When a router runs, the strings are evaluated in order,
19110 to create variables which are added to the set associated with
19111 the address.
19112 The variable is set with the expansion of the value.
19113 The variables can be used by the router options
19114 (not including any preconditions)
19115 and by the transport.
19116 Later definitions of a given named variable will override former ones.
19117 Variable use is via the usual &$r_...$& syntax.
19118
19119 This is similar to the &%address_data%& option, except that
19120 many independent variables can be used, with choice of naming.
19121
19122
19123 .option translate_ip_address routers string&!! unset
19124 .cindex "IP address" "translating"
19125 .cindex "packet radio"
19126 .cindex "router" "IP address translation"
19127 There exist some rare networking situations (for example, packet radio) where
19128 it is helpful to be able to translate IP addresses generated by normal routing
19129 mechanisms into other IP addresses, thus performing a kind of manual IP
19130 routing. This should be done only if the normal IP routing of the TCP/IP stack
19131 is inadequate or broken. Because this is an extremely uncommon requirement, the
19132 code to support this option is not included in the Exim binary unless
19133 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19134
19135 .vindex "&$host_address$&"
19136 The &%translate_ip_address%& string is expanded for every IP address generated
19137 by the router, with the generated address set in &$host_address$&. If the
19138 expansion is forced to fail, no action is taken.
19139 For any other expansion error, delivery of the message is deferred.
19140 If the result of the expansion is an IP address, that replaces the original
19141 address; otherwise the result is assumed to be a host name &-- this is looked
19142 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19143 produce one or more replacement IP addresses. For example, to subvert all IP
19144 addresses in some specific networks, this could be added to a router:
19145 .code
19146 translate_ip_address = \
19147   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19148     {$value}fail}}
19149 .endd
19150 The file would contain lines like
19151 .code
19152 10.2.3.128/26    some.host
19153 10.8.4.34/26     10.44.8.15
19154 .endd
19155 You should not make use of this facility unless you really understand what you
19156 are doing.
19157
19158
19159
19160 .option transport routers string&!! unset
19161 This option specifies the transport to be used when a router accepts an address
19162 and sets it up for delivery. A transport is never needed if a router is used
19163 only for verification. The value of the option is expanded at routing time,
19164 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19165 and result must be the name of one of the configured transports. If it is not,
19166 delivery is deferred.
19167
19168 The &%transport%& option is not used by the &(redirect)& router, but it does
19169 have some private options that set up transports for pipe and file deliveries
19170 (see chapter &<<CHAPredirect>>&).
19171
19172
19173
19174 .option transport_current_directory routers string&!! unset
19175 .cindex "current directory for local transport"
19176 This option associates a current directory with any address that is routed
19177 to a local transport. This can happen either because a transport is
19178 explicitly configured for the router, or because it generates a delivery to a
19179 file or a pipe. During the delivery process (that is, at transport time), this
19180 option string is expanded and is set as the current directory, unless
19181 overridden by a setting on the transport.
19182 If the expansion fails for any reason, including forced failure, an error is
19183 logged, and delivery is deferred.
19184 See chapter &<<CHAPenvironment>>& for details of the local delivery
19185 environment.
19186
19187
19188
19189
19190 .option transport_home_directory routers string&!! "see below"
19191 .cindex "home directory" "for local transport"
19192 This option associates a home directory with any address that is routed to a
19193 local transport. This can happen either because a transport is explicitly
19194 configured for the router, or because it generates a delivery to a file or a
19195 pipe. During the delivery process (that is, at transport time), the option
19196 string is expanded and is set as the home directory, unless overridden by a
19197 setting of &%home_directory%& on the transport.
19198 If the expansion fails for any reason, including forced failure, an error is
19199 logged, and delivery is deferred.
19200
19201 If the transport does not specify a home directory, and
19202 &%transport_home_directory%& is not set for the router, the home directory for
19203 the transport is taken from the password data if &%check_local_user%& is set for
19204 the router. Otherwise it is taken from &%router_home_directory%& if that option
19205 is set; if not, no home directory is set for the transport.
19206
19207 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19208 environment.
19209
19210
19211
19212
19213 .option unseen routers boolean&!! false
19214 .cindex "router" "carrying on after success"
19215 The result of string expansion for this option must be a valid boolean value,
19216 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19217 result causes an error, and delivery is deferred. If the expansion is forced to
19218 fail, the default value for the option (false) is used. Other failures cause
19219 delivery to be deferred.
19220
19221 When this option is set true, routing does not cease if the router accepts the
19222 address. Instead, a copy of the incoming address is passed to the next router,
19223 overriding a false setting of &%more%&. There is little point in setting
19224 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19225 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19226 sometimes true and sometimes false).
19227
19228 .cindex "copy of message (&%unseen%& option)"
19229 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19230 qualifier in filter files. It can be used to cause copies of messages to be
19231 delivered to some other destination, while also carrying out a normal delivery.
19232 In effect, the current address is made into a &"parent"& that has two children
19233 &-- one that is delivered as specified by this router, and a clone that goes on
19234 to be routed further. For this reason, &%unseen%& may not be combined with the
19235 &%one_time%& option in a &(redirect)& router.
19236
19237 &*Warning*&: Header lines added to the address (or specified for removal) by
19238 this router or by previous routers affect the &"unseen"& copy of the message
19239 only. The clone that continues to be processed by further routers starts with
19240 no added headers and none specified for removal. For a &%redirect%& router, if
19241 a generated address is the same as the incoming address, this can lead to
19242 duplicate addresses with different header modifications. Exim does not do
19243 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19244 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19245 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19246 &%redirect%& router may be of help.
19247
19248 Unlike the handling of header modifications, any data that was set by the
19249 &%address_data%& option in the current or previous routers &'is'& passed on to
19250 subsequent routers.
19251
19252
19253 .option user routers string&!! "see below"
19254 .cindex "uid (user id)" "local delivery"
19255 .cindex "local transports" "uid and gid"
19256 .cindex "transport" "local"
19257 .cindex "router" "user for filter processing"
19258 .cindex "filter" "user for processing"
19259 When a router queues an address for a transport, and the transport does not
19260 specify a user, the user given here is used when running the delivery process.
19261 The user may be specified numerically or by name. If expansion fails, the
19262 error is logged and delivery is deferred.
19263 This user is also used by the &(redirect)& router when running a filter file.
19264 The default is unset, except when &%check_local_user%& is set. In this case,
19265 the default is taken from the password information. If the user is specified as
19266 a name, and &%group%& is not set, the group associated with the user is used.
19267 See also &%initgroups%& and &%group%& and the discussion in chapter
19268 &<<CHAPenvironment>>&.
19269
19270
19271
19272 .option verify routers&!? boolean true
19273 Setting this option has the effect of setting &%verify_sender%& and
19274 &%verify_recipient%& to the same value.
19275
19276
19277 .option verify_only routers&!? boolean false
19278 .cindex "EXPN" "with &%verify_only%&"
19279 .oindex "&%-bv%&"
19280 .cindex "router" "used only when verifying"
19281 If this option is set, the router is used only when verifying an address,
19282 delivering in cutthrough mode or
19283 testing with the &%-bv%& option, not when actually doing a delivery, testing
19284 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19285 restricted to verifying only senders or recipients by means of
19286 &%verify_sender%& and &%verify_recipient%&.
19287
19288 &*Warning*&: When the router is being run to verify addresses for an incoming
19289 SMTP message, Exim is not running as root, but under its own uid. If the router
19290 accesses any files, you need to make sure that they are accessible to the Exim
19291 user or group.
19292
19293
19294 .option verify_recipient routers&!? boolean true
19295 If this option is false, the router is skipped when verifying recipient
19296 addresses,
19297 delivering in cutthrough mode
19298 or testing recipient verification using &%-bv%&.
19299 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19300 are evaluated.
19301 See also the &$verify_mode$& variable.
19302
19303
19304 .option verify_sender routers&!? boolean true
19305 If this option is false, the router is skipped when verifying sender addresses
19306 or testing sender verification using &%-bvs%&.
19307 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19308 are evaluated.
19309 See also the &$verify_mode$& variable.
19310 .ecindex IIDgenoprou1
19311 .ecindex IIDgenoprou2
19312
19313
19314
19315
19316
19317
19318 . ////////////////////////////////////////////////////////////////////////////
19319 . ////////////////////////////////////////////////////////////////////////////
19320
19321 .chapter "The accept router" "CHID4"
19322 .cindex "&(accept)& router"
19323 .cindex "routers" "&(accept)&"
19324 The &(accept)& router has no private options of its own. Unless it is being
19325 used purely for verification (see &%verify_only%&) a transport is required to
19326 be defined by the generic &%transport%& option. If the preconditions that are
19327 specified by generic options are met, the router accepts the address and queues
19328 it for the given transport. The most common use of this router is for setting
19329 up deliveries to local mailboxes. For example:
19330 .code
19331 localusers:
19332   driver = accept
19333   domains = mydomain.example
19334   check_local_user
19335   transport = local_delivery
19336 .endd
19337 The &%domains%& condition in this example checks the domain of the address, and
19338 &%check_local_user%& checks that the local part is the login of a local user.
19339 When both preconditions are met, the &(accept)& router runs, and queues the
19340 address for the &(local_delivery)& transport.
19341
19342
19343
19344
19345
19346
19347 . ////////////////////////////////////////////////////////////////////////////
19348 . ////////////////////////////////////////////////////////////////////////////
19349
19350 .chapter "The dnslookup router" "CHAPdnslookup"
19351 .scindex IIDdnsrou1 "&(dnslookup)& router"
19352 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19353 The &(dnslookup)& router looks up the hosts that handle mail for the
19354 recipient's domain in the DNS. A transport must always be set for this router,
19355 unless &%verify_only%& is set.
19356
19357 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19358 SRV records. If none are found, or if SRV support is not configured,
19359 MX records are looked up. If no MX records exist, address records are sought.
19360 However, &%mx_domains%& can be set to disable the direct use of address
19361 records.
19362
19363 MX records of equal priority are sorted by Exim into a random order. Exim then
19364 looks for address records for the host names obtained from MX or SRV records.
19365 When a host has more than one IP address, they are sorted into a random order,
19366 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19367 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19368 generic option, the router declines.
19369
19370 Unless they have the highest priority (lowest MX value), MX records that point
19371 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19372 are discarded, together with any other MX records of equal or lower priority.
19373
19374 .cindex "MX record" "pointing to local host"
19375 .cindex "local host" "MX pointing to"
19376 .oindex "&%self%&" "in &(dnslookup)& router"
19377 If the host pointed to by the highest priority MX record, or looked up as an
19378 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19379 happens is controlled by the generic &%self%& option.
19380
19381
19382 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19383 There have been problems with DNS servers when SRV records are looked up.
19384 Some misbehaving servers return a DNS error or timeout when a non-existent
19385 SRV record is sought. Similar problems have in the past been reported for
19386 MX records. The global &%dns_again_means_nonexist%& option can help with this
19387 problem, but it is heavy-handed because it is a global option.
19388
19389 For this reason, there are two options, &%srv_fail_domains%& and
19390 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19391 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19392 an attempt to look up an SRV or MX record causes one of these results, and the
19393 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19394 such record"&. In the case of an SRV lookup, this means that the router
19395 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19396 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19397 case routing fails.
19398
19399
19400 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19401 .cindex "&(dnslookup)& router" "declines"
19402 There are a few cases where a &(dnslookup)& router will decline to accept
19403 an address; if such a router is expected to handle "all remaining non-local
19404 domains", then it is important to set &%no_more%&.
19405
19406 The router will defer rather than decline if the domain
19407 is found in the &%fail_defer_domains%& router option.
19408
19409 Reasons for a &(dnslookup)& router to decline currently include:
19410 .ilist
19411 The domain does not exist in DNS
19412 .next
19413 The domain exists but the MX record's host part is just "."; this is a common
19414 convention (borrowed from SRV) used to indicate that there is no such service
19415 for this domain and to not fall back to trying A/AAAA records.
19416 .next
19417 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19418 .next
19419 MX record points to a non-existent host.
19420 .next
19421 MX record points to an IP address and the main section option
19422 &%allow_mx_to_ip%& is not set.
19423 .next
19424 MX records exist and point to valid hosts, but all hosts resolve only to
19425 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19426 .next
19427 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19428 &%dns_check_names_pattern%& for handling one variant of this)
19429 .next
19430 &%check_secondary_mx%& is set on this router but the local host can
19431 not be found in the MX records (see below)
19432 .endlist
19433
19434
19435
19436
19437 .section "Private options for dnslookup" "SECID118"
19438 .cindex "options" "&(dnslookup)& router"
19439 The private options for the &(dnslookup)& router are as follows:
19440
19441 .option check_secondary_mx dnslookup boolean false
19442 .cindex "MX record" "checking for secondary"
19443 If this option is set, the router declines unless the local host is found in
19444 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19445 process domains for which the local host is a secondary mail exchanger
19446 differently to other domains. The way in which Exim decides whether a host is
19447 the local host is described in section &<<SECTreclocipadd>>&.
19448
19449
19450 .option check_srv dnslookup string&!! unset
19451 .cindex "SRV record" "enabling use of"
19452 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19453 addition to MX and address records. The support is disabled by default. To
19454 enable SRV support, set the &%check_srv%& option to the name of the service
19455 required. For example,
19456 .code
19457 check_srv = smtp
19458 .endd
19459 looks for SRV records that refer to the normal smtp service. The option is
19460 expanded, so the service name can vary from message to message or address
19461 to address. This might be helpful if SRV records are being used for a
19462 submission service. If the expansion is forced to fail, the &%check_srv%&
19463 option is ignored, and the router proceeds to look for MX records in the
19464 normal way.
19465
19466 When the expansion succeeds, the router searches first for SRV records for
19467 the given service (it assumes TCP protocol). A single SRV record with a
19468 host name that consists of just a single dot indicates &"no such service for
19469 this domain"&; if this is encountered, the router declines. If other kinds of
19470 SRV record are found, they are used to construct a host list for delivery
19471 according to the rules of RFC 2782. MX records are not sought in this case.
19472
19473 When no SRV records are found, MX records (and address records) are sought in
19474 the traditional way. In other words, SRV records take precedence over MX
19475 records, just as MX records take precedence over address records. Note that
19476 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19477 defined it. It is apparently believed that MX records are sufficient for email
19478 and that SRV records should not be used for this purpose. However, SRV records
19479 have an additional &"weight"& feature which some people might find useful when
19480 trying to split an SMTP load between hosts of different power.
19481
19482 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19483 when there is a DNS lookup error.
19484
19485
19486
19487
19488 .option fail_defer_domains dnslookup "domain list&!!" unset
19489 .cindex "MX record" "not found"
19490 DNS lookups for domains matching &%fail_defer_domains%&
19491 which find no matching record will cause the router to defer
19492 rather than the default behaviour of decline.
19493 This maybe be useful for queueing messages for a newly created
19494 domain while the DNS configuration is not ready.
19495 However, it will result in any message with mistyped domains
19496 also being queued.
19497
19498
19499 .option ipv4_only "string&!!" unset
19500 .cindex IPv6 disabling
19501 .cindex DNS "IPv6 disabling"
19502 The string is expanded, and if the result is anything but a forced failure,
19503 or an empty string, or one of the strings “0” or “no” or “false”
19504 (checked without regard to the case of the letters),
19505 only A records are used.
19506
19507 .option ipv4_prefer "string&!!" unset
19508 .cindex IPv4 preference
19509 .cindex DNS "IPv4 preference"
19510 The string is expanded, and if the result is anything but a forced failure,
19511 or an empty string, or one of the strings “0” or “no” or “false”
19512 (checked without regard to the case of the letters),
19513 A records are sorted before AAAA records (inverting the default).
19514
19515 .option mx_domains dnslookup "domain list&!!" unset
19516 .cindex "MX record" "required to exist"
19517 .cindex "SRV record" "required to exist"
19518 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19519 record in order to be recognized. (The name of this option could be improved.)
19520 For example, if all the mail hosts in &'fict.example'& are known to have MX
19521 records, except for those in &'discworld.fict.example'&, you could use this
19522 setting:
19523 .code
19524 mx_domains = ! *.discworld.fict.example : *.fict.example
19525 .endd
19526 This specifies that messages addressed to a domain that matches the list but
19527 has no MX record should be bounced immediately instead of being routed using
19528 the address record.
19529
19530
19531 .option mx_fail_domains dnslookup "domain list&!!" unset
19532 If the DNS lookup for MX records for one of the domains in this list causes a
19533 DNS lookup error, Exim behaves as if no MX records were found. See section
19534 &<<SECTprowitdnsloo>>& for more discussion.
19535
19536
19537
19538
19539 .option qualify_single dnslookup boolean true
19540 .cindex "DNS" "resolver options"
19541 .cindex "DNS" "qualifying single-component names"
19542 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19543 lookups. Typically, but not standardly, this causes the resolver to qualify
19544 single-component names with the default domain. For example, on a machine
19545 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19546 &'thesaurus.ref.example'& inside the resolver. For details of what your
19547 resolver actually does, consult your man pages for &'resolver'& and
19548 &'resolv.conf'&.
19549
19550
19551
19552 .option rewrite_headers dnslookup boolean true
19553 .cindex "rewriting" "header lines"
19554 .cindex "header lines" "rewriting"
19555 If the domain name in the address that is being processed is not fully
19556 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19557 an address is specified as &'dormouse@teaparty'&, the domain might be
19558 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19559 occur as a result of setting the &%widen_domains%& option. If
19560 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19561 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19562 header lines of the message are rewritten with the full domain name.
19563
19564 This option should be turned off only when it is known that no message is
19565 ever going to be sent outside an environment where the abbreviation makes
19566 sense.
19567
19568 When an MX record is looked up in the DNS and matches a wildcard record, name
19569 servers normally return a record containing the name that has been looked up,
19570 making it impossible to detect whether a wildcard was present or not. However,
19571 some name servers have recently been seen to return the wildcard entry. If the
19572 name returned by a DNS lookup begins with an asterisk, it is not used for
19573 header rewriting.
19574
19575
19576 .option same_domain_copy_routing dnslookup boolean false
19577 .cindex "address" "copying routing"
19578 Addresses with the same domain are normally routed by the &(dnslookup)& router
19579 to the same list of hosts. However, this cannot be presumed, because the router
19580 options and preconditions may refer to the local part of the address. By
19581 default, therefore, Exim routes each address in a message independently. DNS
19582 servers run caches, so repeated DNS lookups are not normally expensive, and in
19583 any case, personal messages rarely have more than a few recipients.
19584
19585 If you are running mailing lists with large numbers of subscribers at the same
19586 domain, and you are using a &(dnslookup)& router which is independent of the
19587 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19588 lookups for identical domains in one message. In this case, when &(dnslookup)&
19589 routes an address to a remote transport, any other unrouted addresses in the
19590 message that have the same domain are automatically given the same routing
19591 without processing them independently,
19592 provided the following conditions are met:
19593
19594 .ilist
19595 No router that processed the address specified &%headers_add%& or
19596 &%headers_remove%&.
19597 .next
19598 The router did not change the address in any way, for example, by &"widening"&
19599 the domain.
19600 .endlist
19601
19602
19603
19604
19605 .option search_parents dnslookup boolean false
19606 .cindex "DNS" "resolver options"
19607 When this option is true, the resolver option RES_DNSRCH is set for DNS
19608 lookups. This is different from the &%qualify_single%& option in that it
19609 applies to domains containing dots. Typically, but not standardly, it causes
19610 the resolver to search for the name in the current domain and in parent
19611 domains. For example, on a machine in the &'fict.example'& domain, if looking
19612 up &'teaparty.wonderland'& failed, the resolver would try
19613 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19614 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19615
19616 Setting this option true can cause problems in domains that have a wildcard MX
19617 record, because any domain that does not have its own MX record matches the
19618 local wildcard.
19619
19620
19621
19622 .option srv_fail_domains dnslookup "domain list&!!" unset
19623 If the DNS lookup for SRV records for one of the domains in this list causes a
19624 DNS lookup error, Exim behaves as if no SRV records were found. See section
19625 &<<SECTprowitdnsloo>>& for more discussion.
19626
19627
19628
19629
19630 .option widen_domains dnslookup "string list" unset
19631 .cindex "domain" "partial; widening"
19632 If a DNS lookup fails and this option is set, each of its strings in turn is
19633 added onto the end of the domain, and the lookup is tried again. For example,
19634 if
19635 .code
19636 widen_domains = fict.example:ref.example
19637 .endd
19638 is set and a lookup of &'klingon.dictionary'& fails,
19639 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19640 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19641 and &%search_parents%& options can cause some widening to be undertaken inside
19642 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19643 when verifying, unless &%rewrite_headers%& is false (not the default).
19644
19645
19646 .section "Effect of qualify_single and search_parents" "SECID119"
19647 When a domain from an envelope recipient is changed by the resolver as a result
19648 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19649 corresponding address in the message's header lines unless &%rewrite_headers%&
19650 is set false. Exim then re-routes the address, using the full domain.
19651
19652 These two options affect only the DNS lookup that takes place inside the router
19653 for the domain of the address that is being routed. They do not affect lookups
19654 such as that implied by
19655 .code
19656 domains = @mx_any
19657 .endd
19658 that may happen while processing a router precondition before the router is
19659 entered. No widening ever takes place for these lookups.
19660 .ecindex IIDdnsrou1
19661 .ecindex IIDdnsrou2
19662
19663
19664
19665
19666
19667
19668
19669
19670
19671 . ////////////////////////////////////////////////////////////////////////////
19672 . ////////////////////////////////////////////////////////////////////////////
19673
19674 .chapter "The ipliteral router" "CHID5"
19675 .cindex "&(ipliteral)& router"
19676 .cindex "domain literal" "routing"
19677 .cindex "routers" "&(ipliteral)&"
19678 This router has no private options. Unless it is being used purely for
19679 verification (see &%verify_only%&) a transport is required to be defined by the
19680 generic &%transport%& option. The router accepts the address if its domain part
19681 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19682 router handles the address
19683 .code
19684 root@[192.168.1.1]
19685 .endd
19686 by setting up delivery to the host with that IP address. IPv4 domain literals
19687 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19688 are similar, but the address is preceded by &`ipv6:`&. For example:
19689 .code
19690 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19691 .endd
19692 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19693 grounds that sooner or later somebody will try it.
19694
19695 .oindex "&%self%&" "in &(ipliteral)& router"
19696 If the IP address matches something in &%ignore_target_hosts%&, the router
19697 declines. If an IP literal turns out to refer to the local host, the generic
19698 &%self%& option determines what happens.
19699
19700 The RFCs require support for domain literals; however, their use is
19701 controversial in today's Internet. If you want to use this router, you must
19702 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19703 Exim will not recognize the domain literal syntax in addresses.
19704
19705
19706
19707 . ////////////////////////////////////////////////////////////////////////////
19708 . ////////////////////////////////////////////////////////////////////////////
19709
19710 .chapter "The iplookup router" "CHID6"
19711 .cindex "&(iplookup)& router"
19712 .cindex "routers" "&(iplookup)&"
19713 The &(iplookup)& router was written to fulfil a specific requirement in
19714 Cambridge University (which in fact no longer exists). For this reason, it is
19715 not included in the binary of Exim by default. If you want to include it, you
19716 must set
19717 .code
19718 ROUTER_IPLOOKUP=yes
19719 .endd
19720 in your &_Local/Makefile_& configuration file.
19721
19722 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19723 connection to one or more specific hosts. The host can then return the same or
19724 a different address &-- in effect rewriting the recipient address in the
19725 message's envelope. The new address is then passed on to subsequent routers. If
19726 this process fails, the address can be passed on to other routers, or delivery
19727 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19728 must not be specified for it.
19729
19730 .cindex "options" "&(iplookup)& router"
19731 .option hosts iplookup string unset
19732 This option must be supplied. Its value is a colon-separated list of host
19733 names. The hosts are looked up using &[gethostbyname()]&
19734 (or &[getipnodebyname()]& when available)
19735 and are tried in order until one responds to the query. If none respond, what
19736 happens is controlled by &%optional%&.
19737
19738
19739 .option optional iplookup boolean false
19740 If &%optional%& is true, if no response is obtained from any host, the address
19741 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19742 delivery to the address is deferred.
19743
19744
19745 .option port iplookup integer 0
19746 .cindex "port" "&(iplookup)& router"
19747 This option must be supplied. It specifies the port number for the TCP or UDP
19748 call.
19749
19750
19751 .option protocol iplookup string udp
19752 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19753 protocols is to be used.
19754
19755
19756 .option query iplookup string&!! "see below"
19757 This defines the content of the query that is sent to the remote hosts. The
19758 default value is:
19759 .code
19760 $local_part@$domain $local_part@$domain
19761 .endd
19762 The repetition serves as a way of checking that a response is to the correct
19763 query in the default case (see &%response_pattern%& below).
19764
19765
19766 .option reroute iplookup string&!! unset
19767 If this option is not set, the rerouted address is precisely the byte string
19768 returned by the remote host, up to the first white space, if any. If set, the
19769 string is expanded to form the rerouted address. It can include parts matched
19770 in the response by &%response_pattern%& by means of numeric variables such as
19771 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19772 whether or not a pattern is in use. In all cases, the rerouted address must end
19773 up in the form &'local_part@domain'&.
19774
19775
19776 .option response_pattern iplookup string unset
19777 This option can be set to a regular expression that is applied to the string
19778 returned from the remote host. If the pattern does not match the response, the
19779 router declines. If &%response_pattern%& is not set, no checking of the
19780 response is done, unless the query was defaulted, in which case there is a
19781 check that the text returned after the first white space is the original
19782 address. This checks that the answer that has been received is in response to
19783 the correct question. For example, if the response is just a new domain, the
19784 following could be used:
19785 .code
19786 response_pattern = ^([^@]+)$
19787 reroute = $local_part@$1
19788 .endd
19789
19790 .option timeout iplookup time 5s
19791 This specifies the amount of time to wait for a response from the remote
19792 machine. The same timeout is used for the &[connect()]& function for a TCP
19793 call. It does not apply to UDP.
19794
19795
19796
19797
19798 . ////////////////////////////////////////////////////////////////////////////
19799 . ////////////////////////////////////////////////////////////////////////////
19800
19801 .chapter "The manualroute router" "CHID7"
19802 .scindex IIDmanrou1 "&(manualroute)& router"
19803 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19804 .cindex "domain" "manually routing"
19805 The &(manualroute)& router is so-called because it provides a way of manually
19806 routing an address according to its domain. It is mainly used when you want to
19807 route addresses to remote hosts according to your own rules, bypassing the
19808 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19809 route to local transports, a facility that may be useful if you want to save
19810 messages for dial-in hosts in local files.
19811
19812 The &(manualroute)& router compares a list of domain patterns with the domain
19813 it is trying to route. If there is no match, the router declines. Each pattern
19814 has associated with it a list of hosts and some other optional data, which may
19815 include a transport. The combination of a pattern and its data is called a
19816 &"routing rule"&. For patterns that do not have an associated transport, the
19817 generic &%transport%& option must specify a transport, unless the router is
19818 being used purely for verification (see &%verify_only%&).
19819
19820 .vindex "&$host$&"
19821 In the case of verification, matching the domain pattern is sufficient for the
19822 router to accept the address. When actually routing an address for delivery,
19823 an address that matches a domain pattern is queued for the associated
19824 transport. If the transport is not a local one, a host list must be associated
19825 with the pattern; IP addresses are looked up for the hosts, and these are
19826 passed to the transport along with the mail address. For local transports, a
19827 host list is optional. If it is present, it is passed in &$host$& as a single
19828 text string.
19829
19830 The list of routing rules can be provided as an inline string in
19831 &%route_list%&, or the data can be obtained by looking up the domain in a file
19832 or database by setting &%route_data%&. Only one of these settings may appear in
19833 any one instance of &(manualroute)&. The format of routing rules is described
19834 below, following the list of private options.
19835
19836
19837 .section "Private options for manualroute" "SECTprioptman"
19838
19839 .cindex "options" "&(manualroute)& router"
19840 The private options for the &(manualroute)& router are as follows:
19841
19842 .option host_all_ignored manualroute string defer
19843 See &%host_find_failed%&.
19844
19845 .option host_find_failed manualroute string freeze
19846 This option controls what happens when &(manualroute)& tries to find an IP
19847 address for a host, and the host does not exist. The option can be set to one
19848 of the following values:
19849 .code
19850 decline
19851 defer
19852 fail
19853 freeze
19854 ignore
19855 pass
19856 .endd
19857 The default (&"freeze"&) assumes that this state is a serious configuration
19858 error. The difference between &"pass"& and &"decline"& is that the former
19859 forces the address to be passed to the next router (or the router defined by
19860 &%pass_router%&),
19861 .oindex "&%more%&"
19862 overriding &%no_more%&, whereas the latter passes the address to the next
19863 router only if &%more%& is true.
19864
19865 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19866 cannot be found. If all the hosts in the list are ignored, the behaviour is
19867 controlled by the &%host_all_ignored%& option. This takes the same values
19868 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19869
19870 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19871 state; if a host lookup gets a temporary error, delivery is deferred unless the
19872 generic &%pass_on_timeout%& option is set.
19873
19874
19875 .option hosts_randomize manualroute boolean false
19876 .cindex "randomized host list"
19877 .cindex "host" "list of; randomized"
19878 If this option is set, the order of the items in a host list in a routing rule
19879 is randomized each time the list is used, unless an option in the routing rule
19880 overrides (see below). Randomizing the order of a host list can be used to do
19881 crude load sharing. However, if more than one mail address is routed by the
19882 same router to the same host list, the host lists are considered to be the same
19883 (even though they may be randomized into different orders) for the purpose of
19884 deciding whether to batch the deliveries into a single SMTP transaction.
19885
19886 When &%hosts_randomize%& is true, a host list may be split
19887 into groups whose order is separately randomized. This makes it possible to
19888 set up MX-like behaviour. The boundaries between groups are indicated by an
19889 item that is just &`+`& in the host list. For example:
19890 .code
19891 route_list = * host1:host2:host3:+:host4:host5
19892 .endd
19893 The order of the first three hosts and the order of the last two hosts is
19894 randomized for each use, but the first three always end up before the last two.
19895 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19896 randomized host list is passed to an &(smtp)& transport that also has
19897 &%hosts_randomize set%&, the list is not re-randomized.
19898
19899
19900 .option route_data manualroute string&!! unset
19901 If this option is set, it must expand to yield the data part of a routing rule.
19902 Typically, the expansion string includes a lookup based on the domain. For
19903 example:
19904 .code
19905 route_data = ${lookup{$domain}dbm{/etc/routes}}
19906 .endd
19907 If the expansion is forced to fail, or the result is an empty string, the
19908 router declines. Other kinds of expansion failure cause delivery to be
19909 deferred.
19910
19911
19912 .option route_list manualroute "string list" unset
19913 This string is a list of routing rules, in the form defined below. Note that,
19914 unlike most string lists, the items are separated by semicolons. This is so
19915 that they may contain colon-separated host lists.
19916
19917
19918 .option same_domain_copy_routing manualroute boolean false
19919 .cindex "address" "copying routing"
19920 Addresses with the same domain are normally routed by the &(manualroute)&
19921 router to the same list of hosts. However, this cannot be presumed, because the
19922 router options and preconditions may refer to the local part of the address. By
19923 default, therefore, Exim routes each address in a message independently. DNS
19924 servers run caches, so repeated DNS lookups are not normally expensive, and in
19925 any case, personal messages rarely have more than a few recipients.
19926
19927 If you are running mailing lists with large numbers of subscribers at the same
19928 domain, and you are using a &(manualroute)& router which is independent of the
19929 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19930 lookups for identical domains in one message. In this case, when
19931 &(manualroute)& routes an address to a remote transport, any other unrouted
19932 addresses in the message that have the same domain are automatically given the
19933 same routing without processing them independently. However, this is only done
19934 if &%headers_add%& and &%headers_remove%& are unset.
19935
19936
19937
19938
19939 .section "Routing rules in route_list" "SECID120"
19940 The value of &%route_list%& is a string consisting of a sequence of routing
19941 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19942 entered as two semicolons. Alternatively, the list separator can be changed as
19943 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19944 Empty rules are ignored. The format of each rule is
19945 .display
19946 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19947 .endd
19948 The following example contains two rules, each with a simple domain pattern and
19949 no options:
19950 .code
19951 route_list = \
19952   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19953   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19954 .endd
19955 The three parts of a rule are separated by white space. The pattern and the
19956 list of hosts can be enclosed in quotes if necessary, and if they are, the
19957 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19958 single domain pattern, which is the only mandatory item in the rule. The
19959 pattern is in the same format as one item in a domain list (see section
19960 &<<SECTdomainlist>>&),
19961 except that it may not be the name of an interpolated file.
19962 That is, it may be wildcarded, or a regular expression, or a file or database
19963 lookup (with semicolons doubled, because of the use of semicolon as a separator
19964 in a &%route_list%&).
19965
19966 The rules in &%route_list%& are searched in order until one of the patterns
19967 matches the domain that is being routed. The list of hosts and then options are
19968 then used as described below. If there is no match, the router declines. When
19969 &%route_list%& is set, &%route_data%& must not be set.
19970
19971
19972
19973 .section "Routing rules in route_data" "SECID121"
19974 The use of &%route_list%& is convenient when there are only a small number of
19975 routing rules. For larger numbers, it is easier to use a file or database to
19976 hold the routing information, and use the &%route_data%& option instead.
19977 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19978 Most commonly, &%route_data%& is set as a string that contains an
19979 expansion lookup. For example, suppose we place two routing rules in a file
19980 like this:
19981 .code
19982 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19983 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19984 .endd
19985 This data can be accessed by setting
19986 .code
19987 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19988 .endd
19989 Failure of the lookup results in an empty string, causing the router to
19990 decline. However, you do not have to use a lookup in &%route_data%&. The only
19991 requirement is that the result of expanding the string is a list of hosts,
19992 possibly followed by options, separated by white space. The list of hosts must
19993 be enclosed in quotes if it contains white space.
19994
19995
19996
19997
19998 .section "Format of the list of hosts" "SECID122"
19999 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20000 always separately expanded before use. If the expansion fails, the router
20001 declines. The result of the expansion must be a colon-separated list of names
20002 and/or IP addresses, optionally also including ports.
20003 If the list is written with spaces, it must be protected with quotes.
20004 The format of each item
20005 in the list is described in the next section. The list separator can be changed
20006 as described in section &<<SECTlistsepchange>>&.
20007
20008 If the list of hosts was obtained from a &%route_list%& item, the following
20009 variables are set during its expansion:
20010
20011 .ilist
20012 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20013 If the domain was matched against a regular expression, the numeric variables
20014 &$1$&, &$2$&, etc. may be set. For example:
20015 .code
20016 route_list = ^domain(\d+)   host-$1.text.example
20017 .endd
20018 .next
20019 &$0$& is always set to the entire domain.
20020 .next
20021 &$1$& is also set when partial matching is done in a file lookup.
20022
20023 .next
20024 .vindex "&$value$&"
20025 If the pattern that matched the domain was a lookup item, the data that was
20026 looked up is available in the expansion variable &$value$&. For example:
20027 .code
20028 route_list = lsearch;;/some/file.routes  $value
20029 .endd
20030 .endlist
20031
20032 Note the doubling of the semicolon in the pattern that is necessary because
20033 semicolon is the default route list separator.
20034
20035
20036
20037 .section "Format of one host item" "SECTformatonehostitem"
20038 Each item in the list of hosts is either a host name or an IP address,
20039 optionally with an attached port number. When no port is given, an IP address
20040 is not enclosed in brackets. When a port is specified, it overrides the port
20041 specification on the transport. The port is separated from the name or address
20042 by a colon. This leads to some complications:
20043
20044 .ilist
20045 Because colon is the default separator for the list of hosts, either
20046 the colon that specifies a port must be doubled, or the list separator must
20047 be changed. The following two examples have the same effect:
20048 .code
20049 route_list = * "host1.tld::1225 : host2.tld::1226"
20050 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20051 .endd
20052 .next
20053 When IPv6 addresses are involved, it gets worse, because they contain
20054 colons of their own. To make this case easier, it is permitted to
20055 enclose an IP address (either v4 or v6) in square brackets if a port
20056 number follows. For example:
20057 .code
20058 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20059 .endd
20060 .endlist
20061
20062 .section "How the list of hosts is used" "SECThostshowused"
20063 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20064 the hosts is tried, in the order specified, when carrying out the SMTP
20065 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20066 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20067 transport.
20068
20069 Hosts may be listed by name or by IP address. An unadorned name in the list of
20070 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20071 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20072 records in the DNS. For example:
20073 .code
20074 route_list = *  x.y.z:p.q.r/MX:e.f.g
20075 .endd
20076 If this feature is used with a port specifier, the port must come last. For
20077 example:
20078 .code
20079 route_list = *  dom1.tld/mx::1225
20080 .endd
20081 If the &%hosts_randomize%& option is set, the order of the items in the list is
20082 randomized before any lookups are done. Exim then scans the list; for any name
20083 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20084 be an interface on the local host and the item is not the first in the list,
20085 Exim discards it and any subsequent items. If it is the first item, what
20086 happens is controlled by the
20087 .oindex "&%self%&" "in &(manualroute)& router"
20088 &%self%& option of the router.
20089
20090 A name on the list that is followed by &`/MX`& is replaced with the list of
20091 hosts obtained by looking up MX records for the name. This is always a DNS
20092 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20093 below) are not relevant here. The order of these hosts is determined by the
20094 preference values in the MX records, according to the usual rules. Because
20095 randomizing happens before the MX lookup, it does not affect the order that is
20096 defined by MX preferences.
20097
20098 If the local host is present in the sublist obtained from MX records, but is
20099 not the most preferred host in that list, it and any equally or less
20100 preferred hosts are removed before the sublist is inserted into the main list.
20101
20102 If the local host is the most preferred host in the MX list, what happens
20103 depends on where in the original list of hosts the &`/MX`& item appears. If it
20104 is not the first item (that is, there are previous hosts in the main list),
20105 Exim discards this name and any subsequent items in the main list.
20106
20107 If the MX item is first in the list of hosts, and the local host is the
20108 most preferred host, what happens is controlled by the &%self%& option of the
20109 router.
20110
20111 DNS failures when lookup up the MX records are treated in the same way as DNS
20112 failures when looking up IP addresses: &%pass_on_timeout%& and
20113 &%host_find_failed%& are used when relevant.
20114
20115 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20116 whether obtained from an MX lookup or not.
20117
20118
20119
20120 .section "How the options are used" "SECThowoptused"
20121 The options are a sequence of words, space-separated.
20122 One of the words can be the name of a transport; this overrides the
20123 &%transport%& option on the router for this particular routing rule only. The
20124 other words (if present) control randomization of the list of hosts on a
20125 per-rule basis, and how the IP addresses of the hosts are to be found when
20126 routing to a remote transport. These options are as follows:
20127
20128 .ilist
20129 &%randomize%&: randomize the order of the hosts in this list, overriding the
20130 setting of &%hosts_randomize%& for this routing rule only.
20131 .next
20132 &%no_randomize%&: do not randomize the order of the hosts in this list,
20133 overriding the setting of &%hosts_randomize%& for this routing rule only.
20134 .next
20135 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20136 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20137 also look in &_/etc/hosts_& or other sources of information.
20138 .next
20139 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20140 no address records are found. If there is a temporary DNS error (such as a
20141 timeout), delivery is deferred.
20142 .next
20143 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20144 .next
20145 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20146 .endlist
20147
20148 For example:
20149 .code
20150 route_list = domain1  host1:host2:host3  randomize bydns;\
20151              domain2  host4:host5
20152 .endd
20153 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20154 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20155 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20156 or &[gethostbyname()]&, and the result of the lookup is the result of that
20157 call.
20158
20159 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20160 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20161 instead of TRY_AGAIN. That is why the default action is to try a DNS
20162 lookup first. Only if that gives a definite &"no such host"& is the local
20163 function called.
20164
20165 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20166 inadvertent constraint that a transport name as an option had to be the last
20167 option specified.
20168
20169
20170
20171 If no IP address for a host can be found, what happens is controlled by the
20172 &%host_find_failed%& option.
20173
20174 .vindex "&$host$&"
20175 When an address is routed to a local transport, IP addresses are not looked up.
20176 The host list is passed to the transport in the &$host$& variable.
20177
20178
20179
20180 .section "Manualroute examples" "SECID123"
20181 In some of the examples that follow, the presence of the &%remote_smtp%&
20182 transport, as defined in the default configuration file, is assumed:
20183
20184 .ilist
20185 .cindex "smart host" "example router"
20186 The &(manualroute)& router can be used to forward all external mail to a
20187 &'smart host'&. If you have set up, in the main part of the configuration, a
20188 named domain list that contains your local domains, for example:
20189 .code
20190 domainlist local_domains = my.domain.example
20191 .endd
20192 You can arrange for all other domains to be routed to a smart host by making
20193 your first router something like this:
20194 .code
20195 smart_route:
20196   driver = manualroute
20197   domains = !+local_domains
20198   transport = remote_smtp
20199   route_list = * smarthost.ref.example
20200 .endd
20201 This causes all non-local addresses to be sent to the single host
20202 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20203 they are tried in order
20204 (but you can use &%hosts_randomize%& to vary the order each time).
20205 Another way of configuring the same thing is this:
20206 .code
20207 smart_route:
20208   driver = manualroute
20209   transport = remote_smtp
20210   route_list = !+local_domains  smarthost.ref.example
20211 .endd
20212 There is no difference in behaviour between these two routers as they stand.
20213 However, they behave differently if &%no_more%& is added to them. In the first
20214 example, the router is skipped if the domain does not match the &%domains%&
20215 precondition; the following router is always tried. If the router runs, it
20216 always matches the domain and so can never decline. Therefore, &%no_more%&
20217 would have no effect. In the second case, the router is never skipped; it
20218 always runs. However, if it doesn't match the domain, it declines. In this case
20219 &%no_more%& would prevent subsequent routers from running.
20220
20221 .next
20222 .cindex "mail hub example"
20223 A &'mail hub'& is a host which receives mail for a number of domains via MX
20224 records in the DNS and delivers it via its own private routing mechanism. Often
20225 the final destinations are behind a firewall, with the mail hub being the one
20226 machine that can connect to machines both inside and outside the firewall. The
20227 &(manualroute)& router is usually used on a mail hub to route incoming messages
20228 to the correct hosts. For a small number of domains, the routing can be inline,
20229 using the &%route_list%& option, but for a larger number a file or database
20230 lookup is easier to manage.
20231
20232 If the domain names are in fact the names of the machines to which the mail is
20233 to be sent by the mail hub, the configuration can be quite simple. For
20234 example:
20235 .code
20236 hub_route:
20237   driver = manualroute
20238   transport = remote_smtp
20239   route_list = *.rhodes.tvs.example  $domain
20240 .endd
20241 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20242 whose names are the same as the mail domains. A similar approach can be taken
20243 if the host name can be obtained from the domain name by a string manipulation
20244 that the expansion facilities can handle. Otherwise, a lookup based on the
20245 domain can be used to find the host:
20246 .code
20247 through_firewall:
20248   driver = manualroute
20249   transport = remote_smtp
20250   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20251 .endd
20252 The result of the lookup must be the name or IP address of the host (or
20253 hosts) to which the address is to be routed. If the lookup fails, the route
20254 data is empty, causing the router to decline. The address then passes to the
20255 next router.
20256
20257 .next
20258 .cindex "batched SMTP output example"
20259 .cindex "SMTP" "batched outgoing; example"
20260 You can use &(manualroute)& to deliver messages to pipes or files in batched
20261 SMTP format for onward transportation by some other means. This is one way of
20262 storing mail for a dial-up host when it is not connected. The route list entry
20263 can be as simple as a single domain name in a configuration like this:
20264 .code
20265 save_in_file:
20266   driver = manualroute
20267   transport = batchsmtp_appendfile
20268   route_list = saved.domain.example
20269 .endd
20270 though often a pattern is used to pick up more than one domain. If there are
20271 several domains or groups of domains with different transport requirements,
20272 different transports can be listed in the routing information:
20273 .code
20274 save_in_file:
20275   driver = manualroute
20276   route_list = \
20277     *.saved.domain1.example  $domain  batch_appendfile; \
20278     *.saved.domain2.example  \
20279       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20280       batch_pipe
20281 .endd
20282 .vindex "&$domain$&"
20283 .vindex "&$host$&"
20284 The first of these just passes the domain in the &$host$& variable, which
20285 doesn't achieve much (since it is also in &$domain$&), but the second does a
20286 file lookup to find a value to pass, causing the router to decline to handle
20287 the address if the lookup fails.
20288
20289 .next
20290 .cindex "UUCP" "example of router for"
20291 Routing mail directly to UUCP software is a specific case of the use of
20292 &(manualroute)& in a gateway to another mail environment. This is an example of
20293 one way it can be done:
20294 .code
20295 # Transport
20296 uucp:
20297   driver = pipe
20298   user = nobody
20299   command = /usr/local/bin/uux -r - \
20300     ${substr_-5:$host}!rmail ${local_part}
20301   return_fail_output = true
20302
20303 # Router
20304 uucphost:
20305   transport = uucp
20306   driver = manualroute
20307   route_data = \
20308     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20309 .endd
20310 The file &_/usr/local/exim/uucphosts_& contains entries like
20311 .code
20312 darksite.ethereal.example:           darksite.UUCP
20313 .endd
20314 It can be set up more simply without adding and removing &".UUCP"& but this way
20315 makes clear the distinction between the domain name
20316 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20317 .endlist
20318 .ecindex IIDmanrou1
20319 .ecindex IIDmanrou2
20320
20321
20322
20323
20324
20325
20326
20327
20328 . ////////////////////////////////////////////////////////////////////////////
20329 . ////////////////////////////////////////////////////////////////////////////
20330
20331 .chapter "The queryprogram router" "CHAPdriverlast"
20332 .scindex IIDquerou1 "&(queryprogram)& router"
20333 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20334 .cindex "routing" "by external program"
20335 The &(queryprogram)& router routes an address by running an external command
20336 and acting on its output. This is an expensive way to route, and is intended
20337 mainly for use in lightly-loaded systems, or for performing experiments.
20338 However, if it is possible to use the precondition options (&%domains%&,
20339 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20340 be used in special cases, even on a busy host. There are the following private
20341 options:
20342 .cindex "options" "&(queryprogram)& router"
20343
20344 .option command queryprogram string&!! unset
20345 This option must be set. It specifies the command that is to be run. The
20346 command is split up into a command name and arguments, and then each is
20347 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20348 &<<CHAPpipetransport>>&).
20349
20350
20351 .option command_group queryprogram string unset
20352 .cindex "gid (group id)" "in &(queryprogram)& router"
20353 This option specifies a gid to be set when running the command while routing an
20354 address for deliver. It must be set if &%command_user%& specifies a numerical
20355 uid. If it begins with a digit, it is interpreted as the numerical value of the
20356 gid. Otherwise it is looked up using &[getgrnam()]&.
20357
20358
20359 .option command_user queryprogram string unset
20360 .cindex "uid (user id)" "for &(queryprogram)&"
20361 This option must be set. It specifies the uid which is set when running the
20362 command while routing an address for delivery. If the value begins with a digit,
20363 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20364 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20365 not set, a value for the gid also.
20366
20367 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20368 root, which it does during a normal delivery in a conventional configuration.
20369 However, when an address is being verified during message reception, Exim is
20370 usually running as the Exim user, not as root. If the &(queryprogram)& router
20371 is called from a non-root process, Exim cannot change uid or gid before running
20372 the command. In this circumstance the command runs under the current uid and
20373 gid.
20374
20375
20376 .option current_directory queryprogram string /
20377 This option specifies an absolute path which is made the current directory
20378 before running the command.
20379
20380
20381 .option timeout queryprogram time 1h
20382 If the command does not complete within the timeout period, its process group
20383 is killed and the message is frozen. A value of zero time specifies no
20384 timeout.
20385
20386
20387 The standard output of the command is connected to a pipe, which is read when
20388 the command terminates. It should consist of a single line of output,
20389 containing up to five fields, separated by white space. The maximum length of
20390 the line is 1023 characters. Longer lines are silently truncated. The first
20391 field is one of the following words (case-insensitive):
20392
20393 .ilist
20394 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20395 below).
20396 .next
20397 &'Decline'&: the router declines; pass the address to the next router, unless
20398 &%no_more%& is set.
20399 .next
20400 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20401 subsequent text on the line is an error message. If the router is run as part
20402 of address verification during an incoming SMTP message, the message is
20403 included in the SMTP response.
20404 .next
20405 &'Defer'&: routing could not be completed at this time; try again later. Any
20406 subsequent text on the line is an error message which is logged. It is not
20407 included in any SMTP response.
20408 .next
20409 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20410 .next
20411 &'Pass'&: pass the address to the next router (or the router specified by
20412 &%pass_router%&), overriding &%no_more%&.
20413 .next
20414 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20415 new addresses, which are routed independently, starting with the first router,
20416 or the router specified by &%redirect_router%&, if set.
20417 .endlist
20418
20419 When the first word is &'accept'&, the remainder of the line consists of a
20420 number of keyed data values, as follows (split into two lines here, to fit on
20421 the page):
20422 .code
20423 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20424 LOOKUP=byname|bydns DATA=<text>
20425 .endd
20426 The data items can be given in any order, and all are optional. If no transport
20427 is included, the transport specified by the generic &%transport%& option is
20428 used. The list of hosts and the lookup type are needed only if the transport is
20429 an &(smtp)& transport that does not itself supply a list of hosts.
20430
20431 The format of the list of hosts is the same as for the &(manualroute)& router.
20432 As well as host names and IP addresses with optional port numbers, as described
20433 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20434 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20435 (see section &<<SECThostshowused>>&).
20436
20437 If the lookup type is not specified, Exim behaves as follows when trying to
20438 find an IP address for each host: First, a DNS lookup is done. If this yields
20439 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20440 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20441 result of the lookup is the result of that call.
20442
20443 .vindex "&$address_data$&"
20444 If the DATA field is set, its value is placed in the &$address_data$&
20445 variable. For example, this return line
20446 .code
20447 accept hosts=x1.y.example:x2.y.example data="rule1"
20448 .endd
20449 routes the address to the default transport, passing a list of two hosts. When
20450 the transport runs, the string &"rule1"& is in &$address_data$&.
20451 .ecindex IIDquerou1
20452 .ecindex IIDquerou2
20453
20454
20455
20456
20457 . ////////////////////////////////////////////////////////////////////////////
20458 . ////////////////////////////////////////////////////////////////////////////
20459
20460 .chapter "The redirect router" "CHAPredirect"
20461 .scindex IIDredrou1 "&(redirect)& router"
20462 .scindex IIDredrou2 "routers" "&(redirect)&"
20463 .cindex "alias file" "in a &(redirect)& router"
20464 .cindex "address redirection" "&(redirect)& router"
20465 The &(redirect)& router handles several kinds of address redirection. Its most
20466 common uses are for resolving local part aliases from a central alias file
20467 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20468 files, but it has many other potential uses. The incoming address can be
20469 redirected in several different ways:
20470
20471 .ilist
20472 It can be replaced by one or more new addresses which are themselves routed
20473 independently.
20474 .next
20475 It can be routed to be delivered to a given file or directory.
20476 .next
20477 It can be routed to be delivered to a specified pipe command.
20478 .next
20479 It can cause an automatic reply to be generated.
20480 .next
20481 It can be forced to fail, optionally with a custom error message.
20482 .next
20483 It can be temporarily deferred, optionally with a custom message.
20484 .next
20485 It can be discarded.
20486 .endlist
20487
20488 The generic &%transport%& option must not be set for &(redirect)& routers.
20489 However, there are some private options which define transports for delivery to
20490 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20491 &%pipe_transport%& and &%reply_transport%& descriptions below.
20492
20493 If success DSNs have been requested
20494 .cindex "DSN" "success"
20495 .cindex "Delivery Status Notification" "success"
20496 redirection triggers one and the DSN options are not passed any further.
20497
20498
20499
20500 .section "Redirection data" "SECID124"
20501 The router operates by interpreting a text string which it obtains either by
20502 expanding the contents of the &%data%& option, or by reading the entire
20503 contents of a file whose name is given in the &%file%& option. These two
20504 options are mutually exclusive. The first is commonly used for handling system
20505 aliases, in a configuration like this:
20506 .code
20507 system_aliases:
20508   driver = redirect
20509   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20510 .endd
20511 If the lookup fails, the expanded string in this example is empty. When the
20512 expansion of &%data%& results in an empty string, the router declines. A forced
20513 expansion failure also causes the router to decline; other expansion failures
20514 cause delivery to be deferred.
20515
20516 A configuration using &%file%& is commonly used for handling users'
20517 &_.forward_& files, like this:
20518 .code
20519 userforward:
20520   driver = redirect
20521   check_local_user
20522   file = $home/.forward
20523   no_verify
20524 .endd
20525 If the file does not exist, or causes no action to be taken (for example, it is
20526 empty or consists only of comments), the router declines. &*Warning*&: This
20527 is not the case when the file contains syntactically valid items that happen to
20528 yield empty addresses, for example, items containing only RFC 2822 address
20529 comments.
20530
20531
20532
20533 .section "Forward files and address verification" "SECID125"
20534 .cindex "address redirection" "while verifying"
20535 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20536 &_.forward_& files, as in the example above. There are two reasons for this:
20537
20538 .ilist
20539 When Exim is receiving an incoming SMTP message from a remote host, it is
20540 running under the Exim uid, not as root. Exim is unable to change uid to read
20541 the file as the user, and it may not be able to read it as the Exim user. So in
20542 practice the router may not be able to operate.
20543 .next
20544 However, even when the router can operate, the existence of a &_.forward_& file
20545 is unimportant when verifying an address. What should be checked is whether the
20546 local part is a valid user name or not. Cutting out the redirection processing
20547 saves some resources.
20548 .endlist
20549
20550
20551
20552
20553
20554
20555 .section "Interpreting redirection data" "SECID126"
20556 .cindex "Sieve filter" "specifying in redirection data"
20557 .cindex "filter" "specifying in redirection data"
20558 The contents of the data string, whether obtained from &%data%& or &%file%&,
20559 can be interpreted in two different ways:
20560
20561 .ilist
20562 If the &%allow_filter%& option is set true, and the data begins with the text
20563 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20564 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20565 respectively. Details of the syntax and semantics of filter files are described
20566 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20567 document is intended for use by end users.
20568 .next
20569 Otherwise, the data must be a comma-separated list of redirection items, as
20570 described in the next section.
20571 .endlist
20572
20573 When a message is redirected to a file (a &"mail folder"&), the filename given
20574 in a non-filter redirection list must always be an absolute path. A filter may
20575 generate a relative path &-- how this is handled depends on the transport's
20576 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20577 for the &(appendfile)& transport.
20578
20579
20580
20581 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20582 .cindex "address redirection" "non-filter list items"
20583 When the redirection data is not an Exim or Sieve filter, for example, if it
20584 comes from a conventional alias or forward file, it consists of a list of
20585 addresses, filenames, pipe commands, or certain special items (see section
20586 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20587 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20588 depending on their default values. The items in the list are separated by
20589 commas or newlines.
20590 If a comma is required in an item, the entire item must be enclosed in double
20591 quotes.
20592
20593 Lines starting with a # character are comments, and are ignored, and # may
20594 also appear following a comma, in which case everything between the # and the
20595 next newline character is ignored.
20596
20597 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20598 double quotes are retained because some forms of mail address require their use
20599 (but never to enclose the entire address). In the following description,
20600 &"item"& refers to what remains after any surrounding double quotes have been
20601 removed.
20602
20603 .vindex "&$local_part$&"
20604 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20605 and the expansion contains a reference to &$local_part$&, you should make use
20606 of the &%quote_local_part%& expansion operator, in case the local part contains
20607 special characters. For example, to redirect all mail for the domain
20608 &'obsolete.example'&, retaining the existing local part, you could use this
20609 setting:
20610 .code
20611 data = ${quote_local_part:$local_part}@newdomain.example
20612 .endd
20613
20614
20615 .section "Redirecting to a local mailbox" "SECTredlocmai"
20616 .cindex "routing" "loops in"
20617 .cindex "loop" "while routing, avoidance of"
20618 .cindex "address redirection" "to local mailbox"
20619 A redirection item may safely be the same as the address currently under
20620 consideration. This does not cause a routing loop, because a router is
20621 automatically skipped if any ancestor of the address that is being processed
20622 is the same as the current address and was processed by the current router.
20623 Such an address is therefore passed to the following routers, so it is handled
20624 as if there were no redirection. When making this loop-avoidance test, the
20625 complete local part, including any prefix or suffix, is used.
20626
20627 .cindex "address redirection" "local part without domain"
20628 Specifying the same local part without a domain is a common usage in personal
20629 filter files when the user wants to have messages delivered to the local
20630 mailbox and also forwarded elsewhere. For example, the user whose login is
20631 &'cleo'& might have a &_.forward_& file containing this:
20632 .code
20633 cleo, cleopatra@egypt.example
20634 .endd
20635 .cindex "backslash in alias file"
20636 .cindex "alias file" "backslash in"
20637 For compatibility with other MTAs, such unqualified local parts may be
20638 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20639 it does make a difference if more than one domain is being handled
20640 synonymously.
20641
20642 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20643 2822 address that does not include a domain, the item is qualified using the
20644 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20645 addresses are qualified using the value in &%qualify_recipient%&, but you can
20646 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20647
20648 Care must be taken if there are alias names for local users.
20649 Consider an MTA handling a single local domain where the system alias file
20650 contains:
20651 .code
20652 Sam.Reman: spqr
20653 .endd
20654 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20655 messages in the local mailbox, and also forward copies elsewhere. He creates
20656 this forward file:
20657 .code
20658 Sam.Reman, spqr@reme.elsewhere.example
20659 .endd
20660 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20661 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20662 second time round, because it has previously routed it,
20663 and the following routers presumably cannot handle the alias. The forward file
20664 should really contain
20665 .code
20666 spqr, spqr@reme.elsewhere.example
20667 .endd
20668 but because this is such a common error, the &%check_ancestor%& option (see
20669 below) exists to provide a way to get round it. This is normally set on a
20670 &(redirect)& router that is handling users' &_.forward_& files.
20671
20672
20673
20674 .section "Special items in redirection lists" "SECTspecitredli"
20675 In addition to addresses, the following types of item may appear in redirection
20676 lists (that is, in non-filter redirection data):
20677
20678 .ilist
20679 .cindex "pipe" "in redirection list"
20680 .cindex "address redirection" "to pipe"
20681 An item is treated as a pipe command if it begins with &"|"& and does not parse
20682 as a valid RFC 2822 address that includes a domain. A transport for running the
20683 command must be specified by the &%pipe_transport%& option.
20684 Normally, either the router or the transport specifies a user and a group under
20685 which to run the delivery. The default is to use the Exim user and group.
20686
20687 Single or double quotes can be used for enclosing the individual arguments of
20688 the pipe command; no interpretation of escapes is done for single quotes. If
20689 the command contains a comma character, it is necessary to put the whole item
20690 in double quotes, for example:
20691 .code
20692 "|/some/command ready,steady,go"
20693 .endd
20694 since items in redirection lists are terminated by commas. Do not, however,
20695 quote just the command. An item such as
20696 .code
20697 |"/some/command ready,steady,go"
20698 .endd
20699 is interpreted as a pipe with a rather strange command name, and no arguments.
20700
20701 Note that the above example assumes that the text comes from a lookup source
20702 of some sort, so that the quotes are part of the data.  If composing a
20703 redirect router with a &%data%& option directly specifying this command, the
20704 quotes will be used by the configuration parser to define the extent of one
20705 string, but will not be passed down into the redirect router itself.  There
20706 are two main approaches to get around this: escape quotes to be part of the
20707 data itself, or avoid using this mechanism and instead create a custom
20708 transport with the &%command%& option set and reference that transport from
20709 an &%accept%& router.
20710
20711 .next
20712 .cindex "file" "in redirection list"
20713 .cindex "address redirection" "to file"
20714 An item is interpreted as a path name if it begins with &"/"& and does not
20715 parse as a valid RFC 2822 address that includes a domain. For example,
20716 .code
20717 /home/world/minbari
20718 .endd
20719 is treated as a filename, but
20720 .code
20721 /s=molari/o=babylon/@x400gate.way
20722 .endd
20723 is treated as an address. For a filename, a transport must be specified using
20724 the &%file_transport%& option. However, if the generated path name ends with a
20725 forward slash character, it is interpreted as a directory name rather than a
20726 filename, and &%directory_transport%& is used instead.
20727
20728 Normally, either the router or the transport specifies a user and a group under
20729 which to run the delivery. The default is to use the Exim user and group.
20730
20731 .cindex "&_/dev/null_&"
20732 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20733 bypassed at a high level, and the log entry shows &"**bypassed**"&
20734 instead of a transport name. In this case the user and group are not used.
20735
20736 .next
20737 .cindex "included address list"
20738 .cindex "address redirection" "included external list"
20739 If an item is of the form
20740 .code
20741 :include:<path name>
20742 .endd
20743 a list of further items is taken from the given file and included at that
20744 point. &*Note*&: Such a file can not be a filter file; it is just an
20745 out-of-line addition to the list. The items in the included list are separated
20746 by commas or newlines and are not subject to expansion. If this is the first
20747 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20748 the alias name. This example is incorrect:
20749 .code
20750 list1    :include:/opt/lists/list1
20751 .endd
20752 It must be given as
20753 .code
20754 list1:   :include:/opt/lists/list1
20755 .endd
20756 .next
20757 .cindex "address redirection" "to black hole"
20758 .cindex "delivery" "discard"
20759 .cindex "delivery" "blackhole"
20760 .cindex "black hole"
20761 .cindex "abandoning mail"
20762 Sometimes you want to throw away mail to a particular local part.  Making the
20763 &%data%& option expand to an empty string does not work, because that causes
20764 the router to decline. Instead, the alias item
20765 .code
20766 :blackhole:
20767 .endd
20768 can be used. It does what its name implies. No delivery is
20769 done, and no error message is generated. This has the same effect as specifying
20770 &_/dev/null_& as a destination, but it can be independently disabled.
20771
20772 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20773 delivery is done for the original local part, even if other redirection items
20774 are present. If you are generating a multi-item list (for example, by reading a
20775 database) and need the ability to provide a no-op item, you must use
20776 &_/dev/null_&.
20777
20778 .next
20779 .cindex "delivery" "forcing failure"
20780 .cindex "delivery" "forcing deferral"
20781 .cindex "failing delivery" "forcing"
20782 .cindex "deferred delivery, forcing"
20783 .cindex "customizing" "failure message"
20784 An attempt to deliver a particular address can be deferred or forced to fail by
20785 redirection items of the form
20786 .code
20787 :defer:
20788 :fail:
20789 .endd
20790 respectively. When a redirection list contains such an item, it applies
20791 to the entire redirection; any other items in the list are ignored. Any
20792 text following &':fail:'& or &':defer:'& is placed in the error text
20793 associated with the failure. For example, an alias file might contain:
20794 .code
20795 X.Employee:  :fail: Gone away, no forwarding address
20796 .endd
20797 In the case of an address that is being verified from an ACL or as the subject
20798 of a
20799 .cindex "VRFY" "error text, display of"
20800 VRFY command, the text is included in the SMTP error response by
20801 default.
20802 .cindex "EXPN" "error text, display of"
20803 The text is not included in the response to an EXPN command. In non-SMTP cases
20804 the text is included in the error message that Exim generates.
20805
20806 .cindex "SMTP" "error codes"
20807 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20808 &':fail:'&. However, if the message starts with three digits followed by a
20809 space, optionally followed by an extended code of the form &'n.n.n'&, also
20810 followed by a space, and the very first digit is the same as the default error
20811 code, the code from the message is used instead. If the very first digit is
20812 incorrect, a panic error is logged, and the default code is used. You can
20813 suppress the use of the supplied code in a redirect router by setting the
20814 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20815 ignored.
20816
20817 .vindex "&$acl_verify_message$&"
20818 In an ACL, an explicitly provided message overrides the default, but the
20819 default message is available in the variable &$acl_verify_message$& and can
20820 therefore be included in a custom message if this is desired.
20821
20822 Normally the error text is the rest of the redirection list &-- a comma does
20823 not terminate it &-- but a newline does act as a terminator. Newlines are not
20824 normally present in alias expansions. In &(lsearch)& lookups they are removed
20825 as part of the continuation process, but they may exist in other kinds of
20826 lookup and in &':include:'& files.
20827
20828 During routing for message delivery (as opposed to verification), a redirection
20829 containing &':fail:'& causes an immediate failure of the incoming address,
20830 whereas &':defer:'& causes the message to remain in the queue so that a
20831 subsequent delivery attempt can happen at a later time. If an address is
20832 deferred for too long, it will ultimately fail, because the normal retry
20833 rules still apply.
20834
20835 .next
20836 .cindex "alias file" "exception to default"
20837 Sometimes it is useful to use a single-key search type with a default (see
20838 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20839 for exceptions to the default. These can be handled by aliasing them to
20840 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20841 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20842 results in an empty redirection list has the same effect.
20843 .endlist
20844
20845
20846 .section "Duplicate addresses" "SECTdupaddr"
20847 .cindex "duplicate addresses"
20848 .cindex "address duplicate, discarding"
20849 .cindex "pipe" "duplicated"
20850 Exim removes duplicate addresses from the list to which it is delivering, so as
20851 to deliver just one copy to each address. This does not apply to deliveries
20852 routed to pipes by different immediate parent addresses, but an indirect
20853 aliasing scheme of the type
20854 .code
20855 pipe:       |/some/command $local_part
20856 localpart1: pipe
20857 localpart2: pipe
20858 .endd
20859 does not work with a message that is addressed to both local parts, because
20860 when the second is aliased to the intermediate local part &"pipe"& it gets
20861 discarded as being the same as a previously handled address. However, a scheme
20862 such as
20863 .code
20864 localpart1: |/some/command $local_part
20865 localpart2: |/some/command $local_part
20866 .endd
20867 does result in two different pipe deliveries, because the immediate parents of
20868 the pipes are distinct.
20869
20870
20871
20872 .section "Repeated redirection expansion" "SECID128"
20873 .cindex "repeated redirection expansion"
20874 .cindex "address redirection" "repeated for each delivery attempt"
20875 When a message cannot be delivered to all of its recipients immediately,
20876 leading to two or more delivery attempts, redirection expansion is carried out
20877 afresh each time for those addresses whose children were not all previously
20878 delivered. If redirection is being used as a mailing list, this can lead to new
20879 members of the list receiving copies of old messages. The &%one_time%& option
20880 can be used to avoid this.
20881
20882
20883 .section "Errors in redirection lists" "SECID129"
20884 .cindex "address redirection" "errors"
20885 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20886 error is skipped, and an entry is written to the main log. This may be useful
20887 for mailing lists that are automatically managed. Otherwise, if an error is
20888 detected while generating the list of new addresses, the original address is
20889 deferred. See also &%syntax_errors_to%&.
20890
20891
20892
20893 .section "Private options for the redirect router" "SECID130"
20894
20895 .cindex "options" "&(redirect)& router"
20896 The private options for the &(redirect)& router are as follows:
20897
20898
20899 .option allow_defer redirect boolean false
20900 Setting this option allows the use of &':defer:'& in non-filter redirection
20901 data, or the &%defer%& command in an Exim filter file.
20902
20903
20904 .option allow_fail redirect boolean false
20905 .cindex "failing delivery" "from filter"
20906 If this option is true, the &':fail:'& item can be used in a redirection list,
20907 and the &%fail%& command may be used in an Exim filter file.
20908
20909
20910 .option allow_filter redirect boolean false
20911 .cindex "filter" "enabling use of"
20912 .cindex "Sieve filter" "enabling use of"
20913 Setting this option allows Exim to interpret redirection data that starts with
20914 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20915 are some features of Exim filter files that some administrators may wish to
20916 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20917
20918 It is also possible to lock out Exim filters or Sieve filters while allowing
20919 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20920
20921
20922 The filter is run using the uid and gid set by the generic &%user%& and
20923 &%group%& options. These take their defaults from the password data if
20924 &%check_local_user%& is set, so in the normal case of users' personal filter
20925 files, the filter is run as the relevant user. When &%allow_filter%& is set
20926 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20927
20928
20929
20930 .option allow_freeze redirect boolean false
20931 .cindex "freezing messages" "allowing in filter"
20932 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20933 This command is more normally encountered in system filters, and is disabled by
20934 default for redirection filters because it isn't something you usually want to
20935 let ordinary users do.
20936
20937
20938
20939 .option check_ancestor redirect boolean false
20940 This option is concerned with handling generated addresses that are the same
20941 as some address in the list of redirection ancestors of the current address.
20942 Although it is turned off by default in the code, it is set in the default
20943 configuration file for handling users' &_.forward_& files. It is recommended
20944 for this use of the &(redirect)& router.
20945
20946 When &%check_ancestor%& is set, if a generated address (including the domain)
20947 is the same as any ancestor of the current address, it is replaced by a copy of
20948 the current address. This helps in the case where local part A is aliased to B,
20949 and B has a &_.forward_& file pointing back to A. For example, within a single
20950 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20951 &_&~jb/.forward_& contains:
20952 .code
20953 \Joe.Bloggs, <other item(s)>
20954 .endd
20955 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20956 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20957 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20958 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20959 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20960 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20961 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20962 original address. See also the &%repeat_use%& option below.
20963
20964
20965 .option check_group redirect boolean "see below"
20966 When the &%file%& option is used, the group owner of the file is checked only
20967 when this option is set. The permitted groups are those listed in the
20968 &%owngroups%& option, together with the user's default group if
20969 &%check_local_user%& is set. If the file has the wrong group, routing is
20970 deferred. The default setting for this option is true if &%check_local_user%&
20971 is set and the &%modemask%& option permits the group write bit, or if the
20972 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20973
20974
20975
20976 .option check_owner redirect boolean "see below"
20977 When the &%file%& option is used, the owner of the file is checked only when
20978 this option is set. If &%check_local_user%& is set, the local user is
20979 permitted; otherwise the owner must be one of those listed in the &%owners%&
20980 option. The default value for this option is true if &%check_local_user%& or
20981 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20982
20983
20984 .option data redirect string&!! unset
20985 This option is mutually exclusive with &%file%&. One or other of them must be
20986 set, but not both. The contents of &%data%& are expanded, and then used as the
20987 list of forwarding items, or as a set of filtering instructions. If the
20988 expansion is forced to fail, or the result is an empty string or a string that
20989 has no effect (consists entirely of comments), the router declines.
20990
20991 When filtering instructions are used, the string must begin with &"#Exim
20992 filter"&, and all comments in the string, including this initial one, must be
20993 terminated with newline characters. For example:
20994 .code
20995 data = #Exim filter\n\
20996        if $h_to: contains Exim then save $home/mail/exim endif
20997 .endd
20998 If you are reading the data from a database where newlines cannot be included,
20999 you can use the &${sg}$& expansion item to turn the escape string of your
21000 choice into a newline.
21001
21002
21003 .option directory_transport redirect string&!! unset
21004 A &(redirect)& router sets up a direct delivery to a directory when a path name
21005 ending with a slash is specified as a new &"address"&. The transport used is
21006 specified by this option, which, after expansion, must be the name of a
21007 configured transport. This should normally be an &(appendfile)& transport.
21008
21009
21010 .option file redirect string&!! unset
21011 This option specifies the name of a file that contains the redirection data. It
21012 is mutually exclusive with the &%data%& option. The string is expanded before
21013 use; if the expansion is forced to fail, the router declines. Other expansion
21014 failures cause delivery to be deferred. The result of a successful expansion
21015 must be an absolute path. The entire file is read and used as the redirection
21016 data. If the data is an empty string or a string that has no effect (consists
21017 entirely of comments), the router declines.
21018
21019 .cindex "NFS" "checking for file existence"
21020 If the attempt to open the file fails with a &"does not exist"& error, Exim
21021 runs a check on the containing directory,
21022 unless &%ignore_enotdir%& is true (see below).
21023 If the directory does not appear to exist, delivery is deferred. This can
21024 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21025 is a mount problem. If the containing directory does exist, but the file does
21026 not, the router declines.
21027
21028
21029 .option file_transport redirect string&!! unset
21030 .vindex "&$address_file$&"
21031 A &(redirect)& router sets up a direct delivery to a file when a path name not
21032 ending in a slash is specified as a new &"address"&. The transport used is
21033 specified by this option, which, after expansion, must be the name of a
21034 configured transport. This should normally be an &(appendfile)& transport. When
21035 it is running, the filename is in &$address_file$&.
21036
21037
21038 .option filter_prepend_home redirect boolean true
21039 When this option is true, if a &(save)& command in an Exim filter specifies a
21040 relative path, and &$home$& is defined, it is automatically prepended to the
21041 relative path. If this option is set false, this action does not happen. The
21042 relative path is then passed to the transport unmodified.
21043
21044
21045 .option forbid_blackhole redirect boolean false
21046 .cindex "restricting access to features"
21047 .cindex "filter" "locking out certain features"
21048 If this option is true, the &':blackhole:'& item may not appear in a
21049 redirection list.
21050
21051
21052 .option forbid_exim_filter redirect boolean false
21053 .cindex "restricting access to features"
21054 .cindex "filter" "locking out certain features"
21055 If this option is set true, only Sieve filters are permitted when
21056 &%allow_filter%& is true.
21057
21058
21059
21060
21061 .option forbid_file redirect boolean false
21062 .cindex "restricting access to features"
21063 .cindex "delivery" "to file; forbidding"
21064 .cindex "filter" "locking out certain features"
21065 .cindex "Sieve filter" "forbidding delivery to a file"
21066 .cindex "Sieve filter" "&""keep""& facility; disabling"
21067 If this option is true, this router may not generate a new address that
21068 specifies delivery to a local file or directory, either from a filter or from a
21069 conventional forward file. This option is forced to be true if &%one_time%& is
21070 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21071 locks out the Sieve's &"keep"& facility.
21072
21073
21074 .option forbid_filter_dlfunc redirect boolean false
21075 .cindex "restricting access to features"
21076 .cindex "filter" "locking out certain features"
21077 If this option is true, string expansions in Exim filters are not allowed to
21078 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21079 functions.
21080
21081 .option forbid_filter_existstest redirect boolean false
21082 .cindex "restricting access to features"
21083 .cindex "filter" "locking out certain features"
21084 .cindex "expansion" "statting a file"
21085 If this option is true, string expansions in Exim filters are not allowed to
21086 make use of the &%exists%& condition or the &%stat%& expansion item.
21087
21088 .option forbid_filter_logwrite redirect boolean false
21089 .cindex "restricting access to features"
21090 .cindex "filter" "locking out certain features"
21091 If this option is true, use of the logging facility in Exim filters is not
21092 permitted. Logging is in any case available only if the filter is being run
21093 under some unprivileged uid (which is normally the case for ordinary users'
21094 &_.forward_& files).
21095
21096
21097 .option forbid_filter_lookup redirect boolean false
21098 .cindex "restricting access to features"
21099 .cindex "filter" "locking out certain features"
21100 If this option is true, string expansions in Exim filter files are not allowed
21101 to make use of &%lookup%& items.
21102
21103
21104 .option forbid_filter_perl redirect boolean false
21105 .cindex "restricting access to features"
21106 .cindex "filter" "locking out certain features"
21107 This option has an effect only if Exim is built with embedded Perl support. If
21108 it is true, string expansions in Exim filter files are not allowed to make use
21109 of the embedded Perl support.
21110
21111
21112 .option forbid_filter_readfile redirect boolean false
21113 .cindex "restricting access to features"
21114 .cindex "filter" "locking out certain features"
21115 If this option is true, string expansions in Exim filter files are not allowed
21116 to make use of &%readfile%& items.
21117
21118
21119 .option forbid_filter_readsocket redirect boolean false
21120 .cindex "restricting access to features"
21121 .cindex "filter" "locking out certain features"
21122 If this option is true, string expansions in Exim filter files are not allowed
21123 to make use of &%readsocket%& items.
21124
21125
21126 .option forbid_filter_reply redirect boolean false
21127 .cindex "restricting access to features"
21128 .cindex "filter" "locking out certain features"
21129 If this option is true, this router may not generate an automatic reply
21130 message. Automatic replies can be generated only from Exim or Sieve filter
21131 files, not from traditional forward files. This option is forced to be true if
21132 &%one_time%& is set.
21133
21134
21135 .option forbid_filter_run redirect boolean false
21136 .cindex "restricting access to features"
21137 .cindex "filter" "locking out certain features"
21138 If this option is true, string expansions in Exim filter files are not allowed
21139 to make use of &%run%& items.
21140
21141
21142 .option forbid_include redirect boolean false
21143 .cindex "restricting access to features"
21144 .cindex "filter" "locking out certain features"
21145 If this option is true, items of the form
21146 .code
21147 :include:<path name>
21148 .endd
21149 are not permitted in non-filter redirection lists.
21150
21151
21152 .option forbid_pipe redirect boolean false
21153 .cindex "restricting access to features"
21154 .cindex "filter" "locking out certain features"
21155 .cindex "delivery" "to pipe; forbidding"
21156 If this option is true, this router may not generate a new address which
21157 specifies delivery to a pipe, either from an Exim filter or from a conventional
21158 forward file. This option is forced to be true if &%one_time%& is set.
21159
21160
21161 .option forbid_sieve_filter redirect boolean false
21162 .cindex "restricting access to features"
21163 .cindex "filter" "locking out certain features"
21164 If this option is set true, only Exim filters are permitted when
21165 &%allow_filter%& is true.
21166
21167
21168 .cindex "SMTP" "error codes"
21169 .option forbid_smtp_code redirect boolean false
21170 If this option is set true, any SMTP error codes that are present at the start
21171 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21172 the default codes (451 and 550, respectively) are always used.
21173
21174
21175
21176
21177 .option hide_child_in_errmsg redirect boolean false
21178 .cindex "bounce message" "redirection details; suppressing"
21179 If this option is true, it prevents Exim from quoting a child address if it
21180 generates a bounce or delay message for it. Instead it says &"an address
21181 generated from <&'the top level address'&>"&. Of course, this applies only to
21182 bounces generated locally. If a message is forwarded to another host, &'its'&
21183 bounce may well quote the generated address.
21184
21185
21186 .option ignore_eacces redirect boolean false
21187 .cindex "EACCES"
21188 If this option is set and an attempt to open a redirection file yields the
21189 EACCES error (permission denied), the &(redirect)& router behaves as if the
21190 file did not exist.
21191
21192
21193 .option ignore_enotdir redirect boolean false
21194 .cindex "ENOTDIR"
21195 If this option is set and an attempt to open a redirection file yields the
21196 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21197 router behaves as if the file did not exist.
21198
21199 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21200 router that has the &%file%& option set discovers that the file does not exist
21201 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21202 against unmounted NFS directories. If the parent can not be statted, delivery
21203 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21204 is set, because that option tells Exim to ignore &"something on the path is not
21205 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21206 that some operating systems give ENOENT where others give ENOTDIR.
21207
21208
21209
21210 .option include_directory redirect string unset
21211 If this option is set, the path names of any &':include:'& items in a
21212 redirection list must start with this directory.
21213
21214
21215 .option modemask redirect "octal integer" 022
21216 This specifies mode bits which must not be set for a file specified by the
21217 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21218
21219
21220 .option one_time redirect boolean false
21221 .cindex "one-time aliasing/forwarding expansion"
21222 .cindex "alias file" "one-time expansion"
21223 .cindex "forward file" "one-time expansion"
21224 .cindex "mailing lists" "one-time expansion"
21225 .cindex "address redirection" "one-time expansion"
21226 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21227 files each time it tries to deliver a message causes a problem when one or more
21228 of the generated addresses fails be delivered at the first attempt. The problem
21229 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21230 but of what happens when the redirection list changes during the time that the
21231 message is on Exim's queue. This is particularly true in the case of mailing
21232 lists, where new subscribers might receive copies of messages that were posted
21233 before they subscribed.
21234
21235 If &%one_time%& is set and any addresses generated by the router fail to
21236 deliver at the first attempt, the failing addresses are added to the message as
21237 &"top level"& addresses, and the parent address that generated them is marked
21238 &"delivered"&. Thus, redirection does not happen again at the next delivery
21239 attempt.
21240
21241 &*Warning 1*&: Any header line addition or removal that is specified by this
21242 router would be lost if delivery did not succeed at the first attempt. For this
21243 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21244 permitted when &%one_time%& is set.
21245
21246 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21247 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21248 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21249
21250 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21251 &%one_time%&.
21252
21253 The original top-level address is remembered with each of the generated
21254 addresses, and is output in any log messages. However, any intermediate parent
21255 addresses are not recorded. This makes a difference to the log only if
21256 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21257 typically be used for mailing lists, where there is normally just one level of
21258 expansion.
21259
21260
21261 .option owners redirect "string list" unset
21262 .cindex "ownership" "alias file"
21263 .cindex "ownership" "forward file"
21264 .cindex "alias file" "ownership"
21265 .cindex "forward file" "ownership"
21266 This specifies a list of permitted owners for the file specified by &%file%&.
21267 This list is in addition to the local user when &%check_local_user%& is set.
21268 See &%check_owner%& above.
21269
21270
21271 .option owngroups redirect "string list" unset
21272 This specifies a list of permitted groups for the file specified by &%file%&.
21273 The list is in addition to the local user's primary group when
21274 &%check_local_user%& is set. See &%check_group%& above.
21275
21276
21277 .option pipe_transport redirect string&!! unset
21278 .vindex "&$address_pipe$&"
21279 A &(redirect)& router sets up a direct delivery to a pipe when a string
21280 starting with a vertical bar character is specified as a new &"address"&. The
21281 transport used is specified by this option, which, after expansion, must be the
21282 name of a configured transport. This should normally be a &(pipe)& transport.
21283 When the transport is run, the pipe command is in &$address_pipe$&.
21284
21285
21286 .option qualify_domain redirect string&!! unset
21287 .vindex "&$qualify_recipient$&"
21288 If this option is set, and an unqualified address (one without a domain) is
21289 generated, and that address would normally be qualified by the global setting
21290 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21291 expanding this string. If the expansion fails, the router declines. If you want
21292 to revert to the default, you can have the expansion generate
21293 &$qualify_recipient$&.
21294
21295 This option applies to all unqualified addresses generated by Exim filters,
21296 but for traditional &_.forward_& files, it applies only to addresses that are
21297 not preceded by a backslash. Sieve filters cannot generate unqualified
21298 addresses.
21299
21300 .option qualify_preserve_domain redirect boolean false
21301 .cindex "domain" "in redirection; preserving"
21302 .cindex "preserving domain in redirection"
21303 .cindex "address redirection" "domain; preserving"
21304 If this option is set, the router's local &%qualify_domain%& option must not be
21305 set (a configuration error occurs if it is). If an unqualified address (one
21306 without a domain) is generated, it is qualified with the domain of the parent
21307 address (the immediately preceding ancestor) instead of the global
21308 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21309 this applies whether or not the address is preceded by a backslash.
21310
21311
21312 .option repeat_use redirect boolean true
21313 If this option is set false, the router is skipped for a child address that has
21314 any ancestor that was routed by this router. This test happens before any of
21315 the other preconditions are tested. Exim's default anti-looping rules skip
21316 only when the ancestor is the same as the current address. See also
21317 &%check_ancestor%& above and the generic &%redirect_router%& option.
21318
21319
21320 .option reply_transport redirect string&!! unset
21321 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21322 &%vacation%& command is used in a filter file. The transport used is specified
21323 by this option, which, after expansion, must be the name of a configured
21324 transport. This should normally be an &(autoreply)& transport. Other transports
21325 are unlikely to do anything sensible or useful.
21326
21327
21328 .option rewrite redirect boolean true
21329 .cindex "address redirection" "disabling rewriting"
21330 If this option is set false, addresses generated by the router are not
21331 subject to address rewriting. Otherwise, they are treated like new addresses
21332 and are rewritten according to the global rewriting rules.
21333
21334
21335 .option sieve_subaddress redirect string&!! unset
21336 The value of this option is passed to a Sieve filter to specify the
21337 :subaddress part of an address.
21338
21339 .option sieve_useraddress redirect string&!! unset
21340 The value of this option is passed to a Sieve filter to specify the :user part
21341 of an address. However, if it is unset, the entire original local part
21342 (including any prefix or suffix) is used for :user.
21343
21344
21345 .option sieve_vacation_directory redirect string&!! unset
21346 .cindex "Sieve filter" "vacation directory"
21347 To enable the &"vacation"& extension for Sieve filters, you must set
21348 &%sieve_vacation_directory%& to the directory where vacation databases are held
21349 (do not put anything else in that directory), and ensure that the
21350 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21351 needs their own directory; Exim will create it if necessary.
21352
21353
21354
21355 .option skip_syntax_errors redirect boolean false
21356 .cindex "forward file" "broken"
21357 .cindex "address redirection" "broken files"
21358 .cindex "alias file" "broken"
21359 .cindex "broken alias or forward files"
21360 .cindex "ignoring faulty addresses"
21361 .cindex "skipping faulty addresses"
21362 .cindex "error" "skipping bad syntax"
21363 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21364 non-filter redirection data are skipped, and each failing address is logged. If
21365 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21366 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21367 are expanded and placed at the head of the error message generated by
21368 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21369 be the same address as the generic &%errors_to%& option. The
21370 &%skip_syntax_errors%& option is often used when handling mailing lists.
21371
21372 If all the addresses in a redirection list are skipped because of syntax
21373 errors, the router declines to handle the original address, and it is passed to
21374 the following routers.
21375
21376 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21377 error in the filter causes filtering to be abandoned without any action being
21378 taken. The incident is logged, and the router declines to handle the address,
21379 so it is passed to the following routers.
21380
21381 .cindex "Sieve filter" "syntax errors in"
21382 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21383 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21384 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21385
21386 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21387 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21388 option, used with an address that does not get redirected, can be used to
21389 notify users of these errors, by means of a router like this:
21390 .code
21391 userforward:
21392   driver = redirect
21393   allow_filter
21394   check_local_user
21395   file = $home/.forward
21396   file_transport = address_file
21397   pipe_transport = address_pipe
21398   reply_transport = address_reply
21399   no_verify
21400   skip_syntax_errors
21401   syntax_errors_to = real-$local_part@$domain
21402   syntax_errors_text = \
21403    This is an automatically generated message. An error has\n\
21404    been found in your .forward file. Details of the error are\n\
21405    reported below. While this error persists, you will receive\n\
21406    a copy of this message for every message that is addressed\n\
21407    to you. If your .forward file is a filter file, or if it is\n\
21408    a non-filter file containing no valid forwarding addresses,\n\
21409    a copy of each incoming message will be put in your normal\n\
21410    mailbox. If a non-filter file contains at least one valid\n\
21411    forwarding address, forwarding to the valid addresses will\n\
21412    happen, and those will be the only deliveries that occur.
21413 .endd
21414 You also need a router to ensure that local addresses that are prefixed by
21415 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21416 put this immediately before the &(userforward)& router:
21417 .code
21418 real_localuser:
21419   driver = accept
21420   check_local_user
21421   local_part_prefix = real-
21422   transport = local_delivery
21423 .endd
21424 For security, it would probably be a good idea to restrict the use of this
21425 router to locally-generated messages, using a condition such as this:
21426 .code
21427   condition = ${if match {$sender_host_address}\
21428                          {\N^(|127\.0\.0\.1)$\N}}
21429 .endd
21430
21431
21432 .option syntax_errors_text redirect string&!! unset
21433 See &%skip_syntax_errors%& above.
21434
21435
21436 .option syntax_errors_to redirect string unset
21437 See &%skip_syntax_errors%& above.
21438 .ecindex IIDredrou1
21439 .ecindex IIDredrou2
21440
21441
21442
21443
21444
21445
21446 . ////////////////////////////////////////////////////////////////////////////
21447 . ////////////////////////////////////////////////////////////////////////////
21448
21449 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21450          "Environment for local transports"
21451 .scindex IIDenvlotra1 "local transports" "environment for"
21452 .scindex IIDenvlotra2 "environment" "local transports"
21453 .scindex IIDenvlotra3 "transport" "local; environment for"
21454 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21455 transport can be thought of as similar to a pipe.) Exim always runs transports
21456 in subprocesses, under specified uids and gids. Typical deliveries to local
21457 mailboxes run under the uid and gid of the local user.
21458
21459 Exim also sets a specific current directory while running the transport; for
21460 some transports a home directory setting is also relevant. The &(pipe)&
21461 transport is the only one that sets up environment variables; see section
21462 &<<SECTpipeenv>>& for details.
21463
21464 The values used for the uid, gid, and the directories may come from several
21465 different places. In many cases, the router that handles the address associates
21466 settings with that address as a result of its &%check_local_user%&, &%group%&,
21467 or &%user%& options. However, values may also be given in the transport's own
21468 configuration, and these override anything that comes from the router.
21469
21470
21471
21472 .section "Concurrent deliveries" "SECID131"
21473 .cindex "concurrent deliveries"
21474 .cindex "simultaneous deliveries"
21475 If two different messages for the same local recipient arrive more or less
21476 simultaneously, the two delivery processes are likely to run concurrently. When
21477 the &(appendfile)& transport is used to write to a file, Exim applies locking
21478 rules to stop concurrent processes from writing to the same file at the same
21479 time.
21480
21481 However, when you use a &(pipe)& transport, it is up to you to arrange any
21482 locking that is needed. Here is a silly example:
21483 .code
21484 my_transport:
21485   driver = pipe
21486   command = /bin/sh -c 'cat >>/some/file'
21487 .endd
21488 This is supposed to write the message at the end of the file. However, if two
21489 messages arrive at the same time, the file will be scrambled. You can use the
21490 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21491 file using the same algorithm that Exim itself uses.
21492
21493
21494
21495
21496 .section "Uids and gids" "SECTenvuidgid"
21497 .cindex "local transports" "uid and gid"
21498 .cindex "transport" "local; uid and gid"
21499 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21500 overrides any group that the router set in the address, even if &%user%& is not
21501 set for the transport. This makes it possible, for example, to run local mail
21502 delivery under the uid of the recipient (set by the router), but in a special
21503 group (set by the transport). For example:
21504 .code
21505 # Routers ...
21506 # User/group are set by check_local_user in this router
21507 local_users:
21508   driver = accept
21509   check_local_user
21510   transport = group_delivery
21511
21512 # Transports ...
21513 # This transport overrides the group
21514 group_delivery:
21515   driver = appendfile
21516   file = /var/spool/mail/$local_part
21517   group = mail
21518 .endd
21519 If &%user%& is set for a transport, its value overrides what is set in the
21520 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21521 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21522 set.
21523
21524 .oindex "&%initgroups%&"
21525 When the uid is taken from the transport's configuration, the &[initgroups()]&
21526 function is called for the groups associated with that uid if the
21527 &%initgroups%& option is set for the transport. When the uid is not specified
21528 by the transport, but is associated with the address by a router, the option
21529 for calling &[initgroups()]& is taken from the router configuration.
21530
21531 .cindex "&(pipe)& transport" "uid for"
21532 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21533 is set and &%user%& is not set, the uid of the process that called Exim to
21534 receive the message is used, and if &%group%& is not set, the corresponding
21535 original gid is also used.
21536
21537 This is the detailed preference order for obtaining a gid; the first of the
21538 following that is set is used:
21539
21540 .ilist
21541 A &%group%& setting of the transport;
21542 .next
21543 A &%group%& setting of the router;
21544 .next
21545 A gid associated with a user setting of the router, either as a result of
21546 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21547 .next
21548 The group associated with a non-numeric &%user%& setting of the transport;
21549 .next
21550 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21551 the uid is the creator's uid;
21552 .next
21553 The Exim gid if the Exim uid is being used as a default.
21554 .endlist
21555
21556 If, for example, the user is specified numerically on the router and there are
21557 no group settings, no gid is available. In this situation, an error occurs.
21558 This is different for the uid, for which there always is an ultimate default.
21559 The first of the following that is set is used:
21560
21561 .ilist
21562 A &%user%& setting of the transport;
21563 .next
21564 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21565 .next
21566 A &%user%& setting of the router;
21567 .next
21568 A &%check_local_user%& setting of the router;
21569 .next
21570 The Exim uid.
21571 .endlist
21572
21573 Of course, an error will still occur if the uid that is chosen is on the
21574 &%never_users%& list.
21575
21576
21577
21578
21579
21580 .section "Current and home directories" "SECID132"
21581 .cindex "current directory for local transport"
21582 .cindex "home directory" "for local transport"
21583 .cindex "transport" "local; home directory for"
21584 .cindex "transport" "local; current directory for"
21585 Routers may set current and home directories for local transports by means of
21586 the &%transport_current_directory%& and &%transport_home_directory%& options.
21587 However, if the transport's &%current_directory%& or &%home_directory%& options
21588 are set, they override the router's values. In detail, the home directory
21589 for a local transport is taken from the first of these values that is set:
21590
21591 .ilist
21592 The &%home_directory%& option on the transport;
21593 .next
21594 The &%transport_home_directory%& option on the router;
21595 .next
21596 The password data if &%check_local_user%& is set on the router;
21597 .next
21598 The &%router_home_directory%& option on the router.
21599 .endlist
21600
21601 The current directory is taken from the first of these values that is set:
21602
21603 .ilist
21604 The &%current_directory%& option on the transport;
21605 .next
21606 The &%transport_current_directory%& option on the router.
21607 .endlist
21608
21609
21610 If neither the router nor the transport sets a current directory, Exim uses the
21611 value of the home directory, if it is set. Otherwise it sets the current
21612 directory to &_/_& before running a local transport.
21613
21614
21615
21616 .section "Expansion variables derived from the address" "SECID133"
21617 .vindex "&$domain$&"
21618 .vindex "&$local_part$&"
21619 .vindex "&$original_domain$&"
21620 Normally a local delivery is handling a single address, and in that case the
21621 variables such as &$domain$& and &$local_part$& are set during local
21622 deliveries. However, in some circumstances more than one address may be handled
21623 at once (for example, while writing batch SMTP for onward transmission by some
21624 other means). In this case, the variables associated with the local part are
21625 never set, &$domain$& is set only if all the addresses have the same domain,
21626 and &$original_domain$& is never set.
21627 .ecindex IIDenvlotra1
21628 .ecindex IIDenvlotra2
21629 .ecindex IIDenvlotra3
21630
21631
21632
21633
21634
21635
21636
21637 . ////////////////////////////////////////////////////////////////////////////
21638 . ////////////////////////////////////////////////////////////////////////////
21639
21640 .chapter "Generic options for transports" "CHAPtransportgeneric"
21641 .scindex IIDgenoptra1 "generic options" "transport"
21642 .scindex IIDgenoptra2 "options" "generic; for transports"
21643 .scindex IIDgenoptra3 "transport" "generic options for"
21644 The following generic options apply to all transports:
21645
21646
21647 .option body_only transports boolean false
21648 .cindex "transport" "body only"
21649 .cindex "message" "transporting body only"
21650 .cindex "body of message" "transporting"
21651 If this option is set, the message's headers are not transported. It is
21652 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21653 or &(pipe)& transports, the settings of &%message_prefix%& and
21654 &%message_suffix%& should be checked, because this option does not
21655 automatically suppress them.
21656
21657
21658 .option current_directory transports string&!! unset
21659 .cindex "transport" "current directory for"
21660 This specifies the current directory that is to be set while running the
21661 transport, overriding any value that may have been set by the router.
21662 If the expansion fails for any reason, including forced failure, an error is
21663 logged, and delivery is deferred.
21664
21665
21666 .option disable_logging transports boolean false
21667 If this option is set true, nothing is logged for any
21668 deliveries by the transport or for any
21669 transport errors. You should not set this option unless you really, really know
21670 what you are doing.
21671
21672
21673 .option debug_print transports string&!! unset
21674 .cindex "testing" "variables in drivers"
21675 If this option is set and debugging is enabled (see the &%-d%& command line
21676 option), the string is expanded and included in the debugging output when the
21677 transport is run.
21678 If expansion of the string fails, the error message is written to the debugging
21679 output, and Exim carries on processing.
21680 This facility is provided to help with checking out the values of variables and
21681 so on when debugging driver configurations. For example, if a &%headers_add%&
21682 option is not working properly, &%debug_print%& could be used to output the
21683 variables it references. A newline is added to the text if it does not end with
21684 one.
21685 The variables &$transport_name$& and &$router_name$& contain the name of the
21686 transport and the router that called it.
21687
21688 .option delivery_date_add transports boolean false
21689 .cindex "&'Delivery-date:'& header line"
21690 If this option is true, a &'Delivery-date:'& header is added to the message.
21691 This gives the actual time the delivery was made. As this is not a standard
21692 header, Exim has a configuration option (&%delivery_date_remove%&) which
21693 requests its removal from incoming messages, so that delivered messages can
21694 safely be resent to other recipients.
21695
21696
21697 .option driver transports string unset
21698 This specifies which of the available transport drivers is to be used.
21699 There is no default, and this option must be set for every transport.
21700
21701
21702 .option envelope_to_add transports boolean false
21703 .cindex "&'Envelope-to:'& header line"
21704 If this option is true, an &'Envelope-to:'& header is added to the message.
21705 This gives the original address(es) in the incoming envelope that caused this
21706 delivery to happen. More than one address may be present if the transport is
21707 configured to handle several addresses at once, or if more than one original
21708 address was redirected to the same final address. As this is not a standard
21709 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21710 its removal from incoming messages, so that delivered messages can safely be
21711 resent to other recipients.
21712
21713
21714 .option event_action transports string&!! unset
21715 .cindex events
21716 This option declares a string to be expanded for Exim's events mechanism.
21717 For details see chapter &<<CHAPevents>>&.
21718
21719
21720 .option group transports string&!! "Exim group"
21721 .cindex "transport" "group; specifying"
21722 This option specifies a gid for running the transport process, overriding any
21723 value that the router supplies, and also overriding any value associated with
21724 &%user%& (see below).
21725
21726
21727 .option headers_add transports list&!! unset
21728 .cindex "header lines" "adding in transport"
21729 .cindex "transport" "header lines; adding"
21730 This option specifies a list of text headers,
21731 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21732 which are (separately) expanded and added to the header
21733 portion of a message as it is transported, as described in section
21734 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21735 routers. If the result of the expansion is an empty string, or if the expansion
21736 is forced to fail, no action is taken. Other expansion failures are treated as
21737 errors and cause the delivery to be deferred.
21738
21739 Unlike most options, &%headers_add%& can be specified multiple times
21740 for a transport; all listed headers are added.
21741
21742
21743 .option headers_only transports boolean false
21744 .cindex "transport" "header lines only"
21745 .cindex "message" "transporting headers only"
21746 .cindex "header lines" "transporting"
21747 If this option is set, the message's body is not transported. It is mutually
21748 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21749 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21750 checked, since this option does not automatically suppress them.
21751
21752
21753 .option headers_remove transports list&!! unset
21754 .cindex "header lines" "removing"
21755 .cindex "transport" "header lines; removing"
21756 This option specifies a list of header names,
21757 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21758 these headers are omitted from the message as it is transported, as described
21759 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21760 routers.
21761 Each list item is separately expanded.
21762 If the result of the expansion is an empty string, or if the expansion
21763 is forced to fail, no action is taken. Other expansion failures are treated as
21764 errors and cause the delivery to be deferred.
21765
21766 Unlike most options, &%headers_remove%& can be specified multiple times
21767 for a transport; all listed headers are removed.
21768
21769 &*Warning*&: Because of the separate expansion of the list items,
21770 items that contain a list separator must have it doubled.
21771 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21772
21773
21774
21775 .option headers_rewrite transports string unset
21776 .cindex "transport" "header lines; rewriting"
21777 .cindex "rewriting" "at transport time"
21778 This option allows addresses in header lines to be rewritten at transport time,
21779 that is, as the message is being copied to its destination. The contents of the
21780 option are a colon-separated list of rewriting rules. Each rule is in exactly
21781 the same form as one of the general rewriting rules that are applied when a
21782 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21783 example,
21784 .code
21785 headers_rewrite = a@b c@d f : \
21786                   x@y w@z
21787 .endd
21788 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21789 &'w@z'& in all address-bearing header lines. The rules are applied to the
21790 header lines just before they are written out at transport time, so they affect
21791 only those copies of the message that pass through the transport. However, only
21792 the message's original header lines, and any that were added by a system
21793 filter, are rewritten. If a router or transport adds header lines, they are not
21794 affected by this option. These rewriting rules are &'not'& applied to the
21795 envelope. You can change the return path using &%return_path%&, but you cannot
21796 change envelope recipients at this time.
21797
21798
21799 .option home_directory transports string&!! unset
21800 .cindex "transport" "home directory for"
21801 .vindex "&$home$&"
21802 This option specifies a home directory setting for a local transport,
21803 overriding any value that may be set by the router. The home directory is
21804 placed in &$home$& while expanding the transport's private options. It is also
21805 used as the current directory if no current directory is set by the
21806 &%current_directory%& option on the transport or the
21807 &%transport_current_directory%& option on the router. If the expansion fails
21808 for any reason, including forced failure, an error is logged, and delivery is
21809 deferred.
21810
21811
21812 .option initgroups transports boolean false
21813 .cindex "additional groups"
21814 .cindex "groups" "additional"
21815 .cindex "transport" "group; additional"
21816 If this option is true and the uid for the delivery process is provided by the
21817 transport, the &[initgroups()]& function is called when running the transport
21818 to ensure that any additional groups associated with the uid are set up.
21819
21820
21821 .option max_parallel transports integer&!! unset
21822 .cindex limit "transport parallelism"
21823 .cindex transport "parallel processes"
21824 .cindex transport "concurrency limit"
21825 .cindex "delivery" "parallelism for transport"
21826 If this option is set and expands to an integer greater than zero
21827 it limits the number of concurrent runs of the transport.
21828 The control does not apply to shadow transports.
21829
21830 .cindex "hints database" "transport concurrency control"
21831 Exim implements this control by means of a hints database in which a record is
21832 incremented whenever a transport process is being created. The record
21833 is decremented and possibly removed when the process terminates.
21834 Obviously there is scope for
21835 records to get left lying around if there is a system or program crash. To
21836 guard against this, Exim ignores any records that are more than six hours old.
21837
21838 If you use this option, you should also arrange to delete the
21839 relevant hints database whenever your system reboots. The names of the files
21840 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21841 may be one or two files, depending on the type of DBM in use. The same files
21842 are used for ETRN and smtp transport serialization.
21843
21844
21845 .option message_size_limit transports string&!! 0
21846 .cindex "limit" "message size per transport"
21847 .cindex "size" "of message, limit"
21848 .cindex "transport" "message size; limiting"
21849 This option controls the size of messages passed through the transport. It is
21850 expanded before use; the result of the expansion must be a sequence of decimal
21851 digits, optionally followed by K or M. If the expansion fails for any reason,
21852 including forced failure, or if the result is not of the required form,
21853 delivery is deferred. If the value is greater than zero and the size of a
21854 message exceeds this limit, the address is failed. If there is any chance that
21855 the resulting bounce message could be routed to the same transport, you should
21856 ensure that &%return_size_limit%& is less than the transport's
21857 &%message_size_limit%&, as otherwise the bounce message will fail to get
21858 delivered.
21859
21860
21861
21862 .option rcpt_include_affixes transports boolean false
21863 .cindex "prefix" "for local part, including in envelope"
21864 .cindex "suffix for local part" "including in envelope"
21865 .cindex "local part" "prefix"
21866 .cindex "local part" "suffix"
21867 When this option is false (the default), and an address that has had any
21868 affixes (prefixes or suffixes) removed from the local part is delivered by any
21869 form of SMTP or LMTP, the affixes are not included. For example, if a router
21870 that contains
21871 .code
21872 local_part_prefix = *-
21873 .endd
21874 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21875 is delivered with
21876 .code
21877 RCPT TO:<xyz@some.domain>
21878 .endd
21879 This is also the case when an ACL-time callout is being used to verify a
21880 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21881 whole local part is included in the RCPT command. This option applies to BSMTP
21882 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21883 &(lmtp)& and &(smtp)& transports.
21884
21885
21886 .option retry_use_local_part transports boolean "see below"
21887 .cindex "hints database" "retry keys"
21888 When a delivery suffers a temporary failure, a retry record is created
21889 in Exim's hints database. For remote deliveries, the key for the retry record
21890 is based on the name and/or IP address of the failing remote host. For local
21891 deliveries, the key is normally the entire address, including both the local
21892 part and the domain. This is suitable for most common cases of local delivery
21893 temporary failure &-- for example, exceeding a mailbox quota should delay only
21894 deliveries to that mailbox, not to the whole domain.
21895
21896 However, in some special cases you may want to treat a temporary local delivery
21897 as a failure associated with the domain, and not with a particular local part.
21898 (For example, if you are storing all mail for some domain in files.) You can do
21899 this by setting &%retry_use_local_part%& false.
21900
21901 For all the local transports, its default value is true. For remote transports,
21902 the default value is false for tidiness, but changing the value has no effect
21903 on a remote transport in the current implementation.
21904
21905
21906 .option return_path transports string&!! unset
21907 .cindex "envelope sender"
21908 .cindex "envelope from"
21909 .cindex "transport" "return path; changing"
21910 .cindex "return path" "changing in transport"
21911 If this option is set, the string is expanded at transport time and replaces
21912 the existing return path (envelope sender) value in the copy of the message
21913 that is being delivered. An empty return path is permitted. This feature is
21914 designed for remote deliveries, where the value of this option is used in the
21915 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21916 only effect is to change the address that is placed in the &'Return-path:'&
21917 header line, if one is added to the message (see the next option).
21918
21919 &*Note:*& A changed return path is not logged unless you add
21920 &%return_path_on_delivery%& to the log selector.
21921
21922 .vindex "&$return_path$&"
21923 The expansion can refer to the existing value via &$return_path$&. This is
21924 either the message's envelope sender, or an address set by the
21925 &%errors_to%& option on a router. If the expansion is forced to fail, no
21926 replacement occurs; if it fails for another reason, delivery is deferred. This
21927 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21928 section &<<SECTverp>>&.
21929
21930 &*Note*&: If a delivery error is detected locally, including the case when a
21931 remote server rejects a message at SMTP time, the bounce message is not sent to
21932 the value of this option. It is sent to the previously set errors address.
21933 This defaults to the incoming sender address, but can be changed by setting
21934 &%errors_to%& in a router.
21935
21936
21937
21938 .option return_path_add transports boolean false
21939 .cindex "&'Return-path:'& header line"
21940 If this option is true, a &'Return-path:'& header is added to the message.
21941 Although the return path is normally available in the prefix line of BSD
21942 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21943 have easy access to it.
21944
21945 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21946 the delivery SMTP server makes the final delivery"&. This implies that this
21947 header should not be present in incoming messages. Exim has a configuration
21948 option, &%return_path_remove%&, which requests removal of this header from
21949 incoming messages, so that delivered messages can safely be resent to other
21950 recipients.
21951
21952
21953 .option shadow_condition transports string&!! unset
21954 See &%shadow_transport%& below.
21955
21956
21957 .option shadow_transport transports string unset
21958 .cindex "shadow transport"
21959 .cindex "transport" "shadow"
21960 A local transport may set the &%shadow_transport%& option to the name of
21961 another local transport. Shadow remote transports are not supported.
21962
21963 Whenever a delivery to the main transport succeeds, and either
21964 &%shadow_condition%& is unset, or its expansion does not result in the empty
21965 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21966 passed to the shadow transport, with the same delivery address or addresses. If
21967 expansion fails, no action is taken except that non-forced expansion failures
21968 cause a log line to be written.
21969
21970 The result of the shadow transport is discarded and does not affect the
21971 subsequent processing of the message. Only a single level of shadowing is
21972 provided; the &%shadow_transport%& option is ignored on any transport when it
21973 is running as a shadow. Options concerned with output from pipes are also
21974 ignored. The log line for the successful delivery has an item added on the end,
21975 of the form
21976 .code
21977 ST=<shadow transport name>
21978 .endd
21979 If the shadow transport did not succeed, the error message is put in
21980 parentheses afterwards. Shadow transports can be used for a number of different
21981 purposes, including keeping more detailed log information than Exim normally
21982 provides, and implementing automatic acknowledgment policies based on message
21983 headers that some sites insist on.
21984
21985
21986 .option transport_filter transports string&!! unset
21987 .cindex "transport" "filter"
21988 .cindex "filter" "transport filter"
21989 This option sets up a filtering (in the Unix shell sense) process for messages
21990 at transport time. It should not be confused with mail filtering as set up by
21991 individual users or via a system filter.
21992 If unset, or expanding to an empty string, no filtering is done.
21993
21994 When the message is about to be written out, the command specified by
21995 &%transport_filter%& is started up in a separate, parallel process, and
21996 the entire message, including the header lines, is passed to it on its standard
21997 input (this in fact is done from a third process, to avoid deadlock). The
21998 command must be specified as an absolute path.
21999
22000 The lines of the message that are written to the transport filter are
22001 terminated by newline (&"\n"&). The message is passed to the filter before any
22002 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22003 lines beginning with a dot, and also before any processing implied by the
22004 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22005 &(pipe)& transports.
22006
22007 The standard error for the filter process is set to the same destination as its
22008 standard output; this is read and written to the message's ultimate
22009 destination. The process that writes the message to the filter, the
22010 filter itself, and the original process that reads the result and delivers it
22011 are all run in parallel, like a shell pipeline.
22012
22013 The filter can perform any transformations it likes, but of course should take
22014 care not to break RFC 2822 syntax. Exim does not check the result, except to
22015 test for a final newline when SMTP is in use. All messages transmitted over
22016 SMTP must end with a newline, so Exim supplies one if it is missing.
22017
22018 .cindex "content scanning" "per user"
22019 A transport filter can be used to provide content-scanning on a per-user basis
22020 at delivery time if the only required effect of the scan is to modify the
22021 message. For example, a content scan could insert a new header line containing
22022 a spam score. This could be interpreted by a filter in the user's MUA. It is
22023 not possible to discard a message at this stage.
22024
22025 .cindex "SMTP" "SIZE"
22026 A problem might arise if the filter increases the size of a message that is
22027 being sent down an SMTP connection. If the receiving SMTP server has indicated
22028 support for the SIZE parameter, Exim will have sent the size of the message
22029 at the start of the SMTP session. If what is actually sent is substantially
22030 more, the server might reject the message. This can be worked round by setting
22031 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22032 additions to the message, or to disable the use of SIZE altogether.
22033
22034 .vindex "&$pipe_addresses$&"
22035 The value of the &%transport_filter%& option is the command string for starting
22036 the filter, which is run directly from Exim, not under a shell. The string is
22037 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22038 Exim breaks it up into arguments and then expands each argument separately (see
22039 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22040 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22041 of arguments, one for each address that applies to this delivery. (This isn't
22042 an ideal name for this feature here, but as it was already implemented for the
22043 &(pipe)& transport, it seemed sensible not to change it.)
22044
22045 .vindex "&$host$&"
22046 .vindex "&$host_address$&"
22047 The expansion variables &$host$& and &$host_address$& are available when the
22048 transport is a remote one. They contain the name and IP address of the host to
22049 which the message is being sent. For example:
22050 .code
22051 transport_filter = /some/directory/transport-filter.pl \
22052   $host $host_address $sender_address $pipe_addresses
22053 .endd
22054
22055 Two problems arise if you want to use more complicated expansion items to
22056 generate transport filter commands, both of which due to the fact that the
22057 command is split up &'before'& expansion.
22058 .ilist
22059 If an expansion item contains white space, you must quote it, so that it is all
22060 part of the same command item. If the entire option setting is one such
22061 expansion item, you have to take care what kind of quoting you use. For
22062 example:
22063 .code
22064 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22065 .endd
22066 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22067 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22068 stripped by Exim when it read the option's value. When the value is used, if
22069 the single quotes were missing, the line would be split into two items,
22070 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22071 Exim tried to expand the first one.
22072 .next
22073 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22074 expansion cannot generate multiple arguments, or a command name followed by
22075 arguments. Consider this example:
22076 .code
22077 transport_filter = ${lookup{$host}lsearch{/a/file}\
22078                     {$value}{/bin/cat}}
22079 .endd
22080 The result of the lookup is interpreted as the name of the command, even
22081 if it contains white space. The simplest way round this is to use a shell:
22082 .code
22083 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22084                                {$value}{/bin/cat}}
22085 .endd
22086 .endlist
22087
22088 The filter process is run under the same uid and gid as the normal delivery.
22089 For remote deliveries this is the Exim uid/gid by default. The command should
22090 normally yield a zero return code. Transport filters are not supposed to fail.
22091 A non-zero code is taken to mean that the transport filter encountered some
22092 serious problem. Delivery of the message is deferred; the message remains on
22093 the queue and is tried again later. It is not possible to cause a message to be
22094 bounced from a transport filter.
22095
22096 If a transport filter is set on an autoreply transport, the original message is
22097 passed through the filter as it is being copied into the newly generated
22098 message, which happens if the &%return_message%& option is set.
22099
22100
22101 .option transport_filter_timeout transports time 5m
22102 .cindex "transport" "filter, timeout"
22103 When Exim is reading the output of a transport filter, it applies a timeout
22104 that can be set by this option. Exceeding the timeout is normally treated as a
22105 temporary delivery failure. However, if a transport filter is used with a
22106 &(pipe)& transport, a timeout in the transport filter is treated in the same
22107 way as a timeout in the pipe command itself. By default, a timeout is a hard
22108 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22109 becomes a temporary error.
22110
22111
22112 .option user transports string&!! "Exim user"
22113 .cindex "uid (user id)" "local delivery"
22114 .cindex "transport" "user, specifying"
22115 This option specifies the user under whose uid the delivery process is to be
22116 run, overriding any uid that may have been set by the router. If the user is
22117 given as a name, the uid is looked up from the password data, and the
22118 associated group is taken as the value of the gid to be used if the &%group%&
22119 option is not set.
22120
22121 For deliveries that use local transports, a user and group are normally
22122 specified explicitly or implicitly (for example, as a result of
22123 &%check_local_user%&) by the router or transport.
22124
22125 .cindex "hints database" "access by remote transport"
22126 For remote transports, you should leave this option unset unless you really are
22127 sure you know what you are doing. When a remote transport is running, it needs
22128 to be able to access Exim's hints databases, because each host may have its own
22129 retry data.
22130 .ecindex IIDgenoptra1
22131 .ecindex IIDgenoptra2
22132 .ecindex IIDgenoptra3
22133
22134
22135
22136
22137
22138
22139 . ////////////////////////////////////////////////////////////////////////////
22140 . ////////////////////////////////////////////////////////////////////////////
22141
22142 .chapter "Address batching in local transports" "CHAPbatching" &&&
22143          "Address batching"
22144 .cindex "transport" "local; address batching in"
22145 The only remote transport (&(smtp)&) is normally configured to handle more than
22146 one address at a time, so that when several addresses are routed to the same
22147 remote host, just one copy of the message is sent. Local transports, however,
22148 normally handle one address at a time. That is, a separate instance of the
22149 transport is run for each address that is routed to the transport. A separate
22150 copy of the message is delivered each time.
22151
22152 .cindex "batched local delivery"
22153 .oindex "&%batch_max%&"
22154 .oindex "&%batch_id%&"
22155 In special cases, it may be desirable to handle several addresses at once in a
22156 local transport, for example:
22157
22158 .ilist
22159 In an &(appendfile)& transport, when storing messages in files for later
22160 delivery by some other means, a single copy of the message with multiple
22161 recipients saves space.
22162 .next
22163 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22164 a single copy saves time, and is the normal way LMTP is expected to work.
22165 .next
22166 In a &(pipe)& transport, when passing the message
22167 to a scanner program or
22168 to some other delivery mechanism such as UUCP, multiple recipients may be
22169 acceptable.
22170 .endlist
22171
22172 These three local transports all have the same options for controlling multiple
22173 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22174 repeating the information for each transport, these options are described here.
22175
22176 The &%batch_max%& option specifies the maximum number of addresses that can be
22177 delivered together in a single run of the transport. Its default value is one
22178 (no batching). When more than one address is routed to a transport that has a
22179 &%batch_max%& value greater than one, the addresses are delivered in a batch
22180 (that is, in a single run of the transport with multiple recipients), subject
22181 to certain conditions:
22182
22183 .ilist
22184 .vindex "&$local_part$&"
22185 If any of the transport's options contain a reference to &$local_part$&, no
22186 batching is possible.
22187 .next
22188 .vindex "&$domain$&"
22189 If any of the transport's options contain a reference to &$domain$&, only
22190 addresses with the same domain are batched.
22191 .next
22192 .cindex "customizing" "batching condition"
22193 If &%batch_id%& is set, it is expanded for each address, and only those
22194 addresses with the same expanded value are batched. This allows you to specify
22195 customized batching conditions. Failure of the expansion for any reason,
22196 including forced failure, disables batching, but it does not stop the delivery
22197 from taking place.
22198 .next
22199 Batched addresses must also have the same errors address (where to send
22200 delivery errors), the same header additions and removals, the same user and
22201 group for the transport, and if a host list is present, the first host must
22202 be the same.
22203 .endlist
22204
22205 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22206 both when the file or pipe command is specified in the transport, and when it
22207 is specified by a &(redirect)& router, but all the batched addresses must of
22208 course be routed to the same file or pipe command. These two transports have an
22209 option called &%use_bsmtp%&, which causes them to deliver the message in
22210 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22211 &%check_string%& and &%escape_string%& options are forced to the values
22212 .code
22213 check_string = "."
22214 escape_string = ".."
22215 .endd
22216 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22217 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22218 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22219
22220 .cindex "&'Envelope-to:'& header line"
22221 If the generic &%envelope_to_add%& option is set for a batching transport, the
22222 &'Envelope-to:'& header that is added to the message contains all the addresses
22223 that are being processed together. If you are using a batching &(appendfile)&
22224 transport without &%use_bsmtp%&, the only way to preserve the recipient
22225 addresses is to set the &%envelope_to_add%& option.
22226
22227 .cindex "&(pipe)& transport" "with multiple addresses"
22228 .vindex "&$pipe_addresses$&"
22229 If you are using a &(pipe)& transport without BSMTP, and setting the
22230 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22231 the command. This is not a true variable; it is a bit of magic that causes each
22232 of the recipient addresses to be inserted into the command as a separate
22233 argument. This provides a way of accessing all the addresses that are being
22234 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22235 are specified by a &(redirect)& router.
22236
22237
22238
22239
22240 . ////////////////////////////////////////////////////////////////////////////
22241 . ////////////////////////////////////////////////////////////////////////////
22242
22243 .chapter "The appendfile transport" "CHAPappendfile"
22244 .scindex IIDapptra1 "&(appendfile)& transport"
22245 .scindex IIDapptra2 "transports" "&(appendfile)&"
22246 .cindex "directory creation"
22247 .cindex "creating directories"
22248 The &(appendfile)& transport delivers a message by appending it to an existing
22249 file, or by creating an entirely new file in a specified directory. Single
22250 files to which messages are appended can be in the traditional Unix mailbox
22251 format, or optionally in the MBX format supported by the Pine MUA and
22252 University of Washington IMAP daemon, &'inter alia'&. When each message is
22253 being delivered as a separate file, &"maildir"& format can optionally be used
22254 to give added protection against failures that happen part-way through the
22255 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22256 supported. For all file formats, Exim attempts to create as many levels of
22257 directory as necessary, provided that &%create_directory%& is set.
22258
22259 The code for the optional formats is not included in the Exim binary by
22260 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22261 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22262 included.
22263
22264 .cindex "quota" "system"
22265 Exim recognizes system quota errors, and generates an appropriate message. Exim
22266 also supports its own quota control within the transport, for use when the
22267 system facility is unavailable or cannot be used for some reason.
22268
22269 If there is an error while appending to a file (for example, quota exceeded or
22270 partition filled), Exim attempts to reset the file's length and last
22271 modification time back to what they were before. If there is an error while
22272 creating an entirely new file, the new file is removed.
22273
22274 Before appending to a file, a number of security checks are made, and the
22275 file is locked. A detailed description is given below, after the list of
22276 private options.
22277
22278 The &(appendfile)& transport is most commonly used for local deliveries to
22279 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22280 putting messages into files for remote delivery by some means other than Exim.
22281 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22282 option).
22283
22284
22285
22286 .section "The file and directory options" "SECTfildiropt"
22287 The &%file%& option specifies a single file, to which the message is appended;
22288 the &%directory%& option specifies a directory, in which a new file containing
22289 the message is created. Only one of these two options can be set, and for
22290 normal deliveries to mailboxes, one of them &'must'& be set.
22291
22292 .vindex "&$address_file$&"
22293 .vindex "&$local_part$&"
22294 However, &(appendfile)& is also used for delivering messages to files or
22295 directories whose names (or parts of names) are obtained from alias,
22296 forwarding, or filtering operations (for example, a &%save%& command in a
22297 user's Exim filter). When such a transport is running, &$local_part$& contains
22298 the local part that was aliased or forwarded, and &$address_file$& contains the
22299 name (or partial name) of the file or directory generated by the redirection
22300 operation. There are two cases:
22301
22302 .ilist
22303 If neither &%file%& nor &%directory%& is set, the redirection operation
22304 must specify an absolute path (one that begins with &`/`&). This is the most
22305 common case when users with local accounts use filtering to sort mail into
22306 different folders. See for example, the &(address_file)& transport in the
22307 default configuration. If the path ends with a slash, it is assumed to be the
22308 name of a directory. A delivery to a directory can also be forced by setting
22309 &%maildir_format%& or &%mailstore_format%&.
22310 .next
22311 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22312 used to determine the file or directory name for the delivery. Normally, the
22313 contents of &$address_file$& are used in some way in the string expansion.
22314 .endlist
22315
22316
22317 .cindex "Sieve filter" "configuring &(appendfile)&"
22318 .cindex "Sieve filter" "relative mailbox path handling"
22319 As an example of the second case, consider an environment where users do not
22320 have home directories. They may be permitted to use Exim filter commands of the
22321 form:
22322 .code
22323 save folder23
22324 .endd
22325 or Sieve filter commands of the form:
22326 .code
22327 require "fileinto";
22328 fileinto "folder23";
22329 .endd
22330 In this situation, the expansion of &%file%& or &%directory%& in the transport
22331 must transform the relative path into an appropriate absolute filename. In the
22332 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22333 is used as a result of a &"keep"& action in the filter. This example shows one
22334 way of handling this requirement:
22335 .code
22336 file = ${if eq{$address_file}{inbox} \
22337             {/var/mail/$local_part} \
22338             {${if eq{${substr_0_1:$address_file}}{/} \
22339                   {$address_file} \
22340                   {$home/mail/$address_file} \
22341             }} \
22342        }
22343 .endd
22344 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22345 location, absolute paths are used without change, and other folders are in the
22346 &_mail_& directory within the home directory.
22347
22348 &*Note 1*&: While processing an Exim filter, a relative path such as
22349 &_folder23_& is turned into an absolute path if a home directory is known to
22350 the router. In particular, this is the case if &%check_local_user%& is set. If
22351 you want to prevent this happening at routing time, you can set
22352 &%router_home_directory%& empty. This forces the router to pass the relative
22353 path to the transport.
22354
22355 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22356 the &%file%& or &%directory%& option is still used if it is set.
22357
22358
22359
22360
22361 .section "Private options for appendfile" "SECID134"
22362 .cindex "options" "&(appendfile)& transport"
22363
22364
22365
22366 .option allow_fifo appendfile boolean false
22367 .cindex "fifo (named pipe)"
22368 .cindex "named pipe (fifo)"
22369 .cindex "pipe" "named (fifo)"
22370 Setting this option permits delivery to named pipes (FIFOs) as well as to
22371 regular files. If no process is reading the named pipe at delivery time, the
22372 delivery is deferred.
22373
22374
22375 .option allow_symlink appendfile boolean false
22376 .cindex "symbolic link" "to mailbox"
22377 .cindex "mailbox" "symbolic link"
22378 By default, &(appendfile)& will not deliver if the path name for the file is
22379 that of a symbolic link. Setting this option relaxes that constraint, but there
22380 are security issues involved in the use of symbolic links. Be sure you know
22381 what you are doing if you set this. Details of exactly what this option affects
22382 are included in the discussion which follows this list of options.
22383
22384
22385 .option batch_id appendfile string&!! unset
22386 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22387 However, batching is automatically disabled for &(appendfile)& deliveries that
22388 happen as a result of forwarding or aliasing or other redirection directly to a
22389 file.
22390
22391
22392 .option batch_max appendfile integer 1
22393 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22394
22395
22396 .option check_group appendfile boolean false
22397 When this option is set, the group owner of the file defined by the &%file%&
22398 option is checked to see that it is the same as the group under which the
22399 delivery process is running. The default setting is false because the default
22400 file mode is 0600, which means that the group is irrelevant.
22401
22402
22403 .option check_owner appendfile boolean true
22404 When this option is set, the owner of the file defined by the &%file%& option
22405 is checked to ensure that it is the same as the user under which the delivery
22406 process is running.
22407
22408
22409 .option check_string appendfile string "see below"
22410 .cindex "&""From""& line"
22411 As &(appendfile)& writes the message, the start of each line is tested for
22412 matching &%check_string%&, and if it does, the initial matching characters are
22413 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22414 a literal string, not a regular expression, and the case of any letters it
22415 contains is significant.
22416
22417 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22418 are forced to &"."& and &".."& respectively, and any settings in the
22419 configuration are ignored. Otherwise, they default to &"From&~"& and
22420 &">From&~"& when the &%file%& option is set, and unset when any of the
22421 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22422
22423 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22424 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22425 &"From&~"& indicates the start of a new message. All four options need changing
22426 if another format is used. For example, to deliver to mailboxes in MMDF format:
22427 .cindex "MMDF format mailbox"
22428 .cindex "mailbox" "MMDF format"
22429 .code
22430 check_string = "\1\1\1\1\n"
22431 escape_string = "\1\1\1\1 \n"
22432 message_prefix = "\1\1\1\1\n"
22433 message_suffix = "\1\1\1\1\n"
22434 .endd
22435 .option create_directory appendfile boolean true
22436 .cindex "directory creation"
22437 When this option is true, Exim attempts to create any missing superior
22438 directories for the file that it is about to write. A created directory's mode
22439 is given by the &%directory_mode%& option.
22440
22441 The group ownership of a newly created directory is highly dependent on the
22442 operating system (and possibly the file system) that is being used. For
22443 example, in Solaris, if the parent directory has the setgid bit set, its group
22444 is propagated to the child; if not, the currently set group is used. However,
22445 in FreeBSD, the parent's group is always used.
22446
22447
22448
22449 .option create_file appendfile string anywhere
22450 This option constrains the location of files and directories that are created
22451 by this transport. It applies to files defined by the &%file%& option and
22452 directories defined by the &%directory%& option. In the case of maildir
22453 delivery, it applies to the top level directory, not the maildir directories
22454 beneath.
22455
22456 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22457 &"belowhome"&. In the second and third cases, a home directory must have been
22458 set for the transport. This option is not useful when an explicit filename is
22459 given for normal mailbox deliveries. It is intended for the case when filenames
22460 are generated from users' &_.forward_& files. These are usually handled
22461 by an &(appendfile)& transport called &%address_file%&. See also
22462 &%file_must_exist%&.
22463
22464
22465 .option directory appendfile string&!! unset
22466 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22467 or &%directory%& must be set, unless the delivery is the direct result of a
22468 redirection (see section &<<SECTfildiropt>>&).
22469
22470 When &%directory%& is set, the string is expanded, and the message is delivered
22471 into a new file or files in or below the given directory, instead of being
22472 appended to a single mailbox file. A number of different formats are provided
22473 (see &%maildir_format%& and &%mailstore_format%&), and see section
22474 &<<SECTopdir>>& for further details of this form of delivery.
22475
22476
22477 .option directory_file appendfile string&!! "see below"
22478 .cindex "base62"
22479 .vindex "&$inode$&"
22480 When &%directory%& is set, but neither &%maildir_format%& nor
22481 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22482 whose name is obtained by expanding this string. The default value is:
22483 .code
22484 q${base62:$tod_epoch}-$inode
22485 .endd
22486 This generates a unique name from the current time, in base 62 form, and the
22487 inode of the file. The variable &$inode$& is available only when expanding this
22488 option.
22489
22490
22491 .option directory_mode appendfile "octal integer" 0700
22492 If &(appendfile)& creates any directories as a result of the
22493 &%create_directory%& option, their mode is specified by this option.
22494
22495
22496 .option escape_string appendfile string "see description"
22497 See &%check_string%& above.
22498
22499
22500 .option file appendfile string&!! unset
22501 This option is mutually exclusive with the &%directory%& option, but one of
22502 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22503 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22504 specifies a single file, to which the message is appended. One or more of
22505 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22506 &%file%&.
22507
22508 .cindex "NFS" "lock file"
22509 .cindex "locking files"
22510 .cindex "lock files"
22511 If you are using more than one host to deliver over NFS into the same
22512 mailboxes, you should always use lock files.
22513
22514 The string value is expanded for each delivery, and must yield an absolute
22515 path. The most common settings of this option are variations on one of these
22516 examples:
22517 .code
22518 file = /var/spool/mail/$local_part
22519 file = /home/$local_part/inbox
22520 file = $home/inbox
22521 .endd
22522 .cindex "&""sticky""& bit"
22523 In the first example, all deliveries are done into the same directory. If Exim
22524 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22525 create a file in the directory, so the &"sticky"& bit must be turned on for
22526 deliveries to be possible, or alternatively the &%group%& option can be used to
22527 run the delivery under a group id which has write access to the directory.
22528
22529
22530
22531 .option file_format appendfile string unset
22532 .cindex "file" "mailbox; checking existing format"
22533 This option requests the transport to check the format of an existing file
22534 before adding to it. The check consists of matching a specific string at the
22535 start of the file. The value of the option consists of an even number of
22536 colon-separated strings. The first of each pair is the test string, and the
22537 second is the name of a transport. If the transport associated with a matched
22538 string is not the current transport, control is passed over to the other
22539 transport. For example, suppose the standard &(local_delivery)& transport has
22540 this added to it:
22541 .code
22542 file_format = "From       : local_delivery :\
22543                \1\1\1\1\n : local_mmdf_delivery"
22544 .endd
22545 Mailboxes that begin with &"From"& are still handled by this transport, but if
22546 a mailbox begins with four binary ones followed by a newline, control is passed
22547 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22548 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22549 is assumed to match the current transport. If the start of a mailbox doesn't
22550 match any string, or if the transport named for a given string is not defined,
22551 delivery is deferred.
22552
22553
22554 .option file_must_exist appendfile boolean false
22555 If this option is true, the file specified by the &%file%& option must exist.
22556 A temporary error occurs if it does not, causing delivery to be deferred.
22557 If this option is false, the file is created if it does not exist.
22558
22559
22560 .option lock_fcntl_timeout appendfile time 0s
22561 .cindex "timeout" "mailbox locking"
22562 .cindex "mailbox" "locking, blocking and non-blocking"
22563 .cindex "locking files"
22564 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22565 when locking an open mailbox file. If the call fails, the delivery process
22566 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22567 Non-blocking calls are used so that the file is not kept open during the wait
22568 for the lock; the reason for this is to make it as safe as possible for
22569 deliveries over NFS in the case when processes might be accessing an NFS
22570 mailbox without using a lock file. This should not be done, but
22571 misunderstandings and hence misconfigurations are not unknown.
22572
22573 On a busy system, however, the performance of a non-blocking lock approach is
22574 not as good as using a blocking lock with a timeout. In this case, the waiting
22575 is done inside the system call, and Exim's delivery process acquires the lock
22576 and can proceed as soon as the previous lock holder releases it.
22577
22578 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22579 timeout, are used. There may still be some retrying: the maximum number of
22580 retries is
22581 .code
22582 (lock_retries * lock_interval) / lock_fcntl_timeout
22583 .endd
22584 rounded up to the next whole number. In other words, the total time during
22585 which &(appendfile)& is trying to get a lock is roughly the same, unless
22586 &%lock_fcntl_timeout%& is set very large.
22587
22588 You should consider setting this option if you are getting a lot of delayed
22589 local deliveries because of errors of the form
22590 .code
22591 failed to lock mailbox /some/file (fcntl)
22592 .endd
22593
22594 .option lock_flock_timeout appendfile time 0s
22595 This timeout applies to file locking when using &[flock()]& (see
22596 &%use_flock%&); the timeout operates in a similar manner to
22597 &%lock_fcntl_timeout%&.
22598
22599
22600 .option lock_interval appendfile time 3s
22601 This specifies the time to wait between attempts to lock the file. See below
22602 for details of locking.
22603
22604
22605 .option lock_retries appendfile integer 10
22606 This specifies the maximum number of attempts to lock the file. A value of zero
22607 is treated as 1. See below for details of locking.
22608
22609
22610 .option lockfile_mode appendfile "octal integer" 0600
22611 This specifies the mode of the created lock file, when a lock file is being
22612 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22613
22614
22615 .option lockfile_timeout appendfile time 30m
22616 .cindex "timeout" "mailbox locking"
22617 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22618 exists and is older than this value, it is assumed to have been left behind by
22619 accident, and Exim attempts to remove it.
22620
22621
22622 .option mailbox_filecount appendfile string&!! unset
22623 .cindex "mailbox" "specifying size of"
22624 .cindex "size" "of mailbox"
22625 If this option is set, it is expanded, and the result is taken as the current
22626 number of files in the mailbox. It must be a decimal number, optionally
22627 followed by K or M. This provides a way of obtaining this information from an
22628 external source that maintains the data.
22629
22630
22631 .option mailbox_size appendfile string&!! unset
22632 .cindex "mailbox" "specifying size of"
22633 .cindex "size" "of mailbox"
22634 If this option is set, it is expanded, and the result is taken as the current
22635 size the mailbox. It must be a decimal number, optionally followed by K or M.
22636 This provides a way of obtaining this information from an external source that
22637 maintains the data. This is likely to be helpful for maildir deliveries where
22638 it is computationally expensive to compute the size of a mailbox.
22639
22640
22641
22642 .option maildir_format appendfile boolean false
22643 .cindex "maildir format" "specifying"
22644 If this option is set with the &%directory%& option, the delivery is into a new
22645 file, in the &"maildir"& format that is used by other mail software. When the
22646 transport is activated directly from a &(redirect)& router (for example, the
22647 &(address_file)& transport in the default configuration), setting
22648 &%maildir_format%& causes the path received from the router to be treated as a
22649 directory, whether or not it ends with &`/`&. This option is available only if
22650 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22651 &<<SECTmaildirdelivery>>& below for further details.
22652
22653
22654 .option maildir_quota_directory_regex appendfile string "See below"
22655 .cindex "maildir format" "quota; directories included in"
22656 .cindex "quota" "maildir; directories included in"
22657 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22658 a regular expression for specifying directories, relative to the quota
22659 directory (see &%quota_directory%&), that should be included in the quota
22660 calculation. The default value is:
22661 .code
22662 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22663 .endd
22664 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22665 (directories whose names begin with a dot). If you want to exclude the
22666 &_Trash_&
22667 folder from the count (as some sites do), you need to change this setting to
22668 .code
22669 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22670 .endd
22671 This uses a negative lookahead in the regular expression to exclude the
22672 directory whose name is &_.Trash_&. When a directory is excluded from quota
22673 calculations, quota processing is bypassed for any messages that are delivered
22674 directly into that directory.
22675
22676
22677 .option maildir_retries appendfile integer 10
22678 This option specifies the number of times to retry when writing a file in
22679 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22680
22681
22682 .option maildir_tag appendfile string&!! unset
22683 This option applies only to deliveries in maildir format, and is described in
22684 section &<<SECTmaildirdelivery>>& below.
22685
22686
22687 .option maildir_use_size_file appendfile&!! boolean false
22688 .cindex "maildir format" "&_maildirsize_& file"
22689 The result of string expansion for this option must be a valid boolean value.
22690 If it is true, it enables support for &_maildirsize_& files. Exim
22691 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22692 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22693 value is zero. See &%maildir_quota_directory_regex%& above and section
22694 &<<SECTmaildirdelivery>>& below for further details.
22695
22696 .option maildirfolder_create_regex appendfile string unset
22697 .cindex "maildir format" "&_maildirfolder_& file"
22698 .cindex "&_maildirfolder_&, creating"
22699 The value of this option is a regular expression. If it is unset, it has no
22700 effect. Otherwise, before a maildir delivery takes place, the pattern is
22701 matched against the name of the maildir directory, that is, the directory
22702 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22703 delivery. If there is a match, Exim checks for the existence of a file called
22704 &_maildirfolder_& in the directory, and creates it if it does not exist.
22705 See section &<<SECTmaildirdelivery>>& for more details.
22706
22707
22708 .option mailstore_format appendfile boolean false
22709 .cindex "mailstore format" "specifying"
22710 If this option is set with the &%directory%& option, the delivery is into two
22711 new files in  &"mailstore"& format. The option is available only if
22712 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22713 below for further details.
22714
22715
22716 .option mailstore_prefix appendfile string&!! unset
22717 This option applies only to deliveries in mailstore format, and is described in
22718 section &<<SECTopdir>>& below.
22719
22720
22721 .option mailstore_suffix appendfile string&!! unset
22722 This option applies only to deliveries in mailstore format, and is described in
22723 section &<<SECTopdir>>& below.
22724
22725
22726 .option mbx_format appendfile boolean false
22727 .cindex "locking files"
22728 .cindex "file" "locking"
22729 .cindex "file" "MBX format"
22730 .cindex "MBX format, specifying"
22731 This option is available only if Exim has been compiled with SUPPORT_MBX
22732 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22733 the message is appended to the mailbox file in MBX format instead of
22734 traditional Unix format. This format is supported by Pine4 and its associated
22735 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22736
22737 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22738 automatically changed by the use of &%mbx_format%&. They should normally be set
22739 empty when using MBX format, so this option almost always appears in this
22740 combination:
22741 .code
22742 mbx_format = true
22743 message_prefix =
22744 message_suffix =
22745 .endd
22746 If none of the locking options are mentioned in the configuration,
22747 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22748 is possible to specify the other kinds of locking with &%mbx_format%&, but
22749 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22750 interworks with &'c-client'&, providing for shared access to the mailbox. It
22751 should not be used if any program that does not use this form of locking is
22752 going to access the mailbox, nor should it be used if the mailbox file is NFS
22753 mounted, because it works only when the mailbox is accessed from a single host.
22754
22755 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22756 the standard version of &'c-client'&, because as long as it has a mailbox open
22757 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22758 append messages to it.
22759
22760
22761 .option message_prefix appendfile string&!! "see below"
22762 .cindex "&""From""& line"
22763 The string specified here is expanded and output at the start of every message.
22764 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22765 in which case it is:
22766 .code
22767 message_prefix = "From ${if def:return_path{$return_path}\
22768   {MAILER-DAEMON}} $tod_bsdinbox\n"
22769 .endd
22770 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22771 &`\n`& to &`\r\n`& in &%message_prefix%&.
22772
22773 .option message_suffix appendfile string&!! "see below"
22774 The string specified here is expanded and output at the end of every message.
22775 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22776 in which case it is a single newline character. The suffix can be suppressed by
22777 setting
22778 .code
22779 message_suffix =
22780 .endd
22781 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22782 &`\n`& to &`\r\n`& in &%message_suffix%&.
22783
22784 .option mode appendfile "octal integer" 0600
22785 If the output file is created, it is given this mode. If it already exists and
22786 has wider permissions, they are reduced to this mode. If it has narrower
22787 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22788 if the delivery is the result of a &%save%& command in a filter file specifying
22789 a particular mode, the mode of the output file is always forced to take that
22790 value, and this option is ignored.
22791
22792
22793 .option mode_fail_narrower appendfile boolean true
22794 This option applies in the case when an existing mailbox file has a narrower
22795 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22796 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22797 continues with the delivery attempt, using the existing mode of the file.
22798
22799
22800 .option notify_comsat appendfile boolean false
22801 If this option is true, the &'comsat'& daemon is notified after every
22802 successful delivery to a user mailbox. This is the daemon that notifies logged
22803 on users about incoming mail.
22804
22805
22806 .option quota appendfile string&!! unset
22807 .cindex "quota" "imposed by Exim"
22808 This option imposes a limit on the size of the file to which Exim is appending,
22809 or to the total space used in the directory tree when the &%directory%& option
22810 is set. In the latter case, computation of the space used is expensive, because
22811 all the files in the directory (and any sub-directories) have to be
22812 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22813 &%maildir_use_size_file%& for ways to avoid this in environments where users
22814 have no shell access to their mailboxes).
22815
22816 As there is no interlock against two simultaneous deliveries into a
22817 multi-file mailbox, it is possible for the quota to be overrun in this case.
22818 For single-file mailboxes, of course, an interlock is a necessity.
22819
22820 A file's size is taken as its &'used'& value. Because of blocking effects, this
22821 may be a lot less than the actual amount of disk space allocated to the file.
22822 If the sizes of a number of files are being added up, the rounding effect can
22823 become quite noticeable, especially on systems that have large block sizes.
22824 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22825 the obvious value which users understand most easily.
22826
22827 The value of the option is expanded, and must then be a numerical value
22828 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22829 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22830 and further option modifiers. If Exim is running on a system with
22831 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22832 be handled.
22833
22834 The option modifier &%no_check%& can be used to force delivery even if the over
22835 quota condition is met. The quota gets updated as usual.
22836
22837 &*Note*&: A value of zero is interpreted as &"no quota"&.
22838
22839 The expansion happens while Exim is running as root, before it changes uid for
22840 the delivery. This means that files that are inaccessible to the end user can
22841 be used to hold quota values that are looked up in the expansion. When delivery
22842 fails because this quota is exceeded, the handling of the error is as for
22843 system quota failures.
22844
22845 By default, Exim's quota checking mimics system quotas, and restricts the
22846 mailbox to the specified maximum size, though the value is not accurate to the
22847 last byte, owing to separator lines and additional headers that may get added
22848 during message delivery. When a mailbox is nearly full, large messages may get
22849 refused even though small ones are accepted, because the size of the current
22850 message is added to the quota when the check is made. This behaviour can be
22851 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22852 for exceeding the quota does not include the current message. Thus, deliveries
22853 continue until the quota has been exceeded; thereafter, no further messages are
22854 delivered. See also &%quota_warn_threshold%&.
22855
22856
22857 .option quota_directory appendfile string&!! unset
22858 This option defines the directory to check for quota purposes when delivering
22859 into individual files. The default is the delivery directory, or, if a file
22860 called &_maildirfolder_& exists in a maildir directory, the parent of the
22861 delivery directory.
22862
22863
22864 .option quota_filecount appendfile string&!! 0
22865 This option applies when the &%directory%& option is set. It limits the total
22866 number of files in the directory (compare the inode limit in system quotas). It
22867 can only be used if &%quota%& is also set. The value is expanded; an expansion
22868 failure causes delivery to be deferred. A value of zero is interpreted as
22869 &"no quota"&.
22870
22871 The option modifier &%no_check%& can be used to force delivery even if the over
22872 quota condition is met. The quota gets updated as usual.
22873
22874 .option quota_is_inclusive appendfile boolean true
22875 See &%quota%& above.
22876
22877
22878 .option quota_size_regex appendfile string unset
22879 This option applies when one of the delivery modes that writes a separate file
22880 for each message is being used. When Exim wants to find the size of one of
22881 these files in order to test the quota, it first checks &%quota_size_regex%&.
22882 If this is set to a regular expression that matches the filename, and it
22883 captures one string, that string is interpreted as a representation of the
22884 file's size. The value of &%quota_size_regex%& is not expanded.
22885
22886 This feature is useful only when users have no shell access to their mailboxes
22887 &-- otherwise they could defeat the quota simply by renaming the files. This
22888 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22889 the file length to the filename. For example:
22890 .code
22891 maildir_tag = ,S=$message_size
22892 quota_size_regex = ,S=(\d+)
22893 .endd
22894 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22895 number of lines in the message.
22896
22897 The regular expression should not assume that the length is at the end of the
22898 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22899 sometimes add other information onto the ends of message filenames.
22900
22901 Section &<<SECID136>>& contains further information.
22902
22903 This option should not be used when other message-handling software
22904 may duplicate messages by making hardlinks to the files.  When that is done Exim
22905 will count the message size once for each filename, in contrast with the actual
22906 disk usage.  When the option is not set, calculating total usage requires
22907 a system-call per file to get the size; the number of links is then available also
22908 as is used to adjust the effective size.
22909
22910
22911 .option quota_warn_message appendfile string&!! "see below"
22912 See below for the use of this option. If it is not set when
22913 &%quota_warn_threshold%& is set, it defaults to
22914 .code
22915 quota_warn_message = "\
22916   To: $local_part@$domain\n\
22917   Subject: Your mailbox\n\n\
22918   This message is automatically created \
22919   by mail delivery software.\n\n\
22920   The size of your mailbox has exceeded \
22921   a warning threshold that is\n\
22922   set by the system administrator.\n"
22923 .endd
22924
22925
22926 .option quota_warn_threshold appendfile string&!! 0
22927 .cindex "quota" "warning threshold"
22928 .cindex "mailbox" "size warning"
22929 .cindex "size" "of mailbox"
22930 This option is expanded in the same way as &%quota%& (see above). If the
22931 resulting value is greater than zero, and delivery of the message causes the
22932 size of the file or total space in the directory tree to cross the given
22933 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22934 may be specified as a percentage of it by following the value with a percent
22935 sign. For example:
22936 .code
22937 quota = 10M
22938 quota_warn_threshold = 75%
22939 .endd
22940 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22941 percent sign is ignored.
22942
22943 The warning message itself is specified by the &%quota_warn_message%& option,
22944 and it must start with a &'To:'& header line containing the recipient(s) of the
22945 warning message. These do not necessarily have to include the recipient(s) of
22946 the original message. A &'Subject:'& line should also normally be supplied. You
22947 can include any other header lines that you want. If you do not include a
22948 &'From:'& line, the default is:
22949 .code
22950 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22951 .endd
22952 .oindex &%errors_reply_to%&
22953 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22954 option.
22955
22956 The &%quota%& option does not have to be set in order to use this option; they
22957 are independent of one another except when the threshold is specified as a
22958 percentage.
22959
22960
22961 .option use_bsmtp appendfile boolean false
22962 .cindex "envelope from"
22963 .cindex "envelope sender"
22964 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22965 format, with the envelope sender and recipient(s) included as SMTP commands. If
22966 you want to include a leading HELO command with such messages, you can do
22967 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22968 for details of batch SMTP.
22969
22970
22971 .option use_crlf appendfile boolean false
22972 .cindex "carriage return"
22973 .cindex "linefeed"
22974 This option causes lines to be terminated with the two-character CRLF sequence
22975 (carriage return, linefeed) instead of just a linefeed character. In the case
22976 of batched SMTP, the byte sequence written to the file is then an exact image
22977 of what would be sent down a real SMTP connection.
22978
22979 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22980 (which are used to supply the traditional &"From&~"& and blank line separators
22981 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22982 carriage return characters if these are needed. In cases where these options
22983 have non-empty defaults, the values end with a single linefeed, so they must be
22984 changed to end with &`\r\n`& if &%use_crlf%& is set.
22985
22986
22987 .option use_fcntl_lock appendfile boolean "see below"
22988 This option controls the use of the &[fcntl()]& function to lock a file for
22989 exclusive use when a message is being appended. It is set by default unless
22990 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22991 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22992 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22993
22994
22995 .option use_flock_lock appendfile boolean false
22996 This option is provided to support the use of &[flock()]& for file locking, for
22997 the few situations where it is needed. Most modern operating systems support
22998 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22999 each other. Exim uses &[fcntl()]& locking by default.
23000
23001 This option is required only if you are using an operating system where
23002 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23003 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23004 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23005
23006 .cindex "Solaris" "&[flock()]& support"
23007 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23008 have it (and some, I think, provide a not quite right version built on top of
23009 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23010 the ability to use it, and any attempt to do so will cause a configuration
23011 error.
23012
23013 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23014 is just being mapped onto &[fcntl()]& by the OS).
23015
23016
23017 .option use_lockfile appendfile boolean "see below"
23018 If this option is turned off, Exim does not attempt to create a lock file when
23019 appending to a mailbox file. In this situation, the only locking is by
23020 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23021 sure that every MUA that is ever going to look at your users' mailboxes uses
23022 &[fcntl()]& rather than a lock file, and even then only when you are not
23023 delivering over NFS from more than one host.
23024
23025 .cindex "NFS" "lock file"
23026 In order to append to an NFS file safely from more than one host, it is
23027 necessary to take out a lock &'before'& opening the file, and the lock file
23028 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23029 file corruption.
23030
23031 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23032 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23033 except when &%mbx_format%& is set.
23034
23035
23036 .option use_mbx_lock appendfile boolean "see below"
23037 This option is available only if Exim has been compiled with SUPPORT_MBX
23038 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23039 locking rules be used. It is set by default if &%mbx_format%& is set and none
23040 of the locking options are mentioned in the configuration. The locking rules
23041 are the same as are used by the &'c-client'& library that underlies Pine and
23042 the IMAP4 and POP daemons that come with it (see the discussion below). The
23043 rules allow for shared access to the mailbox. However, this kind of locking
23044 does not work when the mailbox is NFS mounted.
23045
23046 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23047 &%use_flock_lock%& to control what kind of locking is used in implementing the
23048 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23049 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23050
23051
23052
23053
23054 .section "Operational details for appending" "SECTopappend"
23055 .cindex "appending to a file"
23056 .cindex "file" "appending"
23057 Before appending to a file, the following preparations are made:
23058
23059 .ilist
23060 If the name of the file is &_/dev/null_&, no action is taken, and a success
23061 return is given.
23062
23063 .next
23064 .cindex "directory creation"
23065 If any directories on the file's path are missing, Exim creates them if the
23066 &%create_directory%& option is set. A created directory's mode is given by the
23067 &%directory_mode%& option.
23068
23069 .next
23070 If &%file_format%& is set, the format of an existing file is checked. If this
23071 indicates that a different transport should be used, control is passed to that
23072 transport.
23073
23074 .next
23075 .cindex "file" "locking"
23076 .cindex "locking files"
23077 .cindex "NFS" "lock file"
23078 If &%use_lockfile%& is set, a lock file is built in a way that will work
23079 reliably over NFS, as follows:
23080
23081 .olist
23082 Create a &"hitching post"& file whose name is that of the lock file with the
23083 current time, primary host name, and process id added, by opening for writing
23084 as a new file. If this fails with an access error, delivery is deferred.
23085 .next
23086 Close the hitching post file, and hard link it to the lock filename.
23087 .next
23088 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23089 Unlink the hitching post name.
23090 .next
23091 Otherwise, use &[stat()]& to get information about the hitching post file, and
23092 then unlink hitching post name. If the number of links is exactly two, creation
23093 of the lock file succeeded but something (for example, an NFS server crash and
23094 restart) caused this fact not to be communicated to the &[link()]& call.
23095 .next
23096 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23097 up to &%lock_retries%& times. However, since any program that writes to a
23098 mailbox should complete its task very quickly, it is reasonable to time out old
23099 lock files that are normally the result of user agent and system crashes. If an
23100 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23101 it before trying again.
23102 .endlist olist
23103
23104 .next
23105 A call is made to &[lstat()]& to discover whether the main file exists, and if
23106 so, what its characteristics are. If &[lstat()]& fails for any reason other
23107 than non-existence, delivery is deferred.
23108
23109 .next
23110 .cindex "symbolic link" "to mailbox"
23111 .cindex "mailbox" "symbolic link"
23112 If the file does exist and is a symbolic link, delivery is deferred, unless the
23113 &%allow_symlink%& option is set, in which case the ownership of the link is
23114 checked, and then &[stat()]& is called to find out about the real file, which
23115 is then subjected to the checks below. The check on the top-level link
23116 ownership prevents one user creating a link for another's mailbox in a sticky
23117 directory, though allowing symbolic links in this case is definitely not a good
23118 idea. If there is a chain of symbolic links, the intermediate ones are not
23119 checked.
23120
23121 .next
23122 If the file already exists but is not a regular file, or if the file's owner
23123 and group (if the group is being checked &-- see &%check_group%& above) are
23124 different from the user and group under which the delivery is running,
23125 delivery is deferred.
23126
23127 .next
23128 If the file's permissions are more generous than specified, they are reduced.
23129 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23130 is set false, in which case the delivery is tried using the existing
23131 permissions.
23132
23133 .next
23134 The file's inode number is saved, and the file is then opened for appending.
23135 If this fails because the file has vanished, &(appendfile)& behaves as if it
23136 hadn't existed (see below). For any other failures, delivery is deferred.
23137
23138 .next
23139 If the file is opened successfully, check that the inode number hasn't
23140 changed, that it is still a regular file, and that the owner and permissions
23141 have not changed. If anything is wrong, defer delivery and freeze the message.
23142
23143 .next
23144 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23145 option is set. Otherwise, check that the file is being created in a permitted
23146 directory if the &%create_file%& option is set (deferring on failure), and then
23147 open for writing as a new file, with the O_EXCL and O_CREAT options,
23148 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23149 set). In this case, which can happen if the link points to a non-existent file,
23150 the file is opened for writing using O_CREAT but not O_EXCL, because
23151 that prevents link following.
23152
23153 .next
23154 .cindex "loop" "while file testing"
23155 If opening fails because the file exists, obey the tests given above for
23156 existing files. However, to avoid looping in a situation where the file is
23157 being continuously created and destroyed, the exists/not-exists loop is broken
23158 after 10 repetitions, and the message is then frozen.
23159
23160 .next
23161 If opening fails with any other error, defer delivery.
23162
23163 .next
23164 .cindex "file" "locking"
23165 .cindex "locking files"
23166 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23167 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23168 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23169 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23170 file, and an exclusive lock on the file whose name is
23171 .code
23172 /tmp/.<device-number>.<inode-number>
23173 .endd
23174 using the device and inode numbers of the open mailbox file, in accordance with
23175 the MBX locking rules. This file is created with a mode that is specified by
23176 the &%lockfile_mode%& option.
23177
23178 If Exim fails to lock the file, there are two possible courses of action,
23179 depending on the value of the locking timeout. This is obtained from
23180 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23181
23182 If the timeout value is zero, the file is closed, Exim waits for
23183 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23184 to lock it again. This happens up to &%lock_retries%& times, after which the
23185 delivery is deferred.
23186
23187 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23188 &[flock()]& are used (with the given timeout), so there has already been some
23189 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23190 immediately. It retries up to
23191 .code
23192 (lock_retries * lock_interval) / <timeout>
23193 .endd
23194 times (rounded up).
23195 .endlist
23196
23197 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23198 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23199
23200
23201 .section "Operational details for delivery to a new file" "SECTopdir"
23202 .cindex "delivery" "to single file"
23203 .cindex "&""From""& line"
23204 When the &%directory%& option is set instead of &%file%&, each message is
23205 delivered into a newly-created file or set of files. When &(appendfile)& is
23206 activated directly from a &(redirect)& router, neither &%file%& nor
23207 &%directory%& is normally set, because the path for delivery is supplied by the
23208 router. (See for example, the &(address_file)& transport in the default
23209 configuration.) In this case, delivery is to a new file if either the path name
23210 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23211
23212 No locking is required while writing the message to a new file, so the various
23213 locking options of the transport are ignored. The &"From"& line that by default
23214 separates messages in a single file is not normally needed, nor is the escaping
23215 of message lines that start with &"From"&, and there is no need to ensure a
23216 newline at the end of each message. Consequently, the default values for
23217 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23218 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23219
23220 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23221 the files in the delivery directory by default. However, you can specify a
23222 different directory by setting &%quota_directory%&. Also, for maildir
23223 deliveries (see below) the &_maildirfolder_& convention is honoured.
23224
23225
23226 .cindex "maildir format"
23227 .cindex "mailstore format"
23228 There are three different ways in which delivery to individual files can be
23229 done, controlled by the settings of the &%maildir_format%& and
23230 &%mailstore_format%& options. Note that code to support maildir or mailstore
23231 formats is not included in the binary unless SUPPORT_MAILDIR or
23232 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23233
23234 .cindex "directory creation"
23235 In all three cases an attempt is made to create the directory and any necessary
23236 sub-directories if they do not exist, provided that the &%create_directory%&
23237 option is set (the default). The location of a created directory can be
23238 constrained by setting &%create_file%&. A created directory's mode is given by
23239 the &%directory_mode%& option. If creation fails, or if the
23240 &%create_directory%& option is not set when creation is required, delivery is
23241 deferred.
23242
23243
23244
23245 .section "Maildir delivery" "SECTmaildirdelivery"
23246 .cindex "maildir format" "description of"
23247 If the &%maildir_format%& option is true, Exim delivers each message by writing
23248 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23249 directory that is defined by the &%directory%& option (the &"delivery
23250 directory"&). If the delivery is successful, the file is renamed into the
23251 &_new_& subdirectory.
23252
23253 In the filename, <&'stime'&> is the current time of day in seconds, and
23254 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23255 Exim checks that the time-of-day clock has moved on by at least one microsecond
23256 before terminating the delivery process. This guarantees uniqueness for the
23257 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23258 opening it. If any response other than ENOENT (does not exist) is given,
23259 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23260
23261 Before Exim carries out a maildir delivery, it ensures that subdirectories
23262 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23263 do not exist, Exim tries to create them and any superior directories in their
23264 path, subject to the &%create_directory%& and &%create_file%& options. If the
23265 &%maildirfolder_create_regex%& option is set, and the regular expression it
23266 contains matches the delivery directory, Exim also ensures that a file called
23267 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23268 &_maildirfolder_& file cannot be created, delivery is deferred.
23269
23270 These features make it possible to use Exim to create all the necessary files
23271 and directories in a maildir mailbox, including subdirectories for maildir++
23272 folders. Consider this example:
23273 .code
23274 maildir_format = true
23275 directory = /var/mail/$local_part\
23276            ${if eq{$local_part_suffix}{}{}\
23277            {/.${substr_1:$local_part_suffix}}}
23278 maildirfolder_create_regex = /\.[^/]+$
23279 .endd
23280 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23281 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23282 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23283 not match this name, so Exim will not look for or create the file
23284 &_/var/mail/pimbo/maildirfolder_&, though it will create
23285 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23286
23287 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23288 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23289 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23290 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23291 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23292
23293 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23294 not inadvertently match the toplevel maildir directory, because a
23295 &_maildirfolder_& file at top level would completely break quota calculations.
23296
23297 .cindex "quota" "in maildir delivery"
23298 .cindex "maildir++"
23299 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23300 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23301 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23302 Exim assumes the directory is a maildir++ folder directory, which is one level
23303 down from the user's top level mailbox directory. This causes it to start at
23304 the parent directory instead of the current directory when calculating the
23305 amount of space used.
23306
23307 One problem with delivering into a multi-file mailbox is that it is
23308 computationally expensive to compute the size of the mailbox for quota
23309 checking. Various approaches have been taken to reduce the amount of work
23310 needed. The next two sections describe two of them. A third alternative is to
23311 use some external process for maintaining the size data, and use the expansion
23312 of the &%mailbox_size%& option as a way of importing it into Exim.
23313
23314
23315
23316
23317 .section "Using tags to record message sizes" "SECID135"
23318 If &%maildir_tag%& is set, the string is expanded for each delivery.
23319 When the maildir file is renamed into the &_new_& sub-directory, the
23320 tag is added to its name. However, if adding the tag takes the length of the
23321 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23322 the tag is dropped and the maildir file is created with no tag.
23323
23324
23325 .vindex "&$message_size$&"
23326 Tags can be used to encode the size of files in their names; see
23327 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23328 happens after the message has been written. The value of the &$message_size$&
23329 variable is set to the number of bytes actually written. If the expansion is
23330 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23331 be deferred. The expanded tag may contain any printing characters except &"/"&.
23332 Non-printing characters in the string are ignored; if the resulting string is
23333 empty, it is ignored. If it starts with an alphanumeric character, a leading
23334 colon is inserted; this default has not proven to be the path that popular
23335 maildir implementations have chosen (but changing it in Exim would break
23336 backwards compatibility).
23337
23338 For one common implementation, you might set:
23339 .code
23340 maildir_tag = ,S=${message_size}
23341 .endd
23342 but you should check the documentation of the other software to be sure.
23343
23344 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23345 as this allows Exim to extract the size from your tag, instead of having to
23346 &[stat()]& each message file.
23347
23348
23349 .section "Using a maildirsize file" "SECID136"
23350 .cindex "quota" "in maildir delivery"
23351 .cindex "maildir format" "&_maildirsize_& file"
23352 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23353 storing quota and message size information in a file called &_maildirsize_&
23354 within the toplevel maildir directory. If this file does not exist, Exim
23355 creates it, setting the quota from the &%quota%& option of the transport. If
23356 the maildir directory itself does not exist, it is created before any attempt
23357 to write a &_maildirsize_& file.
23358
23359 The &_maildirsize_& file is used to hold information about the sizes of
23360 messages in the maildir, thus speeding up quota calculations. The quota value
23361 in the file is just a cache; if the quota is changed in the transport, the new
23362 value overrides the cached value when the next message is delivered. The cache
23363 is maintained for the benefit of other programs that access the maildir and
23364 need to know the quota.
23365
23366 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23367 file is maintained (with a zero quota setting), but no quota is imposed.
23368
23369 A regular expression is available for controlling which directories in the
23370 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23371 See the description of the &%maildir_quota_directory_regex%& option above for
23372 details.
23373
23374
23375 .section "Mailstore delivery" "SECID137"
23376 .cindex "mailstore format" "description of"
23377 If the &%mailstore_format%& option is true, each message is written as two
23378 files in the given directory. A unique base name is constructed from the
23379 message id and the current delivery process, and the files that are written use
23380 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23381 contains the message's envelope, and the &_.msg_& file contains the message
23382 itself. The base name is placed in the variable &$mailstore_basename$&.
23383
23384 During delivery, the envelope is first written to a file with the suffix
23385 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23386 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23387 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23388 file before accessing either of them. An alternative approach is to wait for
23389 the absence of a &_.tmp_& file.
23390
23391 The envelope file starts with any text defined by the &%mailstore_prefix%&
23392 option, expanded and terminated by a newline if there isn't one. Then follows
23393 the sender address on one line, then all the recipient addresses, one per line.
23394 There can be more than one recipient only if the &%batch_max%& option is set
23395 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23396 appended to the file, followed by a newline if it does not end with one.
23397
23398 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23399 failure, it is ignored. Other expansion errors are treated as serious
23400 configuration errors, and delivery is deferred. The variable
23401 &$mailstore_basename$& is available for use during these expansions.
23402
23403
23404 .section "Non-special new file delivery" "SECID138"
23405 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23406 file is created directly in the named directory. For example, when delivering
23407 messages into files in batched SMTP format for later delivery to some host (see
23408 section &<<SECTbatchSMTP>>&), a setting such as
23409 .code
23410 directory = /var/bsmtp/$host
23411 .endd
23412 might be used. A message is written to a file with a temporary name, which is
23413 then renamed when the delivery is complete. The final name is obtained by
23414 expanding the contents of the &%directory_file%& option.
23415 .ecindex IIDapptra1
23416 .ecindex IIDapptra2
23417
23418
23419
23420
23421
23422
23423 . ////////////////////////////////////////////////////////////////////////////
23424 . ////////////////////////////////////////////////////////////////////////////
23425
23426 .chapter "The autoreply transport" "CHID8"
23427 .scindex IIDauttra1 "transports" "&(autoreply)&"
23428 .scindex IIDauttra2 "&(autoreply)& transport"
23429 The &(autoreply)& transport is not a true transport in that it does not cause
23430 the message to be transmitted. Instead, it generates a new mail message as an
23431 automatic reply to the incoming message. &'References:'& and
23432 &'Auto-Submitted:'& header lines are included. These are constructed according
23433 to the rules in RFCs 2822 and 3834, respectively.
23434
23435 If the router that passes the message to this transport does not have the
23436 &%unseen%& option set, the original message (for the current recipient) is not
23437 delivered anywhere. However, when the &%unseen%& option is set on the router
23438 that passes the message to this transport, routing of the address continues, so
23439 another router can set up a normal message delivery.
23440
23441
23442 The &(autoreply)& transport is usually run as the result of mail filtering, a
23443 &"vacation"& message being the standard example. However, it can also be run
23444 directly from a router like any other transport. To reduce the possibility of
23445 message cascades, messages created by the &(autoreply)& transport always have
23446 empty envelope sender addresses, like bounce messages.
23447
23448 The parameters of the message to be sent can be specified in the configuration
23449 by options described below. However, these are used only when the address
23450 passed to the transport does not contain its own reply information. When the
23451 transport is run as a consequence of a
23452 &%mail%&
23453 or &%vacation%& command in a filter file, the parameters of the message are
23454 supplied by the filter, and passed with the address. The transport's options
23455 that define the message are then ignored (so they are not usually set in this
23456 case). The message is specified entirely by the filter or by the transport; it
23457 is never built from a mixture of options. However, the &%file_optional%&,
23458 &%mode%&, and &%return_message%& options apply in all cases.
23459
23460 &(Autoreply)& is implemented as a local transport. When used as a result of a
23461 command in a user's filter file, &(autoreply)& normally runs under the uid and
23462 gid of the user, and with appropriate current and home directories (see chapter
23463 &<<CHAPenvironment>>&).
23464
23465 There is a subtle difference between routing a message to a &(pipe)& transport
23466 that generates some text to be returned to the sender, and routing it to an
23467 &(autoreply)& transport. This difference is noticeable only if more than one
23468 address from the same message is so handled. In the case of a pipe, the
23469 separate outputs from the different addresses are gathered up and returned to
23470 the sender in a single message, whereas if &(autoreply)& is used, a separate
23471 message is generated for each address that is passed to it.
23472
23473 Non-printing characters are not permitted in the header lines generated for the
23474 message that &(autoreply)& creates, with the exception of newlines that are
23475 immediately followed by white space. If any non-printing characters are found,
23476 the transport defers.
23477 Whether characters with the top bit set count as printing characters or not is
23478 controlled by the &%print_topbitchars%& global option.
23479
23480 If any of the generic options for manipulating headers (for example,
23481 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23482 of the original message that is included in the generated message when
23483 &%return_message%& is set. They do not apply to the generated message itself.
23484
23485 .vindex "&$sender_address$&"
23486 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23487 the message, indicating that there were no recipients, it does not treat this
23488 as an error. This means that autoreplies sent to &$sender_address$& when this
23489 is empty (because the incoming message is a bounce message) do not cause
23490 problems. They are just discarded.
23491
23492
23493
23494 .section "Private options for autoreply" "SECID139"
23495 .cindex "options" "&(autoreply)& transport"
23496
23497 .option bcc autoreply string&!! unset
23498 This specifies the addresses that are to receive &"blind carbon copies"& of the
23499 message when the message is specified by the transport.
23500
23501
23502 .option cc autoreply string&!! unset
23503 This specifies recipients of the message and the contents of the &'Cc:'& header
23504 when the message is specified by the transport.
23505
23506
23507 .option file autoreply string&!! unset
23508 The contents of the file are sent as the body of the message when the message
23509 is specified by the transport. If both &%file%& and &%text%& are set, the text
23510 string comes first.
23511
23512
23513 .option file_expand autoreply boolean false
23514 If this is set, the contents of the file named by the &%file%& option are
23515 subjected to string expansion as they are added to the message.
23516
23517
23518 .option file_optional autoreply boolean false
23519 If this option is true, no error is generated if the file named by the &%file%&
23520 option or passed with the address does not exist or cannot be read.
23521
23522
23523 .option from autoreply string&!! unset
23524 This specifies the contents of the &'From:'& header when the message is
23525 specified by the transport.
23526
23527
23528 .option headers autoreply string&!! unset
23529 This specifies additional RFC 2822 headers that are to be added to the message
23530 when the message is specified by the transport. Several can be given by using
23531 &"\n"& to separate them. There is no check on the format.
23532
23533
23534 .option log autoreply string&!! unset
23535 This option names a file in which a record of every message sent is logged when
23536 the message is specified by the transport.
23537
23538
23539 .option mode autoreply "octal integer" 0600
23540 If either the log file or the &"once"& file has to be created, this mode is
23541 used.
23542
23543
23544 .option never_mail autoreply "address list&!!" unset
23545 If any run of the transport creates a message with a recipient that matches any
23546 item in the list, that recipient is quietly discarded. If all recipients are
23547 discarded, no message is created. This applies both when the recipients are
23548 generated by a filter and when they are specified in the transport.
23549
23550
23551
23552 .option once autoreply string&!! unset
23553 This option names a file or DBM database in which a record of each &'To:'&
23554 recipient is kept when the message is specified by the transport. &*Note*&:
23555 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23556
23557 If &%once%& is unset, or is set to an empty string, the message is always sent.
23558 By default, if &%once%& is set to a non-empty filename, the message
23559 is not sent if a potential recipient is already listed in the database.
23560 However, if the &%once_repeat%& option specifies a time greater than zero, the
23561 message is sent if that much time has elapsed since a message was last sent to
23562 this recipient. A setting of zero time for &%once_repeat%& (the default)
23563 prevents a message from being sent a second time &-- in this case, zero means
23564 infinity.
23565
23566 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23567 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23568 greater than zero, it changes the way Exim implements the &%once%& option.
23569 Instead of using a DBM file to record every recipient it sends to, it uses a
23570 regular file, whose size will never get larger than the given value.
23571
23572 In the file, Exim keeps a linear list of recipient addresses and the times at
23573 which they were sent messages. If the file is full when a new address needs to
23574 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23575 means that a given recipient may receive multiple messages, but at
23576 unpredictable intervals that depend on the rate of turnover of addresses in the
23577 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23578
23579
23580 .option once_file_size autoreply integer 0
23581 See &%once%& above.
23582
23583
23584 .option once_repeat autoreply time&!! 0s
23585 See &%once%& above.
23586 After expansion, the value of this option must be a valid time value.
23587
23588
23589 .option reply_to autoreply string&!! unset
23590 This specifies the contents of the &'Reply-To:'& header when the message is
23591 specified by the transport.
23592
23593
23594 .option return_message autoreply boolean false
23595 If this is set, a copy of the original message is returned with the new
23596 message, subject to the maximum size set in the &%return_size_limit%& global
23597 configuration option.
23598
23599
23600 .option subject autoreply string&!! unset
23601 This specifies the contents of the &'Subject:'& header when the message is
23602 specified by the transport. It is tempting to quote the original subject in
23603 automatic responses. For example:
23604 .code
23605 subject = Re: $h_subject:
23606 .endd
23607 There is a danger in doing this, however. It may allow a third party to
23608 subscribe your users to an opt-in mailing list, provided that the list accepts
23609 bounce messages as subscription confirmations. Well-managed lists require a
23610 non-bounce message to confirm a subscription, so the danger is relatively
23611 small.
23612
23613
23614
23615 .option text autoreply string&!! unset
23616 This specifies a single string to be used as the body of the message when the
23617 message is specified by the transport. If both &%text%& and &%file%& are set,
23618 the text comes first.
23619
23620
23621 .option to autoreply string&!! unset
23622 This specifies recipients of the message and the contents of the &'To:'& header
23623 when the message is specified by the transport.
23624 .ecindex IIDauttra1
23625 .ecindex IIDauttra2
23626
23627
23628
23629
23630 . ////////////////////////////////////////////////////////////////////////////
23631 . ////////////////////////////////////////////////////////////////////////////
23632
23633 .chapter "The lmtp transport" "CHAPLMTP"
23634 .cindex "transports" "&(lmtp)&"
23635 .cindex "&(lmtp)& transport"
23636 .cindex "LMTP" "over a pipe"
23637 .cindex "LMTP" "over a socket"
23638 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23639 specified command
23640 or by interacting with a Unix domain socket.
23641 This transport is something of a cross between the &(pipe)& and &(smtp)&
23642 transports. Exim also has support for using LMTP over TCP/IP; this is
23643 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23644 to be of minority interest, the default build-time configure in &_src/EDITME_&
23645 has it commented out. You need to ensure that
23646 .code
23647 TRANSPORT_LMTP=yes
23648 .endd
23649 .cindex "options" "&(lmtp)& transport"
23650 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23651 included in the Exim binary. The private options of the &(lmtp)& transport are
23652 as follows:
23653
23654 .option batch_id lmtp string&!! unset
23655 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23656
23657
23658 .option batch_max lmtp integer 1
23659 This limits the number of addresses that can be handled in a single delivery.
23660 Most LMTP servers can handle several addresses at once, so it is normally a
23661 good idea to increase this value. See the description of local delivery
23662 batching in chapter &<<CHAPbatching>>&.
23663
23664
23665 .option command lmtp string&!! unset
23666 This option must be set if &%socket%& is not set. The string is a command which
23667 is run in a separate process. It is split up into a command name and list of
23668 arguments, each of which is separately expanded (so expansion cannot change the
23669 number of arguments). The command is run directly, not via a shell. The message
23670 is passed to the new process using the standard input and output to operate the
23671 LMTP protocol.
23672
23673 .option ignore_quota lmtp boolean false
23674 .cindex "LMTP" "ignoring quota errors"
23675 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23676 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23677 in its response to the LHLO command.
23678
23679 .option socket lmtp string&!! unset
23680 This option must be set if &%command%& is not set. The result of expansion must
23681 be the name of a Unix domain socket. The transport connects to the socket and
23682 delivers the message to it using the LMTP protocol.
23683
23684
23685 .option timeout lmtp time 5m
23686 The transport is aborted if the created process or Unix domain socket does not
23687 respond to LMTP commands or message input within this timeout. Delivery
23688 is deferred, and will be tried again later. Here is an example of a typical
23689 LMTP transport:
23690 .code
23691 lmtp:
23692   driver = lmtp
23693   command = /some/local/lmtp/delivery/program
23694   batch_max = 20
23695   user = exim
23696 .endd
23697 This delivers up to 20 addresses at a time, in a mixture of domains if
23698 necessary, running as the user &'exim'&.
23699
23700
23701
23702 . ////////////////////////////////////////////////////////////////////////////
23703 . ////////////////////////////////////////////////////////////////////////////
23704
23705 .chapter "The pipe transport" "CHAPpipetransport"
23706 .scindex IIDpiptra1 "transports" "&(pipe)&"
23707 .scindex IIDpiptra2 "&(pipe)& transport"
23708 The &(pipe)& transport is used to deliver messages via a pipe to a command
23709 running in another process. One example is the use of &(pipe)& as a
23710 pseudo-remote transport for passing messages to some other delivery mechanism
23711 (such as UUCP). Another is the use by individual users to automatically process
23712 their incoming messages. The &(pipe)& transport can be used in one of the
23713 following ways:
23714
23715 .ilist
23716 .vindex "&$local_part$&"
23717 A router routes one address to a transport in the normal way, and the
23718 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23719 contains the local part of the address (as usual), and the command that is run
23720 is specified by the &%command%& option on the transport.
23721 .next
23722 .vindex "&$pipe_addresses$&"
23723 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23724 transport can handle more than one address in a single run. In this case, when
23725 more than one address is routed to the transport, &$local_part$& is not set
23726 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23727 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23728 that are routed to the transport.
23729 .next
23730 .vindex "&$address_pipe$&"
23731 A router redirects an address directly to a pipe command (for example, from an
23732 alias or forward file). In this case, &$address_pipe$& contains the text of the
23733 pipe command, and the &%command%& option on the transport is ignored unless
23734 &%force_command%& is set. If only one address is being transported
23735 (&%batch_max%& is not greater than one, or only one address was redirected to
23736 this pipe command), &$local_part$& contains the local part that was redirected.
23737 .endlist
23738
23739
23740 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23741 deliver messages over pipes using the LMTP interactive protocol. This is
23742 implemented by the &(lmtp)& transport.
23743
23744 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23745 &_.forward_& file, the command runs under the uid and gid of that user. In
23746 other cases, the uid and gid have to be specified explicitly, either on the
23747 transport or on the router that handles the address. Current and &"home"&
23748 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23749 details of the local delivery environment and chapter &<<CHAPbatching>>&
23750 for a discussion of local delivery batching.
23751
23752
23753 .section "Concurrent delivery" "SECID140"
23754 If two messages arrive at almost the same time, and both are routed to a pipe
23755 delivery, the two pipe transports may be run concurrently. You must ensure that
23756 any pipe commands you set up are robust against this happening. If the commands
23757 write to a file, the &%exim_lock%& utility might be of use.
23758 Alternatively the &%max_parallel%& option could be used with a value
23759 of "1" to enforce serialization.
23760
23761
23762
23763
23764 .section "Returned status and data" "SECID141"
23765 .cindex "&(pipe)& transport" "returned data"
23766 If the command exits with a non-zero return code, the delivery is deemed to
23767 have failed, unless either the &%ignore_status%& option is set (in which case
23768 the return code is treated as zero), or the return code is one of those listed
23769 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23770 later"&. In this case, delivery is deferred. Details of a permanent failure are
23771 logged, but are not included in the bounce message, which merely contains
23772 &"local delivery failed"&.
23773
23774 If the command exits on a signal and the &%freeze_signal%& option is set then
23775 the message will be frozen in the queue. If that option is not set, a bounce
23776 will be sent as normal.
23777
23778 If the return code is greater than 128 and the command being run is a shell
23779 script, it normally means that the script was terminated by a signal whose
23780 value is the return code minus 128. The &%freeze_signal%& option does not
23781 apply in this case.
23782
23783 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23784 return code is set to 127. This is the value that a shell returns if it is
23785 asked to run a non-existent command. The wording for the log line suggests that
23786 a non-existent command may be the problem.
23787
23788 The &%return_output%& option can affect the result of a pipe delivery. If it is
23789 set and the command produces any output on its standard output or standard
23790 error streams, the command is considered to have failed, even if it gave a zero
23791 return code or if &%ignore_status%& is set. The output from the command is
23792 included as part of the bounce message. The &%return_fail_output%& option is
23793 similar, except that output is returned only when the command exits with a
23794 failure return code, that is, a value other than zero or a code that matches
23795 &%temp_errors%&.
23796
23797
23798
23799 .section "How the command is run" "SECThowcommandrun"
23800 .cindex "&(pipe)& transport" "path for command"
23801 The command line is (by default) broken down into a command name and arguments
23802 by the &(pipe)& transport itself. The &%allow_commands%& and
23803 &%restrict_to_path%& options can be used to restrict the commands that may be
23804 run.
23805
23806 .cindex "quoting" "in pipe command"
23807 Unquoted arguments are delimited by white space. If an argument appears in
23808 double quotes, backslash is interpreted as an escape character in the usual
23809 way. If an argument appears in single quotes, no escaping is done.
23810
23811 String expansion is applied to the command line except when it comes from a
23812 traditional &_.forward_& file (commands from a filter file are expanded). The
23813 expansion is applied to each argument in turn rather than to the whole line.
23814 For this reason, any string expansion item that contains white space must be
23815 quoted so as to be contained within a single argument. A setting such as
23816 .code
23817 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23818 .endd
23819 will not work, because the expansion item gets split between several
23820 arguments. You have to write
23821 .code
23822 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23823 .endd
23824 to ensure that it is all in one argument. The expansion is done in this way,
23825 argument by argument, so that the number of arguments cannot be changed as a
23826 result of expansion, and quotes or backslashes in inserted variables do not
23827 interact with external quoting. However, this leads to problems if you want to
23828 generate multiple arguments (or the command name plus arguments) from a single
23829 expansion. In this situation, the simplest solution is to use a shell. For
23830 example:
23831 .code
23832 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23833 .endd
23834
23835 .cindex "transport" "filter"
23836 .cindex "filter" "transport filter"
23837 .vindex "&$pipe_addresses$&"
23838 Special handling takes place when an argument consists of precisely the text
23839 &`$pipe_addresses`& (no quotes).
23840 This is not a general expansion variable; the only
23841 place this string is recognized is when it appears as an argument for a pipe or
23842 transport filter command. It causes each address that is being handled to be
23843 inserted in the argument list at that point &'as a separate argument'&. This
23844 avoids any problems with spaces or shell metacharacters, and is of use when a
23845 &(pipe)& transport is handling groups of addresses in a batch.
23846
23847 If &%force_command%& is enabled on the transport, special handling takes place
23848 for an argument that consists of precisely the text &`$address_pipe`&.  It
23849 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23850 argument is inserted in the argument list at that point
23851 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23852 the only item in the argument; in fact, if it were then &%force_command%&
23853 should behave as a no-op.  Rather, it should be used to adjust the command
23854 run while preserving the argument vector separation.
23855
23856 After splitting up into arguments and expansion, the resulting command is run
23857 in a subprocess directly from the transport, &'not'& under a shell. The
23858 message that is being delivered is supplied on the standard input, and the
23859 standard output and standard error are both connected to a single pipe that is
23860 read by Exim. The &%max_output%& option controls how much output the command
23861 may produce, and the &%return_output%& and &%return_fail_output%& options
23862 control what is done with it.
23863
23864 Not running the command under a shell (by default) lessens the security risks
23865 in cases when a command from a user's filter file is built out of data that was
23866 taken from an incoming message. If a shell is required, it can of course be
23867 explicitly specified as the command to be run. However, there are circumstances
23868 where existing commands (for example, in &_.forward_& files) expect to be run
23869 under a shell and cannot easily be modified. To allow for these cases, there is
23870 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23871 works. Instead of breaking up the command line as just described, it expands it
23872 as a single string and passes the result to &_/bin/sh_&. The
23873 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23874 with &%use_shell%&, and the whole mechanism is inherently less secure.
23875
23876
23877
23878 .section "Environment variables" "SECTpipeenv"
23879 .cindex "&(pipe)& transport" "environment for command"
23880 .cindex "environment" "&(pipe)& transport"
23881 The environment variables listed below are set up when the command is invoked.
23882 This list is a compromise for maximum compatibility with other MTAs. Note that
23883 the &%environment%& option can be used to add additional variables to this
23884 environment. The environment for the &(pipe)& transport is not subject
23885 to the &%add_environment%& and &%keep_environment%& main config options.
23886 .display
23887 &`DOMAIN            `&   the domain of the address
23888 &`HOME              `&   the home directory, if set
23889 &`HOST              `&   the host name when called from a router (see below)
23890 &`LOCAL_PART        `&   see below
23891 &`LOCAL_PART_PREFIX `&   see below
23892 &`LOCAL_PART_SUFFIX `&   see below
23893 &`LOGNAME           `&   see below
23894 &`MESSAGE_ID        `&   Exim's local ID for the message
23895 &`PATH              `&   as specified by the &%path%& option below
23896 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23897 &`RECIPIENT         `&   the complete recipient address
23898 &`SENDER            `&   the sender of the message (empty if a bounce)
23899 &`SHELL             `&   &`/bin/sh`&
23900 &`TZ                `&   the value of the &%timezone%& option, if set
23901 &`USER              `&   see below
23902 .endd
23903 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23904 router, LOCAL_PART is set to the local part of the address. When it is
23905 called as a result of a forward or alias expansion, LOCAL_PART is set to
23906 the local part of the address that was expanded. In both cases, any affixes are
23907 removed from the local part, and made available in LOCAL_PART_PREFIX and
23908 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23909 same value as LOCAL_PART for compatibility with other MTAs.
23910
23911 .cindex "HOST"
23912 HOST is set only when a &(pipe)& transport is called from a router that
23913 associates hosts with an address, typically when using &(pipe)& as a
23914 pseudo-remote transport. HOST is set to the first host name specified by
23915 the router.
23916
23917 .cindex "HOME"
23918 If the transport's generic &%home_directory%& option is set, its value is used
23919 for the HOME environment variable. Otherwise, a home directory may be set
23920 by the router's &%transport_home_directory%& option, which defaults to the
23921 user's home directory if &%check_local_user%& is set.
23922
23923
23924 .section "Private options for pipe" "SECID142"
23925 .cindex "options" "&(pipe)& transport"
23926
23927
23928
23929 .option allow_commands pipe "string list&!!" unset
23930 .cindex "&(pipe)& transport" "permitted commands"
23931 The string is expanded, and is then interpreted as a colon-separated list of
23932 permitted commands. If &%restrict_to_path%& is not set, the only commands
23933 permitted are those in the &%allow_commands%& list. They need not be absolute
23934 paths; the &%path%& option is still used for relative paths. If
23935 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23936 in the &%allow_commands%& list, or a name without any slashes that is found on
23937 the path. In other words, if neither &%allow_commands%& nor
23938 &%restrict_to_path%& is set, there is no restriction on the command, but
23939 otherwise only commands that are permitted by one or the other are allowed. For
23940 example, if
23941 .code
23942 allow_commands = /usr/bin/vacation
23943 .endd
23944 and &%restrict_to_path%& is not set, the only permitted command is
23945 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23946 &%use_shell%& is set.
23947
23948
23949 .option batch_id pipe string&!! unset
23950 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23951
23952
23953 .option batch_max pipe integer 1
23954 This limits the number of addresses that can be handled in a single delivery.
23955 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23956
23957
23958 .option check_string pipe string unset
23959 As &(pipe)& writes the message, the start of each line is tested for matching
23960 &%check_string%&, and if it does, the initial matching characters are replaced
23961 by the contents of &%escape_string%&, provided both are set. The value of
23962 &%check_string%& is a literal string, not a regular expression, and the case of
23963 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23964 of &%check_string%& and &%escape_string%& are forced to values that implement
23965 the SMTP escaping protocol. Any settings made in the configuration file are
23966 ignored.
23967
23968
23969 .option command pipe string&!! unset
23970 This option need not be set when &(pipe)& is being used to deliver to pipes
23971 obtained directly from address redirections. In other cases, the option must be
23972 set, to provide a command to be run. It need not yield an absolute path (see
23973 the &%path%& option below). The command is split up into separate arguments by
23974 Exim, and each argument is separately expanded, as described in section
23975 &<<SECThowcommandrun>>& above.
23976
23977
23978 .option environment pipe string&!! unset
23979 .cindex "&(pipe)& transport" "environment for command"
23980 .cindex "environment" "&(pipe)& transport"
23981 This option is used to add additional variables to the environment in which the
23982 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23983 a string which is expanded, and then interpreted as a colon-separated list of
23984 environment settings of the form <&'name'&>=<&'value'&>.
23985
23986
23987 .option escape_string pipe string unset
23988 See &%check_string%& above.
23989
23990
23991 .option freeze_exec_fail pipe boolean false
23992 .cindex "exec failure"
23993 .cindex "failure of exec"
23994 .cindex "&(pipe)& transport" "failure of exec"
23995 Failure to exec the command in a pipe transport is by default treated like
23996 any other failure while running the command. However, if &%freeze_exec_fail%&
23997 is set, failure to exec is treated specially, and causes the message to be
23998 frozen, whatever the setting of &%ignore_status%&.
23999
24000
24001 .option freeze_signal pipe boolean false
24002 .cindex "signal exit"
24003 .cindex "&(pipe)& transport", "signal exit"
24004 Normally if the process run by a command in a pipe transport exits on a signal,
24005 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24006 frozen in Exim's queue instead.
24007
24008
24009 .option force_command pipe boolean false
24010 .cindex "force command"
24011 .cindex "&(pipe)& transport", "force command"
24012 Normally when a router redirects an address directly to a pipe command
24013 the &%command%& option on the transport is ignored.  If &%force_command%&
24014 is set, the &%command%& option will used. This is especially
24015 useful for forcing a wrapper or additional argument to be added to the
24016 command. For example:
24017 .code
24018 command = /usr/bin/remote_exec myhost -- $address_pipe
24019 force_command
24020 .endd
24021
24022 Note that &$address_pipe$& is handled specially in &%command%& when
24023 &%force_command%& is set, expanding out to the original argument vector as
24024 separate items, similarly to a Unix shell &`"$@"`& construct.
24025
24026
24027 .option ignore_status pipe boolean false
24028 If this option is true, the status returned by the subprocess that is set up to
24029 run the command is ignored, and Exim behaves as if zero had been returned.
24030 Otherwise, a non-zero status or termination by signal causes an error return
24031 from the transport unless the status value is one of those listed in
24032 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24033
24034 &*Note*&: This option does not apply to timeouts, which do not return a status.
24035 See the &%timeout_defer%& option for how timeouts are handled.
24036
24037
24038 .option log_defer_output pipe boolean false
24039 .cindex "&(pipe)& transport" "logging output"
24040 If this option is set, and the status returned by the command is
24041 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24042 and any output was produced on stdout or stderr, the first line of it is
24043 written to the main log.
24044
24045
24046 .option log_fail_output pipe boolean false
24047 If this option is set, and the command returns any output on stdout or
24048 stderr, and also ends with a return code that is neither zero nor one of
24049 the return codes listed in &%temp_errors%& (that is, the delivery
24050 failed), the first line of output is written to the main log. This
24051 option and &%log_output%& are mutually exclusive.  Only one of them may
24052 be set.
24053
24054
24055 .option log_output pipe boolean false
24056 If this option is set and the command returns any output on stdout or
24057 stderr, the first line of output is written to the main log, whatever
24058 the return code. This option and &%log_fail_output%& are mutually
24059 exclusive. Only one of them may be set.
24060
24061
24062 .option max_output pipe integer 20K
24063 This specifies the maximum amount of output that the command may produce on its
24064 standard output and standard error file combined. If the limit is exceeded, the
24065 process running the command is killed. This is intended as a safety measure to
24066 catch runaway processes. The limit is applied independently of the settings of
24067 the options that control what is done with such output (for example,
24068 &%return_output%&). Because of buffering effects, the amount of output may
24069 exceed the limit by a small amount before Exim notices.
24070
24071
24072 .option message_prefix pipe string&!! "see below"
24073 The string specified here is expanded and output at the start of every message.
24074 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24075 .code
24076 message_prefix = \
24077   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24078   ${tod_bsdinbox}\n
24079 .endd
24080 .cindex "Cyrus"
24081 .cindex "&%tmail%&"
24082 .cindex "&""From""& line"
24083 This is required by the commonly used &_/usr/bin/vacation_& program.
24084 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24085 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24086 setting
24087 .code
24088 message_prefix =
24089 .endd
24090 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24091 &`\n`& to &`\r\n`& in &%message_prefix%&.
24092
24093
24094 .option message_suffix pipe string&!! "see below"
24095 The string specified here is expanded and output at the end of every message.
24096 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24097 The suffix can be suppressed by setting
24098 .code
24099 message_suffix =
24100 .endd
24101 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24102 &`\n`& to &`\r\n`& in &%message_suffix%&.
24103
24104
24105 .option path pipe string&!! "/bin:/usr/bin"
24106 This option is expanded and
24107 specifies the string that is set up in the PATH environment
24108 variable of the subprocess.
24109 If the &%command%& option does not yield an absolute path name, the command is
24110 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24111 apply to a command specified as a transport filter.
24112
24113
24114 .option permit_coredump pipe boolean false
24115 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24116 a core-dump of a pipe command, enable this command.  This enables core-dumps
24117 during delivery and affects both the Exim binary and the pipe command run.
24118 It is recommended that this option remain off unless and until you have a need
24119 for it and that this only be enabled when needed, as the risk of excessive
24120 resource consumption can be quite high.  Note also that Exim is typically
24121 installed as a setuid binary and most operating systems will inhibit coredumps
24122 of these by default, so further OS-specific action may be required.
24123
24124
24125 .option pipe_as_creator pipe boolean false
24126 .cindex "uid (user id)" "local delivery"
24127 If the generic &%user%& option is not set and this option is true, the delivery
24128 process is run under the uid that was in force when Exim was originally called
24129 to accept the message. If the group id is not otherwise set (via the generic
24130 &%group%& option), the gid that was in force when Exim was originally called to
24131 accept the message is used.
24132
24133
24134 .option restrict_to_path pipe boolean false
24135 When this option is set, any command name not listed in &%allow_commands%& must
24136 contain no slashes. The command is searched for only in the directories listed
24137 in the &%path%& option. This option is intended for use in the case when a pipe
24138 command has been generated from a user's &_.forward_& file. This is usually
24139 handled by a &(pipe)& transport called &%address_pipe%&.
24140
24141
24142 .option return_fail_output pipe boolean false
24143 If this option is true, and the command produced any output and ended with a
24144 return code other than zero or one of the codes listed in &%temp_errors%& (that
24145 is, the delivery failed), the output is returned in the bounce message.
24146 However, if the message has a null sender (that is, it is itself a bounce
24147 message), output from the command is discarded. This option and
24148 &%return_output%& are mutually exclusive. Only one of them may be set.
24149
24150
24151
24152 .option return_output pipe boolean false
24153 If this option is true, and the command produced any output, the delivery is
24154 deemed to have failed whatever the return code from the command, and the output
24155 is returned in the bounce message. Otherwise, the output is just discarded.
24156 However, if the message has a null sender (that is, it is a bounce message),
24157 output from the command is always discarded, whatever the setting of this
24158 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24159 of them may be set.
24160
24161
24162
24163 .option temp_errors pipe "string list" "see below"
24164 .cindex "&(pipe)& transport" "temporary failure"
24165 This option contains either a colon-separated list of numbers, or a single
24166 asterisk. If &%ignore_status%& is false
24167 and &%return_output%& is not set,
24168 and the command exits with a non-zero return code, the failure is treated as
24169 temporary and the delivery is deferred if the return code matches one of the
24170 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24171 codes are treated as permanent errors. The default setting contains the codes
24172 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24173 compiled on a system that does not define these macros, it assumes values of 75
24174 and 73, respectively.
24175
24176
24177 .option timeout pipe time 1h
24178 If the command fails to complete within this time, it is killed. This normally
24179 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24180 specifies no timeout. In order to ensure that any subprocesses created by the
24181 command are also killed, Exim makes the initial process a process group leader,
24182 and kills the whole process group on a timeout. However, this can be defeated
24183 if one of the processes starts a new process group.
24184
24185 .option timeout_defer pipe boolean false
24186 A timeout in a &(pipe)& transport, either in the command that the transport
24187 runs, or in a transport filter that is associated with it, is by default
24188 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24189 is set true, both kinds of timeout become temporary errors, causing the
24190 delivery to be deferred.
24191
24192 .option umask pipe "octal integer" 022
24193 This specifies the umask setting for the subprocess that runs the command.
24194
24195
24196 .option use_bsmtp pipe boolean false
24197 .cindex "envelope sender"
24198 If this option is set true, the &(pipe)& transport writes messages in &"batch
24199 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24200 commands. If you want to include a leading HELO command with such messages,
24201 you can do so by setting the &%message_prefix%& option. See section
24202 &<<SECTbatchSMTP>>& for details of batch SMTP.
24203
24204 .option use_classresources pipe boolean false
24205 .cindex "class resources (BSD)"
24206 This option is available only when Exim is running on FreeBSD, NetBSD, or
24207 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24208 resource limits when a &(pipe)& transport is run to perform a delivery. The
24209 limits for the uid under which the pipe is to run are obtained from the login
24210 class database.
24211
24212
24213 .option use_crlf pipe boolean false
24214 .cindex "carriage return"
24215 .cindex "linefeed"
24216 This option causes lines to be terminated with the two-character CRLF sequence
24217 (carriage return, linefeed) instead of just a linefeed character. In the case
24218 of batched SMTP, the byte sequence written to the pipe is then an exact image
24219 of what would be sent down a real SMTP connection.
24220
24221 The contents of the &%message_prefix%& and &%message_suffix%& options are
24222 written verbatim, so must contain their own carriage return characters if these
24223 are needed. When &%use_bsmtp%& is not set, the default values for both
24224 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24225 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24226
24227
24228 .option use_shell pipe boolean false
24229 .vindex "&$pipe_addresses$&"
24230 If this option is set, it causes the command to be passed to &_/bin/sh_&
24231 instead of being run directly from the transport, as described in section
24232 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24233 where the command is expected to be run under a shell and cannot easily be
24234 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24235 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24236 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24237 its &%-c%& option.
24238
24239
24240
24241 .section "Using an external local delivery agent" "SECID143"
24242 .cindex "local delivery" "using an external agent"
24243 .cindex "&'procmail'&"
24244 .cindex "external local delivery"
24245 .cindex "delivery" "&'procmail'&"
24246 .cindex "delivery" "by external agent"
24247 The &(pipe)& transport can be used to pass all messages that require local
24248 delivery to a separate local delivery agent such as &%procmail%&. When doing
24249 this, care must be taken to ensure that the pipe is run under an appropriate
24250 uid and gid. In some configurations one wants this to be a uid that is trusted
24251 by the delivery agent to supply the correct sender of the message. It may be
24252 necessary to recompile or reconfigure the delivery agent so that it trusts an
24253 appropriate user. The following is an example transport and router
24254 configuration for &%procmail%&:
24255 .code
24256 # transport
24257 procmail_pipe:
24258   driver = pipe
24259   command = /usr/local/bin/procmail -d $local_part
24260   return_path_add
24261   delivery_date_add
24262   envelope_to_add
24263   check_string = "From "
24264   escape_string = ">From "
24265   umask = 077
24266   user = $local_part
24267   group = mail
24268
24269 # router
24270 procmail:
24271   driver = accept
24272   check_local_user
24273   transport = procmail_pipe
24274 .endd
24275 In this example, the pipe is run as the local user, but with the group set to
24276 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24277 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24278 user to supply a correct sender address. If you do not specify either a
24279 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24280 home directory is the user's home directory by default.
24281
24282 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24283 .code
24284 IFS=" "
24285 .endd
24286 as shown in some &%procmail%& documentation, because Exim does not by default
24287 use a shell to run pipe commands.
24288
24289 .cindex "Cyrus"
24290 The next example shows a transport and a router for a system where local
24291 deliveries are handled by the Cyrus IMAP server.
24292 .code
24293 # transport
24294 local_delivery_cyrus:
24295   driver = pipe
24296   command = /usr/cyrus/bin/deliver \
24297             -m ${substr_1:$local_part_suffix} -- $local_part
24298   user = cyrus
24299   group = mail
24300   return_output
24301   log_output
24302   message_prefix =
24303   message_suffix =
24304
24305 # router
24306 local_user_cyrus:
24307   driver = accept
24308   check_local_user
24309   local_part_suffix = .*
24310   transport = local_delivery_cyrus
24311 .endd
24312 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24313 &%return_output%& to cause any text written by Cyrus to be returned to the
24314 sender.
24315 .ecindex IIDpiptra1
24316 .ecindex IIDpiptra2
24317
24318
24319 . ////////////////////////////////////////////////////////////////////////////
24320 . ////////////////////////////////////////////////////////////////////////////
24321
24322 .chapter "The smtp transport" "CHAPsmtptrans"
24323 .scindex IIDsmttra1 "transports" "&(smtp)&"
24324 .scindex IIDsmttra2 "&(smtp)& transport"
24325 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24326 or LMTP protocol. The list of hosts to try can either be taken from the address
24327 that is being processed (having been set up by the router), or specified
24328 explicitly for the transport. Timeout and retry processing (see chapter
24329 &<<CHAPretry>>&) is applied to each IP address independently.
24330
24331
24332 .section "Multiple messages on a single connection" "SECID144"
24333 The sending of multiple messages over a single TCP/IP connection can arise in
24334 two ways:
24335
24336 .ilist
24337 If a message contains more than &%max_rcpt%& (see below) addresses that are
24338 routed to the same host, more than one copy of the message has to be sent to
24339 that host. In this situation, multiple copies may be sent in a single run of
24340 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24341 does when it has too many addresses to send in one message also depends on the
24342 value of the global &%remote_max_parallel%& option. Details are given in
24343 section &<<SECToutSMTPTCP>>&.)
24344 .next
24345 .cindex "hints database" "remembering routing"
24346 When a message has been successfully delivered over a TCP/IP connection, Exim
24347 looks in its hints database to see if there are any other messages awaiting a
24348 connection to the same host. If there are, a new delivery process is started
24349 for one of them, and the current TCP/IP connection is passed on to it. The new
24350 process may in turn send multiple copies and possibly create yet another
24351 process.
24352 .endlist
24353
24354
24355 For each copy sent over the same TCP/IP connection, a sequence counter is
24356 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24357 no further messages are sent over that connection.
24358
24359
24360
24361 .section "Use of the $host and $host_address variables" "SECID145"
24362 .vindex "&$host$&"
24363 .vindex "&$host_address$&"
24364 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24365 &$host_address$& are the name and IP address of the first host on the host list
24366 passed by the router. However, when the transport is about to connect to a
24367 specific host, and while it is connected to that host, &$host$& and
24368 &$host_address$& are set to the values for that host. These are the values
24369 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24370 &%serialize_hosts%&, and the various TLS options are expanded.
24371
24372
24373 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24374 .vindex &$tls_bits$&
24375 .vindex &$tls_cipher$&
24376 .vindex &$tls_peerdn$&
24377 .vindex &$tls_sni$&
24378 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24379 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24380 are the values that were set when the message was received.
24381 These are the values that are used for options that are expanded before any
24382 SMTP connections are made. Just before each connection is made, these four
24383 variables are emptied. If TLS is subsequently started, they are set to the
24384 appropriate values for the outgoing connection, and these are the values that
24385 are in force when any authenticators are run and when the
24386 &%authenticated_sender%& option is expanded.
24387
24388 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24389 and will be removed in a future release.
24390
24391
24392 .section "Private options for smtp" "SECID146"
24393 .cindex "options" "&(smtp)& transport"
24394 The private options of the &(smtp)& transport are as follows:
24395
24396
24397 .option address_retry_include_sender smtp boolean true
24398 .cindex "4&'xx'& responses" "retrying after"
24399 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24400 is the combination of sender and recipient that is delayed in subsequent queue
24401 runs until the retry time is reached. You can delay the recipient without
24402 reference to the sender (which is what earlier versions of Exim did), by
24403 setting &%address_retry_include_sender%& false. However, this can lead to
24404 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24405
24406 .option allow_localhost smtp boolean false
24407 .cindex "local host" "sending to"
24408 .cindex "fallback" "hosts specified on transport"
24409 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24410 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24411 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24412 the delivery anyway. This should be used only in special cases when the
24413 configuration ensures that no looping will result (for example, a differently
24414 configured Exim is listening on the port to which the message is sent).
24415
24416
24417 .option authenticated_sender smtp string&!! unset
24418 .cindex "Cyrus"
24419 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24420 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24421 overriding any existing authenticated sender value. If the string expansion is
24422 forced to fail, the option is ignored. Other expansion failures cause delivery
24423 to be deferred. If the result of expansion is an empty string, that is also
24424 ignored.
24425
24426 The expansion happens after the outgoing connection has been made and TLS
24427 started, if required. This means that the &$host$&, &$host_address$&,
24428 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24429 particular connection.
24430
24431 If the SMTP session is not authenticated, the expansion of
24432 &%authenticated_sender%& still happens (and can cause the delivery to be
24433 deferred if it fails), but no AUTH= item is added to MAIL commands
24434 unless &%authenticated_sender_force%& is true.
24435
24436 This option allows you to use the &(smtp)& transport in LMTP mode to
24437 deliver mail to Cyrus IMAP and provide the proper local part as the
24438 &"authenticated sender"&, via a setting such as:
24439 .code
24440 authenticated_sender = $local_part
24441 .endd
24442 This removes the need for IMAP subfolders to be assigned special ACLs to
24443 allow direct delivery to those subfolders.
24444
24445 Because of expected uses such as that just described for Cyrus (when no
24446 domain is involved), there is no checking on the syntax of the provided
24447 value.
24448
24449
24450 .option authenticated_sender_force smtp boolean false
24451 If this option is set true, the &%authenticated_sender%& option's value
24452 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24453 authenticated as a client.
24454
24455
24456 .option command_timeout smtp time 5m
24457 This sets a timeout for receiving a response to an SMTP command that has been
24458 sent out. It is also used when waiting for the initial banner line from the
24459 remote host. Its value must not be zero.
24460
24461
24462 .option connect_timeout smtp time 5m
24463 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24464 to a remote host. A setting of zero allows the system timeout (typically
24465 several minutes) to act. To have any effect, the value of this option must be
24466 less than the system timeout. However, it has been observed that on some
24467 systems there is no system timeout, which is why the default value for this
24468 option is 5 minutes, a value recommended by RFC 1123.
24469
24470
24471 .option connection_max_messages smtp integer 500
24472 .cindex "SMTP" "passed connection"
24473 .cindex "SMTP" "multiple deliveries"
24474 .cindex "multiple SMTP deliveries"
24475 This controls the maximum number of separate message deliveries that are sent
24476 over a single TCP/IP connection. If the value is zero, there is no limit.
24477 For testing purposes, this value can be overridden by the &%-oB%& command line
24478 option.
24479
24480
24481 .option dane_require_tls_ciphers smtp string&!! unset
24482 .cindex "TLS" "requiring specific ciphers for DANE"
24483 .cindex "cipher" "requiring specific"
24484 .cindex DANE "TLS ciphers"
24485 This option may be used to override &%tls_require_ciphers%& for connections
24486 where DANE has been determined to be in effect.
24487 If not set, then &%tls_require_ciphers%& will be used.
24488 Normal SMTP delivery is not able to make strong demands of TLS cipher
24489 configuration, because delivery will fall back to plaintext.  Once DANE has
24490 been determined to be in effect, there is no plaintext fallback and making the
24491 TLS cipherlist configuration stronger will increase security, rather than
24492 counter-intuitively decreasing it.
24493 If the option expands to be empty or is forced to fail, then it will
24494 be treated as unset and &%tls_require_ciphers%& will be used instead.
24495
24496
24497 .option data_timeout smtp time 5m
24498 This sets a timeout for the transmission of each block in the data portion of
24499 the message. As a result, the overall timeout for a message depends on the size
24500 of the message. Its value must not be zero. See also &%final_timeout%&.
24501
24502
24503 .option dkim_canon smtp string&!! unset
24504 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24505 .option dkim_domain smtp string list&!! unset
24506 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24507 .option dkim_hash smtp string&!! sha256
24508 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24509 .option dkim_identity smtp string&!! unset
24510 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24511 .option dkim_private_key smtp string&!! unset
24512 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24513 .option dkim_selector smtp string&!! unset
24514 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24515 .option dkim_strict smtp string&!! unset
24516 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24517 .option dkim_sign_headers smtp string&!! "per RFC"
24518 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24519 .option dkim_timestamps smtp string&!! unset
24520 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24521
24522
24523 .option delay_after_cutoff smtp boolean true
24524 .cindex "final cutoff" "retries, controlling"
24525 .cindex retry "final cutoff"
24526 This option controls what happens when all remote IP addresses for a given
24527 domain have been inaccessible for so long that they have passed their retry
24528 cutoff times.
24529
24530 In the default state, if the next retry time has not been reached for any of
24531 them, the address is bounced without trying any deliveries. In other words,
24532 Exim delays retrying an IP address after the final cutoff time until a new
24533 retry time is reached, and can therefore bounce an address without ever trying
24534 a delivery, when machines have been down for a long time. Some people are
24535 unhappy at this prospect, so...
24536
24537 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24538 addresses are past their final cutoff time, Exim tries to deliver to those
24539 IP addresses that have not been tried since the message arrived. If there are
24540 none, of if they all fail, the address is bounced. In other words, it does not
24541 delay when a new message arrives, but immediately tries those expired IP
24542 addresses that haven't been tried since the message arrived. If there is a
24543 continuous stream of messages for the dead hosts, unsetting
24544 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24545 to them.
24546
24547
24548 .option dns_qualify_single smtp boolean true
24549 If the &%hosts%& or &%fallback_hosts%& option is being used,
24550 and the &%gethostbyname%& option is false,
24551 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24552 in chapter &<<CHAPdnslookup>>& for more details.
24553
24554
24555 .option dns_search_parents smtp boolean false
24556 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24557 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24558 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24559 details.
24560
24561
24562 .option dnssec_request_domains smtp "domain list&!!" *
24563 .cindex "MX record" "security"
24564 .cindex "DNSSEC" "MX lookup"
24565 .cindex "security" "MX lookup"
24566 .cindex "DNS" "DNSSEC"
24567 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24568 the dnssec request bit set. Setting this transport option is only useful if the
24569 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24570 router option.
24571
24572
24573
24574 .option dnssec_require_domains smtp "domain list&!!" unset
24575 .cindex "MX record" "security"
24576 .cindex "DNSSEC" "MX lookup"
24577 .cindex "security" "MX lookup"
24578 .cindex "DNS" "DNSSEC"
24579 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24580 the dnssec request bit set.  Setting this transport option is only
24581 useful if the transport overrides or sets the host names. See the
24582 &%dnssec_require_domains%& router option.
24583
24584
24585
24586 .option dscp smtp string&!! unset
24587 .cindex "DCSP" "outbound"
24588 This option causes the DSCP value associated with a socket to be set to one
24589 of a number of fixed strings or to numeric value.
24590 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24591 Common values include &`throughput`&, &`mincost`&, and on newer systems
24592 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24593
24594 The outbound packets from Exim will be marked with this value in the header
24595 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24596 that these values will have any effect, not be stripped by networking
24597 equipment, or do much of anything without cooperation with your Network
24598 Engineer and those of all network operators between the source and destination.
24599
24600
24601 .option fallback_hosts smtp "string list" unset
24602 .cindex "fallback" "hosts specified on transport"
24603 String expansion is not applied to this option. The argument must be a
24604 colon-separated list of host names or IP addresses, optionally also including
24605 port numbers, though the separator can be changed, as described in section
24606 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24607 item in a &%route_list%& setting for the &(manualroute)& router, as described
24608 in section &<<SECTformatonehostitem>>&.
24609
24610 Fallback hosts can also be specified on routers, which associate them with the
24611 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24612 &%fallback_hosts%& specified on the transport is used only if the address does
24613 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24614 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24615 However, &%hosts_randomize%& does apply to fallback host lists.
24616
24617 If Exim is unable to deliver to any of the hosts for a particular address, and
24618 the errors are not permanent rejections, the address is put on a separate
24619 transport queue with its host list replaced by the fallback hosts, unless the
24620 address was routed via MX records and the current host was in the original MX
24621 list. In that situation, the fallback host list is not used.
24622
24623 Once normal deliveries are complete, the fallback queue is delivered by
24624 re-running the same transports with the new host lists. If several failing
24625 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24626 copy of the message is sent.
24627
24628 The resolution of the host names on the fallback list is controlled by the
24629 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24630 both to cases when the host list comes with the address and when it is taken
24631 from &%hosts%&. This option provides a &"use a smart host only if delivery
24632 fails"& facility.
24633
24634
24635 .option final_timeout smtp time 10m
24636 This is the timeout that applies while waiting for the response to the final
24637 line containing just &"."& that terminates a message. Its value must not be
24638 zero.
24639
24640 .option gethostbyname smtp boolean false
24641 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24642 being used, names are looked up using &[gethostbyname()]&
24643 (or &[getipnodebyname()]& when available)
24644 instead of using the DNS. Of course, that function may in fact use the DNS, but
24645 it may also consult other sources of information such as &_/etc/hosts_&.
24646
24647 .option gnutls_compat_mode smtp boolean unset
24648 This option controls whether GnuTLS is used in compatibility mode in an Exim
24649 server. This reduces security slightly, but improves interworking with older
24650 implementations of TLS.
24651
24652 .option helo_data smtp string&!! "see below"
24653 .cindex "HELO" "argument, setting"
24654 .cindex "EHLO" "argument, setting"
24655 .cindex "LHLO argument setting"
24656 The value of this option is expanded after a connection to a another host has
24657 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24658 command that starts the outgoing SMTP or LMTP session. The default value of the
24659 option is:
24660 .code
24661 $primary_hostname
24662 .endd
24663 During the expansion, the variables &$host$& and &$host_address$& are set to
24664 the identity of the remote host, and the variables &$sending_ip_address$& and
24665 &$sending_port$& are set to the local IP address and port number that are being
24666 used. These variables can be used to generate different values for different
24667 servers or different local IP addresses. For example, if you want the string
24668 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24669 interface address, you could use this:
24670 .code
24671 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24672   {$primary_hostname}}
24673 .endd
24674 The use of &%helo_data%& applies both to sending messages and when doing
24675 callouts.
24676
24677 .option hosts smtp "string list&!!" unset
24678 Hosts are associated with an address by a router such as &(dnslookup)&, which
24679 finds the hosts by looking up the address domain in the DNS, or by
24680 &(manualroute)&, which has lists of hosts in its configuration. However,
24681 email addresses can be passed to the &(smtp)& transport by any router, and not
24682 all of them can provide an associated list of hosts.
24683
24684 The &%hosts%& option specifies a list of hosts to be used if the address being
24685 processed does not have any hosts associated with it. The hosts specified by
24686 &%hosts%& are also used, whether or not the address has its own hosts, if
24687 &%hosts_override%& is set.
24688
24689 The string is first expanded, before being interpreted as a colon-separated
24690 list of host names or IP addresses, possibly including port numbers. The
24691 separator may be changed to something other than colon, as described in section
24692 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24693 item in a &%route_list%& setting for the &(manualroute)& router, as described
24694 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24695 of the &(manualroute)& router is not available here.
24696
24697 If the expansion fails, delivery is deferred. Unless the failure was caused by
24698 the inability to complete a lookup, the error is logged to the panic log as
24699 well as the main log. Host names are looked up either by searching directly for
24700 address records in the DNS or by calling &[gethostbyname()]& (or
24701 &[getipnodebyname()]& when available), depending on the setting of the
24702 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24703 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24704 address are used.
24705
24706 During delivery, the hosts are tried in order, subject to their retry status,
24707 unless &%hosts_randomize%& is set.
24708
24709
24710 .option hosts_avoid_esmtp smtp "host list&!!" unset
24711 .cindex "ESMTP, avoiding use of"
24712 .cindex "HELO" "forcing use of"
24713 .cindex "EHLO" "avoiding use of"
24714 .cindex "PIPELINING" "avoiding the use of"
24715 This option is for use with broken hosts that announce ESMTP facilities (for
24716 example, PIPELINING) and then fail to implement them properly. When a host
24717 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24718 start of the SMTP session. This means that it cannot use any of the ESMTP
24719 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24720
24721
24722 .option hosts_avoid_pipelining smtp "host list&!!" unset
24723 .cindex "PIPELINING" "avoiding the use of"
24724 Exim will not use the SMTP PIPELINING extension when delivering to any host
24725 that matches this list, even if the server host advertises PIPELINING support.
24726
24727 .option hosts_pipe_connect smtp "host list&!!" unset
24728 .cindex "pipelining" "early connection"
24729 .cindex "pipelining" PIPE_CONNECT
24730 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24731 this option controls which to hosts the facility watched for
24732 and recorded, and used for subsequent connections.
24733
24734 The retry hints database is used for the record,
24735 and records are subject to the &%retry_data_expire%& option.
24736 When used, the pipelining saves on roundtrip times.
24737 It also turns SMTP into a client-first protocol
24738 so combines well with TCP Fast Open.
24739
24740 See also the &%pipelining_connect_advertise_hosts%& main option.
24741
24742 Note:
24743 When the facility is used, the transport &%helo_data%& option
24744 will be expanded before the &$sending_ip_address$& variable
24745 is filled in.
24746 A check is made for the use of that variable, without the
24747 presence of a &"def:"& test on it, but suitably complex coding
24748 can avoid the check and produce unexpected results.
24749 You have been warned.
24750
24751
24752 .option hosts_avoid_tls smtp "host list&!!" unset
24753 .cindex "TLS" "avoiding for certain hosts"
24754 Exim will not try to start a TLS session when delivering to any host that
24755 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24756
24757 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24758 .cindex "TLS" "avoiding for certain hosts"
24759 Exim will not try to start a TLS session for a verify callout,
24760 or when delivering in cutthrough mode,
24761 to any host that matches this list.
24762
24763
24764 .option hosts_max_try smtp integer 5
24765 .cindex "host" "maximum number to try"
24766 .cindex "limit" "number of hosts tried"
24767 .cindex "limit" "number of MX tried"
24768 .cindex "MX record" "maximum tried"
24769 This option limits the number of IP addresses that are tried for any one
24770 delivery in cases where there are temporary delivery errors. Section
24771 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24772
24773
24774 .option hosts_max_try_hardlimit smtp integer 50
24775 This is an additional check on the maximum number of IP addresses that Exim
24776 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24777 why it exists.
24778
24779
24780
24781 .option hosts_nopass_tls smtp "host list&!!" unset
24782 .cindex "TLS" "passing connection"
24783 .cindex "multiple SMTP deliveries"
24784 .cindex "TLS" "multiple message deliveries"
24785 For any host that matches this list, a connection on which a TLS session has
24786 been started will not be passed to a new delivery process for sending another
24787 message on the same connection. See section &<<SECTmulmessam>>& for an
24788 explanation of when this might be needed.
24789
24790 .option hosts_noproxy_tls smtp "host list&!!" unset
24791 .cindex "TLS" "passing connection"
24792 .cindex "multiple SMTP deliveries"
24793 .cindex "TLS" "multiple message deliveries"
24794 For any host that matches this list, a TLS session which has
24795 been started will not be passed to a new delivery process for sending another
24796 message on the same session.
24797
24798 The traditional implementation closes down TLS and re-starts it in the new
24799 process, on the same open TCP connection, for each successive message
24800 sent.  If permitted by this option a pipe to to the new process is set up
24801 instead, and the original process maintains the TLS connection and proxies
24802 the SMTP connection from and to the new process and any subsequents.
24803 The new process has no access to TLS information, so cannot include it in
24804 logging.
24805
24806
24807
24808 .option hosts_override smtp boolean false
24809 If this option is set and the &%hosts%& option is also set, any hosts that are
24810 attached to the address are ignored, and instead the hosts specified by the
24811 &%hosts%& option are always used. This option does not apply to
24812 &%fallback_hosts%&.
24813
24814
24815 .option hosts_randomize smtp boolean false
24816 .cindex "randomized host list"
24817 .cindex "host" "list of; randomized"
24818 .cindex "fallback" "randomized hosts"
24819 If this option is set, and either the list of hosts is taken from the
24820 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24821 were not obtained from MX records (this includes fallback hosts from the
24822 router), and were not randomized by the router, the order of trying the hosts
24823 is randomized each time the transport runs. Randomizing the order of a host
24824 list can be used to do crude load sharing.
24825
24826 When &%hosts_randomize%& is true, a host list may be split into groups whose
24827 order is separately randomized. This makes it possible to set up MX-like
24828 behaviour. The boundaries between groups are indicated by an item that is just
24829 &`+`& in the host list. For example:
24830 .code
24831 hosts = host1:host2:host3:+:host4:host5
24832 .endd
24833 The order of the first three hosts and the order of the last two hosts is
24834 randomized for each use, but the first three always end up before the last two.
24835 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24836
24837 .option hosts_require_auth smtp "host list&!!" unset
24838 .cindex "authentication" "required by client"
24839 This option provides a list of servers for which authentication must succeed
24840 before Exim will try to transfer a message. If authentication fails for
24841 servers which are not in this list, Exim tries to send unauthenticated. If
24842 authentication fails for one of these servers, delivery is deferred. This
24843 temporary error is detectable in the retry rules, so it can be turned into a
24844 hard failure if required. See also &%hosts_try_auth%&, and chapter
24845 &<<CHAPSMTPAUTH>>& for details of authentication.
24846
24847
24848 .option hosts_request_ocsp smtp "host list&!!" *
24849 .cindex "TLS" "requiring for certain servers"
24850 Exim will request a Certificate Status on a
24851 TLS session for any host that matches this list.
24852 &%tls_verify_certificates%& should also be set for the transport.
24853
24854 .option hosts_require_dane smtp "host list&!!" unset
24855 .cindex DANE "transport options"
24856 .cindex DANE "requiring for certain servers"
24857 If built with DANE support, Exim  will require that a DNSSEC-validated
24858 TLSA record is present for any host matching the list,
24859 and that a DANE-verified TLS connection is made. See
24860 the &%dnssec_request_domains%& router and transport options.
24861 There will be no fallback to in-clear communication.
24862 See section &<<SECDANE>>&.
24863
24864 .option hosts_require_ocsp smtp "host list&!!" unset
24865 .cindex "TLS" "requiring for certain servers"
24866 Exim will request, and check for a valid Certificate Status being given, on a
24867 TLS session for any host that matches this list.
24868 &%tls_verify_certificates%& should also be set for the transport.
24869
24870 .option hosts_require_tls smtp "host list&!!" unset
24871 .cindex "TLS" "requiring for certain servers"
24872 Exim will insist on using a TLS session when delivering to any host that
24873 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24874 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24875 incoming messages, use an appropriate ACL.
24876
24877 .option hosts_try_auth smtp "host list&!!" unset
24878 .cindex "authentication" "optional in client"
24879 This option provides a list of servers to which, provided they announce
24880 authentication support, Exim will attempt to authenticate as a client when it
24881 connects. If authentication fails, Exim will try to transfer the message
24882 unauthenticated. See also &%hosts_require_auth%&, and chapter
24883 &<<CHAPSMTPAUTH>>& for details of authentication.
24884
24885 .option hosts_try_chunking smtp "host list&!!" *
24886 .cindex CHUNKING "enabling, in client"
24887 .cindex BDAT "SMTP command"
24888 .cindex "RFC 3030" "CHUNKING"
24889 This option provides a list of servers to which, provided they announce
24890 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24891 .new
24892 Unless DKIM signing is being done,
24893 .wen
24894 BDAT will not be used in conjunction with a transport filter.
24895
24896 .option hosts_try_dane smtp "host list&!!" *
24897 .cindex DANE "transport options"
24898 .cindex DANE "attempting for certain servers"
24899 If built with DANE support, Exim  will require that a DNSSEC-validated
24900 TLSA record is present for any host matching the list,
24901 and that a DANE-verified TLS connection is made. See
24902 the &%dnssec_request_domains%& router and transport options.
24903 There will be no fallback to in-clear communication.
24904 See section &<<SECDANE>>&.
24905
24906 .option hosts_try_fastopen smtp "host list&!!" *
24907 .cindex "fast open, TCP" "enabling, in client"
24908 .cindex "TCP Fast Open" "enabling, in client"
24909 .cindex "RFC 7413" "TCP Fast Open"
24910 This option provides a list of servers to which, provided
24911 the facility is supported by this system, Exim will attempt to
24912 perform a TCP Fast Open.
24913 No data is sent on the SYN segment but, if the remote server also
24914 supports the facility, it can send its SMTP banner immediately after
24915 the SYN,ACK segment.  This can save up to one round-trip time.
24916
24917 The facility is only active for previously-contacted servers,
24918 as the initiator must present a cookie in the SYN segment.
24919
24920 On (at least some) current Linux distributions the facility must be enabled
24921 in the kernel by the sysadmin before the support is usable.
24922 There is no option for control of the server side; if the system supports
24923 it it is always enabled.  Note that lengthy operations in the connect ACL,
24924 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24925
24926 .option hosts_try_prdr smtp "host list&!!" *
24927 .cindex "PRDR" "enabling, optional in client"
24928 This option provides a list of servers to which, provided they announce
24929 PRDR support, Exim will attempt to negotiate PRDR
24930 for multi-recipient messages.
24931 The option can usually be left as default.
24932
24933 .option interface smtp "string list&!!" unset
24934 .cindex "bind IP address"
24935 .cindex "IP address" "binding"
24936 .vindex "&$host$&"
24937 .vindex "&$host_address$&"
24938 This option specifies which interface to bind to when making an outgoing SMTP
24939 call. The value is an IP address, not an interface name such as
24940 &`eth0`&. Do not confuse this with the interface address that was used when a
24941 message was received, which is in &$received_ip_address$&, formerly known as
24942 &$interface_address$&. The name was changed to minimize confusion with the
24943 outgoing interface address. There is no variable that contains an outgoing
24944 interface address because, unless it is set by this option, its value is
24945 unknown.
24946
24947 During the expansion of the &%interface%& option the variables &$host$& and
24948 &$host_address$& refer to the host to which a connection is about to be made
24949 during the expansion of the string. Forced expansion failure, or an empty
24950 string result causes the option to be ignored. Otherwise, after expansion, the
24951 string must be a list of IP addresses, colon-separated by default, but the
24952 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
24953 For example:
24954 .code
24955 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24956 .endd
24957 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24958 connection. If none of them are the correct type, the option is ignored. If
24959 &%interface%& is not set, or is ignored, the system's IP functions choose which
24960 interface to use if the host has more than one.
24961
24962
24963 .option keepalive smtp boolean true
24964 .cindex "keepalive" "on outgoing connection"
24965 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24966 connections. When set, it causes the kernel to probe idle connections
24967 periodically, by sending packets with &"old"& sequence numbers. The other end
24968 of the connection should send a acknowledgment if the connection is still okay
24969 or a reset if the connection has been aborted. The reason for doing this is
24970 that it has the beneficial effect of freeing up certain types of connection
24971 that can get stuck when the remote host is disconnected without tidying up the
24972 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24973 unreachable hosts.
24974
24975
24976 .option lmtp_ignore_quota smtp boolean false
24977 .cindex "LMTP" "ignoring quota errors"
24978 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24979 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24980 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24981
24982 .option max_rcpt smtp integer 100
24983 .cindex "RCPT" "maximum number of outgoing"
24984 This option limits the number of RCPT commands that are sent in a single
24985 SMTP message transaction. Each set of addresses is treated independently, and
24986 so can cause parallel connections to the same host if &%remote_max_parallel%&
24987 permits this.
24988
24989
24990 .option multi_domain smtp boolean&!! true
24991 .vindex "&$domain$&"
24992 When this option is set, the &(smtp)& transport can handle a number of
24993 addresses containing a mixture of different domains provided they all resolve
24994 to the same list of hosts. Turning the option off restricts the transport to
24995 handling only one domain at a time. This is useful if you want to use
24996 &$domain$& in an expansion for the transport, because it is set only when there
24997 is a single domain involved in a remote delivery.
24998
24999 It is expanded per-address and can depend on any of
25000 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25001 &$host$&, &$host_address$& and &$host_port$&.
25002
25003 .option port smtp string&!! "see below"
25004 .cindex "port" "sending TCP/IP"
25005 .cindex "TCP/IP" "setting outgoing port"
25006 This option specifies the TCP/IP port on the server to which Exim connects.
25007 &*Note:*& Do not confuse this with the port that was used when a message was
25008 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25009 The name was changed to minimize confusion with the outgoing port. There is no
25010 variable that contains an outgoing port.
25011
25012 If the value of this option begins with a digit it is taken as a port number;
25013 otherwise it is looked up using &[getservbyname()]&. The default value is
25014 normally &"smtp"&,
25015 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25016 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25017 If the expansion fails, or if a port number cannot be found, delivery
25018 is deferred.
25019
25020 Note that at least one Linux distribution has been seen failing
25021 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25022
25023
25024
25025 .option protocol smtp string smtp
25026 .cindex "LMTP" "over TCP/IP"
25027 .cindex "ssmtp protocol" "outbound"
25028 .cindex "TLS" "SSL-on-connect outbound"
25029 .vindex "&$port$&"
25030 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25031 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25032 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25033 deliveries into closed message stores. Exim also has support for running LMTP
25034 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25035
25036 If this option is set to &"smtps"&, the default value for the &%port%& option
25037 changes to &"smtps"&, and the transport initiates TLS immediately after
25038 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25039 The Internet standards bodies used to strongly discourage use of this mode,
25040 but as of RFC 8314 it is perferred over STARTTLS for message submission
25041 (as distinct from MTA-MTA communication).
25042
25043
25044 .option retry_include_ip_address smtp boolean&!! true
25045 Exim normally includes both the host name and the IP address in the key it
25046 constructs for indexing retry data after a temporary delivery failure. This
25047 means that when one of several IP addresses for a host is failing, it gets
25048 tried periodically (controlled by the retry rules), but use of the other IP
25049 addresses is not affected.
25050
25051 However, in some dialup environments hosts are assigned a different IP address
25052 each time they connect. In this situation the use of the IP address as part of
25053 the retry key leads to undesirable behaviour. Setting this option false causes
25054 Exim to use only the host name.
25055 Since it is expanded it can be made to depend on the host or domain.
25056
25057
25058 .option serialize_hosts smtp "host list&!!" unset
25059 .cindex "serializing connections"
25060 .cindex "host" "serializing connections"
25061 Because Exim operates in a distributed manner, if several messages for the same
25062 host arrive at around the same time, more than one simultaneous connection to
25063 the remote host can occur. This is not usually a problem except when there is a
25064 slow link between the hosts. In that situation it may be helpful to restrict
25065 Exim to one connection at a time. This can be done by setting
25066 &%serialize_hosts%& to match the relevant hosts.
25067
25068 .cindex "hints database" "serializing deliveries to a host"
25069 Exim implements serialization by means of a hints database in which a record is
25070 written whenever a process connects to one of the restricted hosts. The record
25071 is deleted when the connection is completed. Obviously there is scope for
25072 records to get left lying around if there is a system or program crash. To
25073 guard against this, Exim ignores any records that are more than six hours old.
25074
25075 If you set up this kind of serialization, you should also arrange to delete the
25076 relevant hints database whenever your system reboots. The names of the files
25077 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25078 may be one or two files, depending on the type of DBM in use. The same files
25079 are used for ETRN serialization.
25080
25081 See also the &%max_parallel%& generic transport option.
25082
25083
25084 .option size_addition smtp integer 1024
25085 .cindex "SMTP" "SIZE"
25086 .cindex "message" "size issue for transport filter"
25087 .cindex "size" "of message"
25088 .cindex "transport" "filter"
25089 .cindex "filter" "transport filter"
25090 If a remote SMTP server indicates that it supports the SIZE option of the
25091 MAIL command, Exim uses this to pass over the message size at the start of
25092 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25093 sends, to allow for headers and other text that may be added during delivery by
25094 configuration options or in a transport filter. It may be necessary to increase
25095 this if a lot of text is added to messages.
25096
25097 Alternatively, if the value of &%size_addition%& is set negative, it disables
25098 the use of the SIZE option altogether.
25099
25100
25101 .option socks_proxy smtp string&!! unset
25102 .cindex proxy SOCKS
25103 This option enables use of SOCKS proxies for connections made by the
25104 transport.  For details see section &<<SECTproxySOCKS>>&.
25105
25106
25107 .option tls_certificate smtp string&!! unset
25108 .cindex "TLS" "client certificate, location of"
25109 .cindex "certificate" "client, location of"
25110 .vindex "&$host$&"
25111 .vindex "&$host_address$&"
25112 The value of this option must be the absolute path to a file which contains the
25113 client's certificate, for possible use when sending a message over an encrypted
25114 connection. The values of &$host$& and &$host_address$& are set to the name and
25115 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25116 details of TLS.
25117
25118 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25119 certificate when sending messages as a client. The global option of the same
25120 name specifies the certificate for Exim as a server; it is not automatically
25121 assumed that the same certificate should be used when Exim is operating as a
25122 client.
25123
25124
25125 .option tls_crl smtp string&!! unset
25126 .cindex "TLS" "client certificate revocation list"
25127 .cindex "certificate" "revocation list for client"
25128 This option specifies a certificate revocation list. The expanded value must
25129 be the name of a file that contains a CRL in PEM format.
25130
25131
25132 .option tls_dh_min_bits smtp integer 1024
25133 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25134 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25135 key agreement is negotiated, the server will provide a large prime number
25136 for use.  This option establishes the minimum acceptable size of that number.
25137 If the parameter offered by the server is too small, then the TLS handshake
25138 will fail.
25139
25140 Only supported when using GnuTLS.
25141
25142
25143 .option tls_privatekey smtp string&!! unset
25144 .cindex "TLS" "client private key, location of"
25145 .vindex "&$host$&"
25146 .vindex "&$host_address$&"
25147 The value of this option must be the absolute path to a file which contains the
25148 client's private key. This is used when sending a message over an encrypted
25149 connection using a client certificate. The values of &$host$& and
25150 &$host_address$& are set to the name and address of the server during the
25151 expansion. If this option is unset, or the expansion is forced to fail, or the
25152 result is an empty string, the private key is assumed to be in the same file as
25153 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25154
25155
25156 .option tls_require_ciphers smtp string&!! unset
25157 .cindex "TLS" "requiring specific ciphers"
25158 .cindex "cipher" "requiring specific"
25159 .vindex "&$host$&"
25160 .vindex "&$host_address$&"
25161 The value of this option must be a list of permitted cipher suites, for use
25162 when setting up an outgoing encrypted connection. (There is a global option of
25163 the same name for controlling incoming connections.) The values of &$host$& and
25164 &$host_address$& are set to the name and address of the server during the
25165 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25166 is used in different ways by OpenSSL and GnuTLS (see sections
25167 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25168 ciphers is a preference order.
25169
25170
25171
25172 .option tls_sni smtp string&!! unset
25173 .cindex "TLS" "Server Name Indication"
25174 .vindex "&$tls_sni$&"
25175 If this option is set then it sets the $tls_out_sni variable and causes any
25176 TLS session to pass this value as the Server Name Indication extension to
25177 the remote side, which can be used by the remote side to select an appropriate
25178 certificate and private key for the session.
25179
25180 See &<<SECTtlssni>>& for more information.
25181
25182 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25183 TLS extensions.
25184
25185
25186
25187
25188 .option tls_tempfail_tryclear smtp boolean true
25189 .cindex "4&'xx'& responses" "to STARTTLS"
25190 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25191 setting up a TLS session, this option determines whether or not Exim should try
25192 to deliver the message unencrypted. If it is set false, delivery to the
25193 current host is deferred; if there are other hosts, they are tried. If this
25194 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25195 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25196 TLS negotiation fails, Exim closes the current connection (because it is in an
25197 unknown state), opens a new one to the same host, and then tries the delivery
25198 in clear.
25199
25200
25201 .option tls_try_verify_hosts smtp "host list&!!" *
25202 .cindex "TLS" "server certificate verification"
25203 .cindex "certificate" "verification of server"
25204 This option gives a list of hosts for which, on encrypted connections,
25205 certificate verification will be tried but need not succeed.
25206 The &%tls_verify_certificates%& option must also be set.
25207 Note that unless the host is in this list
25208 TLS connections will be denied to hosts using self-signed certificates
25209 when &%tls_verify_certificates%& is matched.
25210 The &$tls_out_certificate_verified$& variable is set when
25211 certificate verification succeeds.
25212
25213
25214 .option tls_verify_cert_hostnames smtp "host list&!!" *
25215 .cindex "TLS" "server certificate hostname verification"
25216 .cindex "certificate" "verification of server"
25217 This option give a list of hosts for which,
25218 while verifying the server certificate,
25219 checks will be included on the host name
25220 (note that this will generally be the result of a DNS MX lookup)
25221 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25222 limited to being the initial component of a 3-or-more component FQDN.
25223
25224 There is no equivalent checking on client certificates.
25225
25226
25227 .option tls_verify_certificates smtp string&!! system
25228 .cindex "TLS" "server certificate verification"
25229 .cindex "certificate" "verification of server"
25230 .vindex "&$host$&"
25231 .vindex "&$host_address$&"
25232 The value of this option must be either the
25233 word "system"
25234 or the absolute path to
25235 a file or directory containing permitted certificates for servers,
25236 for use when setting up an encrypted connection.
25237
25238 The "system" value for the option will use a location compiled into the SSL library.
25239 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25240 is taken as empty and an explicit location
25241 must be specified.
25242
25243 The use of a directory for the option value is not available for GnuTLS versions
25244 preceding 3.3.6 and a single file must be used.
25245
25246 With OpenSSL the certificates specified
25247 explicitly
25248 either by file or directory
25249 are added to those given by the system default location.
25250
25251 The values of &$host$& and
25252 &$host_address$& are set to the name and address of the server during the
25253 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25254
25255 For back-compatibility,
25256 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25257 (a single-colon empty list counts as being set)
25258 and certificate verification fails the TLS connection is closed.
25259
25260
25261 .option tls_verify_hosts smtp "host list&!!" unset
25262 .cindex "TLS" "server certificate verification"
25263 .cindex "certificate" "verification of server"
25264 This option gives a list of hosts for which, on encrypted connections,
25265 certificate verification must succeed.
25266 The &%tls_verify_certificates%& option must also be set.
25267 If both this option and &%tls_try_verify_hosts%& are unset
25268 operation is as if this option selected all hosts.
25269
25270 .option utf8_downconvert smtp integer!! unset
25271 .cindex utf8 "address downconversion"
25272 .cindex i18n "utf8 address downconversion"
25273 If built with internationalization support,
25274 this option controls conversion of UTF-8 in message addresses
25275 to a-label form.
25276 For details see section &<<SECTi18nMTA>>&.
25277
25278
25279
25280
25281 .section "How the limits for the number of hosts to try are used" &&&
25282          "SECTvalhosmax"
25283 .cindex "host" "maximum number to try"
25284 .cindex "limit" "hosts; maximum number tried"
25285 There are two options that are concerned with the number of hosts that are
25286 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25287 &%hosts_max_try_hardlimit%&.
25288
25289
25290 The &%hosts_max_try%& option limits the number of hosts that are tried
25291 for a single delivery. However, despite the term &"host"& in its name, the
25292 option actually applies to each IP address independently. In other words, a
25293 multihomed host is treated as several independent hosts, just as it is for
25294 retrying.
25295
25296 Many of the larger ISPs have multiple MX records which often point to
25297 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25298 created as a result of routing one of these domains.
25299
25300 Trying every single IP address on such a long list does not seem sensible; if
25301 several at the top of the list fail, it is reasonable to assume there is some
25302 problem that is likely to affect all of them. Roughly speaking, the value of
25303 &%hosts_max_try%& is the maximum number that are tried before deferring the
25304 delivery. However, the logic cannot be quite that simple.
25305
25306 Firstly, IP addresses that are skipped because their retry times have not
25307 arrived do not count, and in addition, addresses that are past their retry
25308 limits are also not counted, even when they are tried. This means that when
25309 some IP addresses are past their retry limits, more than the value of
25310 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25311 that all IP addresses are considered before timing out an email address (but
25312 see below for an exception).
25313
25314 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25315 list to see if there is a subsequent host with a different (higher valued) MX.
25316 If there is, that host is considered next, and the current IP address is used
25317 but not counted. This behaviour helps in the case of a domain with a retry rule
25318 that hardly ever delays any hosts, as is now explained:
25319
25320 Consider the case of a long list of hosts with one MX value, and a few with a
25321 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25322 hosts at the top of the list are tried at first. With the default retry rule,
25323 which specifies increasing retry times, the higher MX hosts are eventually
25324 tried when those at the top of the list are skipped because they have not
25325 reached their retry times.
25326
25327 However, it is common practice to put a fixed short retry time on domains for
25328 large ISPs, on the grounds that their servers are rarely down for very long.
25329 Unfortunately, these are exactly the domains that tend to resolve to long lists
25330 of hosts. The short retry time means that the lowest MX hosts are tried every
25331 time. The attempts may be in a different order because of random sorting, but
25332 without the special MX check, the higher MX hosts would never be tried until
25333 all the lower MX hosts had timed out (which might be several days), because
25334 there are always some lower MX hosts that have reached their retry times. With
25335 the special check, Exim considers at least one IP address from each MX value at
25336 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25337 reached.
25338
25339 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25340 particular, Exim normally eventually tries all the IP addresses before timing
25341 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25342 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25343 been set up with hundreds of IP addresses for some domains. It can
25344 take a very long time indeed for an address to time out in these cases.
25345
25346 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25347 Exim never tries more than this number of IP addresses; if it hits this limit
25348 and they are all timed out, the email address is bounced, even though not all
25349 possible IP addresses have been tried.
25350 .ecindex IIDsmttra1
25351 .ecindex IIDsmttra2
25352
25353
25354
25355
25356
25357 . ////////////////////////////////////////////////////////////////////////////
25358 . ////////////////////////////////////////////////////////////////////////////
25359
25360 .chapter "Address rewriting" "CHAPrewrite"
25361 .scindex IIDaddrew "rewriting" "addresses"
25362 There are some circumstances in which Exim automatically rewrites domains in
25363 addresses. The two most common are when an address is given without a domain
25364 (referred to as an &"unqualified address"&) or when an address contains an
25365 abbreviated domain that is expanded by DNS lookup.
25366
25367 Unqualified envelope addresses are accepted only for locally submitted
25368 messages, or for messages that are received from hosts matching
25369 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25370 appropriate. Unqualified addresses in header lines are qualified if they are in
25371 locally submitted messages, or messages from hosts that are permitted to send
25372 unqualified envelope addresses. Otherwise, unqualified addresses in header
25373 lines are neither qualified nor rewritten.
25374
25375 One situation in which Exim does &'not'& automatically rewrite a domain is
25376 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25377 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25378 do this. The new RFCs do not contain this suggestion.
25379
25380
25381 .section "Explicitly configured address rewriting" "SECID147"
25382 This chapter describes the rewriting rules that can be used in the
25383 main rewrite section of the configuration file, and also in the generic
25384 &%headers_rewrite%& option that can be set on any transport.
25385
25386 Some people believe that configured address rewriting is a Mortal Sin.
25387 Others believe that life is not possible without it. Exim provides the
25388 facility; you do not have to use it.
25389
25390 The main rewriting rules that appear in the &"rewrite"& section of the
25391 configuration file are applied to addresses in incoming messages, both envelope
25392 addresses and addresses in header lines. Each rule specifies the types of
25393 address to which it applies.
25394
25395 Whether or not addresses in header lines are rewritten depends on the origin of
25396 the headers and the type of rewriting. Global rewriting, that is, rewriting
25397 rules from the rewrite section of the configuration file, is applied only to
25398 those headers that were received with the message. Header lines that are added
25399 by ACLs or by a system filter or by individual routers or transports (which
25400 are specific to individual recipient addresses) are not rewritten by the global
25401 rules.
25402
25403 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25404 applies all headers except those added by routers and transports. That is, as
25405 well as the headers that were received with the message, it also applies to
25406 headers that were added by an ACL or a system filter.
25407
25408
25409 In general, rewriting addresses from your own system or domain has some
25410 legitimacy. Rewriting other addresses should be done only with great care and
25411 in special circumstances. The author of Exim believes that rewriting should be
25412 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25413 Although it can sometimes be used as a routing tool, this is very strongly
25414 discouraged.
25415
25416 There are two commonly encountered circumstances where rewriting is used, as
25417 illustrated by these examples:
25418
25419 .ilist
25420 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25421 exchange mail with each other behind a firewall, but there is only a single
25422 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25423 &'hitch.fict.example'& when sending mail off-site.
25424 .next
25425 A host rewrites the local parts of its own users so that, for example,
25426 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25427 .endlist
25428
25429
25430
25431 .section "When does rewriting happen?" "SECID148"
25432 .cindex "rewriting" "timing of"
25433 .cindex "&ACL;" "rewriting addresses in"
25434 Configured address rewriting can take place at several different stages of a
25435 message's processing.
25436
25437 .vindex "&$sender_address$&"
25438 At the start of an ACL for MAIL, the sender address may have been rewritten
25439 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25440 ordinary rewrite rules have yet been applied. If, however, the sender address
25441 is verified in the ACL, it is rewritten before verification, and remains
25442 rewritten thereafter. The subsequent value of &$sender_address$& is the
25443 rewritten address. This also applies if sender verification happens in a
25444 RCPT ACL. Otherwise, when the sender address is not verified, it is
25445 rewritten as soon as a message's header lines have been received.
25446
25447 .vindex "&$domain$&"
25448 .vindex "&$local_part$&"
25449 Similarly, at the start of an ACL for RCPT, the current recipient's address
25450 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25451 rewrite rules have yet been applied to it. However, the behaviour is different
25452 from the sender address when a recipient is verified. The address is rewritten
25453 for the verification, but the rewriting is not remembered at this stage. The
25454 value of &$local_part$& and &$domain$& after verification are always the same
25455 as they were before (that is, they contain the unrewritten &-- except for
25456 SMTP-time rewriting &-- address).
25457
25458 As soon as a message's header lines have been received, all the envelope
25459 recipient addresses are permanently rewritten, and rewriting is also applied to
25460 the addresses in the header lines (if configured). This happens before adding
25461 any header lines that were specified in MAIL or RCPT ACLs, and
25462 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25463 before the DATA ACL and &[local_scan()]& functions are run.
25464
25465 When an address is being routed, either for delivery or for verification,
25466 rewriting is applied immediately to child addresses that are generated by
25467 redirection, unless &%no_rewrite%& is set on the router.
25468
25469 .cindex "envelope from"
25470 .cindex "envelope sender" "rewriting at transport time"
25471 .cindex "rewriting" "at transport time"
25472 .cindex "header lines" "rewriting at transport time"
25473 At transport time, additional rewriting of addresses in header lines can be
25474 specified by setting the generic &%headers_rewrite%& option on a transport.
25475 This option contains rules that are identical in form to those in the rewrite
25476 section of the configuration file. They are applied to the original message
25477 header lines and any that were added by ACLs or a system filter. They are not
25478 applied to header lines that are added by routers or the transport.
25479
25480 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25481 transport option. However, it is not possible to rewrite envelope recipients at
25482 transport time.
25483
25484
25485
25486
25487 .section "Testing the rewriting rules that apply on input" "SECID149"
25488 .cindex "rewriting" "testing"
25489 .cindex "testing" "rewriting"
25490 Exim's input rewriting configuration appears in a part of the runtime
25491 configuration file headed by &"begin rewrite"&. It can be tested by the
25492 &%-brw%& command line option. This takes an address (which can be a full RFC
25493 2822 address) as its argument. The output is a list of how the address would be
25494 transformed by the rewriting rules for each of the different places it might
25495 appear in an incoming message, that is, for each different header and for the
25496 envelope sender and recipient fields. For example,
25497 .code
25498 exim -brw ph10@exim.workshop.example
25499 .endd
25500 might produce the output
25501 .code
25502 sender: Philip.Hazel@exim.workshop.example
25503 from: Philip.Hazel@exim.workshop.example
25504 to: ph10@exim.workshop.example
25505 cc: ph10@exim.workshop.example
25506 bcc: ph10@exim.workshop.example
25507 reply-to: Philip.Hazel@exim.workshop.example
25508 env-from: Philip.Hazel@exim.workshop.example
25509 env-to: ph10@exim.workshop.example
25510 .endd
25511 which shows that rewriting has been set up for that address when used in any of
25512 the source fields, but not when it appears as a recipient address. At the
25513 present time, there is no equivalent way of testing rewriting rules that are
25514 set for a particular transport.
25515
25516
25517 .section "Rewriting rules" "SECID150"
25518 .cindex "rewriting" "rules"
25519 The rewrite section of the configuration file consists of lines of rewriting
25520 rules in the form
25521 .display
25522 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25523 .endd
25524 Rewriting rules that are specified for the &%headers_rewrite%& generic
25525 transport option are given as a colon-separated list. Each item in the list
25526 takes the same form as a line in the main rewriting configuration (except that
25527 any colons must be doubled, of course).
25528
25529 The formats of source patterns and replacement strings are described below.
25530 Each is terminated by white space, unless enclosed in double quotes, in which
25531 case normal quoting conventions apply inside the quotes. The flags are single
25532 characters which may appear in any order. Spaces and tabs between them are
25533 ignored.
25534
25535 For each address that could potentially be rewritten, the rules are scanned in
25536 order, and replacements for the address from earlier rules can themselves be
25537 replaced by later rules (but see the &"q"& and &"R"& flags).
25538
25539 The order in which addresses are rewritten is undefined, may change between
25540 releases, and must not be relied on, with one exception: when a message is
25541 received, the envelope sender is always rewritten first, before any header
25542 lines are rewritten. For example, the replacement string for a rewrite of an
25543 address in &'To:'& must not assume that the message's address in &'From:'& has
25544 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25545 that the envelope sender has already been rewritten.
25546
25547 .vindex "&$domain$&"
25548 .vindex "&$local_part$&"
25549 The variables &$local_part$& and &$domain$& can be used in the replacement
25550 string to refer to the address that is being rewritten. Note that lookup-driven
25551 rewriting can be done by a rule of the form
25552 .code
25553 *@*   ${lookup ...
25554 .endd
25555 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25556 refer to the address that is being rewritten.
25557
25558
25559 .section "Rewriting patterns" "SECID151"
25560 .cindex "rewriting" "patterns"
25561 .cindex "address list" "in a rewriting pattern"
25562 The source pattern in a rewriting rule is any item which may appear in an
25563 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25564 single-item address list, which means that it is expanded before being tested
25565 against the address. As always, if you use a regular expression as a pattern,
25566 you must take care to escape dollar and backslash characters, or use the &`\N`&
25567 facility to suppress string expansion within the regular expression.
25568
25569 Domains in patterns should be given in lower case. Local parts in patterns are
25570 case-sensitive. If you want to do case-insensitive matching of local parts, you
25571 can use a regular expression that starts with &`^(?i)`&.
25572
25573 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25574 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25575 depending on the type of match which occurred. These can be used in the
25576 replacement string to insert portions of the incoming address. &$0$& always
25577 refers to the complete incoming address. When a regular expression is used, the
25578 numerical variables are set from its capturing subexpressions. For other types
25579 of pattern they are set as follows:
25580
25581 .ilist
25582 If a local part or domain starts with an asterisk, the numerical variables
25583 refer to the character strings matched by asterisks, with &$1$& associated with
25584 the first asterisk, and &$2$& with the second, if present. For example, if the
25585 pattern
25586 .code
25587 *queen@*.fict.example
25588 .endd
25589 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25590 .code
25591 $0 = hearts-queen@wonderland.fict.example
25592 $1 = hearts-
25593 $2 = wonderland
25594 .endd
25595 Note that if the local part does not start with an asterisk, but the domain
25596 does, it is &$1$& that contains the wild part of the domain.
25597
25598 .next
25599 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25600 of the domain are placed in the next available numerical variables. Suppose,
25601 for example, that the address &'foo@bar.baz.example'& is processed by a
25602 rewriting rule of the form
25603 .display
25604 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25605 .endd
25606 and the key in the file that matches the domain is &`*.baz.example`&. Then
25607 .code
25608 $1 = foo
25609 $2 = bar
25610 $3 = baz.example
25611 .endd
25612 If the address &'foo@baz.example'& is looked up, this matches the same
25613 wildcard file entry, and in this case &$2$& is set to the empty string, but
25614 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25615 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25616 whole domain. For non-partial domain lookups, no numerical variables are set.
25617 .endlist
25618
25619
25620 .section "Rewriting replacements" "SECID152"
25621 .cindex "rewriting" "replacements"
25622 If the replacement string for a rule is a single asterisk, addresses that
25623 match the pattern and the flags are &'not'& rewritten, and no subsequent
25624 rewriting rules are scanned. For example,
25625 .code
25626 hatta@lookingglass.fict.example  *  f
25627 .endd
25628 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25629 &'From:'& headers.
25630
25631 .vindex "&$domain$&"
25632 .vindex "&$local_part$&"
25633 If the replacement string is not a single asterisk, it is expanded, and must
25634 yield a fully qualified address. Within the expansion, the variables
25635 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25636 Any letters they contain retain their original case &-- they are not lower
25637 cased. The numerical variables are set up according to the type of pattern that
25638 matched the address, as described above. If the expansion is forced to fail by
25639 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25640 current rule is abandoned, but subsequent rules may take effect. Any other
25641 expansion failure causes the entire rewriting operation to be abandoned, and an
25642 entry written to the panic log.
25643
25644
25645
25646 .section "Rewriting flags" "SECID153"
25647 There are three different kinds of flag that may appear on rewriting rules:
25648
25649 .ilist
25650 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25651 c, f, h, r, s, t.
25652 .next
25653 A flag that specifies rewriting at SMTP time: S.
25654 .next
25655 Flags that control the rewriting process: Q, q, R, w.
25656 .endlist
25657
25658 For rules that are part of the &%headers_rewrite%& generic transport option,
25659 E, F, T, and S are not permitted.
25660
25661
25662
25663 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25664          "SECID154"
25665 .cindex "rewriting" "flags"
25666 If none of the following flag letters, nor the &"S"& flag (see section
25667 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25668 and to both the sender and recipient fields of the envelope, whereas a
25669 transport-time rewriting rule just applies to all headers. Otherwise, the
25670 rewriting rule is skipped unless the relevant addresses are being processed.
25671 .display
25672 &`E`&       rewrite all envelope fields
25673 &`F`&       rewrite the envelope From field
25674 &`T`&       rewrite the envelope To field
25675 &`b`&       rewrite the &'Bcc:'& header
25676 &`c`&       rewrite the &'Cc:'& header
25677 &`f`&       rewrite the &'From:'& header
25678 &`h`&       rewrite all headers
25679 &`r`&       rewrite the &'Reply-To:'& header
25680 &`s`&       rewrite the &'Sender:'& header
25681 &`t`&       rewrite the &'To:'& header
25682 .endd
25683 "All headers" means all of the headers listed above that can be selected
25684 individually, plus their &'Resent-'& versions. It does not include
25685 other headers such as &'Subject:'& etc.
25686
25687 You should be particularly careful about rewriting &'Sender:'& headers, and
25688 restrict this to special known cases in your own domains.
25689
25690
25691 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25692 .cindex "SMTP" "rewriting malformed addresses"
25693 .cindex "RCPT" "rewriting argument of"
25694 .cindex "MAIL" "rewriting argument of"
25695 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25696 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25697 before any other processing; even before syntax checking. The pattern is
25698 required to be a regular expression, and it is matched against the whole of the
25699 data for the command, including any surrounding angle brackets.
25700
25701 .vindex "&$domain$&"
25702 .vindex "&$local_part$&"
25703 This form of rewrite rule allows for the handling of addresses that are not
25704 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25705 input). Because the input is not required to be a syntactically valid address,
25706 the variables &$local_part$& and &$domain$& are not available during the
25707 expansion of the replacement string. The result of rewriting replaces the
25708 original address in the MAIL or RCPT command.
25709
25710
25711 .section "Flags controlling the rewriting process" "SECID155"
25712 There are four flags which control the way the rewriting process works. These
25713 take effect only when a rule is invoked, that is, when the address is of the
25714 correct type (matches the flags) and matches the pattern:
25715
25716 .ilist
25717 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25718 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25719 absence of &"Q"& the rewritten address must always include a domain.
25720 .next
25721 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25722 even if no rewriting actually takes place because of a &"fail"& in the
25723 expansion. The &"q"& flag is not effective if the address is of the wrong type
25724 (does not match the flags) or does not match the pattern.
25725 .next
25726 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25727 address, up to ten times. It can be combined with the &"q"& flag, to stop
25728 rewriting once it fails to match (after at least one successful rewrite).
25729 .next
25730 .cindex "rewriting" "whole addresses"
25731 When an address in a header is rewritten, the rewriting normally applies only
25732 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25733 left unchanged. For example, rewriting might change
25734 .code
25735 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25736 .endd
25737 into
25738 .code
25739 From: Ford Prefect <prefectf@hitch.fict.example>
25740 .endd
25741 .cindex "RFC 2047"
25742 Sometimes there is a need to replace the whole address item, and this can be
25743 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25744 causes an address in a header line to be rewritten, the entire address is
25745 replaced, not just the working part. The replacement must be a complete RFC
25746 2822 address, including the angle brackets if necessary. If text outside angle
25747 brackets contains a character whose value is greater than 126 or less than 32
25748 (except for tab), the text is encoded according to RFC 2047. The character set
25749 is taken from &%headers_charset%&, which gets its default at build time.
25750
25751 When the &"w"& flag is set on a rule that causes an envelope address to be
25752 rewritten, all but the working part of the replacement address is discarded.
25753 .endlist
25754
25755
25756 .section "Rewriting examples" "SECID156"
25757 Here is an example of the two common rewriting paradigms:
25758 .code
25759 *@*.hitch.fict.example  $1@hitch.fict.example
25760 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25761                      {$value}fail}@hitch.fict.example bctfrF
25762 .endd
25763 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25764 the string expansion to fail if the lookup does not succeed. In this context it
25765 has the effect of leaving the original address unchanged, but Exim goes on to
25766 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25767 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25768 explicitly, which would cause the rewritten address to be the same as before,
25769 at the cost of a small bit of processing. Not supplying either of these is an
25770 error, since the rewritten address would then contain no local part.
25771
25772 The first example above replaces the domain with a superior, more general
25773 domain. This may not be desirable for certain local parts. If the rule
25774 .code
25775 root@*.hitch.fict.example  *
25776 .endd
25777 were inserted before the first rule, rewriting would be suppressed for the
25778 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25779
25780 Rewriting can be made conditional on a number of tests, by making use of
25781 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25782 messages that originate outside the local host:
25783 .code
25784 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25785                          {$1@hitch.fict.example}fail}"
25786 .endd
25787 The replacement string is quoted in this example because it contains white
25788 space.
25789
25790 .cindex "rewriting" "bang paths"
25791 .cindex "bang paths" "rewriting"
25792 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25793 an address it treats it as an unqualified local part which it qualifies with
25794 the local qualification domain (if the source of the message is local or if the
25795 remote host is permitted to send unqualified addresses). Rewriting can
25796 sometimes be used to handle simple bang paths with a fixed number of
25797 components. For example, the rule
25798 .code
25799 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25800 .endd
25801 rewrites a two-component bang path &'host.name!user'& as the domain address
25802 &'user@host.name'&. However, there is a security implication in using this as
25803 a global rewriting rule for envelope addresses. It can provide a backdoor
25804 method for using your system as a relay, because the incoming addresses appear
25805 to be local. If the bang path addresses are received via SMTP, it is safer to
25806 use the &"S"& flag to rewrite them as they are received, so that relay checking
25807 can be done on the rewritten addresses.
25808 .ecindex IIDaddrew
25809
25810
25811
25812
25813
25814 . ////////////////////////////////////////////////////////////////////////////
25815 . ////////////////////////////////////////////////////////////////////////////
25816
25817 .chapter "Retry configuration" "CHAPretry"
25818 .scindex IIDretconf1 "retry" "configuration, description of"
25819 .scindex IIDregconf2 "configuration file" "retry section"
25820 The &"retry"& section of the runtime configuration file contains a list of
25821 retry rules that control how often Exim tries to deliver messages that cannot
25822 be delivered at the first attempt. If there are no retry rules (the section is
25823 empty or not present), there are no retries. In this situation, temporary
25824 errors are treated as permanent. The default configuration contains a single,
25825 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25826 line option can be used to test which retry rule will be used for a given
25827 address, domain and error.
25828
25829 The most common cause of retries is temporary failure to deliver to a remote
25830 host because the host is down, or inaccessible because of a network problem.
25831 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25832 address) basis, not on a per-message basis. Thus, if one message has recently
25833 been delayed, delivery of a new message to the same host is not immediately
25834 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25835 log selector is set, the message
25836 .cindex "retry" "time not reached"
25837 &"retry time not reached"& is written to the main log whenever a delivery is
25838 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25839 the handling of errors during remote deliveries.
25840
25841 Retry processing applies to routing as well as to delivering, except as covered
25842 in the next paragraph. The retry rules do not distinguish between these
25843 actions. It is not possible, for example, to specify different behaviour for
25844 failures to route the domain &'snark.fict.example'& and failures to deliver to
25845 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25846 added complication, so did not implement it. However, although they share the
25847 same retry rule, the actual retry times for routing and transporting a given
25848 domain are maintained independently.
25849
25850 When a delivery is not part of a queue run (typically an immediate delivery on
25851 receipt of a message), the routers are always run, and local deliveries are
25852 always attempted, even if retry times are set for them. This makes for better
25853 behaviour if one particular message is causing problems (for example, causing
25854 quota overflow, or provoking an error in a filter file). If such a delivery
25855 suffers a temporary failure, the retry data is updated as normal, and
25856 subsequent delivery attempts from queue runs occur only when the retry time for
25857 the local address is reached.
25858
25859 .section "Changing retry rules" "SECID157"
25860 If you change the retry rules in your configuration, you should consider
25861 whether or not to delete the retry data that is stored in Exim's spool area in
25862 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25863 always safe; that is why they are called &"hints"&.
25864
25865 The hints retry data contains suggested retry times based on the previous
25866 rules. In the case of a long-running problem with a remote host, it might
25867 record the fact that the host has timed out. If your new rules increase the
25868 timeout time for such a host, you should definitely remove the old retry data
25869 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25870 messages that it should now be retaining.
25871
25872
25873
25874 .section "Format of retry rules" "SECID158"
25875 .cindex "retry" "rules"
25876 Each retry rule occupies one line and consists of three or four parts,
25877 separated by white space: a pattern, an error name, an optional list of sender
25878 addresses, and a list of retry parameters. The pattern and sender lists must be
25879 enclosed in double quotes if they contain white space. The rules are searched
25880 in order until one is found where the pattern, error name, and sender list (if
25881 present) match the failing host or address, the error that occurred, and the
25882 message's sender, respectively.
25883
25884
25885 The pattern is any single item that may appear in an address list (see section
25886 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25887 which means that it is expanded before being tested against the address that
25888 has been delayed. A negated address list item is permitted. Address
25889 list processing treats a plain domain name as if it were preceded by &"*@"&,
25890 which makes it possible for many retry rules to start with just a domain. For
25891 example,
25892 .code
25893 lookingglass.fict.example        *  F,24h,30m;
25894 .endd
25895 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25896 whereas
25897 .code
25898 alice@lookingglass.fict.example  *  F,24h,30m;
25899 .endd
25900 applies only to temporary failures involving the local part &%alice%&.
25901 In practice, almost all rules start with a domain name pattern without a local
25902 part.
25903
25904 .cindex "regular expressions" "in retry rules"
25905 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25906 must match a complete address, not just a domain, because that is how regular
25907 expressions work in address lists.
25908 .display
25909 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25910 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25911 .endd
25912
25913
25914 .section "Choosing which retry rule to use for address errors" "SECID159"
25915 When Exim is looking for a retry rule after a routing attempt has failed (for
25916 example, after a DNS timeout), each line in the retry configuration is tested
25917 against the complete address only if &%retry_use_local_part%& is set for the
25918 router. Otherwise, only the domain is used, except when matching against a
25919 regular expression, when the local part of the address is replaced with &"*"&.
25920 A domain on its own can match a domain pattern, or a pattern that starts with
25921 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25922 &%check_local_user%& is true, and false for other routers.
25923
25924 Similarly, when Exim is looking for a retry rule after a local delivery has
25925 failed (for example, after a mailbox full error), each line in the retry
25926 configuration is tested against the complete address only if
25927 &%retry_use_local_part%& is set for the transport (it defaults true for all
25928 local transports).
25929
25930 .cindex "4&'xx'& responses" "retry rules for"
25931 However, when Exim is looking for a retry rule after a remote delivery attempt
25932 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25933 whole address is always used as the key when searching the retry rules. The
25934 rule that is found is used to create a retry time for the combination of the
25935 failing address and the message's sender. It is the combination of sender and
25936 recipient that is delayed in subsequent queue runs until its retry time is
25937 reached. You can delay the recipient without regard to the sender by setting
25938 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25939 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25940 commands.
25941
25942
25943
25944 .section "Choosing which retry rule to use for host and message errors" &&&
25945          "SECID160"
25946 For a temporary error that is not related to an individual address (for
25947 example, a connection timeout), each line in the retry configuration is checked
25948 twice. First, the name of the remote host is used as a domain name (preceded by
25949 &"*@"& when matching a regular expression). If this does not match the line,
25950 the domain from the email address is tried in a similar fashion. For example,
25951 suppose the MX records for &'a.b.c.example'& are
25952 .code
25953 a.b.c.example  MX  5  x.y.z.example
25954                MX  6  p.q.r.example
25955                MX  7  m.n.o.example
25956 .endd
25957 and the retry rules are
25958 .code
25959 p.q.r.example    *      F,24h,30m;
25960 a.b.c.example    *      F,4d,45m;
25961 .endd
25962 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25963 first rule matches neither the host nor the domain, so Exim looks at the second
25964 rule. This does not match the host, but it does match the domain, so it is used
25965 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25966 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25967 first retry rule is used, because it matches the host.
25968
25969 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25970 first rule to determine retry times, but for all the other hosts for the domain
25971 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25972 routing to &'a.b.c.example'& suffers a temporary failure.
25973
25974 &*Note*&: The host name is used when matching the patterns, not its IP address.
25975 However, if a message is routed directly to an IP address without the use of a
25976 host name, for example, if a &(manualroute)& router contains a setting such as:
25977 .code
25978 route_list = *.a.example  192.168.34.23
25979 .endd
25980 then the &"host name"& that is used when searching for a retry rule is the
25981 textual form of the IP address.
25982
25983 .section "Retry rules for specific errors" "SECID161"
25984 .cindex "retry" "specific errors; specifying"
25985 The second field in a retry rule is the name of a particular error, or an
25986 asterisk, which matches any error. The errors that can be tested for are:
25987
25988 .vlist
25989 .vitem &%auth_failed%&
25990 Authentication failed when trying to send to a host in the
25991 &%hosts_require_auth%& list in an &(smtp)& transport.
25992
25993 .vitem &%data_4xx%&
25994 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25995 after the command, or after sending the message's data.
25996
25997 .vitem &%mail_4xx%&
25998 A 4&'xx'& error was received for an outgoing MAIL command.
25999
26000 .vitem &%rcpt_4xx%&
26001 A 4&'xx'& error was received for an outgoing RCPT command.
26002 .endlist
26003
26004 For the three 4&'xx'& errors, either the first or both of the x's can be given
26005 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26006 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26007 and have retries every ten minutes with a one-hour timeout, you could set up a
26008 retry rule of this form:
26009 .code
26010 the.domain.name  rcpt_452   F,1h,10m
26011 .endd
26012 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26013 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26014
26015 .vlist
26016 .vitem &%lost_connection%&
26017 A server unexpectedly closed the SMTP connection. There may, of course,
26018 legitimate reasons for this (host died, network died), but if it repeats a lot
26019 for the same host, it indicates something odd.
26020
26021 .vitem &%lookup%&
26022 A DNS lookup for a host failed.
26023 Note that a &%dnslookup%& router will need to have matched
26024 its &%fail_defer_domains%& option for this retry type to be usable.
26025 Also note that a &%manualroute%& router will probably need
26026 its &%host_find_failed%& option set to &%defer%&.
26027
26028 .vitem &%refused_MX%&
26029 A connection to a host obtained from an MX record was refused.
26030
26031 .vitem &%refused_A%&
26032 A connection to a host not obtained from an MX record was refused.
26033
26034 .vitem &%refused%&
26035 A connection was refused.
26036
26037 .vitem &%timeout_connect_MX%&
26038 A connection attempt to a host obtained from an MX record timed out.
26039
26040 .vitem &%timeout_connect_A%&
26041 A connection attempt to a host not obtained from an MX record timed out.
26042
26043 .vitem &%timeout_connect%&
26044 A connection attempt timed out.
26045
26046 .vitem &%timeout_MX%&
26047 There was a timeout while connecting or during an SMTP session with a host
26048 obtained from an MX record.
26049
26050 .vitem &%timeout_A%&
26051 There was a timeout while connecting or during an SMTP session with a host not
26052 obtained from an MX record.
26053
26054 .vitem &%timeout%&
26055 There was a timeout while connecting or during an SMTP session.
26056
26057 .vitem &%tls_required%&
26058 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26059 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26060 to STARTTLS, or there was a problem setting up the TLS connection.
26061
26062 .vitem &%quota%&
26063 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26064 transport.
26065
26066 .vitem &%quota_%&<&'time'&>
26067 .cindex "quota" "error testing in retry rule"
26068 .cindex "retry" "quota error testing"
26069 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26070 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26071 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26072 for four days.
26073 .endlist
26074
26075 .cindex "mailbox" "time of last read"
26076 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26077 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26078 it should be based on the last time that the user accessed the mailbox.
26079 However, it is not always possible to determine this. Exim uses the following
26080 heuristic rules:
26081
26082 .ilist
26083 If the mailbox is a single file, the time of last access (the &"atime"&) is
26084 used. As no new messages are being delivered (because the mailbox is over
26085 quota), Exim does not access the file, so this is the time of last user access.
26086 .next
26087 .cindex "maildir format" "time of last read"
26088 For a maildir delivery, the time of last modification of the &_new_&
26089 subdirectory is used. As the mailbox is over quota, no new files are created in
26090 the &_new_& subdirectory, because no new messages are being delivered. Any
26091 change to the &_new_& subdirectory is therefore assumed to be the result of an
26092 MUA moving a new message to the &_cur_& directory when it is first read. The
26093 time that is used is therefore the last time that the user read a new message.
26094 .next
26095 For other kinds of multi-file mailbox, the time of last access cannot be
26096 obtained, so a retry rule that uses this type of error field is never matched.
26097 .endlist
26098
26099 The quota errors apply both to system-enforced quotas and to Exim's own quota
26100 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26101 when a local delivery is deferred because a partition is full (the ENOSPC
26102 error).
26103
26104
26105
26106 .section "Retry rules for specified senders" "SECID162"
26107 .cindex "retry" "rules; sender-specific"
26108 You can specify retry rules that apply only when the failing message has a
26109 specific sender. In particular, this can be used to define retry rules that
26110 apply only to bounce messages. The third item in a retry rule can be of this
26111 form:
26112 .display
26113 &`senders=`&<&'address list'&>
26114 .endd
26115 The retry timings themselves are then the fourth item. For example:
26116 .code
26117 *   rcpt_4xx   senders=:   F,1h,30m
26118 .endd
26119 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26120 host. If the address list contains white space, it must be enclosed in quotes.
26121 For example:
26122 .code
26123 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26124 .endd
26125 &*Warning*&: This facility can be unhelpful if it is used for host errors
26126 (which do not depend on the recipient). The reason is that the sender is used
26127 only to match the retry rule. Once the rule has been found for a host error,
26128 its contents are used to set a retry time for the host, and this will apply to
26129 all messages, not just those with specific senders.
26130
26131 When testing retry rules using &%-brt%&, you can supply a sender using the
26132 &%-f%& command line option, like this:
26133 .code
26134 exim -f "" -brt user@dom.ain
26135 .endd
26136 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26137 list is never matched.
26138
26139
26140
26141
26142
26143 .section "Retry parameters" "SECID163"
26144 .cindex "retry" "parameters in rules"
26145 The third (or fourth, if a senders list is present) field in a retry rule is a
26146 sequence of retry parameter sets, separated by semicolons. Each set consists of
26147 .display
26148 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26149 .endd
26150 The letter identifies the algorithm for computing a new retry time; the cutoff
26151 time is the time beyond which this algorithm no longer applies, and the
26152 arguments vary the algorithm's action. The cutoff time is measured from the
26153 time that the first failure for the domain (combined with the local part if
26154 relevant) was detected, not from the time the message was received.
26155
26156 .cindex "retry" "algorithms"
26157 .cindex "retry" "fixed intervals"
26158 .cindex "retry" "increasing intervals"
26159 .cindex "retry" "random intervals"
26160 The available algorithms are:
26161
26162 .ilist
26163 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26164 the interval.
26165 .next
26166 &'G'&: retry at geometrically increasing intervals. The first argument
26167 specifies a starting value for the interval, and the second a multiplier, which
26168 is used to increase the size of the interval at each retry.
26169 .next
26170 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26171 retry, the previous interval is multiplied by the factor in order to get a
26172 maximum for the next interval. The minimum interval is the first argument of
26173 the parameter, and an actual interval is chosen randomly between them. Such a
26174 rule has been found to be helpful in cluster configurations when all the
26175 members of the cluster restart at once, and may therefore synchronize their
26176 queue processing times.
26177 .endlist
26178
26179 When computing the next retry time, the algorithm definitions are scanned in
26180 order until one whose cutoff time has not yet passed is reached. This is then
26181 used to compute a new retry time that is later than the current time. In the
26182 case of fixed interval retries, this simply means adding the interval to the
26183 current time. For geometrically increasing intervals, retry intervals are
26184 computed from the rule's parameters until one that is greater than the previous
26185 interval is found. The main configuration variable
26186 .cindex "limit" "retry interval"
26187 .cindex "retry" "interval, maximum"
26188 .oindex "&%retry_interval_max%&"
26189 &%retry_interval_max%& limits the maximum interval between retries. It
26190 cannot be set greater than &`24h`&, which is its default value.
26191
26192 A single remote domain may have a number of hosts associated with it, and each
26193 host may have more than one IP address. Retry algorithms are selected on the
26194 basis of the domain name, but are applied to each IP address independently. If,
26195 for example, a host has two IP addresses and one is unusable, Exim will
26196 generate retry times for it and will not try to use it until its next retry
26197 time comes. Thus the good IP address is likely to be tried first most of the
26198 time.
26199
26200 .cindex "hints database" "use for retrying"
26201 Retry times are hints rather than promises. Exim does not make any attempt to
26202 run deliveries exactly at the computed times. Instead, a queue runner process
26203 starts delivery processes for delayed messages periodically, and these attempt
26204 new deliveries only for those addresses that have passed their next retry time.
26205 If a new message arrives for a deferred address, an immediate delivery attempt
26206 occurs only if the address has passed its retry time. In the absence of new
26207 messages, the minimum time between retries is the interval between queue runner
26208 processes. There is not much point in setting retry times of five minutes if
26209 your queue runners happen only once an hour, unless there are a significant
26210 number of incoming messages (which might be the case on a system that is
26211 sending everything to a smart host, for example).
26212
26213 The data in the retry hints database can be inspected by using the
26214 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26215 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26216 &'exinext'& utility script can be used to find out what the next retry times
26217 are for the hosts associated with a particular mail domain, and also for local
26218 deliveries that have been deferred.
26219
26220
26221 .section "Retry rule examples" "SECID164"
26222 Here are some example retry rules:
26223 .code
26224 alice@wonderland.fict.example quota_5d  F,7d,3h
26225 wonderland.fict.example       quota_5d
26226 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26227 lookingglass.fict.example     *         F,24h,30m;
26228 *                 refused_A   F,2h,20m;
26229 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26230 .endd
26231 The first rule sets up special handling for mail to
26232 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26233 mailbox has not been read for at least 5 days. Retries continue every three
26234 hours for 7 days. The second rule handles over-quota errors for all other local
26235 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26236 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26237 fail are bounced immediately if the mailbox has not been read for at least 5
26238 days.
26239
26240 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26241 happen every 15 minutes for an hour, then with geometrically increasing
26242 intervals until two days have passed since a delivery first failed. After the
26243 first hour there is a delay of one hour, then two hours, then four hours, and
26244 so on (this is a rather extreme example).
26245
26246 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26247 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26248 all other domains, with special action for connection refusal from hosts that
26249 were not obtained from an MX record.
26250
26251 The final rule in a retry configuration should always have asterisks in the
26252 first two fields so as to provide a general catch-all for any addresses that do
26253 not have their own special handling. This example tries every 15 minutes for 2
26254 hours, then with intervals starting at one hour and increasing by a factor of
26255 1.5 up to 16 hours, then every 8 hours up to 5 days.
26256
26257
26258
26259 .section "Timeout of retry data" "SECID165"
26260 .cindex "timeout" "of retry data"
26261 .oindex "&%retry_data_expire%&"
26262 .cindex "hints database" "data expiry"
26263 .cindex "retry" "timeout of data"
26264 Exim timestamps the data that it writes to its retry hints database. When it
26265 consults the data during a delivery it ignores any that is older than the value
26266 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26267 been tried for 7 days, Exim will try to deliver to it immediately a message
26268 arrives, and if that fails, it will calculate a retry time as if it were
26269 failing for the first time.
26270
26271 This improves the behaviour for messages routed to rarely-used hosts such as MX
26272 backups. If such a host was down at one time, and happens to be down again when
26273 Exim tries a month later, using the old retry data would imply that it had been
26274 down all the time, which is not a justified assumption.
26275
26276 If a host really is permanently dead, this behaviour causes a burst of retries
26277 every now and again, but only if messages routed to it are rare. If there is a
26278 message at least once every 7 days the retry data never expires.
26279
26280
26281
26282
26283 .section "Long-term failures" "SECID166"
26284 .cindex "delivery failure, long-term"
26285 .cindex "retry" "after long-term failure"
26286 Special processing happens when an email address has been failing for so long
26287 that the cutoff time for the last algorithm is reached. For example, using the
26288 default retry rule:
26289 .code
26290 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26291 .endd
26292 the cutoff time is four days. Reaching the retry cutoff is independent of how
26293 long any specific message has been failing; it is the length of continuous
26294 failure for the recipient address that counts.
26295
26296 When the cutoff time is reached for a local delivery, or for all the IP
26297 addresses associated with a remote delivery, a subsequent delivery failure
26298 causes Exim to give up on the address, and a bounce message is generated.
26299 In order to cater for new messages that use the failing address, a next retry
26300 time is still computed from the final algorithm, and is used as follows:
26301
26302 For local deliveries, one delivery attempt is always made for any subsequent
26303 messages. If this delivery fails, the address fails immediately. The
26304 post-cutoff retry time is not used.
26305
26306 .cindex "final cutoff" "retries, controlling"
26307 .cindex retry "final cutoff"
26308 If the delivery is remote, there are two possibilities, controlled by the
26309 .oindex "&%delay_after_cutoff%&"
26310 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26311 default. Until the post-cutoff retry time for one of the IP addresses,
26312 as set by the &%retry_data_expire%& option, is
26313 reached, the failing email address is bounced immediately, without a delivery
26314 attempt taking place. After that time, one new delivery attempt is made to
26315 those IP addresses that are past their retry times, and if that still fails,
26316 the address is bounced and new retry times are computed.
26317
26318 In other words, when all the hosts for a given email address have been failing
26319 for a long time, Exim bounces rather then defers until one of the hosts' retry
26320 times is reached. Then it tries once, and bounces if that attempt fails. This
26321 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26322 to a broken destination, but if the host does recover, Exim will eventually
26323 notice.
26324
26325 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26326 addresses are past their final cutoff time, Exim tries to deliver to those IP
26327 addresses that have not been tried since the message arrived. If there are
26328 no suitable IP addresses, or if they all fail, the address is bounced. In other
26329 words, it does not delay when a new message arrives, but tries the expired
26330 addresses immediately, unless they have been tried since the message arrived.
26331 If there is a continuous stream of messages for the failing domains, setting
26332 &%delay_after_cutoff%& false means that there will be many more attempts to
26333 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26334 true.
26335
26336 .section "Deliveries that work intermittently" "SECID167"
26337 .cindex "retry" "intermittently working deliveries"
26338 Some additional logic is needed to cope with cases where a host is
26339 intermittently available, or when a message has some attribute that prevents
26340 its delivery when others to the same address get through. In this situation,
26341 because some messages are successfully delivered, the &"retry clock"& for the
26342 host or address keeps getting reset by the successful deliveries, and so
26343 failing messages remain in the queue for ever because the cutoff time is never
26344 reached.
26345
26346 Two exceptional actions are applied to prevent this happening. The first
26347 applies to errors that are related to a message rather than a remote host.
26348 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26349 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26350 commands, and quota failures. For this type of error, if a message's arrival
26351 time is earlier than the &"first failed"& time for the error, the earlier time
26352 is used when scanning the retry rules to decide when to try next and when to
26353 time out the address.
26354
26355 The exceptional second action applies in all cases. If a message has been on
26356 the queue for longer than the cutoff time of any applicable retry rule for a
26357 given address, a delivery is attempted for that address, even if it is not yet
26358 time, and if this delivery fails, the address is timed out. A new retry time is
26359 not computed in this case, so that other messages for the same address are
26360 considered immediately.
26361 .ecindex IIDretconf1
26362 .ecindex IIDregconf2
26363
26364
26365
26366
26367
26368
26369 . ////////////////////////////////////////////////////////////////////////////
26370 . ////////////////////////////////////////////////////////////////////////////
26371
26372 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26373 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26374 .scindex IIDauthconf2 "authentication"
26375 The &"authenticators"& section of Exim's runtime configuration is concerned
26376 with SMTP authentication. This facility is an extension to the SMTP protocol,
26377 described in RFC 2554, which allows a client SMTP host to authenticate itself
26378 to a server. This is a common way for a server to recognize clients that are
26379 permitted to use it as a relay. SMTP authentication is not of relevance to the
26380 transfer of mail between servers that have no managerial connection with each
26381 other.
26382
26383 .cindex "AUTH" "description of"
26384 Very briefly, the way SMTP authentication works is as follows:
26385
26386 .ilist
26387 The server advertises a number of authentication &'mechanisms'& in response to
26388 the client's EHLO command.
26389 .next
26390 The client issues an AUTH command, naming a specific mechanism. The command
26391 may, optionally, contain some authentication data.
26392 .next
26393 The server may issue one or more &'challenges'&, to which the client must send
26394 appropriate responses. In simple authentication mechanisms, the challenges are
26395 just prompts for user names and passwords. The server does not have to issue
26396 any challenges &-- in some mechanisms the relevant data may all be transmitted
26397 with the AUTH command.
26398 .next
26399 The server either accepts or denies authentication.
26400 .next
26401 If authentication succeeds, the client may optionally make use of the AUTH
26402 option on the MAIL command to pass an authenticated sender in subsequent
26403 mail transactions. Authentication lasts for the remainder of the SMTP
26404 connection.
26405 .next
26406 If authentication fails, the client may give up, or it may try a different
26407 authentication mechanism, or it may try transferring mail over the
26408 unauthenticated connection.
26409 .endlist
26410
26411 If you are setting up a client, and want to know which authentication
26412 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26413 SMTP port) on the server, and issue an EHLO command. The response to this
26414 includes the list of supported mechanisms. For example:
26415 .display
26416 &`$ `&&*&`telnet server.example 25`&*&
26417 &`Trying 192.168.34.25...`&
26418 &`Connected to server.example.`&
26419 &`Escape character is &#x0027;^]&#x0027;.`&
26420 &`220 server.example ESMTP Exim 4.20 ...`&
26421 &*&`ehlo client.example`&*&
26422 &`250-server.example Hello client.example [10.8.4.5]`&
26423 &`250-SIZE 52428800`&
26424 &`250-PIPELINING`&
26425 &`250-AUTH PLAIN`&
26426 &`250 HELP`&
26427 .endd
26428 The second-last line of this example output shows that the server supports
26429 authentication using the PLAIN mechanism. In Exim, the different authentication
26430 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26431 routers and transports, which authenticators are included in the binary is
26432 controlled by build-time definitions. The following are currently available,
26433 included by setting
26434 .code
26435 AUTH_CRAM_MD5=yes
26436 AUTH_CYRUS_SASL=yes
26437 AUTH_DOVECOT=yes
26438 AUTH_EXTERNAL=yes
26439 AUTH_GSASL=yes
26440 AUTH_HEIMDAL_GSSAPI=yes
26441 AUTH_PLAINTEXT=yes
26442 AUTH_SPA=yes
26443 AUTH_TLS=yes
26444 .endd
26445 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26446 authentication mechanism (RFC 2195), and the second provides an interface to
26447 the Cyrus SASL authentication library.
26448 The third is an interface to Dovecot's authentication system, delegating the
26449 work via a socket interface.
26450 The fourth provides for negotiation of authentication done via non-SMTP means,
26451 as defined by RFC 4422 Appendix A.
26452 The fifth provides an interface to the GNU SASL authentication library, which
26453 provides mechanisms but typically not data sources.
26454 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26455 supporting setting a server keytab.
26456 The seventh can be configured to support
26457 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26458 not formally documented, but used by several MUAs.
26459 The eighth authenticator
26460 supports Microsoft's &'Secure Password Authentication'& mechanism.
26461 The last is an Exim authenticator but not an SMTP one;
26462 instead it can use information from a TLS negotiation.
26463
26464 The authenticators are configured using the same syntax as other drivers (see
26465 section &<<SECTfordricon>>&). If no authenticators are required, no
26466 authentication section need be present in the configuration file. Each
26467 authenticator can in principle have both server and client functions. When Exim
26468 is receiving SMTP mail, it is acting as a server; when it is sending out
26469 messages over SMTP, it is acting as a client. Authenticator configuration
26470 options are provided for use in both these circumstances.
26471
26472 To make it clear which options apply to which situation, the prefixes
26473 &%server_%& and &%client_%& are used on option names that are specific to
26474 either the server or the client function, respectively. Server and client
26475 functions are disabled if none of their options are set. If an authenticator is
26476 to be used for both server and client functions, a single definition, using
26477 both sets of options, is required. For example:
26478 .code
26479 cram:
26480   driver = cram_md5
26481   public_name = CRAM-MD5
26482   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26483   client_name = ph10
26484   client_secret = secret2
26485 .endd
26486 The &%server_%& option is used when Exim is acting as a server, and the
26487 &%client_%& options when it is acting as a client.
26488
26489 Descriptions of the individual authenticators are given in subsequent chapters.
26490 The remainder of this chapter covers the generic options for the
26491 authenticators, followed by general discussion of the way authentication works
26492 in Exim.
26493
26494 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26495 per-mechanism basis.  Please read carefully to determine which variables hold
26496 account labels such as usercodes and which hold passwords or other
26497 authenticating data.
26498
26499 Note that some mechanisms support two different identifiers for accounts: the
26500 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26501 and &'authz'& are commonly encountered.  The American spelling is standard here.
26502 Conceptually, authentication data such as passwords are tied to the identifier
26503 used to authenticate; servers may have rules to permit one user to act as a
26504 second user, so that after login the session is treated as though that second
26505 user had logged in.  That second user is the &'authorization id'&.  A robust
26506 configuration might confirm that the &'authz'& field is empty or matches the
26507 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26508 as verified data, the &'authz'& as an unverified request which the server might
26509 choose to honour.
26510
26511 A &'realm'& is a text string, typically a domain name, presented by a server
26512 to a client to help it select an account and credentials to use.  In some
26513 mechanisms, the client and server provably agree on the realm, but clients
26514 typically can not treat the realm as secure data to be blindly trusted.
26515
26516
26517
26518 .section "Generic options for authenticators" "SECID168"
26519 .cindex "authentication" "generic options"
26520 .cindex "options" "generic; for authenticators"
26521
26522 .option client_condition authenticators string&!! unset
26523 When Exim is authenticating as a client, it skips any authenticator whose
26524 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26525 used, for example, to skip plain text authenticators when the connection is not
26526 encrypted by a setting such as:
26527 .code
26528 client_condition = ${if !eq{$tls_out_cipher}{}}
26529 .endd
26530
26531
26532 .option client_set_id authenticators string&!! unset
26533 When client authentication succeeds, this condition is expanded; the
26534 result is used in the log lines for outbound messages.
26535 Typically it will be the user name used for authentication.
26536
26537
26538 .option driver authenticators string unset
26539 This option must always be set. It specifies which of the available
26540 authenticators is to be used.
26541
26542
26543 .option public_name authenticators string unset
26544 This option specifies the name of the authentication mechanism that the driver
26545 implements, and by which it is known to the outside world. These names should
26546 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26547 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26548 defaults to the driver's instance name.
26549
26550
26551 .option server_advertise_condition authenticators string&!! unset
26552 When a server is about to advertise an authentication mechanism, the condition
26553 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26554 mechanism is not advertised.
26555 If the expansion fails, the mechanism is not advertised. If the failure was not
26556 forced, and was not caused by a lookup defer, the incident is logged.
26557 See section &<<SECTauthexiser>>& below for further discussion.
26558
26559
26560 .option server_condition authenticators string&!! unset
26561 This option must be set for a &%plaintext%& server authenticator, where it
26562 is used directly to control authentication. See section &<<SECTplainserver>>&
26563 for details.
26564
26565 For the &(gsasl)& authenticator, this option is required for various
26566 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26567
26568 For the other authenticators, &%server_condition%& can be used as an additional
26569 authentication or authorization mechanism that is applied after the other
26570 authenticator conditions succeed. If it is set, it is expanded when the
26571 authenticator would otherwise return a success code. If the expansion is forced
26572 to fail, authentication fails. Any other expansion failure causes a temporary
26573 error code to be returned. If the result of a successful expansion is an empty
26574 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26575 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26576 other result, a temporary error code is returned, with the expanded string as
26577 the error text.
26578
26579
26580 .option server_debug_print authenticators string&!! unset
26581 If this option is set and authentication debugging is enabled (see the &%-d%&
26582 command line option), the string is expanded and included in the debugging
26583 output when the authenticator is run as a server. This can help with checking
26584 out the values of variables.
26585 If expansion of the string fails, the error message is written to the debugging
26586 output, and Exim carries on processing.
26587
26588
26589 .option server_set_id authenticators string&!! unset
26590 .vindex "&$authenticated_id$&"
26591 .vindex "&$authenticated_fail_id$&"
26592 When an Exim server successfully authenticates a client, this string is
26593 expanded using data from the authentication, and preserved for any incoming
26594 messages in the variable &$authenticated_id$&. It is also included in the log
26595 lines for incoming messages. For example, a user/password authenticator
26596 configuration might preserve the user name that was used to authenticate, and
26597 refer to it subsequently during delivery of the message.
26598 On a failing authentication the expansion result is instead saved in
26599 the &$authenticated_fail_id$& variable.
26600 If expansion fails, the option is ignored.
26601
26602
26603 .option server_mail_auth_condition authenticators string&!! unset
26604 This option allows a server to discard authenticated sender addresses supplied
26605 as part of MAIL commands in SMTP connections that are authenticated by the
26606 driver on which &%server_mail_auth_condition%& is set. The option is not used
26607 as part of the authentication process; instead its (unexpanded) value is
26608 remembered for later use.
26609 How it is used is described in the following section.
26610
26611
26612
26613
26614
26615 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26616 .cindex "authentication" "sender; authenticated"
26617 .cindex "AUTH" "on MAIL command"
26618 When a client supplied an AUTH= item on a MAIL command, Exim applies
26619 the following checks before accepting it as the authenticated sender of the
26620 message:
26621
26622 .ilist
26623 If the connection is not using extended SMTP (that is, HELO was used rather
26624 than EHLO), the use of AUTH= is a syntax error.
26625 .next
26626 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26627 .next
26628 .vindex "&$authenticated_sender$&"
26629 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26630 running, the value of &$authenticated_sender$& is set to the value obtained
26631 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26632 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26633 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26634 given for the MAIL command.
26635 .next
26636 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26637 is accepted and placed in &$authenticated_sender$& only if the client has
26638 authenticated.
26639 .next
26640 If the AUTH= value was accepted by either of the two previous rules, and
26641 the client has authenticated, and the authenticator has a setting for the
26642 &%server_mail_auth_condition%&, the condition is checked at this point. The
26643 valued that was saved from the authenticator is expanded. If the expansion
26644 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26645 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26646 the value of &$authenticated_sender$& is retained and passed on with the
26647 message.
26648 .endlist
26649
26650
26651 When &$authenticated_sender$& is set for a message, it is passed on to other
26652 hosts to which Exim authenticates as a client. Do not confuse this value with
26653 &$authenticated_id$&, which is a string obtained from the authentication
26654 process, and which is not usually a complete email address.
26655
26656 .vindex "&$sender_address$&"
26657 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26658 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26659 therefore make use of &$authenticated_sender$&. The converse is not true: the
26660 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26661 ACL is run.
26662
26663
26664
26665 .section "Authentication on an Exim server" "SECTauthexiser"
26666 .cindex "authentication" "on an Exim server"
26667 When Exim receives an EHLO command, it advertises the public names of those
26668 authenticators that are configured as servers, subject to the following
26669 conditions:
26670
26671 .ilist
26672 The client host must match &%auth_advertise_hosts%& (default *).
26673 .next
26674 It the &%server_advertise_condition%& option is set, its expansion must not
26675 yield the empty string, &"0"&, &"no"&, or &"false"&.
26676 .endlist
26677
26678 The order in which the authenticators are defined controls the order in which
26679 the mechanisms are advertised.
26680
26681 Some mail clients (for example, some versions of Netscape) require the user to
26682 provide a name and password for authentication whenever AUTH is advertised,
26683 even though authentication may not in fact be needed (for example, Exim may be
26684 set up to allow unconditional relaying from the client by an IP address check).
26685 You can make such clients more friendly by not advertising AUTH to them.
26686 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26687 that runs for RCPT) to relay without authentication, you should set
26688 .code
26689 auth_advertise_hosts = ! 10.9.8.0/24
26690 .endd
26691 so that no authentication mechanisms are advertised to them.
26692
26693 The &%server_advertise_condition%& controls the advertisement of individual
26694 authentication mechanisms. For example, it can be used to restrict the
26695 advertisement of a particular mechanism to encrypted connections, by a setting
26696 such as:
26697 .code
26698 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26699 .endd
26700 .vindex "&$tls_in_cipher$&"
26701 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26702 yields &"yes"&, which allows the advertisement to happen.
26703
26704 When an Exim server receives an AUTH command from a client, it rejects it
26705 immediately if AUTH was not advertised in response to an earlier EHLO
26706 command. This is the case if
26707
26708 .ilist
26709 The client host does not match &%auth_advertise_hosts%&; or
26710 .next
26711 No authenticators are configured with server options; or
26712 .next
26713 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26714 server authenticators.
26715 .endlist
26716
26717
26718 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26719 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26720 AUTH is accepted from any client host.
26721
26722 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26723 server authentication mechanism that was advertised in response to EHLO and
26724 that matches the one named in the AUTH command. If it finds one, it runs
26725 the appropriate authentication protocol, and authentication either succeeds or
26726 fails. If there is no matching advertised mechanism, the AUTH command is
26727 rejected with a 504 error.
26728
26729 .vindex "&$received_protocol$&"
26730 .vindex "&$sender_host_authenticated$&"
26731 When a message is received from an authenticated host, the value of
26732 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26733 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26734 public name) of the authenticator driver that successfully authenticated the
26735 client from which the message was received. This variable is empty if there was
26736 no successful authentication.
26737
26738 .cindex authentication "expansion item"
26739 Successful authentication sets up information used by the
26740 &%authresults%& expansion item.
26741
26742
26743
26744
26745 .section "Testing server authentication" "SECID169"
26746 .cindex "authentication" "testing a server"
26747 .cindex "AUTH" "testing a server"
26748 .cindex "base64 encoding" "creating authentication test data"
26749 Exim's &%-bh%& option can be useful for testing server authentication
26750 configurations. The data for the AUTH command has to be sent using base64
26751 encoding. A quick way to produce such data for testing is the following Perl
26752 script:
26753 .code
26754 use MIME::Base64;
26755 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26756 .endd
26757 .cindex "binary zero" "in authentication data"
26758 This interprets its argument as a Perl string, and then encodes it. The
26759 interpretation as a Perl string allows binary zeros, which are required for
26760 some kinds of authentication, to be included in the data. For example, a
26761 command line to run this script on such data might be
26762 .code
26763 encode '\0user\0password'
26764 .endd
26765 Note the use of single quotes to prevent the shell interpreting the
26766 backslashes, so that they can be interpreted by Perl to specify characters
26767 whose code value is zero.
26768
26769 &*Warning 1*&: If either of the user or password strings starts with an octal
26770 digit, you must use three zeros instead of one after the leading backslash. If
26771 you do not, the octal digit that starts your string will be incorrectly
26772 interpreted as part of the code for the first character.
26773
26774 &*Warning 2*&: If there are characters in the strings that Perl interprets
26775 specially, you must use a Perl escape to prevent them being misinterpreted. For
26776 example, a command such as
26777 .code
26778 encode '\0user@domain.com\0pas$$word'
26779 .endd
26780 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26781
26782 If you have the &%mimencode%& command installed, another way to do produce
26783 base64-encoded strings is to run the command
26784 .code
26785 echo -e -n `\0user\0password' | mimencode
26786 .endd
26787 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26788 in the argument, and the &%-n%& option specifies no newline at the end of its
26789 output. However, not all versions of &%echo%& recognize these options, so you
26790 should check your version before relying on this suggestion.
26791
26792
26793
26794 .section "Authentication by an Exim client" "SECID170"
26795 .cindex "authentication" "on an Exim client"
26796 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26797 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26798 announces support for authentication, and the host matches an entry in either
26799 of these options, Exim (as a client) tries to authenticate as follows:
26800
26801 .ilist
26802 For each authenticator that is configured as a client, in the order in which
26803 they are defined in the configuration, it searches the authentication
26804 mechanisms announced by the server for one whose name matches the public name
26805 of the authenticator.
26806 .next
26807 .vindex "&$host$&"
26808 .vindex "&$host_address$&"
26809 When it finds one that matches, it runs the authenticator's client code. The
26810 variables &$host$& and &$host_address$& are available for any string expansions
26811 that the client might do. They are set to the server's name and IP address. If
26812 any expansion is forced to fail, the authentication attempt is abandoned, and
26813 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26814 delivery to be deferred.
26815 .next
26816 If the result of the authentication attempt is a temporary error or a timeout,
26817 Exim abandons trying to send the message to the host for the moment. It will
26818 try again later. If there are any backup hosts available, they are tried in the
26819 usual way.
26820 .next
26821 If the response to authentication is a permanent error (5&'xx'& code), Exim
26822 carries on searching the list of authenticators and tries another one if
26823 possible. If all authentication attempts give permanent errors, or if there are
26824 no attempts because no mechanisms match (or option expansions force failure),
26825 what happens depends on whether the host matches &%hosts_require_auth%& or
26826 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26827 delivery is deferred. The error can be detected in the retry rules, and thereby
26828 turned into a permanent error if you wish. In the second case, Exim tries to
26829 deliver the message unauthenticated.
26830 .endlist
26831
26832 Note that the hostlist test for whether to do authentication can be
26833 confused if name-IP lookups change between the time the peer is decided
26834 upon and the time that the transport runs.  For example, with a manualroute
26835 router given a host name, and with DNS "round-robin" used by that name: if
26836 the local resolver cache times out between the router and the transport
26837 running, the transport may get an IP for the name for its authentication
26838 check which does not match the connection peer IP.
26839 No authentication will then be done, despite the names being identical.
26840
26841 For such cases use a separate transport which always authenticates.
26842
26843 .cindex "AUTH" "on MAIL command"
26844 When Exim has authenticated itself to a remote server, it adds the AUTH
26845 parameter to the MAIL commands it sends, if it has an authenticated sender for
26846 the message. If the message came from a remote host, the authenticated sender
26847 is the one that was receiving on an incoming MAIL command, provided that the
26848 incoming connection was authenticated and the &%server_mail_auth%& condition
26849 allowed the authenticated sender to be retained. If a local process calls Exim
26850 to send a message, the sender address that is built from the login name and
26851 &%qualify_domain%& is treated as authenticated. However, if the
26852 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26853 the authenticated sender that was received with the message.
26854 .ecindex IIDauthconf1
26855 .ecindex IIDauthconf2
26856
26857
26858
26859
26860
26861
26862 . ////////////////////////////////////////////////////////////////////////////
26863 . ////////////////////////////////////////////////////////////////////////////
26864
26865 .chapter "The plaintext authenticator" "CHAPplaintext"
26866 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26867 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26868 The &(plaintext)& authenticator can be configured to support the PLAIN and
26869 LOGIN authentication mechanisms, both of which transfer authentication data as
26870 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26871 security risk; you are strongly advised to insist on the use of SMTP encryption
26872 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26873 use unencrypted plain text, you should not use the same passwords for SMTP
26874 connections as you do for login accounts.
26875
26876 .section "Avoiding cleartext use" "SECTplain_TLS"
26877 The following generic option settings will disable &(plaintext)& authenticators when
26878 TLS is not being used:
26879 .code
26880   server_advertise_condition = ${if def:tls_in_cipher }
26881   client_condition =           ${if def:tls_out_cipher}
26882 .endd
26883
26884 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
26885 but is still vulnerable to a Man In The Middle attack unless certificates
26886 (including their names) have been properly verified.
26887
26888 .section "Plaintext server options" "SECID171"
26889 .cindex "options" "&(plaintext)& authenticator (server)"
26890 When configured as a server, &(plaintext)& uses the following options:
26891
26892 .option server_condition authenticators string&!! unset
26893 This is actually a global authentication option, but it must be set in order to
26894 configure the &(plaintext)& driver as a server. Its use is described below.
26895
26896 .option server_prompts plaintext "string list&!!" unset
26897 The contents of this option, after expansion, must be a colon-separated list of
26898 prompt strings. If expansion fails, a temporary authentication rejection is
26899 given.
26900
26901 .section "Using plaintext in a server" "SECTplainserver"
26902 .cindex "AUTH" "in &(plaintext)& authenticator"
26903 .cindex "binary zero" "in &(plaintext)& authenticator"
26904 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26905         "in &(plaintext)& authenticator"
26906 .vindex "&$auth1$&, &$auth2$&, etc"
26907 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26908
26909 When running as a server, &(plaintext)& performs the authentication test by
26910 expanding a string. The data sent by the client with the AUTH command, or in
26911 response to subsequent prompts, is base64 encoded, and so may contain any byte
26912 values when decoded. If any data is supplied with the command, it is treated as
26913 a list of strings, separated by NULs (binary zeros), the first three of which
26914 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26915 (neither LOGIN nor PLAIN uses more than three strings).
26916
26917 For compatibility with previous releases of Exim, the values are also placed in
26918 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26919 variables for this purpose is now deprecated, as it can lead to confusion in
26920 string expansions that also use them for other things.
26921
26922 If there are more strings in &%server_prompts%& than the number of strings
26923 supplied with the AUTH command, the remaining prompts are used to obtain more
26924 data. Each response from the client may be a list of NUL-separated strings.
26925
26926 .vindex "&$authenticated_id$&"
26927 Once a sufficient number of data strings have been received,
26928 &%server_condition%& is expanded. If the expansion is forced to fail,
26929 authentication fails. Any other expansion failure causes a temporary error code
26930 to be returned. If the result of a successful expansion is an empty string,
26931 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26932 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26933 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26934 For any other result, a temporary error code is returned, with the expanded
26935 string as the error text.
26936
26937 &*Warning*&: If you use a lookup in the expansion to find the user's
26938 password, be sure to make the authentication fail if the user is unknown.
26939 There are good and bad examples at the end of the next section.
26940
26941
26942
26943 .section "The PLAIN authentication mechanism" "SECID172"
26944 .cindex "PLAIN authentication mechanism"
26945 .cindex "authentication" "PLAIN mechanism"
26946 .cindex "binary zero" "in &(plaintext)& authenticator"
26947 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26948 sent as one item of data (that is, one combined string containing two NUL
26949 separators). The data is sent either as part of the AUTH command, or
26950 subsequently in response to an empty prompt from the server.
26951
26952 The second and third strings are a user name and a corresponding password.
26953 Using a single fixed user name and password as an example, this could be
26954 configured as follows:
26955 .code
26956 fixed_plain:
26957   driver = plaintext
26958   public_name = PLAIN
26959   server_prompts = :
26960   server_condition = \
26961     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26962   server_set_id = $auth2
26963 .endd
26964 Note that the default result strings from &%if%& (&"true"& or an empty string)
26965 are exactly what we want here, so they need not be specified. Obviously, if the
26966 password contains expansion-significant characters such as dollar, backslash,
26967 or closing brace, they have to be escaped.
26968
26969 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26970 the end of a string list are ignored). If all the data comes as part of the
26971 AUTH command, as is commonly the case, the prompt is not used. This
26972 authenticator is advertised in the response to EHLO as
26973 .code
26974 250-AUTH PLAIN
26975 .endd
26976 and a client host can authenticate itself by sending the command
26977 .code
26978 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26979 .endd
26980 As this contains three strings (more than the number of prompts), no further
26981 data is required from the client. Alternatively, the client may just send
26982 .code
26983 AUTH PLAIN
26984 .endd
26985 to initiate authentication, in which case the server replies with an empty
26986 prompt. The client must respond with the combined data string.
26987
26988 The data string is base64 encoded, as required by the RFC. This example,
26989 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26990 represents a zero byte. This is split up into three strings, the first of which
26991 is empty. The &%server_condition%& option in the authenticator checks that the
26992 second two are &`username`& and &`mysecret`& respectively.
26993
26994 Having just one fixed user name and password, as in this example, is not very
26995 realistic, though for a small organization with only a handful of
26996 authenticating clients it could make sense.
26997
26998 A more sophisticated instance of this authenticator could use the user name in
26999 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27000 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27001 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27002 This is an incorrect example:
27003 .code
27004 server_condition = \
27005   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27006 .endd
27007 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27008 which it then compares to the supplied password (&$auth3$&). Why is this example
27009 incorrect? It works fine for existing users, but consider what happens if a
27010 non-existent user name is given. The lookup fails, but as no success/failure
27011 strings are given for the lookup, it yields an empty string. Thus, to defeat
27012 the authentication, all a client has to do is to supply a non-existent user
27013 name and an empty password. The correct way of writing this test is:
27014 .code
27015 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27016   {${if eq{$value}{$auth3}}} {false}}
27017 .endd
27018 In this case, if the lookup succeeds, the result is checked; if the lookup
27019 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27020 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27021 always fails if its second argument is empty. However, the second way of
27022 writing the test makes the logic clearer.
27023
27024
27025 .section "The LOGIN authentication mechanism" "SECID173"
27026 .cindex "LOGIN authentication mechanism"
27027 .cindex "authentication" "LOGIN mechanism"
27028 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27029 in a number of programs. No data is sent with the AUTH command. Instead, a
27030 user name and password are supplied separately, in response to prompts. The
27031 plaintext authenticator can be configured to support this as in this example:
27032 .code
27033 fixed_login:
27034   driver = plaintext
27035   public_name = LOGIN
27036   server_prompts = User Name : Password
27037   server_condition = \
27038     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27039   server_set_id = $auth1
27040 .endd
27041 Because of the way plaintext operates, this authenticator accepts data supplied
27042 with the AUTH command (in contravention of the specification of LOGIN), but
27043 if the client does not supply it (as is the case for LOGIN clients), the prompt
27044 strings are used to obtain two data items.
27045
27046 Some clients are very particular about the precise text of the prompts. For
27047 example, Outlook Express is reported to recognize only &"Username:"& and
27048 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27049 strings. It uses the &%ldapauth%& expansion condition to check the user
27050 name and password by binding to an LDAP server:
27051 .code
27052 login:
27053   driver = plaintext
27054   public_name = LOGIN
27055   server_prompts = Username:: : Password::
27056   server_condition = ${if and{{ \
27057     !eq{}{$auth1} }{ \
27058     ldapauth{\
27059       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27060       pass=${quote:$auth2} \
27061       ldap://ldap.example.org/} }} }
27062   server_set_id = uid=$auth1,ou=people,o=example.org
27063 .endd
27064 We have to check that the username is not empty before using it, because LDAP
27065 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27066 operator to correctly quote the DN for authentication. However, the basic
27067 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27068 correct one to use for the password, because quoting is needed only to make
27069 the password conform to the Exim syntax. At the LDAP level, the password is an
27070 uninterpreted string.
27071
27072
27073 .section "Support for different kinds of authentication" "SECID174"
27074 A number of string expansion features are provided for the purpose of
27075 interfacing to different ways of user authentication. These include checking
27076 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27077 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27078 &<<SECTexpcond>>&.
27079
27080
27081
27082
27083 .section "Using plaintext in a client" "SECID175"
27084 .cindex "options" "&(plaintext)& authenticator (client)"
27085 The &(plaintext)& authenticator has two client options:
27086
27087 .option client_ignore_invalid_base64 plaintext boolean false
27088 If the client receives a server prompt that is not a valid base64 string,
27089 authentication is abandoned by default. However, if this option is set true,
27090 the error in the challenge is ignored and the client sends the response as
27091 usual.
27092
27093 .option client_send plaintext string&!! unset
27094 The string is a colon-separated list of authentication data strings. Each
27095 string is independently expanded before being sent to the server. The first
27096 string is sent with the AUTH command; any more strings are sent in response
27097 to prompts from the server. Before each string is expanded, the value of the
27098 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27099 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27100 way. Thus, the prompt that is received in response to sending the first string
27101 (with the AUTH command) can be used in the expansion of the second string, and
27102 so on. If an invalid base64 string is received when
27103 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27104 &$auth$&<&'n'&> variable.
27105
27106 &*Note*&: You cannot use expansion to create multiple strings, because
27107 splitting takes priority and happens first.
27108
27109 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27110 the data, further processing is applied to each string before it is sent. If
27111 there are any single circumflex characters in the string, they are converted to
27112 NULs. Should an actual circumflex be required as data, it must be doubled in
27113 the string.
27114
27115 This is an example of a client configuration that implements the PLAIN
27116 authentication mechanism with a fixed user name and password:
27117 .code
27118 fixed_plain:
27119   driver = plaintext
27120   public_name = PLAIN
27121   client_send = ^username^mysecret
27122 .endd
27123 The lack of colons means that the entire text is sent with the AUTH
27124 command, with the circumflex characters converted to NULs. A similar example
27125 that uses the LOGIN mechanism is:
27126 .code
27127 fixed_login:
27128   driver = plaintext
27129   public_name = LOGIN
27130   client_send = : username : mysecret
27131 .endd
27132 The initial colon means that the first string is empty, so no data is sent with
27133 the AUTH command itself. The remaining strings are sent in response to
27134 prompts.
27135 .ecindex IIDplaiauth1
27136 .ecindex IIDplaiauth2
27137
27138
27139
27140
27141 . ////////////////////////////////////////////////////////////////////////////
27142 . ////////////////////////////////////////////////////////////////////////////
27143
27144 .chapter "The cram_md5 authenticator" "CHID9"
27145 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27146 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27147 .cindex "CRAM-MD5 authentication mechanism"
27148 .cindex "authentication" "CRAM-MD5 mechanism"
27149 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27150 sends a challenge string to the client, and the response consists of a user
27151 name and the CRAM-MD5 digest of the challenge string combined with a secret
27152 string (password) which is known to both server and client. Thus, the secret
27153 is not sent over the network as plain text, which makes this authenticator more
27154 secure than &(plaintext)&. However, the downside is that the secret has to be
27155 available in plain text at either end.
27156
27157
27158 .section "Using cram_md5 as a server" "SECID176"
27159 .cindex "options" "&(cram_md5)& authenticator (server)"
27160 This authenticator has one server option, which must be set to configure the
27161 authenticator as a server:
27162
27163 .option server_secret cram_md5 string&!! unset
27164 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27165 When the server receives the client's response, the user name is placed in
27166 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27167 obtain the password for that user. The server then computes the CRAM-MD5 digest
27168 that the client should have sent, and checks that it received the correct
27169 string. If the expansion of &%server_secret%& is forced to fail, authentication
27170 fails. If the expansion fails for some other reason, a temporary error code is
27171 returned to the client.
27172
27173 For compatibility with previous releases of Exim, the user name is also placed
27174 in &$1$&. However, the use of this variables for this purpose is now
27175 deprecated, as it can lead to confusion in string expansions that also use
27176 numeric variables for other things.
27177
27178 For example, the following authenticator checks that the user name given by the
27179 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27180 user name, authentication fails.
27181 .code
27182 fixed_cram:
27183   driver = cram_md5
27184   public_name = CRAM-MD5
27185   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27186   server_set_id = $auth1
27187 .endd
27188 .vindex "&$authenticated_id$&"
27189 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27190 name in &$authenticated_id$&. A more typical configuration might look up the
27191 secret string in a file, using the user name as the key. For example:
27192 .code
27193 lookup_cram:
27194   driver = cram_md5
27195   public_name = CRAM-MD5
27196   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27197                   {$value}fail}
27198   server_set_id = $auth1
27199 .endd
27200 Note that this expansion explicitly forces failure if the lookup fails
27201 because &$auth1$& contains an unknown user name.
27202
27203 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27204 using the relevant libraries, you need to know the realm to specify in the
27205 lookup and then ask for the &"userPassword"& attribute for that user in that
27206 realm, with:
27207 .code
27208 cyrusless_crammd5:
27209   driver = cram_md5
27210   public_name = CRAM-MD5
27211   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27212                   dbmjz{/etc/sasldb2}{$value}fail}
27213   server_set_id = $auth1
27214 .endd
27215
27216 .section "Using cram_md5 as a client" "SECID177"
27217 .cindex "options" "&(cram_md5)& authenticator (client)"
27218 When used as a client, the &(cram_md5)& authenticator has two options:
27219
27220
27221
27222 .option client_name cram_md5 string&!! "the primary host name"
27223 This string is expanded, and the result used as the user name data when
27224 computing the response to the server's challenge.
27225
27226
27227 .option client_secret cram_md5 string&!! unset
27228 This option must be set for the authenticator to work as a client. Its value is
27229 expanded and the result used as the secret string when computing the response.
27230
27231
27232 .vindex "&$host$&"
27233 .vindex "&$host_address$&"
27234 Different user names and secrets can be used for different servers by referring
27235 to &$host$& or &$host_address$& in the options. Forced failure of either
27236 expansion string is treated as an indication that this authenticator is not
27237 prepared to handle this case. Exim moves on to the next configured client
27238 authenticator. Any other expansion failure causes Exim to give up trying to
27239 send the message to the current server.
27240
27241 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27242 strings, is:
27243 .code
27244 fixed_cram:
27245   driver = cram_md5
27246   public_name = CRAM-MD5
27247   client_name = ph10
27248   client_secret = secret
27249 .endd
27250 .ecindex IIDcramauth1
27251 .ecindex IIDcramauth2
27252
27253
27254
27255 . ////////////////////////////////////////////////////////////////////////////
27256 . ////////////////////////////////////////////////////////////////////////////
27257
27258 .chapter "The cyrus_sasl authenticator" "CHID10"
27259 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27260 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27261 .cindex "Cyrus" "SASL library"
27262 .cindex "Kerberos"
27263 The code for this authenticator was provided by Matthew Byng-Maddick while
27264 at A L Digital Ltd.
27265
27266 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27267 library implementation of the RFC 2222 (&"Simple Authentication and Security
27268 Layer"&). This library supports a number of authentication mechanisms,
27269 including PLAIN and LOGIN, but also several others that Exim does not support
27270 directly. In particular, there is support for Kerberos authentication.
27271
27272 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27273 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27274 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27275 name of the driver to determine which mechanism to support.
27276
27277 Where access to some kind of secret file is required, for example, in GSSAPI
27278 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27279 user, and that the Cyrus SASL library has no way of escalating privileges
27280 by default. You may also find you need to set environment variables,
27281 depending on the driver you are using.
27282
27283 The application name provided by Exim is &"exim"&, so various SASL options may
27284 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27285 Kerberos, note that because of limitations in the GSSAPI interface,
27286 changing the server keytab might need to be communicated down to the Kerberos
27287 layer independently. The mechanism for doing so is dependent upon the Kerberos
27288 implementation.
27289
27290 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27291 may be set to point to an alternative keytab file. Exim will pass this
27292 variable through from its own inherited environment when started as root or the
27293 Exim user. The keytab file needs to be readable by the Exim user.
27294 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27295 environment variable.  In practice, for those releases, the Cyrus authenticator
27296 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27297 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27298
27299
27300 .section "Using cyrus_sasl as a server" "SECID178"
27301 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27302 (on a successful authentication) into &$auth1$&. For compatibility with
27303 previous releases of Exim, the username is also placed in &$1$&. However, the
27304 use of this variable for this purpose is now deprecated, as it can lead to
27305 confusion in string expansions that also use numeric variables for other
27306 things.
27307
27308
27309 .option server_hostname cyrus_sasl string&!! "see below"
27310 This option selects the hostname that is used when communicating with the
27311 library. The default value is &`$primary_hostname`&. It is up to the underlying
27312 SASL plug-in what it does with this data.
27313
27314
27315 .option server_mech cyrus_sasl string "see below"
27316 This option selects the authentication mechanism this driver should use. The
27317 default is the value of the generic &%public_name%& option. This option allows
27318 you to use a different underlying mechanism from the advertised name. For
27319 example:
27320 .code
27321 sasl:
27322   driver = cyrus_sasl
27323   public_name = X-ANYTHING
27324   server_mech = CRAM-MD5
27325   server_set_id = $auth1
27326 .endd
27327
27328 .option server_realm cyrus_sasl string&!! unset
27329 This specifies the SASL realm that the server claims to be in.
27330
27331
27332 .option server_service cyrus_sasl string &`smtp`&
27333 This is the SASL service that the server claims to implement.
27334
27335
27336 For straightforward cases, you do not need to set any of the authenticator's
27337 private options. All you need to do is to specify an appropriate mechanism as
27338 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27339 PLAIN, you could have two authenticators as follows:
27340 .code
27341 sasl_cram_md5:
27342   driver = cyrus_sasl
27343   public_name = CRAM-MD5
27344   server_set_id = $auth1
27345
27346 sasl_plain:
27347   driver = cyrus_sasl
27348   public_name = PLAIN
27349   server_set_id = $auth2
27350 .endd
27351 Cyrus SASL does implement the LOGIN authentication method, even though it is
27352 not a standard method. It is disabled by default in the source distribution,
27353 but it is present in many binary distributions.
27354 .ecindex IIDcyrauth1
27355 .ecindex IIDcyrauth2
27356
27357
27358
27359
27360 . ////////////////////////////////////////////////////////////////////////////
27361 . ////////////////////////////////////////////////////////////////////////////
27362 .chapter "The dovecot authenticator" "CHAPdovecot"
27363 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27364 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27365 This authenticator is an interface to the authentication facility of the
27366 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27367 Note that Dovecot must be configured to use auth-client not auth-userdb.
27368 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27369 to use the same mechanisms for SMTP authentication. This is a server
27370 authenticator only. There is only one option:
27371
27372 .option server_socket dovecot string unset
27373
27374 This option must specify the UNIX socket that is the interface to Dovecot
27375 authentication. The &%public_name%& option must specify an authentication
27376 mechanism that Dovecot is configured to support. You can have several
27377 authenticators for different mechanisms. For example:
27378 .code
27379 dovecot_plain:
27380   driver = dovecot
27381   public_name = PLAIN
27382   server_socket = /var/run/dovecot/auth-client
27383   server_set_id = $auth1
27384
27385 dovecot_ntlm:
27386   driver = dovecot
27387   public_name = NTLM
27388   server_socket = /var/run/dovecot/auth-client
27389   server_set_id = $auth1
27390 .endd
27391 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27392 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27393 option is passed in the Dovecot authentication command. If, for a TLS
27394 connection, a client certificate has been verified, the &"valid-client-cert"&
27395 option is passed. When authentication succeeds, the identity of the user
27396 who authenticated is placed in &$auth1$&.
27397
27398 .new
27399 The Dovecot configuration to match the above wil look
27400 something like:
27401 .code
27402 conf.d/10-master.conf :-
27403
27404 service auth {
27405 ...
27406 #SASL
27407   unix_listener auth-client {
27408     mode = 0660
27409     user = mail
27410   }
27411 ...
27412 }
27413
27414 conf.d/10-auth.conf :-
27415
27416 auth_mechanisms = plain login ntlm
27417 .endd
27418 .wen
27419
27420 .ecindex IIDdcotauth1
27421 .ecindex IIDdcotauth2
27422
27423
27424 . ////////////////////////////////////////////////////////////////////////////
27425 . ////////////////////////////////////////////////////////////////////////////
27426 .chapter "The gsasl authenticator" "CHAPgsasl"
27427 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27428 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27429 .cindex "authentication" "GNU SASL"
27430 .cindex "authentication" "SASL"
27431 .cindex "authentication" "EXTERNAL"
27432 .cindex "authentication" "ANONYMOUS"
27433 .cindex "authentication" "PLAIN"
27434 .cindex "authentication" "LOGIN"
27435 .cindex "authentication" "DIGEST-MD5"
27436 .cindex "authentication" "CRAM-MD5"
27437 .cindex "authentication" "SCRAM-SHA-1"
27438 The &(gsasl)& authenticator provides server integration for the GNU SASL
27439 library and the mechanisms it provides.  This is new as of the 4.80 release
27440 and there are a few areas where the library does not let Exim smoothly
27441 scale to handle future authentication mechanisms, so no guarantee can be
27442 made that any particular new authentication mechanism will be supported
27443 without code changes in Exim.
27444
27445 Exim's &(gsasl)& authenticator does not have client-side support at this
27446 time; only the server-side support is implemented.  Patches welcome.
27447
27448
27449 .option server_channelbinding gsasl boolean false
27450 Do not set this true without consulting a cryptographic engineer.
27451
27452 Some authentication mechanisms are able to use external context at both ends
27453 of the session to bind the authentication to that context, and fail the
27454 authentication process if that context differs.  Specifically, some TLS
27455 ciphersuites can provide identifying information about the cryptographic
27456 context.
27457
27458 This should have meant that certificate identity and verification becomes a
27459 non-issue, as a man-in-the-middle attack will cause the correct client and
27460 server to see different identifiers and authentication will fail.
27461
27462 .new
27463 This is
27464 only usable by mechanisms which support "channel binding"; at time of
27465 writing, that's the SCRAM family.
27466 .wen
27467
27468 This defaults off to ensure smooth upgrade across Exim releases, in case
27469 this option causes some clients to start failing.  Some future release
27470 of Exim might have switched the default to be true.
27471
27472 However, Channel Binding in TLS has proven to be broken in current versions.
27473 Do not plan to rely upon this feature for security, ever, without consulting
27474 with a subject matter expert (a cryptographic engineer).
27475
27476
27477 .option server_hostname gsasl string&!! "see below"
27478 This option selects the hostname that is used when communicating with the
27479 library. The default value is &`$primary_hostname`&.
27480 Some mechanisms will use this data.
27481
27482
27483 .option server_mech gsasl string "see below"
27484 This option selects the authentication mechanism this driver should use. The
27485 default is the value of the generic &%public_name%& option. This option allows
27486 you to use a different underlying mechanism from the advertised name. For
27487 example:
27488 .code
27489 sasl:
27490   driver = gsasl
27491   public_name = X-ANYTHING
27492   server_mech = CRAM-MD5
27493   server_set_id = $auth1
27494 .endd
27495
27496
27497 .option server_password gsasl string&!! unset
27498 Various mechanisms need access to the cleartext password on the server, so
27499 that proof-of-possession can be demonstrated on the wire, without sending
27500 the password itself.
27501
27502 The data available for lookup varies per mechanism.
27503 In all cases, &$auth1$& is set to the &'authentication id'&.
27504 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27505 if available, else the empty string.
27506 The &$auth3$& variable will always be the &'realm'& if available,
27507 else the empty string.
27508
27509 A forced failure will cause authentication to defer.
27510
27511 If using this option, it may make sense to set the &%server_condition%&
27512 option to be simply "true".
27513
27514
27515 .option server_realm gsasl string&!! unset
27516 This specifies the SASL realm that the server claims to be in.
27517 Some mechanisms will use this data.
27518
27519
27520 .option server_scram_iter gsasl string&!! unset
27521 This option provides data for the SCRAM family of mechanisms.
27522 &$auth1$& is not available at evaluation time.
27523 (This may change, as we receive feedback on use)
27524
27525
27526 .option server_scram_salt gsasl string&!! unset
27527 This option provides data for the SCRAM family of mechanisms.
27528 &$auth1$& is not available at evaluation time.
27529 (This may change, as we receive feedback on use)
27530
27531
27532 .option server_service gsasl string &`smtp`&
27533 This is the SASL service that the server claims to implement.
27534 Some mechanisms will use this data.
27535
27536
27537 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27538 .vindex "&$auth1$&, &$auth2$&, etc"
27539 These may be set when evaluating specific options, as detailed above.
27540 They will also be set when evaluating &%server_condition%&.
27541
27542 Unless otherwise stated below, the &(gsasl)& integration will use the following
27543 meanings for these variables:
27544
27545 .ilist
27546 .vindex "&$auth1$&"
27547 &$auth1$&: the &'authentication id'&
27548 .next
27549 .vindex "&$auth2$&"
27550 &$auth2$&: the &'authorization id'&
27551 .next
27552 .vindex "&$auth3$&"
27553 &$auth3$&: the &'realm'&
27554 .endlist
27555
27556 On a per-mechanism basis:
27557
27558 .ilist
27559 .cindex "authentication" "EXTERNAL"
27560 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27561 the &%server_condition%& option must be present.
27562 .next
27563 .cindex "authentication" "ANONYMOUS"
27564 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27565 the &%server_condition%& option must be present.
27566 .next
27567 .cindex "authentication" "GSSAPI"
27568 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27569 &$auth2$& will be set to the &'authorization id'&,
27570 the &%server_condition%& option must be present.
27571 .endlist
27572
27573 An &'anonymous token'& is something passed along as an unauthenticated
27574 identifier; this is analogous to FTP anonymous authentication passing an
27575 email address, or software-identifier@, as the "password".
27576
27577
27578 An example showing the password having the realm specified in the callback
27579 and demonstrating a Cyrus SASL to GSASL migration approach is:
27580 .code
27581 gsasl_cyrusless_crammd5:
27582   driver = gsasl
27583   public_name = CRAM-MD5
27584   server_realm = imap.example.org
27585   server_password = ${lookup{$auth1:$auth3:userPassword}\
27586                     dbmjz{/etc/sasldb2}{$value}fail}
27587   server_set_id = ${quote:$auth1}
27588   server_condition = yes
27589 .endd
27590
27591
27592 . ////////////////////////////////////////////////////////////////////////////
27593 . ////////////////////////////////////////////////////////////////////////////
27594
27595 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27596 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27597 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27598 .cindex "authentication" "GSSAPI"
27599 .cindex "authentication" "Kerberos"
27600 The &(heimdal_gssapi)& authenticator provides server integration for the
27601 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27602 reliably.
27603
27604 .option server_hostname heimdal_gssapi string&!! "see below"
27605 This option selects the hostname that is used, with &%server_service%&,
27606 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27607 identifier.  The default value is &`$primary_hostname`&.
27608
27609 .option server_keytab heimdal_gssapi string&!! unset
27610 If set, then Heimdal will not use the system default keytab (typically
27611 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27612 The value should be a pathname, with no &"file:"& prefix.
27613
27614 .option server_service heimdal_gssapi string&!! "smtp"
27615 This option specifies the service identifier used, in conjunction with
27616 &%server_hostname%&, for building the identifier for finding credentials
27617 from the keytab.
27618
27619
27620 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27621 Beware that these variables will typically include a realm, thus will appear
27622 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27623 not verified, so a malicious client can set it to anything.
27624
27625 The &$auth1$& field should be safely trustable as a value from the Key
27626 Distribution Center.  Note that these are not quite email addresses.
27627 Each identifier is for a role, and so the left-hand-side may include a
27628 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27629
27630 .vindex "&$auth1$&, &$auth2$&, etc"
27631 .ilist
27632 .vindex "&$auth1$&"
27633 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27634 .next
27635 .vindex "&$auth2$&"
27636 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27637 authentication.  If that was empty, this will also be set to the
27638 GSS Display Name.
27639 .endlist
27640
27641
27642 . ////////////////////////////////////////////////////////////////////////////
27643 . ////////////////////////////////////////////////////////////////////////////
27644
27645 .chapter "The spa authenticator" "CHAPspa"
27646 .scindex IIDspaauth1 "&(spa)& authenticator"
27647 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27648 .cindex "authentication" "Microsoft Secure Password"
27649 .cindex "authentication" "NTLM"
27650 .cindex "Microsoft Secure Password Authentication"
27651 .cindex "NTLM authentication"
27652 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27653 Password Authentication'& mechanism,
27654 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27655 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27656 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27657 server side was subsequently contributed by Tom Kistner. The mechanism works as
27658 follows:
27659
27660 .ilist
27661 After the AUTH command has been accepted, the client sends an SPA
27662 authentication request based on the user name and optional domain.
27663 .next
27664 The server sends back a challenge.
27665 .next
27666 The client builds a challenge response which makes use of the user's password
27667 and sends it to the server, which then accepts or rejects it.
27668 .endlist
27669
27670 Encryption is used to protect the password in transit.
27671
27672
27673
27674 .section "Using spa as a server" "SECID179"
27675 .cindex "options" "&(spa)& authenticator (server)"
27676 The &(spa)& authenticator has just one server option:
27677
27678 .option server_password spa string&!! unset
27679 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27680 This option is expanded, and the result must be the cleartext password for the
27681 authenticating user, whose name is at this point in &$auth1$&. For
27682 compatibility with previous releases of Exim, the user name is also placed in
27683 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27684 it can lead to confusion in string expansions that also use numeric variables
27685 for other things. For example:
27686 .code
27687 spa:
27688   driver = spa
27689   public_name = NTLM
27690   server_password = \
27691     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27692 .endd
27693 If the expansion is forced to fail, authentication fails. Any other expansion
27694 failure causes a temporary error code to be returned.
27695
27696
27697
27698
27699
27700 .section "Using spa as a client" "SECID180"
27701 .cindex "options" "&(spa)& authenticator (client)"
27702 The &(spa)& authenticator has the following client options:
27703
27704
27705
27706 .option client_domain spa string&!! unset
27707 This option specifies an optional domain for the authentication.
27708
27709
27710 .option client_password spa string&!! unset
27711 This option specifies the user's password, and must be set.
27712
27713
27714 .option client_username spa string&!! unset
27715 This option specifies the user name, and must be set. Here is an example of a
27716 configuration of this authenticator for use with the mail servers at
27717 &'msn.com'&:
27718 .code
27719 msn:
27720   driver = spa
27721   public_name = MSN
27722   client_username = msn/msn_username
27723   client_password = msn_plaintext_password
27724   client_domain = DOMAIN_OR_UNSET
27725 .endd
27726 .ecindex IIDspaauth1
27727 .ecindex IIDspaauth2
27728
27729
27730
27731
27732
27733 . ////////////////////////////////////////////////////////////////////////////
27734 . ////////////////////////////////////////////////////////////////////////////
27735
27736 .chapter "The external authenticator" "CHAPexternauth"
27737 .scindex IIDexternauth1 "&(external)& authenticator"
27738 .scindex IIDexternauth2 "authenticators" "&(external)&"
27739 .cindex "authentication" "Client Certificate"
27740 .cindex "authentication" "X509"
27741 .cindex "Certificate-based authentication"
27742 The &(external)& authenticator provides support for
27743 authentication based on non-SMTP information.
27744 The specification is in RFC 4422 Appendix A
27745 (&url(https://tools.ietf.org/html/rfc4422)).
27746 It is only a transport and negotiation mechanism;
27747 the process of authentication is entirely controlled
27748 by the server configuration.
27749
27750 The client presents an identity in-clear.
27751 It is probably wise for a server to only advertise,
27752 and for clients to only attempt,
27753 this authentication method on a secure (eg. under TLS) connection.
27754
27755 One possible use, compatible with the
27756 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27757 is for using X509 client certificates.
27758
27759 It thus overlaps in function with the TLS authenticator
27760 (see &<<CHAPtlsauth>>&)
27761 but is a full SMTP SASL authenticator
27762 rather than being implicit for TLS-connection carried
27763 client certificates only.
27764
27765 The examples and discussion in this chapter assume that
27766 client-certificate authentication is being done.
27767
27768 The client must present a certificate,
27769 for which it must have been requested via the
27770 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27771 (see &<<CHAPTLS>>&).
27772 For authentication to be effective the certificate should be
27773 verifiable against a trust-anchor certificate known to the server.
27774
27775 .section "External options" "SECTexternsoptions"
27776 .cindex "options" "&(external)& authenticator (server)"
27777 The &(external)& authenticator has two server options:
27778
27779 .option server_param2 external string&!! unset
27780 .option server_param3 external string&!! unset
27781 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27782 These options are expanded before the &%server_condition%& option
27783 and the result are placed in &$auth2$& and &$auth3$& resectively.
27784 If the expansion is forced to fail, authentication fails. Any other expansion
27785 failure causes a temporary error code to be returned.
27786
27787 They can be used to clarify the coding of a complex &%server_condition%&.
27788
27789 .section "Using external in a server" "SECTexternserver"
27790 .cindex "AUTH" "in &(external)& authenticator"
27791 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27792         "in &(external)& authenticator"
27793 .vindex "&$auth1$&, &$auth2$&, etc"
27794 .cindex "base64 encoding" "in &(external)& authenticator"
27795
27796 When running as a server, &(external)& performs the authentication test by
27797 expanding a string. The data sent by the client with the AUTH command, or in
27798 response to subsequent prompts, is base64 encoded, and so may contain any byte
27799 values when decoded. The decoded value is treated as
27800 an identity for authentication and
27801 placed in the expansion variable &$auth1$&.
27802
27803 For compatibility with previous releases of Exim, the value is also placed in
27804 the expansion variable &$1$&. However, the use of this
27805 variable for this purpose is now deprecated, as it can lead to confusion in
27806 string expansions that also use them for other things.
27807
27808 .vindex "&$authenticated_id$&"
27809 Once an identity has been received,
27810 &%server_condition%& is expanded. If the expansion is forced to fail,
27811 authentication fails. Any other expansion failure causes a temporary error code
27812 to be returned. If the result of a successful expansion is an empty string,
27813 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27814 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27815 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27816 For any other result, a temporary error code is returned, with the expanded
27817 string as the error text.
27818
27819 Example:
27820 .code
27821 ext_ccert_san_mail:
27822   driver =            external
27823   public_name =       EXTERNAL
27824
27825   server_advertise_condition = $tls_in_certificate_verified
27826   server_param2 =     ${certextract {subj_altname,mail,>:} \
27827                                     {$tls_in_peercert}}
27828   server_condition =  ${if forany {$auth2} \
27829                             {eq {$item}{$auth1}}}
27830   server_set_id =     $auth1
27831 .endd
27832 This accepts a client certificate that is verifiable against any
27833 of your configured trust-anchors
27834 (which usually means the full set of public CAs)
27835 and which has a mail-SAN matching the claimed identity sent by the client.
27836
27837 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
27838 The account name is therefore guessable by an opponent.
27839 TLS 1.3 protects both server and client certificates, and is not vulnerable
27840 in this way.
27841
27842
27843 .section "Using external in a client" "SECTexternclient"
27844 .cindex "options" "&(external)& authenticator (client)"
27845 The &(external)& authenticator has one client option:
27846
27847 .option client_send external string&!! unset
27848 This option is expanded and sent with the AUTH command as the
27849 identity being asserted.
27850
27851 Example:
27852 .code
27853 ext_ccert:
27854   driver =      external
27855   public_name = EXTERNAL
27856
27857   client_condition = ${if !eq{$tls_out_cipher}{}}
27858   client_send = myaccount@smarthost.example.net
27859 .endd
27860
27861
27862 .ecindex IIDexternauth1
27863 .ecindex IIDexternauth2
27864
27865
27866
27867
27868
27869 . ////////////////////////////////////////////////////////////////////////////
27870 . ////////////////////////////////////////////////////////////////////////////
27871
27872 .chapter "The tls authenticator" "CHAPtlsauth"
27873 .scindex IIDtlsauth1 "&(tls)& authenticator"
27874 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27875 .cindex "authentication" "Client Certificate"
27876 .cindex "authentication" "X509"
27877 .cindex "Certificate-based authentication"
27878 The &(tls)& authenticator provides server support for
27879 authentication based on client certificates.
27880
27881 It is not an SMTP authentication mechanism and is not
27882 advertised by the server as part of the SMTP EHLO response.
27883 It is an Exim authenticator in the sense that it affects
27884 the protocol element of the log line, can be tested for
27885 by the &%authenticated%& ACL condition, and can set
27886 the &$authenticated_id$& variable.
27887
27888 The client must present a verifiable certificate,
27889 for which it must have been requested via the
27890 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27891 (see &<<CHAPTLS>>&).
27892
27893 If an authenticator of this type is configured it is
27894 run before any SMTP-level communication is done,
27895 and can authenticate the connection.
27896 If it does, SMTP authentication is not offered.
27897
27898 A maximum of one authenticator of this type may be present.
27899
27900
27901 .cindex "options" "&(tls)& authenticator (server)"
27902 The &(tls)& authenticator has three server options:
27903
27904 .option server_param1 tls string&!! unset
27905 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27906 This option is expanded after the TLS negotiation and
27907 the result is placed in &$auth1$&.
27908 If the expansion is forced to fail, authentication fails. Any other expansion
27909 failure causes a temporary error code to be returned.
27910
27911 .option server_param2 tls string&!! unset
27912 .option server_param3 tls string&!! unset
27913 As above, for &$auth2$& and &$auth3$&.
27914
27915 &%server_param1%& may also be spelled &%server_param%&.
27916
27917
27918 Example:
27919 .code
27920 tls:
27921   driver = tls
27922   server_param1 =     ${certextract {subj_altname,mail,>:} \
27923                                     {$tls_in_peercert}}
27924   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
27925                                  {forany {$auth1} \
27926                             {!= {0} \
27927                                 {${lookup ldap{ldap:///\
27928                          mailname=${quote_ldap_dn:${lc:$item}},\
27929                          ou=users,LDAP_DC?mailid} {$value}{0} \
27930                        }    }  } }}}
27931   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27932 .endd
27933 This accepts a client certificate that is verifiable against any
27934 of your configured trust-anchors
27935 (which usually means the full set of public CAs)
27936 and which has a SAN with a good account name.
27937
27938 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27939 The account name is therefore guessable by an opponent.
27940 TLS 1.3 protects both server and client certificates, and is not vulnerable
27941 in this way.
27942 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27943
27944 . An alternative might use
27945 . .code
27946 .   server_param1 = ${sha256:$tls_in_peercert}
27947 . .endd
27948 . to require one of a set of specific certs that define a given account
27949 . (the verification is still required, but mostly irrelevant).
27950 . This would help for per-device use.
27951 .
27952 . However, for the future we really need support for checking a
27953 . user cert in LDAP - which probably wants a base-64 DER.
27954
27955 .ecindex IIDtlsauth1
27956 .ecindex IIDtlsauth2
27957
27958
27959 Note that because authentication is traditionally an SMTP operation,
27960 the &%authenticated%& ACL condition cannot be used in
27961 a connect- or helo-ACL.
27962
27963
27964
27965 . ////////////////////////////////////////////////////////////////////////////
27966 . ////////////////////////////////////////////////////////////////////////////
27967
27968 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27969          "Encrypted SMTP connections"
27970 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27971 .scindex IIDencsmtp2 "SMTP" "encryption"
27972 .cindex "TLS" "on SMTP connection"
27973 .cindex "OpenSSL"
27974 .cindex "GnuTLS"
27975 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27976 Sockets Layer), is implemented by making use of the OpenSSL library or the
27977 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27978 cryptographic code in the Exim distribution itself for implementing TLS. In
27979 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27980 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27981 You also need to understand the basic concepts of encryption at a managerial
27982 level, and in particular, the way that public keys, private keys, and
27983 certificates are used.
27984
27985 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27986 connection is established, the client issues a STARTTLS command. If the
27987 server accepts this, the client and the server negotiate an encryption
27988 mechanism. If the negotiation succeeds, the data that subsequently passes
27989 between them is encrypted.
27990
27991 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27992 and if so, what cipher suite is in use, whether the client supplied a
27993 certificate, and whether or not that certificate was verified. This makes it
27994 possible for an Exim server to deny or accept certain commands based on the
27995 encryption state.
27996
27997 &*Warning*&: Certain types of firewall and certain anti-virus products can
27998 disrupt TLS connections. You need to turn off SMTP scanning for these products
27999 in order to get TLS to work.
28000
28001
28002
28003 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28004          "SECID284"
28005 .cindex "submissions protocol"
28006 .cindex "ssmtp protocol"
28007 .cindex "smtps protocol"
28008 .cindex "SMTP" "submissions protocol"
28009 .cindex "SMTP" "ssmtp protocol"
28010 .cindex "SMTP" "smtps protocol"
28011 The history of port numbers for TLS in SMTP is a little messy and has been
28012 contentious.  As of RFC 8314, the common practice of using the historically
28013 allocated port 465 for "email submission but with TLS immediately upon connect
28014 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28015 by them in preference to STARTTLS.
28016
28017 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28018 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28019 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28020
28021 This approach was, for a while, officially abandoned when encrypted SMTP was
28022 standardized, but many clients kept using it, even as the TCP port number was
28023 reassigned for other use.
28024 Thus you may encounter guidance claiming that you shouldn't enable use of
28025 this port.
28026 In practice, a number of mail-clients have only ever supported submissions,
28027 not submission with STARTTLS upgrade.
28028 Ideally, offer both submission (587) and submissions (465) service.
28029
28030 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28031 global option. Its value must be a list of port numbers;
28032 the most common use is expected to be:
28033 .code
28034 tls_on_connect_ports = 465
28035 .endd
28036 The port numbers specified by this option apply to all SMTP connections, both
28037 via the daemon and via &'inetd'&. You still need to specify all the ports that
28038 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28039 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28040 an extra port &-- rather, it specifies different behaviour on a port that is
28041 defined elsewhere.
28042
28043 There is also a &%-tls-on-connect%& command line option. This overrides
28044 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28045
28046
28047
28048
28049
28050
28051 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28052 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28053 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28054 To build Exim to use OpenSSL you need to set
28055 .code
28056 USE_OPENSSL=yes
28057 .endd
28058 in Local/Makefile.
28059
28060 To build Exim to use GnuTLS, you need to set
28061 .code
28062 USE_GNUTLS=yes
28063 .endd
28064 in Local/Makefile.
28065
28066 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28067 include files and libraries for GnuTLS can be found.
28068
28069 There are some differences in usage when using GnuTLS instead of OpenSSL:
28070
28071 .ilist
28072 The &%tls_verify_certificates%& option
28073 cannot be the path of a directory
28074 for GnuTLS versions before 3.3.6
28075 (for later versions, or OpenSSL, it can be either).
28076 .next
28077 The default value for &%tls_dhparam%& differs for historical reasons.
28078 .next
28079 .vindex "&$tls_in_peerdn$&"
28080 .vindex "&$tls_out_peerdn$&"
28081 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28082 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28083 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28084 .next
28085 OpenSSL identifies cipher suites using hyphens as separators, for example:
28086 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28087 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28088 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28089 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28090 to handle its own older variants) when processing lists of cipher suites in the
28091 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28092 option).
28093 .next
28094 The &%tls_require_ciphers%& options operate differently, as described in the
28095 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28096 .next
28097 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28098 When using OpenSSL, this option is ignored.
28099 (If an API is found to let OpenSSL be configured in this way,
28100 let the Exim Maintainers know and we'll likely use it).
28101 .next
28102 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28103 main option, it must be ordered to match the &%tls_certificate%& list.
28104 .next
28105 Some other recently added features may only be available in one or the other.
28106 This should be documented with the feature.  If the documentation does not
28107 explicitly state that the feature is infeasible in the other TLS
28108 implementation, then patches are welcome.
28109 .endlist
28110
28111
28112 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28113 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28114 an explicit path; if the latter, then the text about generation still applies,
28115 but not the chosen filename.
28116 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28117 See the documentation of &%tls_dhparam%& for more information.
28118
28119 GnuTLS uses D-H parameters that may take a substantial amount of time
28120 to compute. It is unreasonable to re-compute them for every TLS session.
28121 Therefore, Exim keeps this data in a file in its spool directory, called
28122 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28123 of bits requested.
28124 The file is owned by the Exim user and is readable only by
28125 its owner. Every Exim process that start up GnuTLS reads the D-H
28126 parameters from this file. If the file does not exist, the first Exim process
28127 that needs it computes the data and writes it to a temporary file which is
28128 renamed once it is complete. It does not matter if several Exim processes do
28129 this simultaneously (apart from wasting a few resources). Once a file is in
28130 place, new Exim processes immediately start using it.
28131
28132 For maximum security, the parameters that are stored in this file should be
28133 recalculated periodically, the frequency depending on your paranoia level.
28134 If you are avoiding using the fixed D-H primes published in RFCs, then you
28135 are concerned about some advanced attacks and will wish to do this; if you do
28136 not regenerate then you might as well stick to the standard primes.
28137
28138 Arranging this is easy in principle; just delete the file when you want new
28139 values to be computed. However, there may be a problem. The calculation of new
28140 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28141 If the system is not very active, &_/dev/random_& may delay returning data
28142 until enough randomness (entropy) is available. This may cause Exim to hang for
28143 a substantial amount of time, causing timeouts on incoming connections.
28144
28145 The solution is to generate the parameters externally to Exim. They are stored
28146 in &_gnutls-params-N_& in PEM format, which means that they can be
28147 generated externally using the &(certtool)& command that is part of GnuTLS.
28148
28149 To replace the parameters with new ones, instead of deleting the file
28150 and letting Exim re-create it, you can generate new parameters using
28151 &(certtool)& and, when this has been done, replace Exim's cache file by
28152 renaming. The relevant commands are something like this:
28153 .code
28154 # ls
28155 [ look for file; assume gnutls-params-2236 is the most recent ]
28156 # rm -f new-params
28157 # touch new-params
28158 # chown exim:exim new-params
28159 # chmod 0600 new-params
28160 # certtool --generate-dh-params --bits 2236 >>new-params
28161 # openssl dhparam -noout -text -in new-params | head
28162 [ check the first line, make sure it's not more than 2236;
28163   if it is, then go back to the start ("rm") and repeat
28164   until the size generated is at most the size requested ]
28165 # chmod 0400 new-params
28166 # mv new-params gnutls-params-2236
28167 .endd
28168 If Exim never has to generate the parameters itself, the possibility of
28169 stalling is removed.
28170
28171 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28172 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28173 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28174 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28175 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28176 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28177 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28178 which applies to all D-H usage, client or server.  If the value returned by
28179 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28180 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28181 limit, which is still much higher than Exim historically used.
28182
28183 The filename and bits used will change as the GnuTLS maintainers change the
28184 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28185 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28186 2432 bits, while NSS is limited to 2236 bits.
28187
28188 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28189 increase the chance of the generated prime actually being within acceptable
28190 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28191 procedure above.  There is no sane procedure available to Exim to double-check
28192 the size of the generated prime, so it might still be too large.
28193
28194
28195 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28196 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28197 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28198 There is a function in the OpenSSL library that can be passed a list of cipher
28199 suites before the cipher negotiation takes place. This specifies which ciphers
28200 are acceptable for TLS versions prior to 1.3.
28201 The list is colon separated and may contain names like
28202 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28203 directly to this function call.
28204 Many systems will install the OpenSSL manual-pages, so you may have
28205 &'ciphers(1)'& available to you.
28206 The following quotation from the OpenSSL
28207 documentation specifies what forms of item are allowed in the cipher string:
28208
28209 .ilist
28210 It can consist of a single cipher suite such as RC4-SHA.
28211 .next
28212 It can represent a list of cipher suites containing a certain algorithm,
28213 or cipher suites of a certain type. For example SHA1 represents all
28214 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28215 SSL v3 algorithms.
28216 .next
28217 Lists of cipher suites can be combined in a single cipher string using
28218 the + character. This is used as a logical and operation. For example
28219 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28220 algorithms.
28221 .endlist
28222
28223 Each cipher string can be optionally preceded by one of the characters &`!`&,
28224 &`-`& or &`+`&.
28225 .ilist
28226 If &`!`& is used, the ciphers are permanently deleted from the list. The
28227 ciphers deleted can never reappear in the list even if they are explicitly
28228 stated.
28229 .next
28230 If &`-`& is used, the ciphers are deleted from the list, but some or all
28231 of the ciphers can be added again by later options.
28232 .next
28233 If &`+`& is used, the ciphers are moved to the end of the list. This
28234 option does not add any new ciphers; it just moves matching existing ones.
28235 .endlist
28236
28237 If none of these characters is present, the string is interpreted as
28238 a list of ciphers to be appended to the current preference list. If the list
28239 includes any ciphers already present they will be ignored: that is, they will
28240 not be moved to the end of the list.
28241 .endlist
28242
28243 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28244 string:
28245 .code
28246 # note single-quotes to get ! past any shell history expansion
28247 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28248 .endd
28249
28250 This example will let the library defaults be permitted on the MX port, where
28251 there's probably no identity verification anyway, but ups the ante on the
28252 submission ports where the administrator might have some influence on the
28253 choice of clients used:
28254 .code
28255 # OpenSSL variant; see man ciphers(1)
28256 tls_require_ciphers = ${if =={$received_port}{25}\
28257                            {DEFAULT}\
28258                            {HIGH:!MD5:!SHA1}}
28259 .endd
28260
28261 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28262 .code
28263 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28264 .endd
28265
28266 For TLS version 1.3 the control available is less fine-grained
28267 and Exim does not provide access to it at present.
28268 The value of the &%tls_require_ciphers%& option is ignored when
28269 TLS version 1.3 is negotiated.
28270
28271 As of writing the library default cipher suite list for TLSv1.3 is
28272 .code
28273 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28274 .endd
28275
28276
28277 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28278          "SECTreqciphgnu"
28279 .cindex "GnuTLS" "specifying parameters for"
28280 .cindex "TLS" "specifying ciphers (GnuTLS)"
28281 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28282 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28283 .cindex "TLS" "specifying protocols (GnuTLS)"
28284 .cindex "TLS" "specifying priority string (GnuTLS)"
28285 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28286 The GnuTLS library allows the caller to provide a "priority string", documented
28287 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28288 ciphersuite specification in OpenSSL.
28289
28290 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28291 and controls both protocols and ciphers.
28292
28293 The &%tls_require_ciphers%& option is available both as an global option,
28294 controlling how Exim behaves as a server, and also as an option of the
28295 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28296 the value is string expanded.  The resulting string is not an Exim list and
28297 the string is given to the GnuTLS library, so that Exim does not need to be
28298 aware of future feature enhancements of GnuTLS.
28299
28300 Documentation of the strings accepted may be found in the GnuTLS manual, under
28301 "Priority strings".  This is online as
28302 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28303 but beware that this relates to GnuTLS 3, which may be newer than the version
28304 installed on your system.  If you are using GnuTLS 3,
28305 then the example code
28306 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28307 on that site can be used to test a given string.
28308
28309 For example:
28310 .code
28311 # Disable older versions of protocols
28312 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28313 .endd
28314
28315 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28316 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28317 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28318
28319 This example will let the library defaults be permitted on the MX port, where
28320 there's probably no identity verification anyway, and lowers security further
28321 by increasing compatibility; but this ups the ante on the submission ports
28322 where the administrator might have some influence on the choice of clients
28323 used:
28324 .code
28325 # GnuTLS variant
28326 tls_require_ciphers = ${if =={$received_port}{25}\
28327                            {NORMAL:%COMPAT}\
28328                            {SECURE128}}
28329 .endd
28330
28331
28332 .section "Configuring an Exim server to use TLS" "SECID182"
28333 .cindex "TLS" "configuring an Exim server"
28334 When Exim has been built with TLS support, it advertises the availability of
28335 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28336 but not to any others. The default value of this option is *, which means
28337 that STARTTLS is always advertised.  Set it to blank to never advertise;
28338 this is reasonable for systems that want to use TLS only as a client.
28339
28340 If STARTTLS is to be used you
28341 need to set some other options in order to make TLS available.
28342
28343 If a client issues a STARTTLS command and there is some configuration
28344 problem in the server, the command is rejected with a 454 error. If the client
28345 persists in trying to issue SMTP commands, all except QUIT are rejected
28346 with the error
28347 .code
28348 554 Security failure
28349 .endd
28350 If a STARTTLS command is issued within an existing TLS session, it is
28351 rejected with a 554 error code.
28352
28353 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28354 must be set to match some hosts. The default is * which matches all hosts.
28355
28356 If this is all you do, TLS encryption will be enabled but not authentication -
28357 meaning that the peer has no assurance it is actually you he is talking to.
28358 You gain protection from a passive sniffer listening on the wire but not
28359 from someone able to intercept the communication.
28360
28361 Further protection requires some further configuration at the server end.
28362
28363 To make TLS work you need to set, in the server,
28364 .code
28365 tls_certificate = /some/file/name
28366 tls_privatekey = /some/file/name
28367 .endd
28368 These options are, in fact, expanded strings, so you can make them depend on
28369 the identity of the client that is connected if you wish. The first file
28370 contains the server's X509 certificate, and the second contains the private key
28371 that goes with it. These files need to be
28372 PEM format and readable by the Exim user, and must
28373 always be given as full path names.
28374 The key must not be password-protected.
28375 They can be the same file if both the
28376 certificate and the key are contained within it. If &%tls_privatekey%& is not
28377 set, or if its expansion is forced to fail or results in an empty string, this
28378 is assumed to be the case. The certificate file may also contain intermediate
28379 certificates that need to be sent to the client to enable it to authenticate
28380 the server's certificate.
28381
28382 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28383 colon-separated lists of file paths.  Ciphers using given authentication
28384 algorithms require the presence of a suitable certificate to supply the
28385 public-key.  The server selects among the certificates to present to the
28386 client depending on the selected cipher, hence the priority ordering for
28387 ciphers will affect which certificate is used.
28388
28389 If you do not understand about certificates and keys, please try to find a
28390 source of this background information, which is not Exim-specific. (There are a
28391 few comments below in section &<<SECTcerandall>>&.)
28392
28393 &*Note*&: These options do not apply when Exim is operating as a client &--
28394 they apply only in the case of a server. If you need to use a certificate in an
28395 Exim client, you must set the options of the same names in an &(smtp)&
28396 transport.
28397
28398 With just these options, an Exim server will be able to use TLS. It does not
28399 require the client to have a certificate (but see below for how to insist on
28400 this). There is one other option that may be needed in other situations. If
28401 .code
28402 tls_dhparam = /some/file/name
28403 .endd
28404 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28405 with the parameters contained in the file.
28406 Set this to &`none`& to disable use of DH entirely, by making no prime
28407 available:
28408 .code
28409 tls_dhparam = none
28410 .endd
28411 This may also be set to a string identifying a standard prime to be used for
28412 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28413 used is &`ike23`&.  There are a few standard primes available, see the
28414 documentation for &%tls_dhparam%& for the complete list.
28415
28416 See the command
28417 .code
28418 openssl dhparam
28419 .endd
28420 for a way of generating file data.
28421
28422 The strings supplied for these three options are expanded every time a client
28423 host connects. It is therefore possible to use different certificates and keys
28424 for different hosts, if you so wish, by making use of the client's IP address
28425 in &$sender_host_address$& to control the expansion. If a string expansion is
28426 forced to fail, Exim behaves as if the option is not set.
28427
28428 .cindex "cipher" "logging"
28429 .cindex "log" "TLS cipher"
28430 .vindex "&$tls_in_cipher$&"
28431 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28432 an incoming TLS connection. It is included in the &'Received:'& header of an
28433 incoming message (by default &-- you can, of course, change this), and it is
28434 also included in the log line that records a message's arrival, keyed by
28435 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28436 condition can be used to test for specific cipher suites in ACLs.
28437
28438 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28439 can check the name of the cipher suite and vary their actions accordingly. The
28440 cipher suite names vary, depending on which TLS library is being used. For
28441 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28442 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28443 documentation for more details.
28444
28445 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28446 (again depending on the &%tls_cipher%& log selector).
28447
28448
28449 .section "Requesting and verifying client certificates" "SECID183"
28450 .cindex "certificate" "verification of client"
28451 .cindex "TLS" "client certificate verification"
28452 If you want an Exim server to request a certificate when negotiating a TLS
28453 session with a client, you must set either &%tls_verify_hosts%& or
28454 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28455 apply to all TLS connections. For any host that matches one of these options,
28456 Exim requests a certificate as part of the setup of the TLS session. The
28457 contents of the certificate are verified by comparing it with a list of
28458 expected trust-anchors or certificates.
28459 These may be the system default set (depending on library version),
28460 an explicit file or,
28461 depending on library version, a directory, identified by
28462 &%tls_verify_certificates%&.
28463
28464 A file can contain multiple certificates, concatenated end to end. If a
28465 directory is used
28466 (OpenSSL only),
28467 each certificate must be in a separate file, with a name (or a symbolic link)
28468 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28469 certificate. You can compute the relevant hash by running the command
28470 .code
28471 openssl x509 -hash -noout -in /cert/file
28472 .endd
28473 where &_/cert/file_& contains a single certificate.
28474
28475 There is no checking of names of the client against the certificate
28476 Subject Name or Subject Alternate Names.
28477
28478 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28479 what happens if the client does not supply a certificate, or if the certificate
28480 does not match any of the certificates in the collection named by
28481 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28482 attempt to set up a TLS session is aborted, and the incoming connection is
28483 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28484 session continues. ACLs that run for subsequent SMTP commands can detect the
28485 fact that no certificate was verified, and vary their actions accordingly. For
28486 example, you can insist on a certificate before accepting a message for
28487 relaying, but not when the message is destined for local delivery.
28488
28489 .vindex "&$tls_in_peerdn$&"
28490 When a client supplies a certificate (whether it verifies or not), the value of
28491 the Distinguished Name of the certificate is made available in the variable
28492 &$tls_in_peerdn$& during subsequent processing of the message.
28493
28494 .cindex "log" "distinguished name"
28495 Because it is often a long text string, it is not included in the log line or
28496 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28497 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28498 &%received_header_text%& to change the &'Received:'& header. When no
28499 certificate is supplied, &$tls_in_peerdn$& is empty.
28500
28501
28502 .section "Revoked certificates" "SECID184"
28503 .cindex "TLS" "revoked certificates"
28504 .cindex "revocation list"
28505 .cindex "certificate" "revocation list"
28506 .cindex "OCSP" "stapling"
28507 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28508 certificates are revoked. If you have such a list, you can pass it to an Exim
28509 server using the global option called &%tls_crl%& and to an Exim client using
28510 an identically named option for the &(smtp)& transport. In each case, the value
28511 of the option is expanded and must then be the name of a file that contains a
28512 CRL in PEM format.
28513 The downside is that clients have to periodically re-download a potentially huge
28514 file from every certificate authority they know of.
28515
28516 The way with most moving parts at query time is Online Certificate
28517 Status Protocol (OCSP), where the client verifies the certificate
28518 against an OCSP server run by the CA.  This lets the CA track all
28519 usage of the certs.  It requires running software with access to the
28520 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28521 is based on HTTP and can be proxied accordingly.
28522
28523 The only widespread OCSP server implementation (known to this writer)
28524 comes as part of OpenSSL and aborts on an invalid request, such as
28525 connecting to the port and then disconnecting.  This requires
28526 re-entering the passphrase each time some random client does this.
28527
28528 The third way is OCSP Stapling; in this, the server using a certificate
28529 issued by the CA periodically requests an OCSP proof of validity from
28530 the OCSP server, then serves it up inline as part of the TLS
28531 negotiation.   This approach adds no extra round trips, does not let the
28532 CA track users, scales well with number of certs issued by the CA and is
28533 resilient to temporary OCSP server failures, as long as the server
28534 starts retrying to fetch an OCSP proof some time before its current
28535 proof expires.  The downside is that it requires server support.
28536
28537 Unless Exim is built with the support disabled,
28538 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28539 support for OCSP stapling is included.
28540
28541 There is a global option called &%tls_ocsp_file%&.
28542 The file specified therein is expected to be in DER format, and contain
28543 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28544 option will be re-expanded for SNI, if the &%tls_certificate%& option
28545 contains &`tls_in_sni`&, as per other TLS options.
28546
28547 Exim does not at this time implement any support for fetching a new OCSP
28548 proof.  The burden is on the administrator to handle this, outside of
28549 Exim.  The file specified should be replaced atomically, so that the
28550 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28551 on each connection, so a new file will be handled transparently on the
28552 next connection.
28553
28554 When built with OpenSSL Exim will check for a valid next update timestamp
28555 in the OCSP proof; if not present, or if the proof has expired, it will be
28556 ignored.
28557
28558 For the client to be able to verify the stapled OCSP the server must
28559 also supply, in its stapled information, any intermediate
28560 certificates for the chain leading to the OCSP proof from the signer
28561 of the server certificate.  There may be zero or one such. These
28562 intermediate certificates should be added to the server OCSP stapling
28563 file named by &%tls_ocsp_file%&.
28564
28565 Note that the proof only covers the terminal server certificate,
28566 not any of the chain from CA to it.
28567
28568 There is no current way to staple a proof for a client certificate.
28569
28570 .code
28571   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28572   OCSP server is supplied.  The server URL may be included in the
28573   server certificate, if the CA is helpful.
28574
28575   One failure mode seen was the OCSP Signer cert expiring before the end
28576   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28577   noted this as invalid overall, but the re-fetch script did not.
28578 .endd
28579
28580
28581
28582
28583 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28584 .cindex "cipher" "logging"
28585 .cindex "log" "TLS cipher"
28586 .cindex "log" "distinguished name"
28587 .cindex "TLS" "configuring an Exim client"
28588 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28589 deliveries as well as to incoming, the latter one causing logging of the
28590 server certificate's DN. The remaining client configuration for TLS is all
28591 within the &(smtp)& transport.
28592
28593 It is not necessary to set any options to have TLS work in the &(smtp)&
28594 transport. If Exim is built with TLS support, and TLS is advertised by a
28595 server, the &(smtp)& transport always tries to start a TLS session. However,
28596 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28597 transport) to a list of server hosts for which TLS should not be used.
28598
28599 If you do not want Exim to attempt to send messages unencrypted when an attempt
28600 to set up an encrypted connection fails in any way, you can set
28601 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28602 those hosts, delivery is always deferred if an encrypted connection cannot be
28603 set up. If there are any other hosts for the address, they are tried in the
28604 usual way.
28605
28606 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28607 the message unencrypted. It always does this if the response to STARTTLS is
28608 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28609 session after a success response code, what happens is controlled by the
28610 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28611 delivery to this host is deferred, and other hosts (if available) are tried. If
28612 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28613 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28614 negotiation fails, Exim closes the current connection (because it is in an
28615 unknown state), opens a new one to the same host, and then tries the delivery
28616 unencrypted.
28617
28618 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28619 transport provide the client with a certificate, which is passed to the server
28620 if it requests it. If the server is Exim, it will request a certificate only if
28621 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28622
28623 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
28624 for client use (they are usable for server use).
28625 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
28626 in failed connections.
28627
28628 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28629 specifies a collection of expected server certificates.
28630 These may be
28631 the system default set (depending on library version),
28632 a file,
28633 or (depending on library version) a directory.
28634 The client verifies the server's certificate
28635 against this collection, taking into account any revoked certificates that are
28636 in the list defined by &%tls_crl%&.
28637 Failure to verify fails the TLS connection unless either of the
28638 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28639
28640 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28641 certificate verification to the listed servers.  Verification either must
28642 or need not succeed respectively.
28643
28644 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28645 checks are made: that the host name (the one in the DNS A record)
28646 is valid for the certificate.
28647 The option defaults to always checking.
28648
28649 The &(smtp)& transport has two OCSP-related options:
28650 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28651 is requested and required for the connection to proceed.  The default
28652 value is empty.
28653 &%hosts_request_ocsp%&; a host-list for which (additionally)
28654 a Certificate Status is requested (but not necessarily verified).  The default
28655 value is "*" meaning that requests are made unless configured
28656 otherwise.
28657
28658 The host(s) should also be in &%hosts_require_tls%&, and
28659 &%tls_verify_certificates%& configured for the transport,
28660 for OCSP to be relevant.
28661
28662 If
28663 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28664 list of permitted cipher suites. If either of these checks fails, delivery to
28665 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28666 alternative hosts, if any.
28667
28668  &*Note*&:
28669 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28670 is operating as a client. Exim does not assume that a server certificate (set
28671 by the global options of the same name) should also be used when operating as a
28672 client.
28673
28674 .vindex "&$host$&"
28675 .vindex "&$host_address$&"
28676 All the TLS options in the &(smtp)& transport are expanded before use, with
28677 &$host$& and &$host_address$& containing the name and address of the server to
28678 which the client is connected. Forced failure of an expansion causes Exim to
28679 behave as if the relevant option were unset.
28680
28681 .vindex &$tls_out_bits$&
28682 .vindex &$tls_out_cipher$&
28683 .vindex &$tls_out_peerdn$&
28684 .vindex &$tls_out_sni$&
28685 Before an SMTP connection is established, the
28686 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28687 variables are emptied. (Until the first connection, they contain the values
28688 that were set when the message was received.) If STARTTLS is subsequently
28689 successfully obeyed, these variables are set to the relevant values for the
28690 outgoing connection.
28691
28692
28693
28694 .section "Use of TLS Server Name Indication" "SECTtlssni"
28695 .cindex "TLS" "Server Name Indication"
28696 .vindex "&$tls_in_sni$&"
28697 .oindex "&%tls_in_sni%&"
28698 With TLS1.0 or above, there is an extension mechanism by which extra
28699 information can be included at various points in the protocol.  One of these
28700 extensions, documented in RFC 6066 (and before that RFC 4366) is
28701 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28702 client in the initial handshake, so that the server can examine the servername
28703 within and possibly choose to use different certificates and keys (and more)
28704 for this session.
28705
28706 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28707 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28708 address.
28709
28710 With SMTP to MX, there are the same problems here as in choosing the identity
28711 against which to validate a certificate: you can't rely on insecure DNS to
28712 provide the identity which you then cryptographically verify.  So this will
28713 be of limited use in that environment.
28714
28715 With SMTP to Submission, there is a well-defined hostname which clients are
28716 connecting to and can validate certificates against.  Thus clients &*can*&
28717 choose to include this information in the TLS negotiation.  If this becomes
28718 wide-spread, then hosters can choose to present different certificates to
28719 different clients.  Or even negotiate different cipher suites.
28720
28721 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28722 if not empty, will be sent on a TLS session as part of the handshake.  There's
28723 nothing more to it.  Choosing a sensible value not derived insecurely is the
28724 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28725 for the lifetime of the client connection (including during authentication).
28726
28727 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28728 received from a client.
28729 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28730
28731 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28732 option (prior to expansion) then the following options will be re-expanded
28733 during TLS session handshake, to permit alternative values to be chosen:
28734
28735 .ilist
28736 &%tls_certificate%&
28737 .next
28738 &%tls_crl%&
28739 .next
28740 &%tls_privatekey%&
28741 .next
28742 &%tls_verify_certificates%&
28743 .next
28744 &%tls_ocsp_file%&
28745 .endlist
28746
28747 Great care should be taken to deal with matters of case, various injection
28748 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28749 can always be referenced; it is important to remember that &$tls_in_sni$& is
28750 arbitrary unverified data provided prior to authentication.
28751 Further, the initial certificate is loaded before SNI has arrived, so
28752 an expansion for &%tls_certificate%& must have a default which is used
28753 when &$tls_in_sni$& is empty.
28754
28755 The Exim developers are proceeding cautiously and so far no other TLS options
28756 are re-expanded.
28757
28758 When Exim is built against OpenSSL, OpenSSL must have been built with support
28759 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28760 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28761 see &`-servername`& in the output, then OpenSSL has support.
28762
28763 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28764 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28765 built, then you have SNI support).
28766
28767
28768
28769 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28770          "SECTmulmessam"
28771 .cindex "multiple SMTP deliveries with TLS"
28772 .cindex "TLS" "multiple message deliveries"
28773 Exim sends multiple messages down the same TCP/IP connection by starting up
28774 an entirely new delivery process for each message, passing the socket from
28775 one process to the next. This implementation does not fit well with the use
28776 of TLS, because there is quite a lot of state information associated with a TLS
28777 connection, not just a socket identification. Passing all the state information
28778 to a new process is not feasible. Consequently, for sending using TLS Exim
28779 starts an additional proxy process for handling the encryption, piping the
28780 unencrypted data stream from and to the delivery processes.
28781
28782 An older mode of operation can be enabled on a per-host basis by the
28783 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28784 this list the proxy process described above is not used; instead Exim
28785 shuts down an existing TLS session being run by the delivery process
28786 before passing the socket to a new process. The new process may then
28787 try to start a new TLS session, and if successful, may try to re-authenticate
28788 if AUTH is in use, before sending the next message.
28789
28790 The RFC is not clear as to whether or not an SMTP session continues in clear
28791 after TLS has been shut down, or whether TLS may be restarted again later, as
28792 just described. However, if the server is Exim, this shutdown and
28793 reinitialization works. It is not known which (if any) other servers operate
28794 successfully if the client closes a TLS session and continues with unencrypted
28795 SMTP, but there are certainly some that do not work. For such servers, Exim
28796 should not pass the socket to another process, because the failure of the
28797 subsequent attempt to use it would cause Exim to record a temporary host error,
28798 and delay other deliveries to that host.
28799
28800 To test for this case, Exim sends an EHLO command to the server after
28801 closing down the TLS session. If this fails in any way, the connection is
28802 closed instead of being passed to a new delivery process, but no retry
28803 information is recorded.
28804
28805 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28806 &(smtp)& transport to match those hosts for which Exim should not pass
28807 connections to new processes if TLS has been used.
28808
28809
28810
28811
28812 .section "Certificates and all that" "SECTcerandall"
28813 .cindex "certificate" "references to discussion"
28814 In order to understand fully how TLS works, you need to know about
28815 certificates, certificate signing, and certificate authorities.
28816 This is a large topic and an introductory guide is unsuitable for the Exim
28817 reference manual, so instead we provide pointers to existing documentation.
28818
28819 The Apache web-server was for a long time the canonical guide, so their
28820 documentation is a good place to start; their SSL module's Introduction
28821 document is currently at
28822 .display
28823 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28824 .endd
28825 and their FAQ is at
28826 .display
28827 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28828 .endd
28829
28830 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28831 0-201-61598-3) in 2001, contains both introductory and more in-depth
28832 descriptions.
28833 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28834 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28835 Ivan is the author of the popular TLS testing tools at
28836 &url(https://www.ssllabs.com/).
28837
28838
28839 .section "Certificate chains" "SECID186"
28840 The file named by &%tls_certificate%& may contain more than one
28841 certificate. This is useful in the case where the certificate that is being
28842 sent is validated by an intermediate certificate which the other end does
28843 not have. Multiple certificates must be in the correct order in the file.
28844 First the host's certificate itself, then the first intermediate
28845 certificate to validate the issuer of the host certificate, then the next
28846 intermediate certificate to validate the issuer of the first intermediate
28847 certificate, and so on, until finally (optionally) the root certificate.
28848 The root certificate must already be trusted by the recipient for
28849 validation to succeed, of course, but if it's not preinstalled, sending the
28850 root certificate along with the rest makes it available for the user to
28851 install if the receiving end is a client MUA that can interact with a user.
28852
28853 Note that certificates using MD5 are unlikely to work on today's Internet;
28854 even if your libraries allow loading them for use in Exim when acting as a
28855 server, increasingly clients will not accept such certificates.  The error
28856 diagnostics in such a case can be frustratingly vague.
28857
28858
28859
28860 .section "Self-signed certificates" "SECID187"
28861 .cindex "certificate" "self-signed"
28862 You can create a self-signed certificate using the &'req'& command provided
28863 with OpenSSL, like this:
28864 . ==== Do not shorten the duration here without reading and considering
28865 . ==== the text below.  Please leave it at 9999 days.
28866 .code
28867 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28868             -days 9999 -nodes
28869 .endd
28870 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28871 delimited and so can be identified independently. The &%-days%& option
28872 specifies a period for which the certificate is valid. The &%-nodes%& option is
28873 important: if you do not set it, the key is encrypted with a passphrase
28874 that you are prompted for, and any use that is made of the key causes more
28875 prompting for the passphrase. This is not helpful if you are going to use
28876 this certificate and key in an MTA, where prompting is not possible.
28877
28878 . ==== I expect to still be working 26 years from now.  The less technical
28879 . ==== debt I create, in terms of storing up trouble for my later years, the
28880 . ==== happier I will be then.  We really have reached the point where we
28881 . ==== should start, at the very least, provoking thought and making folks
28882 . ==== pause before proceeding, instead of leaving all the fixes until two
28883 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28884 . ==== -pdp, 2012
28885 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28886 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28887 the above command might produce a date in the past.  Think carefully about
28888 the lifetime of the systems you're deploying, and either reduce the duration
28889 of the certificate or reconsider your platform deployment.  (At time of
28890 writing, reducing the duration is the most likely choice, but the inexorable
28891 progression of time takes us steadily towards an era where this will not
28892 be a sensible resolution).
28893
28894 A self-signed certificate made in this way is sufficient for testing, and
28895 may be adequate for all your requirements if you are mainly interested in
28896 encrypting transfers, and not in secure identification.
28897
28898 However, many clients require that the certificate presented by the server be a
28899 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28900 certificate. In this situation, the self-signed certificate described above
28901 must be installed on the client host as a trusted root &'certification
28902 authority'& (CA), and the certificate used by Exim must be a user certificate
28903 signed with that self-signed certificate.
28904
28905 For information on creating self-signed CA certificates and using them to sign
28906 user certificates, see the &'General implementation overview'& chapter of the
28907 Open-source PKI book, available online at
28908 &url(https://sourceforge.net/projects/ospkibook/).
28909 .ecindex IIDencsmtp1
28910 .ecindex IIDencsmtp2
28911
28912
28913
28914 .section DANE "SECDANE"
28915 .cindex DANE
28916 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28917 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28918 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28919 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28920 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28921 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28922
28923 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28924 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28925 by (a) is thought to be smaller than that of the set of root CAs.
28926
28927 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28928 fail to pass on a server's STARTTLS.
28929
28930 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28931 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28932 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28933
28934 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28935 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28936 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28937 DNSSEC.
28938 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28939 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28940
28941 There are no changes to Exim specific to server-side operation of DANE.
28942 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28943 in &_Local/Makefile_&.
28944 If it has been included, the macro "_HAVE_DANE" will be defined.
28945
28946 A TLSA record consist of 4 fields, the "Certificate Usage", the
28947 "Selector", the "Matching type", and the "Certificate Association Data".
28948 For a detailed description of the TLSA record see
28949 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
28950
28951 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
28952 These are the "Trust Anchor" and "End Entity" variants.
28953 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28954 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28955 this is appropriate for a single system, using a self-signed certificate.
28956 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28957 well-known one.
28958 A private CA at simplest is just a self-signed certificate (with certain
28959 attributes) which is used to sign server certificates, but running one securely
28960 does require careful arrangement.
28961 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28962 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28963 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28964 all of which point to a single TLSA record.
28965 DANE-TA and DANE-EE can both be used together.
28966
28967 Our recommendation is to use DANE with a certificate from a public CA,
28968 because this enables a variety of strategies for remote clients to verify
28969 your certificate.
28970 You can then publish information both via DANE and another technology,
28971 "MTA-STS", described below.
28972
28973 When you use DANE-TA to publish trust anchor information, you ask entities
28974 outside your administrative control to trust the Certificate Authority for
28975 connections to you.
28976 If using a private CA then you should expect others to still apply the
28977 technical criteria they'd use for a public CA to your certificates.
28978 In particular, you should probably try to follow current best practices for CA
28979 operation around hash algorithms and key sizes.
28980 Do not expect other organizations to lower their security expectations just
28981 because a particular profile might be reasonable for your own internal use.
28982
28983 When this text was last updated, this in practice means to avoid use of SHA-1
28984 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28985 than 4096, for interoperability); to use keyUsage fields correctly; to use
28986 random serial numbers.
28987 The list of requirements is subject to change as best practices evolve.
28988 If you're not already using a private CA, or it doesn't meet these
28989 requirements, then we encourage you to avoid all these issues and use a public
28990 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28991
28992 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
28993 a "Matching Type" (3rd) field of SHA2-512(2).
28994
28995 For the "Certificate Authority Data" (4th) field, commands like
28996
28997 .code
28998   openssl x509 -pubkey -noout <certificate.pem \
28999   | openssl rsa -outform der -pubin 2>/dev/null \
29000   | openssl sha512 \
29001   | awk '{print $2}'
29002 .endd
29003
29004 are workable to create a hash of the certificate's public key.
29005
29006 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29007
29008 .code
29009   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29010 .endd
29011
29012 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29013 is useful for quickly generating TLSA records.
29014
29015
29016 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29017
29018 The Certificate issued by the CA published in the DANE-TA model should be
29019 issued using a strong hash algorithm.
29020 Exim, and importantly various other MTAs sending to you, will not
29021 re-enable hash algorithms which have been disabled by default in TLS
29022 libraries.
29023 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29024 interoperability (and probably the maximum too, in 2018).
29025
29026 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29027 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29028 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29029
29030 .code
29031   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29032                                  {= {4}{$tls_out_tlsa_usage}} } \
29033                          {*}{}}
29034 .endd
29035
29036 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29037 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29038 found. If the definition of &%hosts_request_ocsp%& includes the
29039 string "tls_out_tlsa_usage", they are re-expanded in time to
29040 control the OCSP request.
29041
29042 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29043 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29044
29045
29046 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29047 and &%dane_require_tls_ciphers%&.
29048 The &"require"& variant will result in failure if the target host is not
29049 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29050 the &%dnssec_request_domains%& router or transport option.
29051
29052 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29053
29054 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29055 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29056 will be required for the host.  If it does not, the host will not
29057 be used; there is no fallback to non-DANE or non-TLS.
29058
29059 If DANE is requested and usable, then the TLS cipher list configuration
29060 prefers to use the option &%dane_require_tls_ciphers%& and falls
29061 back to &%tls_require_ciphers%& only if that is unset.
29062 This lets you configure "decent crypto" for DANE and "better than nothing
29063 crypto" as the default.  Note though that while GnuTLS lets the string control
29064 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29065 limited to ciphersuite constraints.
29066
29067 If DANE is requested and useable (see above) the following transport options are ignored:
29068 .code
29069   hosts_require_tls
29070   tls_verify_hosts
29071   tls_try_verify_hosts
29072   tls_verify_certificates
29073   tls_crl
29074   tls_verify_cert_hostnames
29075 .endd
29076
29077 If DANE is not usable, whether requested or not, and CA-anchored
29078 verification evaluation is wanted, the above variables should be set appropriately.
29079
29080 The router and transport option &%dnssec_request_domains%& must not be
29081 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29082
29083 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29084
29085 There is a new variable &$tls_out_dane$& which will have "yes" if
29086 verification succeeded using DANE and "no" otherwise (only useful
29087 in combination with events; see &<<CHAPevents>>&),
29088 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29089
29090 .cindex DANE reporting
29091 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29092 to achieve DANE-verified connection, if one was either requested and offered, or
29093 required.  This is intended to support TLS-reporting as defined in
29094 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29095 The &$event_data$& will be one of the Result Types defined in
29096 Section 4.3 of that document.
29097
29098 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29099
29100 DANE is specified in published RFCs and decouples certificate authority trust
29101 selection from a "race to the bottom" of "you must trust everything for mail
29102 to get through".  There is an alternative technology called MTA-STS, which
29103 instead publishes MX trust anchor information on an HTTPS website.  At the
29104 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29105 Exim has no support for MTA-STS as a client, but Exim mail server operators
29106 can choose to publish information describing their TLS configuration using
29107 MTA-STS to let those clients who do use that protocol derive trust
29108 information.
29109
29110 The MTA-STS design requires a certificate from a public Certificate Authority
29111 which is recognized by clients sending to you.
29112 That selection of which CAs are trusted by others is outside your control.
29113
29114 The most interoperable course of action is probably to use
29115 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29116 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29117 records for DANE clients (such as Exim and Postfix) and to publish anchor
29118 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29119 domain itself (with caveats around occasionally broken MTA-STS because of
29120 incompatible specification changes prior to reaching RFC status).
29121
29122
29123
29124 . ////////////////////////////////////////////////////////////////////////////
29125 . ////////////////////////////////////////////////////////////////////////////
29126
29127 .chapter "Access control lists" "CHAPACL"
29128 .scindex IIDacl "&ACL;" "description"
29129 .cindex "control of incoming mail"
29130 .cindex "message" "controlling incoming"
29131 .cindex "policy control" "access control lists"
29132 Access Control Lists (ACLs) are defined in a separate section of the runtime
29133 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29134 name, terminated by a colon. Here is a complete ACL section that contains just
29135 one very small ACL:
29136 .code
29137 begin acl
29138 small_acl:
29139   accept   hosts = one.host.only
29140 .endd
29141 You can have as many lists as you like in the ACL section, and the order in
29142 which they appear does not matter. The lists are self-terminating.
29143
29144 The majority of ACLs are used to control Exim's behaviour when it receives
29145 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29146 when a local process submits a message using SMTP by specifying the &%-bs%&
29147 option. The most common use is for controlling which recipients are accepted
29148 in incoming messages. In addition, you can define an ACL that is used to check
29149 local non-SMTP messages. The default configuration file contains an example of
29150 a realistic ACL for checking RCPT commands. This is discussed in chapter
29151 &<<CHAPdefconfil>>&.
29152
29153
29154 .section "Testing ACLs" "SECID188"
29155 The &%-bh%& command line option provides a way of testing your ACL
29156 configuration locally by running a fake SMTP session with which you interact.
29157
29158
29159 .section "Specifying when ACLs are used" "SECID189"
29160 .cindex "&ACL;" "options for specifying"
29161 In order to cause an ACL to be used, you have to name it in one of the relevant
29162 options in the main part of the configuration. These options are:
29163 .cindex "AUTH" "ACL for"
29164 .cindex "DATA" "ACLs for"
29165 .cindex "ETRN" "ACL for"
29166 .cindex "EXPN" "ACL for"
29167 .cindex "HELO" "ACL for"
29168 .cindex "EHLO" "ACL for"
29169 .cindex "DKIM" "ACL for"
29170 .cindex "MAIL" "ACL for"
29171 .cindex "QUIT, ACL for"
29172 .cindex "RCPT" "ACL for"
29173 .cindex "STARTTLS, ACL for"
29174 .cindex "VRFY" "ACL for"
29175 .cindex "SMTP" "connection, ACL for"
29176 .cindex "non-SMTP messages" "ACLs for"
29177 .cindex "MIME content scanning" "ACL for"
29178 .cindex "PRDR" "ACL for"
29179
29180 .table2 140pt
29181 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29182 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29183 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29184 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29185 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29186 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29187 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29188 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29189 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29190 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29191 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29192 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29193 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29194 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29195 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29196 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29197 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29198 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29199 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29200 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29201 .endtable
29202
29203 For example, if you set
29204 .code
29205 acl_smtp_rcpt = small_acl
29206 .endd
29207 the little ACL defined above is used whenever Exim receives a RCPT command
29208 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29209 done when RCPT commands arrive. A rejection of RCPT should cause the
29210 sending MTA to give up on the recipient address contained in the RCPT
29211 command, whereas rejection at other times may cause the client MTA to keep on
29212 trying to deliver the message. It is therefore recommended that you do as much
29213 testing as possible at RCPT time.
29214
29215
29216 .section "The non-SMTP ACLs" "SECID190"
29217 .cindex "non-SMTP messages" "ACLs for"
29218 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29219 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29220 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29221 the state of the SMTP connection such as encryption and authentication) are not
29222 relevant and are forbidden in these ACLs. However, the sender and recipients
29223 are known, so the &%senders%& and &%sender_domains%& conditions and the
29224 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29225 &$authenticated_sender$& are also available. You can specify added header lines
29226 in any of these ACLs.
29227
29228 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29229 non-SMTP message, before any of the message has been read. (This is the
29230 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29231 batched SMTP input, it runs after the DATA command has been reached. The
29232 result of this ACL is ignored; it cannot be used to reject a message. If you
29233 really need to, you could set a value in an ACL variable here and reject based
29234 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29235 controls, and in particular, it can be used to set
29236 .code
29237 control = suppress_local_fixups
29238 .endd
29239 This cannot be used in the other non-SMTP ACLs because by the time they are
29240 run, it is too late.
29241
29242 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29243 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29244
29245 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29246 kind of rejection is treated as permanent, because there is no way of sending a
29247 temporary error for these kinds of message.
29248
29249
29250 .section "The SMTP connect ACL" "SECID191"
29251 .cindex "SMTP" "connection, ACL for"
29252 .oindex &%smtp_banner%&
29253 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29254 session, after the test specified by &%host_reject_connection%& (which is now
29255 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29256 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29257 the message override the banner message that is otherwise specified by the
29258 &%smtp_banner%& option.
29259
29260
29261 .section "The EHLO/HELO ACL" "SECID192"
29262 .cindex "EHLO" "ACL for"
29263 .cindex "HELO" "ACL for"
29264 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29265 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29266 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29267 Note that a client may issue more than one EHLO or HELO command in an SMTP
29268 session, and indeed is required to issue a new EHLO or HELO after successfully
29269 setting up encryption following a STARTTLS command.
29270
29271 Note also that a deny neither forces the client to go away nor means that
29272 mail will be refused on the connection.  Consider checking for
29273 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29274
29275 If the command is accepted by an &%accept%& verb that has a &%message%&
29276 modifier, the message may not contain more than one line (it will be truncated
29277 at the first newline and a panic logged if it does). Such a message cannot
29278 affect the EHLO options that are listed on the second and subsequent lines of
29279 an EHLO response.
29280
29281
29282 .section "The DATA ACLs" "SECID193"
29283 .cindex "DATA" "ACLs for"
29284 Two ACLs are associated with the DATA command, because it is two-stage
29285 command, with two responses being sent to the client.
29286 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29287 is obeyed. This gives you control after all the RCPT commands, but before
29288 the message itself is received. It offers the opportunity to give a negative
29289 response to the DATA command before the data is transmitted. Header lines
29290 added by MAIL or RCPT ACLs are not visible at this time, but any that
29291 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29292
29293 You cannot test the contents of the message, for example, to verify addresses
29294 in the headers, at RCPT time or when the DATA command is received. Such
29295 tests have to appear in the ACL that is run after the message itself has been
29296 received, before the final response to the DATA command is sent. This is
29297 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29298 associated with the DATA command.
29299
29300 .cindex CHUNKING "BDAT command"
29301 .cindex BDAT "SMTP command"
29302 .cindex "RFC 3030" CHUNKING
29303 If CHUNKING was advertised and a BDAT command sequence is received,
29304 the &%acl_smtp_predata%& ACL is not run.
29305 . XXX why not?  It should be possible, for the first BDAT.
29306 The &%acl_smtp_data%& is run after the last BDAT command and all of
29307 the data specified is received.
29308
29309 For both of these ACLs, it is not possible to reject individual recipients. An
29310 error response rejects the entire message. Unfortunately, it is known that some
29311 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29312 before or after the data) correctly &-- they keep the message on their queues
29313 and try again later, but that is their problem, though it does waste some of
29314 your resources.
29315
29316 The &%acl_smtp_data%& ACL is run after
29317 the &%acl_smtp_data_prdr%&,
29318 the &%acl_smtp_dkim%&
29319 and the &%acl_smtp_mime%& ACLs.
29320
29321 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29322 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29323 enabled (which is the default).
29324
29325 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29326 received, and is executed for each DKIM signature found in a message.  If not
29327 otherwise specified, the default action is to accept.
29328
29329 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29330
29331 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29332
29333
29334 .section "The SMTP MIME ACL" "SECID194"
29335 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29336 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29337
29338 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29339
29340
29341 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29342 .cindex "PRDR" "ACL for"
29343 .oindex "&%prdr_enable%&"
29344 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29345 with PRDR support enabled (which is the default).
29346 It becomes active only when the PRDR feature is negotiated between
29347 client and server for a message, and more than one recipient
29348 has been accepted.
29349
29350 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29351 has been received, and is executed once for each recipient of the message
29352 with &$local_part$& and &$domain$& valid.
29353 The test may accept, defer or deny for individual recipients.
29354 The &%acl_smtp_data%& will still be called after this ACL and
29355 can reject the message overall, even if this ACL has accepted it
29356 for some or all recipients.
29357
29358 PRDR may be used to support per-user content filtering.  Without it
29359 one must defer any recipient after the first that has a different
29360 content-filter configuration.  With PRDR, the RCPT-time check
29361 .cindex "PRDR" "variable for"
29362 for this can be disabled when the variable &$prdr_requested$&
29363 is &"yes"&.
29364 Any required difference in behaviour of the main DATA-time
29365 ACL should however depend on the PRDR-time ACL having run, as Exim
29366 will avoid doing so in some situations (e.g. single-recipient mails).
29367
29368 See also the &%prdr_enable%& global option
29369 and the &%hosts_try_prdr%& smtp transport option.
29370
29371 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29372 If the ACL is not defined, processing completes as if
29373 the feature was not requested by the client.
29374
29375 .section "The QUIT ACL" "SECTQUITACL"
29376 .cindex "QUIT, ACL for"
29377 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29378 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29379 does not in fact control any access.
29380 For this reason, it may only accept
29381 or warn as its final result.
29382
29383 This ACL can be used for tasks such as custom logging at the end of an SMTP
29384 session. For example, you can use ACL variables in other ACLs to count
29385 messages, recipients, etc., and log the totals at QUIT time using one or
29386 more &%logwrite%& modifiers on a &%warn%& verb.
29387
29388 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29389 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29390
29391 You do not need to have a final &%accept%&, but if you do, you can use a
29392 &%message%& modifier to specify custom text that is sent as part of the 221
29393 response to QUIT.
29394
29395 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29396 failure (for example, failure to open a log file, or when Exim is bombing out
29397 because it has detected an unrecoverable error), all SMTP commands from the
29398 client are given temporary error responses until QUIT is received or the
29399 connection is closed. In these special cases, the QUIT ACL does not run.
29400
29401
29402 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29403 .vindex &$acl_smtp_notquit$&
29404 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29405 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29406 trouble, such as being unable to write to its log files, this ACL is not run,
29407 because it might try to do things (such as write to log files) that make the
29408 situation even worse.
29409
29410 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29411 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29412 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29413 and &%warn%&.
29414
29415 .vindex &$smtp_notquit_reason$&
29416 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29417 to a string that indicates the reason for the termination of the SMTP
29418 connection. The possible values are:
29419 .table2
29420 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29421 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29422 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29423 .irow &`connection-lost`&          "The SMTP connection has been lost"
29424 .irow &`data-timeout`&             "Timeout while reading message data"
29425 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29426 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29427 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29428 .irow &`synchronization-error`&    "SMTP synchronization error"
29429 .irow &`tls-failed`&               "TLS failed to start"
29430 .endtable
29431 In most cases when an SMTP connection is closed without having received QUIT,
29432 Exim sends an SMTP response message before actually closing the connection.
29433 With the exception of the &`acl-drop`& case, the default message can be
29434 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29435 &%drop%& verb in another ACL, it is the message from the other ACL that is
29436 used.
29437
29438
29439 .section "Finding an ACL to use" "SECID195"
29440 .cindex "&ACL;" "finding which to use"
29441 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29442 you can use different ACLs in different circumstances. For example,
29443 .code
29444 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29445                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29446 .endd
29447 In the default configuration file there are some example settings for
29448 providing an RFC 4409 message &"submission"& service on port 587 and
29449 an RFC 8314 &"submissions"& service on port 465. You can use a string
29450 expansion like this to choose an ACL for MUAs on these ports which is
29451 more appropriate for this purpose than the default ACL on port 25.
29452
29453 The expanded string does not have to be the name of an ACL in the
29454 configuration file; there are other possibilities. Having expanded the
29455 string, Exim searches for an ACL as follows:
29456
29457 .ilist
29458 If the string begins with a slash, Exim uses it as a filename, and reads its
29459 contents as an ACL. The lines are processed in the same way as lines in the
29460 Exim configuration file. In particular, continuation lines are supported, blank
29461 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29462 If the file does not exist or cannot be read, an error occurs (typically
29463 causing a temporary failure of whatever caused the ACL to be run). For example:
29464 .code
29465 acl_smtp_data = /etc/acls/\
29466   ${lookup{$sender_host_address}lsearch\
29467   {/etc/acllist}{$value}{default}}
29468 .endd
29469 This looks up an ACL file to use on the basis of the host's IP address, falling
29470 back to a default if the lookup fails. If an ACL is successfully read from a
29471 file, it is retained in memory for the duration of the Exim process, so that it
29472 can be re-used without having to re-read the file.
29473 .next
29474 If the string does not start with a slash, and does not contain any spaces,
29475 Exim searches the ACL section of the configuration for an ACL whose name
29476 matches the string.
29477 .next
29478 If no named ACL is found, or if the string contains spaces, Exim parses
29479 the string as an inline ACL. This can save typing in cases where you just
29480 want to have something like
29481 .code
29482 acl_smtp_vrfy = accept
29483 .endd
29484 in order to allow free use of the VRFY command. Such a string may contain
29485 newlines; it is processed in the same way as an ACL that is read from a file.
29486 .endlist
29487
29488
29489
29490
29491 .section "ACL return codes" "SECID196"
29492 .cindex "&ACL;" "return codes"
29493 Except for the QUIT ACL, which does not affect the SMTP return code (see
29494 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29495 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29496 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29497 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29498 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29499 This also causes a 4&'xx'& return code.
29500
29501 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29502 &"deny"&, because there is no mechanism for passing temporary errors to the
29503 submitters of non-SMTP messages.
29504
29505
29506 ACLs that are relevant to message reception may also return &"discard"&. This
29507 has the effect of &"accept"&, but causes either the entire message or an
29508 individual recipient address to be discarded. In other words, it is a
29509 blackholing facility. Use it with care.
29510
29511 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29512 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29513 RCPT ACL is to discard just the one recipient address. If there are no
29514 recipients left when the message's data is received, the DATA ACL is not
29515 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29516 remaining recipients. The &"discard"& return is not permitted for the
29517 &%acl_smtp_predata%& ACL.
29518
29519 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29520 is done on the address and the result determines the SMTP response.
29521
29522
29523 .cindex "&[local_scan()]& function" "when all recipients discarded"
29524 The &[local_scan()]& function is always run, even if there are no remaining
29525 recipients; it may create new recipients.
29526
29527
29528
29529 .section "Unset ACL options" "SECID197"
29530 .cindex "&ACL;" "unset options"
29531 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29532 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29533 not defined at all. For any defined ACL, the default action when control
29534 reaches the end of the ACL statements is &"deny"&.
29535
29536 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29537 these two are ACLs that are used only for their side effects. They cannot be
29538 used to accept or reject anything.
29539
29540 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29541 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29542 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29543 when the ACL is not defined is &"accept"&.
29544
29545 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29546 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29547 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29548 messages over an SMTP connection. For an example, see the ACL in the default
29549 configuration file.
29550
29551
29552
29553
29554 .section "Data for message ACLs" "SECID198"
29555 .cindex "&ACL;" "data for message ACL"
29556 .vindex &$domain$&
29557 .vindex &$local_part$&
29558 .vindex &$sender_address$&
29559 .vindex &$sender_host_address$&
29560 .vindex &$smtp_command$&
29561 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29562 that contain information about the host and the message's sender (for example,
29563 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29564 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29565 &$local_part$& are set from the argument address. The entire SMTP command
29566 is available in &$smtp_command$&.
29567
29568 When an ACL for the AUTH parameter of MAIL is running, the variables that
29569 contain information about the host are set, but &$sender_address$& is not yet
29570 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29571 how it is used.
29572
29573 .vindex "&$message_size$&"
29574 The &$message_size$& variable is set to the value of the SIZE parameter on
29575 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29576 that parameter is not given. The value is updated to the true message size by
29577 the time the final DATA ACL is run (after the message data has been
29578 received).
29579
29580 .vindex "&$rcpt_count$&"
29581 .vindex "&$recipients_count$&"
29582 The &$rcpt_count$& variable increases by one for each RCPT command received.
29583 The &$recipients_count$& variable increases by one each time a RCPT command is
29584 accepted, so while an ACL for RCPT is being processed, it contains the number
29585 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29586 &$rcpt_count$& contains the total number of RCPT commands, and
29587 &$recipients_count$& contains the total number of accepted recipients.
29588
29589
29590
29591
29592
29593 .section "Data for non-message ACLs" "SECTdatfornon"
29594 .cindex "&ACL;" "data for non-message ACL"
29595 .vindex &$smtp_command_argument$&
29596 .vindex &$smtp_command$&
29597 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29598 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29599 and the entire SMTP command is available in &$smtp_command$&.
29600 These variables can be tested using a &%condition%& condition. For example,
29601 here is an ACL for use with AUTH, which insists that either the session is
29602 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29603 does not permit authentication methods that use cleartext passwords on
29604 unencrypted connections.
29605 .code
29606 acl_check_auth:
29607   accept encrypted = *
29608   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29609                      {CRAM-MD5}}
29610   deny   message   = TLS encryption or CRAM-MD5 required
29611 .endd
29612 (Another way of applying this restriction is to arrange for the authenticators
29613 that use cleartext passwords not to be advertised when the connection is not
29614 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29615 option to do this.)
29616
29617
29618
29619 .section "Format of an ACL" "SECID199"
29620 .cindex "&ACL;" "format of"
29621 .cindex "&ACL;" "verbs, definition of"
29622 An individual ACL consists of a number of statements. Each statement starts
29623 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29624 Modifiers can change the way the verb operates, define error and log messages,
29625 set variables, insert delays, and vary the processing of accepted messages.
29626
29627 If all the conditions are met, the verb is obeyed. The same condition may be
29628 used (with different arguments) more than once in the same statement. This
29629 provides a means of specifying an &"and"& conjunction between conditions. For
29630 example:
29631 .code
29632 deny  dnslists = list1.example
29633       dnslists = list2.example
29634 .endd
29635 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29636 the conditions and modifiers when it reaches a condition that fails. What
29637 happens then depends on the verb (and in one case, on a special modifier). Not
29638 all the conditions make sense at every testing point. For example, you cannot
29639 test a sender address in the ACL that is run for a VRFY command.
29640
29641
29642 .section "ACL verbs" "SECID200"
29643 The ACL verbs are as follows:
29644
29645 .ilist
29646 .cindex "&%accept%& ACL verb"
29647 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29648 of the conditions are not met, what happens depends on whether &%endpass%&
29649 appears among the conditions (for syntax see below). If the failing condition
29650 is before &%endpass%&, control is passed to the next ACL statement; if it is
29651 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29652 check a RCPT command:
29653 .code
29654 accept domains = +local_domains
29655        endpass
29656        verify = recipient
29657 .endd
29658 If the recipient domain does not match the &%domains%& condition, control
29659 passes to the next statement. If it does match, the recipient is verified, and
29660 the command is accepted if verification succeeds. However, if verification
29661 fails, the ACL yields &"deny"&, because the failing condition is after
29662 &%endpass%&.
29663
29664 The &%endpass%& feature has turned out to be confusing to many people, so its
29665 use is not recommended nowadays. It is always possible to rewrite an ACL so
29666 that &%endpass%& is not needed, and it is no longer used in the default
29667 configuration.
29668
29669 .cindex "&%message%& ACL modifier" "with &%accept%&"
29670 If a &%message%& modifier appears on an &%accept%& statement, its action
29671 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29672 (when an &%accept%& verb either accepts or passes control to the next
29673 statement), &%message%& can be used to vary the message that is sent when an
29674 SMTP command is accepted. For example, in a RCPT ACL you could have:
29675 .display
29676 &`accept  `&<&'some conditions'&>
29677 &`        message = OK, I will allow you through today`&
29678 .endd
29679 You can specify an SMTP response code, optionally followed by an &"extended
29680 response code"& at the start of the message, but the first digit must be the
29681 same as would be sent by default, which is 2 for an &%accept%& verb.
29682
29683 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29684 an error message that is used when access is denied. This behaviour is retained
29685 for backward compatibility, but current &"best practice"& is to avoid the use
29686 of &%endpass%&.
29687
29688
29689 .next
29690 .cindex "&%defer%& ACL verb"
29691 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29692 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29693 &%defer%& is the same as &%deny%&, because there is no way of sending a
29694 temporary error. For a RCPT command, &%defer%& is much the same as using a
29695 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29696 be used in any ACL, and even for a recipient it might be a simpler approach.
29697
29698
29699 .next
29700 .cindex "&%deny%& ACL verb"
29701 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29702 the conditions are not met, control is passed to the next ACL statement. For
29703 example,
29704 .code
29705 deny dnslists = blackholes.mail-abuse.org
29706 .endd
29707 rejects commands from hosts that are on a DNS black list.
29708
29709
29710 .next
29711 .cindex "&%discard%& ACL verb"
29712 &%discard%&: This verb behaves like &%accept%&, except that it returns
29713 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29714 that are concerned with receiving messages. When all the conditions are true,
29715 the sending entity receives a &"success"& response. However, &%discard%& causes
29716 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29717 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29718 message's recipients are discarded. Recipients that are discarded before DATA
29719 do not appear in the log line when the &%received_recipients%& log selector is set.
29720
29721 If the &%log_message%& modifier is set when &%discard%& operates,
29722 its contents are added to the line that is automatically written to the log.
29723 The &%message%& modifier operates exactly as it does for &%accept%&.
29724
29725
29726 .next
29727 .cindex "&%drop%& ACL verb"
29728 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29729 forcibly closed after the 5&'xx'& error message has been sent. For example:
29730 .code
29731 drop   message   = I don't take more than 20 RCPTs
29732        condition = ${if > {$rcpt_count}{20}}
29733 .endd
29734 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29735 The connection is always dropped after sending a 550 response.
29736
29737 .next
29738 .cindex "&%require%& ACL verb"
29739 &%require%&: If all the conditions are met, control is passed to the next ACL
29740 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29741 example, when checking a RCPT command,
29742 .code
29743 require message = Sender did not verify
29744         verify  = sender
29745 .endd
29746 passes control to subsequent statements only if the message's sender can be
29747 verified. Otherwise, it rejects the command. Note the positioning of the
29748 &%message%& modifier, before the &%verify%& condition. The reason for this is
29749 discussed in section &<<SECTcondmodproc>>&.
29750
29751 .next
29752 .cindex "&%warn%& ACL verb"
29753 &%warn%&: If all the conditions are true, a line specified by the
29754 &%log_message%& modifier is written to Exim's main log. Control always passes
29755 to the next ACL statement. If any condition is false, the log line is not
29756 written. If an identical log line is requested several times in the same
29757 message, only one copy is actually written to the log. If you want to force
29758 duplicates to be written, use the &%logwrite%& modifier instead.
29759
29760 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29761 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29762 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29763 first failing condition. There is more about adding header lines in section
29764 &<<SECTaddheadacl>>&.
29765
29766 If any condition on a &%warn%& statement cannot be completed (that is, there is
29767 some sort of defer), the log line specified by &%log_message%& is not written.
29768 This does not include the case of a forced failure from a lookup, which
29769 is considered to be a successful completion. After a defer, no further
29770 conditions or modifiers in the &%warn%& statement are processed. The incident
29771 is logged, and the ACL continues to be processed, from the next statement
29772 onwards.
29773
29774
29775 .vindex "&$acl_verify_message$&"
29776 When one of the &%warn%& conditions is an address verification that fails, the
29777 text of the verification failure message is in &$acl_verify_message$&. If you
29778 want this logged, you must set it up explicitly. For example:
29779 .code
29780 warn   !verify = sender
29781        log_message = sender verify failed: $acl_verify_message
29782 .endd
29783 .endlist
29784
29785 At the end of each ACL there is an implicit unconditional &%deny%&.
29786
29787 As you can see from the examples above, the conditions and modifiers are
29788 written one to a line, with the first one on the same line as the verb, and
29789 subsequent ones on following lines. If you have a very long condition, you can
29790 continue it onto several physical lines by the usual backslash continuation
29791 mechanism. It is conventional to align the conditions vertically.
29792
29793
29794
29795 .section "ACL variables" "SECTaclvariables"
29796 .cindex "&ACL;" "variables"
29797 There are some special variables that can be set during ACL processing. They
29798 can be used to pass information between different ACLs, different invocations
29799 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29800 transports, and filters that are used to deliver a message. The names of these
29801 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29802 an underscore, but the remainder of the name can be any sequence of
29803 alphanumeric characters and underscores that you choose. There is no limit on
29804 the number of ACL variables. The two sets act as follows:
29805 .ilist
29806 The values of those variables whose names begin with &$acl_c$& persist
29807 throughout an SMTP connection. They are never reset. Thus, a value that is set
29808 while receiving one message is still available when receiving the next message
29809 on the same SMTP connection.
29810 .next
29811 The values of those variables whose names begin with &$acl_m$& persist only
29812 while a message is being received. They are reset afterwards. They are also
29813 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29814 .endlist
29815
29816 When a message is accepted, the current values of all the ACL variables are
29817 preserved with the message and are subsequently made available at delivery
29818 time. The ACL variables are set by a modifier called &%set%&. For example:
29819 .code
29820 accept hosts = whatever
29821        set acl_m4 = some value
29822 accept authenticated = *
29823        set acl_c_auth = yes
29824 .endd
29825 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29826 be set. If you want to set a variable without taking any action, you can use a
29827 &%warn%& verb without any other modifiers or conditions.
29828
29829 .oindex &%strict_acl_vars%&
29830 What happens if a syntactically valid but undefined ACL variable is
29831 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29832 false (the default), an empty string is substituted; if it is true, an
29833 error is generated.
29834
29835 Versions of Exim before 4.64 have a limited set of numbered variables, but
29836 their names are compatible, so there is no problem with upgrading.
29837
29838
29839 .section "Condition and modifier processing" "SECTcondmodproc"
29840 .cindex "&ACL;" "conditions; processing"
29841 .cindex "&ACL;" "modifiers; processing"
29842 An exclamation mark preceding a condition negates its result. For example:
29843 .code
29844 deny   domains = *.dom.example
29845       !verify  = recipient
29846 .endd
29847 causes the ACL to return &"deny"& if the recipient domain ends in
29848 &'dom.example'& and the recipient address cannot be verified. Sometimes
29849 negation can be used on the right-hand side of a condition. For example, these
29850 two statements are equivalent:
29851 .code
29852 deny  hosts = !192.168.3.4
29853 deny !hosts =  192.168.3.4
29854 .endd
29855 However, for many conditions (&%verify%& being a good example), only left-hand
29856 side negation of the whole condition is possible.
29857
29858 The arguments of conditions and modifiers are expanded. A forced failure
29859 of an expansion causes a condition to be ignored, that is, it behaves as if the
29860 condition is true. Consider these two statements:
29861 .code
29862 accept  senders = ${lookup{$host_name}lsearch\
29863                   {/some/file}{$value}fail}
29864 accept  senders = ${lookup{$host_name}lsearch\
29865                   {/some/file}{$value}{}}
29866 .endd
29867 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29868 the returned list is searched, but if the lookup fails the behaviour is
29869 different in the two cases. The &%fail%& in the first statement causes the
29870 condition to be ignored, leaving no further conditions. The &%accept%& verb
29871 therefore succeeds. The second statement, however, generates an empty list when
29872 the lookup fails. No sender can match an empty list, so the condition fails,
29873 and therefore the &%accept%& also fails.
29874
29875 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29876 specify actions that are taken as the conditions for a statement are checked;
29877 others specify text for messages that are used when access is denied or a
29878 warning is generated. The &%control%& modifier affects the way an incoming
29879 message is handled.
29880
29881 The positioning of the modifiers in an ACL statement is important, because the
29882 processing of a verb ceases as soon as its outcome is known. Only those
29883 modifiers that have already been encountered will take effect. For example,
29884 consider this use of the &%message%& modifier:
29885 .code
29886 require message = Can't verify sender
29887         verify  = sender
29888         message = Can't verify recipient
29889         verify  = recipient
29890         message = This message cannot be used
29891 .endd
29892 If sender verification fails, Exim knows that the result of the statement is
29893 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29894 so its text is used as the error message. If sender verification succeeds, but
29895 recipient verification fails, the second message is used. If recipient
29896 verification succeeds, the third message becomes &"current"&, but is never used
29897 because there are no more conditions to cause failure.
29898
29899 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29900 modifier that is used, because all the conditions must be true for rejection to
29901 happen. Specifying more than one &%message%& modifier does not make sense, and
29902 the message can even be specified after all the conditions. For example:
29903 .code
29904 deny   hosts = ...
29905       !senders = *@my.domain.example
29906        message = Invalid sender from client host
29907 .endd
29908 The &"deny"& result does not happen until the end of the statement is reached,
29909 by which time Exim has set up the message.
29910
29911
29912
29913 .section "ACL modifiers" "SECTACLmodi"
29914 .cindex "&ACL;" "modifiers; list of"
29915 The ACL modifiers are as follows:
29916
29917 .vlist
29918 .vitem &*add_header*&&~=&~<&'text'&>
29919 This modifier specifies one or more header lines that are to be added to an
29920 incoming message, assuming, of course, that the message is ultimately
29921 accepted. For details, see section &<<SECTaddheadacl>>&.
29922
29923 .vitem &*continue*&&~=&~<&'text'&>
29924 .cindex "&%continue%& ACL modifier"
29925 .cindex "database" "updating in ACL"
29926 This modifier does nothing of itself, and processing of the ACL always
29927 continues with the next condition or modifier. The value of &%continue%& is in
29928 the side effects of expanding its argument. Typically this could be used to
29929 update a database. It is really just a syntactic tidiness, to avoid having to
29930 write rather ugly lines like this:
29931 .display
29932 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29933 .endd
29934 Instead, all you need is
29935 .display
29936 &`continue = `&<&'some expansion'&>
29937 .endd
29938
29939 .vitem &*control*&&~=&~<&'text'&>
29940 .cindex "&%control%& ACL modifier"
29941 This modifier affects the subsequent processing of the SMTP connection or of an
29942 incoming message that is accepted. The effect of the first type of control
29943 lasts for the duration of the connection, whereas the effect of the second type
29944 lasts only until the current message has been received. The message-specific
29945 controls always apply to the whole message, not to individual recipients,
29946 even if the &%control%& modifier appears in a RCPT ACL.
29947
29948 As there are now quite a few controls that can be applied, they are described
29949 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29950 in several different ways. For example:
29951
29952 . ==== As this is a nested list, any displays it contains must be indented
29953 . ==== as otherwise they are too far to the left. That comment applies only
29954 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29955 . ==== way.
29956
29957 .ilist
29958 It can be at the end of an &%accept%& statement:
29959 .code
29960     accept  ...some conditions
29961             control = queue_only
29962 .endd
29963 In this case, the control is applied when this statement yields &"accept"&, in
29964 other words, when the conditions are all true.
29965
29966 .next
29967 It can be in the middle of an &%accept%& statement:
29968 .code
29969     accept  ...some conditions...
29970             control = queue_only
29971             ...some more conditions...
29972 .endd
29973 If the first set of conditions are true, the control is applied, even if the
29974 statement does not accept because one of the second set of conditions is false.
29975 In this case, some subsequent statement must yield &"accept"& for the control
29976 to be relevant.
29977
29978 .next
29979 It can be used with &%warn%& to apply the control, leaving the
29980 decision about accepting or denying to a subsequent verb. For
29981 example:
29982 .code
29983     warn    ...some conditions...
29984             control = freeze
29985     accept  ...
29986 .endd
29987 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29988 &%logwrite%&, so it does not add anything to the message and does not write a
29989 log entry.
29990
29991 .next
29992 If you want to apply a control unconditionally, you can use it with a
29993 &%require%& verb. For example:
29994 .code
29995     require  control = no_multiline_responses
29996 .endd
29997 .endlist
29998
29999 .vitem &*delay*&&~=&~<&'time'&>
30000 .cindex "&%delay%& ACL modifier"
30001 .oindex "&%-bh%&"
30002 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30003 the time interval before proceeding. However, when testing Exim using the
30004 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30005 output instead). The time is given in the usual Exim notation, and the delay
30006 happens as soon as the modifier is processed. In an SMTP session, pending
30007 output is flushed before the delay is imposed.
30008
30009 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30010 example:
30011 .code
30012 deny    ...some conditions...
30013         delay = 30s
30014 .endd
30015 The delay happens if all the conditions are true, before the statement returns
30016 &"deny"&. Compare this with:
30017 .code
30018 deny    delay = 30s
30019         ...some conditions...
30020 .endd
30021 which waits for 30s before processing the conditions. The &%delay%& modifier
30022 can also be used with &%warn%& and together with &%control%&:
30023 .code
30024 warn    ...some conditions...
30025         delay = 2m
30026         control = freeze
30027 accept  ...
30028 .endd
30029
30030 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30031 responses to several commands are no longer buffered and sent in one packet (as
30032 they would normally be) because all output is flushed before imposing the
30033 delay. This optimization is disabled so that a number of small delays do not
30034 appear to the client as one large aggregated delay that might provoke an
30035 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30036 using a &%control%& modifier to set &%no_delay_flush%&.
30037
30038
30039 .vitem &*endpass*&
30040 .cindex "&%endpass%& ACL modifier"
30041 This modifier, which has no argument, is recognized only in &%accept%& and
30042 &%discard%& statements. It marks the boundary between the conditions whose
30043 failure causes control to pass to the next statement, and the conditions whose
30044 failure causes the ACL to return &"deny"&. This concept has proved to be
30045 confusing to some people, so the use of &%endpass%& is no longer recommended as
30046 &"best practice"&. See the description of &%accept%& above for more details.
30047
30048
30049 .vitem &*log_message*&&~=&~<&'text'&>
30050 .cindex "&%log_message%& ACL modifier"
30051 This modifier sets up a message that is used as part of the log message if the
30052 ACL denies access or a &%warn%& statement's conditions are true. For example:
30053 .code
30054 require log_message = wrong cipher suite $tls_in_cipher
30055         encrypted   = DES-CBC3-SHA
30056 .endd
30057 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30058 example:
30059 .display
30060 &`discard `&<&'some conditions'&>
30061 &`        log_message = Discarded $local_part@$domain because...`&
30062 .endd
30063 When access is denied, &%log_message%& adds to any underlying error message
30064 that may exist because of a condition failure. For example, while verifying a
30065 recipient address, a &':fail:'& redirection might have already set up a
30066 message.
30067
30068 The message may be defined before the conditions to which it applies, because
30069 the string expansion does not happen until Exim decides that access is to be
30070 denied. This means that any variables that are set by the condition are
30071 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30072 variables are set after a DNS black list lookup succeeds. If the expansion of
30073 &%log_message%& fails, or if the result is an empty string, the modifier is
30074 ignored.
30075
30076 .vindex "&$acl_verify_message$&"
30077 If you want to use a &%warn%& statement to log the result of an address
30078 verification, you can use &$acl_verify_message$& to include the verification
30079 error message.
30080
30081 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30082 the start of the logged message. If the same warning log message is requested
30083 more than once while receiving  a single email message, only one copy is
30084 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30085 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30086 is logged for a successful &%warn%& statement.
30087
30088 If &%log_message%& is not present and there is no underlying error message (for
30089 example, from the failure of address verification), but &%message%& is present,
30090 the &%message%& text is used for logging rejections. However, if any text for
30091 logging contains newlines, only the first line is logged. In the absence of
30092 both &%log_message%& and &%message%&, a default built-in message is used for
30093 logging rejections.
30094
30095
30096 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30097 .cindex "&%log_reject_target%& ACL modifier"
30098 .cindex "logging in ACL" "specifying which log"
30099 This modifier makes it possible to specify which logs are used for messages
30100 about ACL rejections. Its argument is a colon-separated list of words that can
30101 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30102 may be empty, in which case a rejection is not logged at all. For example, this
30103 ACL fragment writes no logging information when access is denied:
30104 .display
30105 &`deny `&<&'some conditions'&>
30106 &`     log_reject_target =`&
30107 .endd
30108 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30109 permanent and temporary rejections. Its effect lasts for the rest of the
30110 current ACL.
30111
30112
30113 .vitem &*logwrite*&&~=&~<&'text'&>
30114 .cindex "&%logwrite%& ACL modifier"
30115 .cindex "logging in ACL" "immediate"
30116 This modifier writes a message to a log file as soon as it is encountered when
30117 processing an ACL. (Compare &%log_message%&, which, except in the case of
30118 &%warn%& and &%discard%&, is used only if the ACL statement denies
30119 access.) The &%logwrite%& modifier can be used to log special incidents in
30120 ACLs. For example:
30121 .display
30122 &`accept `&<&'some special conditions'&>
30123 &`       control  = freeze`&
30124 &`       logwrite = froze message because ...`&
30125 .endd
30126 By default, the message is written to the main log. However, it may begin
30127 with a colon, followed by a comma-separated list of log names, and then
30128 another colon, to specify exactly which logs are to be written. For
30129 example:
30130 .code
30131 logwrite = :main,reject: text for main and reject logs
30132 logwrite = :panic: text for panic log only
30133 .endd
30134
30135
30136 .vitem &*message*&&~=&~<&'text'&>
30137 .cindex "&%message%& ACL modifier"
30138 This modifier sets up a text string that is expanded and used as a response
30139 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30140 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30141 there is some complication if &%endpass%& is involved; see the description of
30142 &%accept%& for details.)
30143
30144 The expansion of the message happens at the time Exim decides that the ACL is
30145 to end, not at the time it processes &%message%&. If the expansion fails, or
30146 generates an empty string, the modifier is ignored. Here is an example where
30147 &%message%& must be specified first, because the ACL ends with a rejection if
30148 the &%hosts%& condition fails:
30149 .code
30150 require  message = Host not recognized
30151          hosts = 10.0.0.0/8
30152 .endd
30153 (Once a condition has failed, no further conditions or modifiers are
30154 processed.)
30155
30156 .cindex "SMTP" "error codes"
30157 .oindex "&%smtp_banner%&
30158 For ACLs that are triggered by SMTP commands, the message is returned as part
30159 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30160 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30161 is accepted. In the case of the connect ACL, accepting with a message modifier
30162 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30163 accept message may not contain more than one line (otherwise it will be
30164 truncated at the first newline and a panic logged), and it cannot affect the
30165 EHLO options.
30166
30167 When SMTP is involved, the message may begin with an overriding response code,
30168 consisting of three digits optionally followed by an &"extended response code"&
30169 of the form &'n.n.n'&, each code being followed by a space. For example:
30170 .code
30171 deny  message = 599 1.2.3 Host not welcome
30172       hosts = 192.168.34.0/24
30173 .endd
30174 The first digit of the supplied response code must be the same as would be sent
30175 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30176 access, but for the predata ACL, note that the default success code is 354, not
30177 2&'xx'&.
30178
30179 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30180 the message modifier cannot override the 221 response code.
30181
30182 The text in a &%message%& modifier is literal; any quotes are taken as
30183 literals, but because the string is expanded, backslash escapes are processed
30184 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30185 response.
30186
30187 .vindex "&$acl_verify_message$&"
30188 For ACLs that are called by an &%acl =%& ACL condition, the message is
30189 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30190
30191 If &%message%& is used on a statement that verifies an address, the message
30192 specified overrides any message that is generated by the verification process.
30193 However, the original message is available in the variable
30194 &$acl_verify_message$&, so you can incorporate it into your message if you
30195 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30196 routers to be passed back as part of the SMTP response, you should either not
30197 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30198
30199 For compatibility with previous releases of Exim, a &%message%& modifier that
30200 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30201 modifier, but this usage is now deprecated. However, &%message%& acts only when
30202 all the conditions are true, wherever it appears in an ACL command, whereas
30203 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30204 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30205 effect.
30206
30207
30208 .vitem &*queue*&&~=&~<&'text'&>
30209 .cindex "&%queue%& ACL modifier"
30210 .cindex "named queues" "selecting in ACL"
30211 This modifier specifies the use of a named queue for spool files
30212 for the message.
30213 It can only be used before the message is received (i.e. not in
30214 the DATA ACL).
30215 This could be used, for example, for known high-volume burst sources
30216 of traffic, or for quarantine of messages.
30217 Separate queue-runner processes will be needed for named queues.
30218 If the text after expansion is empty, the default queue is used.
30219
30220
30221 .vitem &*remove_header*&&~=&~<&'text'&>
30222 This modifier specifies one or more header names in a colon-separated list
30223  that are to be removed from an incoming message, assuming, of course, that
30224 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30225
30226
30227 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30228 .cindex "&%set%& ACL modifier"
30229 This modifier puts a value into one of the ACL variables (see section
30230 &<<SECTaclvariables>>&).
30231
30232
30233 .vitem &*udpsend*&&~=&~<&'parameters'&>
30234 .cindex "UDP communications"
30235 This modifier sends a UDP packet, for purposes such as statistics
30236 collection or behaviour monitoring. The parameters are expanded, and
30237 the result of the expansion must be a colon-separated list consisting
30238 of a destination server, port number, and the packet contents. The
30239 server can be specified as a host name or IPv4 or IPv6 address. The
30240 separator can be changed with the usual angle bracket syntax. For
30241 example, you might want to collect information on which hosts connect
30242 when:
30243 .code
30244 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30245              $tod_zulu $sender_host_address
30246 .endd
30247 .endlist
30248
30249
30250
30251
30252 .section "Use of the control modifier" "SECTcontrols"
30253 .cindex "&%control%& ACL modifier"
30254 The &%control%& modifier supports the following settings:
30255
30256 .vlist
30257 .vitem &*control&~=&~allow_auth_unadvertised*&
30258 This modifier allows a client host to use the SMTP AUTH command even when it
30259 has not been advertised in response to EHLO. Furthermore, because there are
30260 apparently some really broken clients that do this, Exim will accept AUTH after
30261 HELO (rather than EHLO) when this control is set. It should be used only if you
30262 really need it, and you should limit its use to those broken clients that do
30263 not work without it. For example:
30264 .code
30265 warn hosts   = 192.168.34.25
30266      control = allow_auth_unadvertised
30267 .endd
30268 Normally, when an Exim server receives an AUTH command, it checks the name of
30269 the authentication mechanism that is given in the command to ensure that it
30270 matches an advertised mechanism. When this control is set, the check that a
30271 mechanism has been advertised is bypassed. Any configured mechanism can be used
30272 by the client. This control is permitted only in the connection and HELO ACLs.
30273
30274
30275 .vitem &*control&~=&~caseful_local_part*& &&&
30276        &*control&~=&~caselower_local_part*&
30277 .cindex "&ACL;" "case of local part in"
30278 .cindex "case of local parts"
30279 .vindex "&$local_part$&"
30280 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30281 (that is, during RCPT processing). By default, the contents of &$local_part$&
30282 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30283 any uppercase letters in the original local part are restored in &$local_part$&
30284 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30285 is encountered.
30286
30287 These controls affect only the current recipient. Moreover, they apply only to
30288 local part handling that takes place directly in the ACL (for example, as a key
30289 in lookups). If a test to verify the recipient is obeyed, the case-related
30290 handling of the local part during the verification is controlled by the router
30291 configuration (see the &%caseful_local_part%& generic router option).
30292
30293 This facility could be used, for example, to add a spam score to local parts
30294 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30295 spam score:
30296 .code
30297 warn  control = caseful_local_part
30298       set acl_m4 = ${eval:\
30299                      $acl_m4 + \
30300                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30301                     }
30302       control = caselower_local_part
30303 .endd
30304 Notice that we put back the lower cased version afterwards, assuming that
30305 is what is wanted for subsequent tests.
30306
30307
30308 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30309 .cindex "&ACL;" "cutthrough routing"
30310 .cindex "cutthrough" "requesting"
30311 This option requests delivery be attempted while the item is being received.
30312
30313 The option is usable in the RCPT ACL.
30314 If enabled for a message received via smtp and routed to an smtp transport,
30315 and only one transport, interface, destination host and port combination
30316 is used for all recipients of the message,
30317 then the delivery connection is made while the receiving connection is open
30318 and data is copied from one to the other.
30319
30320 An attempt to set this option for any recipient but the first
30321 for a mail will be quietly ignored.
30322 If a recipient-verify callout
30323 (with use_sender)
30324 connection is subsequently
30325 requested in the same ACL it is held open and used for
30326 any subsequent recipients and the data,
30327 otherwise one is made after the initial RCPT ACL completes.
30328
30329 Note that routers are used in verify mode,
30330 and cannot depend on content of received headers.
30331 Note also that headers cannot be
30332 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30333 Headers may be modified by routers (subject to the above) and transports.
30334 The &'Received-By:'& header is generated as soon as the body reception starts,
30335 rather than the traditional time after the full message is received;
30336 this will affect the timestamp.
30337
30338 All the usual ACLs are called; if one results in the message being
30339 rejected, all effort spent in delivery (including the costs on
30340 the ultimate destination) will be wasted.
30341 Note that in the case of data-time ACLs this includes the entire
30342 message body.
30343
30344 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30345 of outgoing messages is done, because it sends data to the ultimate destination
30346 before the entire message has been received from the source.
30347 It is not supported for messages received with the SMTP PRDR
30348 or CHUNKING
30349 options in use.
30350
30351 Should the ultimate destination system positively accept or reject the mail,
30352 a corresponding indication is given to the source system and nothing is queued.
30353 If the item is successfully delivered in cutthrough mode
30354 the delivery log lines are tagged with ">>" rather than "=>" and appear
30355 before the acceptance "<=" line.
30356
30357 If there is a temporary error the item is queued for later delivery in the
30358 usual fashion.
30359 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30360 to the control; the default value is &"spool"& and the alternate value
30361 &"pass"& copies an SMTP defer response from the target back to the initiator
30362 and does not queue the message.
30363 Note that this is independent of any recipient verify conditions in the ACL.
30364
30365 Delivery in this mode avoids the generation of a bounce mail to a
30366 (possibly faked)
30367 sender when the destination system is doing content-scan based rejection.
30368
30369
30370 .vitem &*control&~=&~debug/*&<&'options'&>
30371 .cindex "&ACL;" "enabling debug logging"
30372 .cindex "debugging" "enabling from an ACL"
30373 This control turns on debug logging, almost as though Exim had been invoked
30374 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30375 by default called &'debuglog'&.
30376 The filename can be adjusted with the &'tag'& option, which
30377 may access any variables already defined.  The logging may be adjusted with
30378 the &'opts'& option, which takes the same values as the &`-d`& command-line
30379 option.
30380 Logging started this way may be stopped, and the file removed,
30381 with the &'kill'& option.
30382 Some examples (which depend on variables that don't exist in all
30383 contexts):
30384 .code
30385       control = debug
30386       control = debug/tag=.$sender_host_address
30387       control = debug/opts=+expand+acl
30388       control = debug/tag=.$message_exim_id/opts=+expand
30389       control = debug/kill
30390 .endd
30391
30392
30393 .vitem &*control&~=&~dkim_disable_verify*&
30394 .cindex "disable DKIM verify"
30395 .cindex "DKIM" "disable verify"
30396 This control turns off DKIM verification processing entirely.  For details on
30397 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30398
30399
30400 .vitem &*control&~=&~dmarc_disable_verify*&
30401 .cindex "disable DMARC verify"
30402 .cindex "DMARC" "disable verify"
30403 This control turns off DMARC verification processing entirely.  For details on
30404 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30405
30406
30407 .vitem &*control&~=&~dscp/*&<&'value'&>
30408 .cindex "&ACL;" "setting DSCP value"
30409 .cindex "DSCP" "inbound"
30410 This option causes the DSCP value associated with the socket for the inbound
30411 connection to be adjusted to a given value, given as one of a number of fixed
30412 strings or to numeric value.
30413 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30414 Common values include &`throughput`&, &`mincost`&, and on newer systems
30415 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30416
30417 The outbound packets from Exim will be marked with this value in the header
30418 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30419 that these values will have any effect, not be stripped by networking
30420 equipment, or do much of anything without cooperation with your Network
30421 Engineer and those of all network operators between the source and destination.
30422
30423
30424 .vitem &*control&~=&~enforce_sync*& &&&
30425        &*control&~=&~no_enforce_sync*&
30426 .cindex "SMTP" "synchronization checking"
30427 .cindex "synchronization checking in SMTP"
30428 These controls make it possible to be selective about when SMTP synchronization
30429 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30430 state of the switch (it is true by default). See the description of this option
30431 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30432
30433 The effect of these two controls lasts for the remainder of the SMTP
30434 connection. They can appear in any ACL except the one for the non-SMTP
30435 messages. The most straightforward place to put them is in the ACL defined by
30436 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30437 before the first synchronization check. The expected use is to turn off the
30438 synchronization checks for badly-behaved hosts that you nevertheless need to
30439 work with.
30440
30441
30442 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30443 .cindex "fake defer"
30444 .cindex "defer, fake"
30445 This control works in exactly the same way as &%fakereject%& (described below)
30446 except that it causes an SMTP 450 response after the message data instead of a
30447 550 response. You must take care when using &%fakedefer%& because it causes the
30448 messages to be duplicated when the sender retries. Therefore, you should not
30449 use &%fakedefer%& if the message is to be delivered normally.
30450
30451 .vitem &*control&~=&~fakereject/*&<&'message'&>
30452 .cindex "fake rejection"
30453 .cindex "rejection, fake"
30454 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30455 words, only when an SMTP message is being received. If Exim accepts the
30456 message, instead the final 250 response, a 550 rejection message is sent.
30457 However, Exim proceeds to deliver the message as normal. The control applies
30458 only to the current message, not to any subsequent ones that may be received in
30459 the same SMTP connection.
30460
30461 The text for the 550 response is taken from the &%control%& modifier. If no
30462 message is supplied, the following is used:
30463 .code
30464 550-Your message has been rejected but is being
30465 550-kept for evaluation.
30466 550-If it was a legitimate message, it may still be
30467 550 delivered to the target recipient(s).
30468 .endd
30469 This facility should be used with extreme caution.
30470
30471 .vitem &*control&~=&~freeze*&
30472 .cindex "frozen messages" "forcing in ACL"
30473 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30474 other words, only when a message is being received. If the message is accepted,
30475 it is placed on Exim's queue and frozen. The control applies only to the
30476 current message, not to any subsequent ones that may be received in the same
30477 SMTP connection.
30478
30479 This modifier can optionally be followed by &`/no_tell`&. If the global option
30480 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30481 is told about the freezing), provided all the &*control=freeze*& modifiers that
30482 are obeyed for the current message have the &`/no_tell`& option.
30483
30484 .vitem &*control&~=&~no_delay_flush*&
30485 .cindex "SMTP" "output flushing, disabling for delay"
30486 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30487 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30488 use. This control, as long as it is encountered before the &%delay%& modifier,
30489 disables such output flushing.
30490
30491 .vitem &*control&~=&~no_callout_flush*&
30492 .cindex "SMTP" "output flushing, disabling for callout"
30493 Exim normally flushes SMTP output before performing a callout in an ACL, to
30494 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30495 use. This control, as long as it is encountered before the &%verify%& condition
30496 that causes the callout, disables such output flushing.
30497
30498 .vitem &*control&~=&~no_mbox_unspool*&
30499 This control is available when Exim is compiled with the content scanning
30500 extension. Content scanning may require a copy of the current message, or parts
30501 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30502 or spam scanner. Normally, such copies are deleted when they are no longer
30503 needed. If this control is set, the copies are not deleted. The control applies
30504 only to the current message, not to any subsequent ones that may be received in
30505 the same SMTP connection. It is provided for debugging purposes and is unlikely
30506 to be useful in production.
30507
30508 .vitem &*control&~=&~no_multiline_responses*&
30509 .cindex "multiline responses, suppressing"
30510 This control is permitted for any ACL except the one for non-SMTP messages.
30511 It seems that there are broken clients in use that cannot handle multiline
30512 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30513
30514 If this control is set, multiline SMTP responses from ACL rejections are
30515 suppressed. One way of doing this would have been to put out these responses as
30516 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30517 (&"use multiline responses for more"& it says &-- ha!), and some of the
30518 responses might get close to that. So this facility, which is after all only a
30519 sop to broken clients, is implemented by doing two very easy things:
30520
30521 .ilist
30522 Extra information that is normally output as part of a rejection caused by
30523 sender verification failure is omitted. Only the final line (typically &"sender
30524 verification failed"&) is sent.
30525 .next
30526 If a &%message%& modifier supplies a multiline response, only the first
30527 line is output.
30528 .endlist
30529
30530 The setting of the switch can, of course, be made conditional on the
30531 calling host. Its effect lasts until the end of the SMTP connection.
30532
30533 .vitem &*control&~=&~no_pipelining*&
30534 .cindex "PIPELINING" "suppressing advertising"
30535 This control turns off the advertising of the PIPELINING extension to SMTP in
30536 the current session. To be useful, it must be obeyed before Exim sends its
30537 response to an EHLO command. Therefore, it should normally appear in an ACL
30538 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30539 &%pipelining_advertise_hosts%&.
30540
30541 .vitem &*control&~=&~queue_only*&
30542 .oindex "&%queue_only%&"
30543 .cindex "queueing incoming messages"
30544 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30545 other words, only when a message is being received. If the message is accepted,
30546 it is placed on Exim's queue and left there for delivery by a subsequent queue
30547 runner. No immediate delivery process is started. In other words, it has the
30548 effect as the &%queue_only%& global option. However, the control applies only
30549 to the current message, not to any subsequent ones that may be received in the
30550 same SMTP connection.
30551
30552 .vitem &*control&~=&~submission/*&<&'options'&>
30553 .cindex "message" "submission"
30554 .cindex "submission mode"
30555 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30556 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30557 the current message is a submission from a local MUA. In this case, Exim
30558 operates in &"submission mode"&, and applies certain fixups to the message if
30559 necessary. For example, it adds a &'Date:'& header line if one is not present.
30560 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30561 late (the message has already been created).
30562
30563 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30564 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30565 submission mode; the available options for this control are described there.
30566 The control applies only to the current message, not to any subsequent ones
30567 that may be received in the same SMTP connection.
30568
30569 .vitem &*control&~=&~suppress_local_fixups*&
30570 .cindex "submission fixups, suppressing"
30571 This control applies to locally submitted (non TCP/IP) messages, and is the
30572 complement of &`control = submission`&. It disables the fixups that are
30573 normally applied to locally-submitted messages. Specifically:
30574
30575 .ilist
30576 Any &'Sender:'& header line is left alone (in this respect, it is a
30577 dynamic version of &%local_sender_retain%&).
30578 .next
30579 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30580 .next
30581 There is no check that &'From:'& corresponds to the actual sender.
30582 .endlist ilist
30583
30584 This control may be useful when a remotely-originated message is accepted,
30585 passed to some scanning program, and then re-submitted for delivery. It can be
30586 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30587 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30588 data is read.
30589
30590 &*Note:*& This control applies only to the current message, not to any others
30591 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30592
30593 .vitem &*control&~=&~utf8_downconvert*&
30594 This control enables conversion of UTF-8 in message addresses
30595 to a-label form.
30596 For details see section &<<SECTi18nMTA>>&.
30597 .endlist vlist
30598
30599
30600 .section "Summary of message fixup control" "SECTsummesfix"
30601 All four possibilities for message fixups can be specified:
30602
30603 .ilist
30604 Locally submitted, fixups applied: the default.
30605 .next
30606 Locally submitted, no fixups applied: use
30607 &`control = suppress_local_fixups`&.
30608 .next
30609 Remotely submitted, no fixups applied: the default.
30610 .next
30611 Remotely submitted, fixups applied: use &`control = submission`&.
30612 .endlist
30613
30614
30615
30616 .section "Adding header lines in ACLs" "SECTaddheadacl"
30617 .cindex "header lines" "adding in an ACL"
30618 .cindex "header lines" "position of added lines"
30619 .cindex "&%add_header%& ACL modifier"
30620 The &%add_header%& modifier can be used to add one or more extra header lines
30621 to an incoming message, as in this example:
30622 .code
30623 warn dnslists = sbl.spamhaus.org : \
30624                 dialup.mail-abuse.org
30625      add_header = X-blacklisted-at: $dnslist_domain
30626 .endd
30627 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30628 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30629 receiving a message). The message must ultimately be accepted for
30630 &%add_header%& to have any significant effect. You can use &%add_header%& with
30631 any ACL verb, including &%deny%& (though this is potentially useful only in a
30632 RCPT ACL).
30633
30634 Headers will not be added to the message if the modifier is used in
30635 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30636
30637 Leading and trailing newlines are removed from
30638 the data for the &%add_header%& modifier; if it then
30639 contains one or more newlines that
30640 are not followed by a space or a tab, it is assumed to contain multiple header
30641 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30642 front of any line that is not a valid header line.
30643
30644 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30645 They are added to the message before processing the DATA and MIME ACLs.
30646 However, if an identical header line is requested more than once, only one copy
30647 is actually added to the message. Further header lines may be accumulated
30648 during the DATA and MIME ACLs, after which they are added to the message, again
30649 with duplicates suppressed. Thus, it is possible to add two identical header
30650 lines to an SMTP message, but only if one is added before DATA and one after.
30651 In the case of non-SMTP messages, new headers are accumulated during the
30652 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30653 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30654 are included in the entry that is written to the reject log.
30655
30656 .cindex "header lines" "added; visibility of"
30657 Header lines are not visible in string expansions
30658 of message headers
30659 until they are added to the
30660 message. It follows that header lines defined in the MAIL, RCPT, and predata
30661 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30662 header lines that are added by the DATA or MIME ACLs are not visible in those
30663 ACLs. Because of this restriction, you cannot use header lines as a way of
30664 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30665 this, you can use ACL variables, as described in section
30666 &<<SECTaclvariables>>&.
30667
30668 The list of headers yet to be added is given by the &%$headers_added%& variable.
30669
30670 The &%add_header%& modifier acts immediately as it is encountered during the
30671 processing of an ACL. Notice the difference between these two cases:
30672 .display
30673 &`accept add_header = ADDED: some text`&
30674 &`       `&<&'some condition'&>
30675
30676 &`accept `&<&'some condition'&>
30677 &`       add_header = ADDED: some text`&
30678 .endd
30679 In the first case, the header line is always added, whether or not the
30680 condition is true. In the second case, the header line is added only if the
30681 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30682 ACL statement. All those that are encountered before a condition fails are
30683 honoured.
30684
30685 .cindex "&%warn%& ACL verb"
30686 For compatibility with previous versions of Exim, a &%message%& modifier for a
30687 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30688 effect only if all the conditions are true, even if it appears before some of
30689 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30690 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30691 are present on a &%warn%& verb, both are processed according to their
30692 specifications.
30693
30694 By default, new header lines are added to a message at the end of the existing
30695 header lines. However, you can specify that any particular header line should
30696 be added right at the start (before all the &'Received:'& lines), immediately
30697 after the first block of &'Received:'& lines, or immediately before any line
30698 that is not a &'Received:'& or &'Resent-something:'& header.
30699
30700 This is done by specifying &":at_start:"&, &":after_received:"&, or
30701 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30702 header line, respectively. (Header text cannot start with a colon, as there has
30703 to be a header name first.) For example:
30704 .code
30705 warn add_header = \
30706        :after_received:X-My-Header: something or other...
30707 .endd
30708 If more than one header line is supplied in a single &%add_header%& modifier,
30709 each one is treated independently and can therefore be placed differently. If
30710 you add more than one line at the start, or after the Received: block, they end
30711 up in reverse order.
30712
30713 &*Warning*&: This facility currently applies only to header lines that are
30714 added in an ACL. It does NOT work for header lines that are added in a
30715 system filter or in a router or transport.
30716
30717
30718
30719 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30720 .cindex "header lines" "removing in an ACL"
30721 .cindex "header lines" "position of removed lines"
30722 .cindex "&%remove_header%& ACL modifier"
30723 The &%remove_header%& modifier can be used to remove one or more header lines
30724 from an incoming message, as in this example:
30725 .code
30726 warn   message        = Remove internal headers
30727        remove_header  = x-route-mail1 : x-route-mail2
30728 .endd
30729 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30730 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30731 receiving a message). The message must ultimately be accepted for
30732 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30733 with any ACL verb, including &%deny%&, though this is really not useful for
30734 any verb that doesn't result in a delivered message.
30735
30736 Headers will not be removed from the message if the modifier is used in
30737 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30738
30739 More than one header can be removed at the same time by using a colon separated
30740 list of header names. The header matching is case insensitive. Wildcards are
30741 not permitted, nor is list expansion performed, so you cannot use hostlists to
30742 create a list of headers, however both connection and message variable expansion
30743 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30744 .code
30745 warn   hosts           = +internal_hosts
30746        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30747 warn   message         = Remove internal headers
30748        remove_header   = $acl_c_ihdrs
30749 .endd
30750 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30751 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30752 If multiple header lines match, all are removed.
30753 There is no harm in attempting to remove the same header twice nor in removing
30754 a non-existent header. Further header lines to be removed may be accumulated
30755 during the DATA and MIME ACLs, after which they are removed from the message,
30756 if present. In the case of non-SMTP messages, headers to be removed are
30757 accumulated during the non-SMTP ACLs, and are removed from the message after
30758 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30759 ACL, there really is no effect because there is no logging of what headers
30760 would have been removed.
30761
30762 .cindex "header lines" "removed; visibility of"
30763 Header lines are not visible in string expansions until the DATA phase when it
30764 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30765 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30766 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30767 this restriction, you cannot use header lines as a way of controlling data
30768 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30769 you should instead use ACL variables, as described in section
30770 &<<SECTaclvariables>>&.
30771
30772 The &%remove_header%& modifier acts immediately as it is encountered during the
30773 processing of an ACL. Notice the difference between these two cases:
30774 .display
30775 &`accept remove_header = X-Internal`&
30776 &`       `&<&'some condition'&>
30777
30778 &`accept `&<&'some condition'&>
30779 &`       remove_header = X-Internal`&
30780 .endd
30781 In the first case, the header line is always removed, whether or not the
30782 condition is true. In the second case, the header line is removed only if the
30783 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30784 same ACL statement. All those that are encountered before a condition fails
30785 are honoured.
30786
30787 &*Warning*&: This facility currently applies only to header lines that are
30788 present during ACL processing. It does NOT remove header lines that are added
30789 in a system filter or in a router or transport.
30790
30791
30792
30793
30794 .section "ACL conditions" "SECTaclconditions"
30795 .cindex "&ACL;" "conditions; list of"
30796 Some of the conditions listed in this section are available only when Exim is
30797 compiled with the content-scanning extension. They are included here briefly
30798 for completeness. More detailed descriptions can be found in the discussion on
30799 content scanning in chapter &<<CHAPexiscan>>&.
30800
30801 Not all conditions are relevant in all circumstances. For example, testing
30802 senders and recipients does not make sense in an ACL that is being run as the
30803 result of the arrival of an ETRN command, and checks on message headers can be
30804 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30805 can use the same condition (with different parameters) more than once in the
30806 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30807 The conditions are as follows:
30808
30809
30810 .vlist
30811 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30812 .cindex "&ACL;" "nested"
30813 .cindex "&ACL;" "indirect"
30814 .cindex "&ACL;" "arguments"
30815 .cindex "&%acl%& ACL condition"
30816 The possible values of the argument are the same as for the
30817 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30818 &"accept"& the condition is true; if it returns &"deny"& the condition is
30819 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30820 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30821 condition false. This means that further processing of the &%warn%& verb
30822 ceases, but processing of the ACL continues.
30823
30824 If the argument is a named ACL, up to nine space-separated optional values
30825 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30826 and $acl_narg is set to the count of values.
30827 Previous values of these variables are restored after the call returns.
30828 The name and values are expanded separately.
30829 Note that spaces in complex expansions which are used as arguments
30830 will act as argument separators.
30831
30832 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30833 the connection is dropped. If it returns &"discard"&, the verb must be
30834 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30835 conditions are tested.
30836
30837 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30838 loops. This condition allows you to use different ACLs in different
30839 circumstances. For example, different ACLs can be used to handle RCPT commands
30840 for different local users or different local domains.
30841
30842 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30843 .cindex "&%authenticated%& ACL condition"
30844 .cindex "authentication" "ACL checking"
30845 .cindex "&ACL;" "testing for authentication"
30846 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30847 the name of the authenticator is tested against the list. To test for
30848 authentication by any authenticator, you can set
30849 .code
30850 authenticated = *
30851 .endd
30852
30853 .vitem &*condition&~=&~*&<&'string'&>
30854 .cindex "&%condition%& ACL condition"
30855 .cindex "customizing" "ACL condition"
30856 .cindex "&ACL;" "customized test"
30857 .cindex "&ACL;" "testing, customized"
30858 This feature allows you to make up custom conditions. If the result of
30859 expanding the string is an empty string, the number zero, or one of the strings
30860 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30861 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30862 any other value, some error is assumed to have occurred, and the ACL returns
30863 &"defer"&. However, if the expansion is forced to fail, the condition is
30864 ignored. The effect is to treat it as true, whether it is positive or
30865 negative.
30866
30867 .vitem &*decode&~=&~*&<&'location'&>
30868 .cindex "&%decode%& ACL condition"
30869 This condition is available only when Exim is compiled with the
30870 content-scanning extension, and it is allowed only in the ACL defined by
30871 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30872 If all goes well, the condition is true. It is false only if there are
30873 problems such as a syntax error or a memory shortage. For more details, see
30874 chapter &<<CHAPexiscan>>&.
30875
30876 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30877 .cindex "&%dnslists%& ACL condition"
30878 .cindex "DNS list" "in ACL"
30879 .cindex "black list (DNS)"
30880 .cindex "&ACL;" "testing a DNS list"
30881 This condition checks for entries in DNS black lists. These are also known as
30882 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30883 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30884 different variants of this condition to describe briefly here. See sections
30885 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30886
30887 .vitem &*domains&~=&~*&<&'domain&~list'&>
30888 .cindex "&%domains%& ACL condition"
30889 .cindex "domain" "ACL checking"
30890 .cindex "&ACL;" "testing a recipient domain"
30891 .vindex "&$domain_data$&"
30892 This condition is relevant only after a RCPT command. It checks that the domain
30893 of the recipient address is in the domain list. If percent-hack processing is
30894 enabled, it is done before this test is done. If the check succeeds with a
30895 lookup, the result of the lookup is placed in &$domain_data$& until the next
30896 &%domains%& test.
30897
30898 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30899 use &%domains%& in a DATA ACL.
30900
30901
30902 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30903 .cindex "&%encrypted%& ACL condition"
30904 .cindex "encryption" "checking in an ACL"
30905 .cindex "&ACL;" "testing for encryption"
30906 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30907 name of the cipher suite in use is tested against the list. To test for
30908 encryption without testing for any specific cipher suite(s), set
30909 .code
30910 encrypted = *
30911 .endd
30912
30913
30914 .vitem &*hosts&~=&~*&<&'host&~list'&>
30915 .cindex "&%hosts%& ACL condition"
30916 .cindex "host" "ACL checking"
30917 .cindex "&ACL;" "testing the client host"
30918 This condition tests that the calling host matches the host list. If you have
30919 name lookups or wildcarded host names and IP addresses in the same host list,
30920 you should normally put the IP addresses first. For example, you could have:
30921 .code
30922 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30923 .endd
30924 The lookup in this example uses the host name for its key. This is implied by
30925 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30926 and it wouldn't matter which way round you had these two items.)
30927
30928 The reason for the problem with host names lies in the left-to-right way that
30929 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30930 but when it reaches an item that requires a host name, it fails if it cannot
30931 find a host name to compare with the pattern. If the above list is given in the
30932 opposite order, the &%accept%& statement fails for a host whose name cannot be
30933 found, even if its IP address is 10.9.8.7.
30934
30935 If you really do want to do the name check first, and still recognize the IP
30936 address even if the name lookup fails, you can rewrite the ACL like this:
30937 .code
30938 accept hosts = dbm;/etc/friendly/hosts
30939 accept hosts = 10.9.8.7
30940 .endd
30941 The default action on failing to find the host name is to assume that the host
30942 is not in the list, so the first &%accept%& statement fails. The second
30943 statement can then check the IP address.
30944
30945 .vindex "&$host_data$&"
30946 If a &%hosts%& condition is satisfied by means of a lookup, the result
30947 of the lookup is made available in the &$host_data$& variable. This
30948 allows you, for example, to set up a statement like this:
30949 .code
30950 deny  hosts = net-lsearch;/some/file
30951 message = $host_data
30952 .endd
30953 which gives a custom error message for each denied host.
30954
30955 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30956 .cindex "&%local_parts%& ACL condition"
30957 .cindex "local part" "ACL checking"
30958 .cindex "&ACL;" "testing a local part"
30959 .vindex "&$local_part_data$&"
30960 This condition is relevant only after a RCPT command. It checks that the local
30961 part of the recipient address is in the list. If percent-hack processing is
30962 enabled, it is done before this test. If the check succeeds with a lookup, the
30963 result of the lookup is placed in &$local_part_data$&, which remains set until
30964 the next &%local_parts%& test.
30965
30966 .vitem &*malware&~=&~*&<&'option'&>
30967 .cindex "&%malware%& ACL condition"
30968 .cindex "&ACL;" "virus scanning"
30969 .cindex "&ACL;" "scanning for viruses"
30970 This condition is available only when Exim is compiled with the
30971 content-scanning extension
30972 and only after a DATA command.
30973 It causes the incoming message to be scanned for
30974 viruses. For details, see chapter &<<CHAPexiscan>>&.
30975
30976 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30977 .cindex "&%mime_regex%& ACL condition"
30978 .cindex "&ACL;" "testing by regex matching"
30979 This condition is available only when Exim is compiled with the
30980 content-scanning extension, and it is allowed only in the ACL defined by
30981 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30982 with any of the regular expressions. For details, see chapter
30983 &<<CHAPexiscan>>&.
30984
30985 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30986 .cindex "rate limiting"
30987 This condition can be used to limit the rate at which a user or host submits
30988 messages. Details are given in section &<<SECTratelimiting>>&.
30989
30990 .vitem &*recipients&~=&~*&<&'address&~list'&>
30991 .cindex "&%recipients%& ACL condition"
30992 .cindex "recipient" "ACL checking"
30993 .cindex "&ACL;" "testing a recipient"
30994 This condition is relevant only after a RCPT command. It checks the entire
30995 recipient address against a list of recipients.
30996
30997 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30998 .cindex "&%regex%& ACL condition"
30999 .cindex "&ACL;" "testing by regex matching"
31000 This condition is available only when Exim is compiled with the
31001 content-scanning extension, and is available only in the DATA, MIME, and
31002 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31003 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31004
31005 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31006 .cindex "&%sender_domains%& ACL condition"
31007 .cindex "sender" "ACL checking"
31008 .cindex "&ACL;" "testing a sender domain"
31009 .vindex "&$domain$&"
31010 .vindex "&$sender_address_domain$&"
31011 This condition tests the domain of the sender of the message against the given
31012 domain list. &*Note*&: The domain of the sender address is in
31013 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31014 of this condition. This is an exception to the general rule for testing domain
31015 lists. It is done this way so that, if this condition is used in an ACL for a
31016 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31017 influence the sender checking.
31018
31019 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31020 relaying, because sender addresses are easily, and commonly, forged.
31021
31022 .vitem &*senders&~=&~*&<&'address&~list'&>
31023 .cindex "&%senders%& ACL condition"
31024 .cindex "sender" "ACL checking"
31025 .cindex "&ACL;" "testing a sender"
31026 This condition tests the sender of the message against the given list. To test
31027 for a bounce message, which has an empty sender, set
31028 .code
31029 senders = :
31030 .endd
31031 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31032 relaying, because sender addresses are easily, and commonly, forged.
31033
31034 .vitem &*spam&~=&~*&<&'username'&>
31035 .cindex "&%spam%& ACL condition"
31036 .cindex "&ACL;" "scanning for spam"
31037 This condition is available only when Exim is compiled with the
31038 content-scanning extension. It causes the incoming message to be scanned by
31039 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31040
31041 .vitem &*verify&~=&~certificate*&
31042 .cindex "&%verify%& ACL condition"
31043 .cindex "TLS" "client certificate verification"
31044 .cindex "certificate" "verification of client"
31045 .cindex "&ACL;" "certificate verification"
31046 .cindex "&ACL;" "testing a TLS certificate"
31047 This condition is true in an SMTP session if the session is encrypted, and a
31048 certificate was received from the client, and the certificate was verified. The
31049 server requests a certificate only if the client matches &%tls_verify_hosts%&
31050 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31051
31052 .vitem &*verify&~=&~csa*&
31053 .cindex "CSA verification"
31054 This condition checks whether the sending host (the client) is authorized to
31055 send email. Details of how this works are given in section
31056 &<<SECTverifyCSA>>&.
31057
31058 .vitem &*verify&~=&~header_names_ascii*&
31059 .cindex "&%verify%& ACL condition"
31060 .cindex "&ACL;" "verifying header names only ASCII"
31061 .cindex "header lines" "verifying header names only ASCII"
31062 .cindex "verifying" "header names only ASCII"
31063 This condition is relevant only in an ACL that is run after a message has been
31064 received, that is, in an ACL specified by &%acl_smtp_data%& or
31065 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31066 there are no non-ASCII characters, also excluding control characters.  The
31067 allowable characters are decimal ASCII values 33 through 126.
31068
31069 Exim itself will handle headers with non-ASCII characters, but it can cause
31070 problems for downstream applications, so this option will allow their
31071 detection and rejection in the DATA ACL's.
31072
31073 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31074 .cindex "&%verify%& ACL condition"
31075 .cindex "&ACL;" "verifying sender in the header"
31076 .cindex "header lines" "verifying the sender in"
31077 .cindex "sender" "verifying in header"
31078 .cindex "verifying" "sender in header"
31079 This condition is relevant only in an ACL that is run after a message has been
31080 received, that is, in an ACL specified by &%acl_smtp_data%& or
31081 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31082 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31083 is loosely thought of as a &"sender"& address (hence the name of the test).
31084 However, an address that appears in one of these headers need not be an address
31085 that accepts bounce messages; only sender addresses in envelopes are required
31086 to accept bounces. Therefore, if you use the callout option on this check, you
31087 might want to arrange for a non-empty address in the MAIL command.
31088
31089 Details of address verification and the options are given later, starting at
31090 section &<<SECTaddressverification>>& (callouts are described in section
31091 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31092 condition to restrict it to bounce messages only:
31093 .code
31094 deny    senders = :
31095         message = A valid sender header is required for bounces
31096        !verify  = header_sender
31097 .endd
31098
31099 .vitem &*verify&~=&~header_syntax*&
31100 .cindex "&%verify%& ACL condition"
31101 .cindex "&ACL;" "verifying header syntax"
31102 .cindex "header lines" "verifying syntax"
31103 .cindex "verifying" "header syntax"
31104 This condition is relevant only in an ACL that is run after a message has been
31105 received, that is, in an ACL specified by &%acl_smtp_data%& or
31106 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31107 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31108 and &'Bcc:'&), returning true if there are no problems.
31109 Unqualified addresses (local parts without domains) are
31110 permitted only in locally generated messages and from hosts that match
31111 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31112 appropriate.
31113
31114 Note that this condition is a syntax check only. However, a common spamming
31115 ploy used to be to send syntactically invalid headers such as
31116 .code
31117 To: @
31118 .endd
31119 and this condition can be used to reject such messages, though they are not as
31120 common as they used to be.
31121
31122 .vitem &*verify&~=&~helo*&
31123 .cindex "&%verify%& ACL condition"
31124 .cindex "&ACL;" "verifying HELO/EHLO"
31125 .cindex "HELO" "verifying"
31126 .cindex "EHLO" "verifying"
31127 .cindex "verifying" "EHLO"
31128 .cindex "verifying" "HELO"
31129 This condition is true if a HELO or EHLO command has been received from the
31130 client host, and its contents have been verified. If there has been no previous
31131 attempt to verify the HELO/EHLO contents, it is carried out when this
31132 condition is encountered. See the description of the &%helo_verify_hosts%& and
31133 &%helo_try_verify_hosts%& options for details of how to request verification
31134 independently of this condition, and for detail of the verification.
31135
31136 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31137 option), this condition is always true.
31138
31139
31140 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31141 .cindex "verifying" "not blind"
31142 .cindex "bcc recipients, verifying none"
31143 This condition checks that there are no blind (bcc) recipients in the message.
31144 Every envelope recipient must appear either in a &'To:'& header line or in a
31145 &'Cc:'& header line for this condition to be true. Local parts are checked
31146 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31147 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31148 used only in a DATA or non-SMTP ACL.
31149
31150 There is one possible option, &`case_insensitive`&.  If this is present then
31151 local parts are checked case-insensitively.
31152
31153 There are, of course, many legitimate messages that make use of blind (bcc)
31154 recipients. This check should not be used on its own for blocking messages.
31155
31156
31157 .vitem &*verify&~=&~recipient/*&<&'options'&>
31158 .cindex "&%verify%& ACL condition"
31159 .cindex "&ACL;" "verifying recipient"
31160 .cindex "recipient" "verifying"
31161 .cindex "verifying" "recipient"
31162 .vindex "&$address_data$&"
31163 This condition is relevant only after a RCPT command. It verifies the current
31164 recipient. Details of address verification are given later, starting at section
31165 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31166 of &$address_data$& is the last value that was set while routing the address.
31167 This applies even if the verification fails. When an address that is being
31168 verified is redirected to a single address, verification continues with the new
31169 address, and in that case, the subsequent value of &$address_data$& is the
31170 value for the child address.
31171
31172 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31173 .cindex "&%verify%& ACL condition"
31174 .cindex "&ACL;" "verifying host reverse lookup"
31175 .cindex "host" "verifying reverse lookup"
31176 This condition ensures that a verified host name has been looked up from the IP
31177 address of the client host. (This may have happened already if the host name
31178 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31179 Verification ensures that the host name obtained from a reverse DNS lookup, or
31180 one of its aliases, does, when it is itself looked up in the DNS, yield the
31181 original IP address.
31182
31183 There is one possible option, &`defer_ok`&.  If this is present and a
31184 DNS operation returns a temporary error, the verify condition succeeds.
31185
31186 If this condition is used for a locally generated message (that is, when there
31187 is no client host involved), it always succeeds.
31188
31189 .vitem &*verify&~=&~sender/*&<&'options'&>
31190 .cindex "&%verify%& ACL condition"
31191 .cindex "&ACL;" "verifying sender"
31192 .cindex "sender" "verifying"
31193 .cindex "verifying" "sender"
31194 This condition is relevant only after a MAIL or RCPT command, or after a
31195 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31196 the message's sender is empty (that is, this is a bounce message), the
31197 condition is true. Otherwise, the sender address is verified.
31198
31199 .vindex "&$address_data$&"
31200 .vindex "&$sender_address_data$&"
31201 If there is data in the &$address_data$& variable at the end of routing, its
31202 value is placed in &$sender_address_data$& at the end of verification. This
31203 value can be used in subsequent conditions and modifiers in the same ACL
31204 statement. It does not persist after the end of the current statement. If you
31205 want to preserve the value for longer, you can save it in an ACL variable.
31206
31207 Details of verification are given later, starting at section
31208 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31209 to avoid doing it more than once per message.
31210
31211 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31212 .cindex "&%verify%& ACL condition"
31213 This is a variation of the previous option, in which a modified address is
31214 verified as a sender.
31215
31216 Note that '/' is legal in local-parts; if the address may have such
31217 (eg. is generated from the received message)
31218 they must be protected from the options parsing by doubling:
31219 .code
31220 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31221 .endd
31222 .endlist
31223
31224
31225
31226 .section "Using DNS lists" "SECTmorednslists"
31227 .cindex "DNS list" "in ACL"
31228 .cindex "black list (DNS)"
31229 .cindex "&ACL;" "testing a DNS list"
31230 In its simplest form, the &%dnslists%& condition tests whether the calling host
31231 is on at least one of a number of DNS lists by looking up the inverted IP
31232 address in one or more DNS domains. (Note that DNS list domains are not mail
31233 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31234 special options instead.) For example, if the calling host's IP
31235 address is 192.168.62.43, and the ACL statement is
31236 .code
31237 deny dnslists = blackholes.mail-abuse.org : \
31238                 dialups.mail-abuse.org
31239 .endd
31240 the following records are looked up:
31241 .code
31242 43.62.168.192.blackholes.mail-abuse.org
31243 43.62.168.192.dialups.mail-abuse.org
31244 .endd
31245 As soon as Exim finds an existing DNS record, processing of the list stops.
31246 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31247 to test that a host is on more than one list (an &"and"& conjunction), you can
31248 use two separate conditions:
31249 .code
31250 deny dnslists = blackholes.mail-abuse.org
31251      dnslists = dialups.mail-abuse.org
31252 .endd
31253 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31254 behaves as if the host does not match the list item, that is, as if the DNS
31255 record does not exist. If there are further items in the DNS list, they are
31256 processed.
31257
31258 This is usually the required action when &%dnslists%& is used with &%deny%&
31259 (which is the most common usage), because it prevents a DNS failure from
31260 blocking mail. However, you can change this behaviour by putting one of the
31261 following special items in the list:
31262 .display
31263 &`+include_unknown `&   behave as if the item is on the list
31264 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31265 &`+defer_unknown   `&   give a temporary error
31266 .endd
31267 .cindex "&`+include_unknown`&"
31268 .cindex "&`+exclude_unknown`&"
31269 .cindex "&`+defer_unknown`&"
31270 Each of these applies to any subsequent items on the list. For example:
31271 .code
31272 deny dnslists = +defer_unknown : foo.bar.example
31273 .endd
31274 Testing the list of domains stops as soon as a match is found. If you want to
31275 warn for one list and block for another, you can use two different statements:
31276 .code
31277 deny  dnslists = blackholes.mail-abuse.org
31278 warn  message  = X-Warn: sending host is on dialups list
31279       dnslists = dialups.mail-abuse.org
31280 .endd
31281 .cindex caching "of dns lookup"
31282 .cindex DNS TTL
31283 DNS list lookups are cached by Exim for the duration of the SMTP session
31284 (but limited by the DNS return TTL value),
31285 so a lookup based on the IP address is done at most once for any incoming
31286 connection (assuming long-enough TTL).
31287 Exim does not share information between multiple incoming
31288 connections (but your local name server cache should be active).
31289
31290 There are a number of DNS lists to choose from, some commercial, some free,
31291 or free for small deployments.  An overview can be found at
31292 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31293
31294
31295
31296 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31297 .cindex "DNS list" "keyed by explicit IP address"
31298 By default, the IP address that is used in a DNS list lookup is the IP address
31299 of the calling host. However, you can specify another IP address by listing it
31300 after the domain name, introduced by a slash. For example:
31301 .code
31302 deny dnslists = black.list.tld/192.168.1.2
31303 .endd
31304 This feature is not very helpful with explicit IP addresses; it is intended for
31305 use with IP addresses that are looked up, for example, the IP addresses of the
31306 MX hosts or nameservers of an email sender address. For an example, see section
31307 &<<SECTmulkeyfor>>& below.
31308
31309
31310
31311
31312 .section "DNS lists keyed on domain names" "SECID202"
31313 .cindex "DNS list" "keyed by domain name"
31314 There are some lists that are keyed on domain names rather than inverted IP
31315 addresses (see, e.g., the &'domain based zones'& link at
31316 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31317 with these lists. You can change the name that is looked up in a DNS list by
31318 listing it after the domain name, introduced by a slash. For example,
31319 .code
31320 deny  message  = Sender's domain is listed at $dnslist_domain
31321       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31322 .endd
31323 This particular example is useful only in ACLs that are obeyed after the
31324 RCPT or DATA commands, when a sender address is available. If (for
31325 example) the message's sender is &'user@tld.example'& the name that is looked
31326 up by this example is
31327 .code
31328 tld.example.dsn.rfc-ignorant.org
31329 .endd
31330 A single &%dnslists%& condition can contain entries for both names and IP
31331 addresses. For example:
31332 .code
31333 deny dnslists = sbl.spamhaus.org : \
31334                 dsn.rfc-ignorant.org/$sender_address_domain
31335 .endd
31336 The first item checks the sending host's IP address; the second checks a domain
31337 name. The whole condition is true if either of the DNS lookups succeeds.
31338
31339
31340
31341
31342 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31343 .cindex "DNS list" "multiple keys for"
31344 The syntax described above for looking up explicitly-defined values (either
31345 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31346 name for the DNS list, what follows the slash can in fact be a list of items.
31347 As with all lists in Exim, the default separator is a colon. However, because
31348 this is a sublist within the list of DNS blacklist domains, it is necessary
31349 either to double the separators like this:
31350 .code
31351 dnslists = black.list.tld/name.1::name.2
31352 .endd
31353 or to change the separator character, like this:
31354 .code
31355 dnslists = black.list.tld/<;name.1;name.2
31356 .endd
31357 If an item in the list is an IP address, it is inverted before the DNS
31358 blacklist domain is appended. If it is not an IP address, no inversion
31359 occurs. Consider this condition:
31360 .code
31361 dnslists = black.list.tld/<;192.168.1.2;a.domain
31362 .endd
31363 The DNS lookups that occur are:
31364 .code
31365 2.1.168.192.black.list.tld
31366 a.domain.black.list.tld
31367 .endd
31368 Once a DNS record has been found (that matches a specific IP return
31369 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31370 are done. If there is a temporary DNS error, the rest of the sublist of domains
31371 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31372 only if no other DNS lookup in this sublist succeeds. In other words, a
31373 successful lookup for any of the items in the sublist overrides a temporary
31374 error for a previous item.
31375
31376 The ability to supply a list of items after the slash is in some sense just a
31377 syntactic convenience. These two examples have the same effect:
31378 .code
31379 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31380 dnslists = black.list.tld/a.domain::b.domain
31381 .endd
31382 However, when the data for the list is obtained from a lookup, the second form
31383 is usually much more convenient. Consider this example:
31384 .code
31385 deny message  = The mail servers for the domain \
31386                 $sender_address_domain \
31387                 are listed at $dnslist_domain ($dnslist_value); \
31388                 see $dnslist_text.
31389      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31390                                    ${lookup dnsdb {>|mxh=\
31391                                    $sender_address_domain} }} }
31392 .endd
31393 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31394 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31395 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31396 of expanding the condition might be something like this:
31397 .code
31398 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31399 .endd
31400 Thus, this example checks whether or not the IP addresses of the sender
31401 domain's mail servers are on the Spamhaus black list.
31402
31403 The key that was used for a successful DNS list lookup is put into the variable
31404 &$dnslist_matched$& (see section &<<SECID204>>&).
31405
31406
31407
31408
31409 .section "Data returned by DNS lists" "SECID203"
31410 .cindex "DNS list" "data returned from"
31411 DNS lists are constructed using address records in the DNS. The original RBL
31412 just used the address 127.0.0.1 on the right hand side of each record, but the
31413 RBL+ list and some other lists use a number of values with different meanings.
31414 The values used on the RBL+ list are:
31415 .display
31416 127.1.0.1  RBL
31417 127.1.0.2  DUL
31418 127.1.0.3  DUL and RBL
31419 127.1.0.4  RSS
31420 127.1.0.5  RSS and RBL
31421 127.1.0.6  RSS and DUL
31422 127.1.0.7  RSS and DUL and RBL
31423 .endd
31424 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31425 different values. Some DNS lists may return more than one address record;
31426 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31427
31428
31429 .section "Variables set from DNS lists" "SECID204"
31430 .cindex "expansion" "variables, set from DNS list"
31431 .cindex "DNS list" "variables set from"
31432 .vindex "&$dnslist_domain$&"
31433 .vindex "&$dnslist_matched$&"
31434 .vindex "&$dnslist_text$&"
31435 .vindex "&$dnslist_value$&"
31436 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31437 the name of the overall domain that matched (for example,
31438 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31439 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31440 the DNS record. When the key is an IP address, it is not reversed in
31441 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31442 cases, for example:
31443 .code
31444 deny dnslists = spamhaus.example
31445 .endd
31446 the key is also available in another variable (in this case,
31447 &$sender_host_address$&). In more complicated cases, however, this is not true.
31448 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31449 might generate a dnslists lookup like this:
31450 .code
31451 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31452 .endd
31453 If this condition succeeds, the value in &$dnslist_matched$& might be
31454 &`192.168.6.7`& (for example).
31455
31456 If more than one address record is returned by the DNS lookup, all the IP
31457 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31458 The variable &$dnslist_text$& contains the contents of any associated TXT
31459 record. For lists such as RBL+ the TXT record for a merged entry is often not
31460 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31461 information.
31462
31463 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31464 &-- although these appear before the condition in the ACL, they are not
31465 expanded until after it has failed. For example:
31466 .code
31467 deny    hosts = !+local_networks
31468         message = $sender_host_address is listed \
31469                   at $dnslist_domain
31470         dnslists = rbl-plus.mail-abuse.example
31471 .endd
31472
31473
31474
31475 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31476 .cindex "DNS list" "matching specific returned data"
31477 You can add an equals sign and an IP address after a &%dnslists%& domain name
31478 in order to restrict its action to DNS records with a matching right hand side.
31479 For example,
31480 .code
31481 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31482 .endd
31483 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31484 any address record is considered to be a match. For the moment, we assume
31485 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31486 describes how multiple records are handled.
31487
31488 More than one IP address may be given for checking, using a comma as a
31489 separator. These are alternatives &-- if any one of them matches, the
31490 &%dnslists%& condition is true. For example:
31491 .code
31492 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31493 .endd
31494 If you want to specify a constraining address list and also specify names or IP
31495 addresses to be looked up, the constraining address list must be specified
31496 first. For example:
31497 .code
31498 deny dnslists = dsn.rfc-ignorant.org\
31499                 =127.0.0.2/$sender_address_domain
31500 .endd
31501
31502 If the character &`&&`& is used instead of &`=`&, the comparison for each
31503 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31504 In other words, the listed addresses are used as bit masks. The comparison is
31505 true if all the bits in the mask are present in the address that is being
31506 tested. For example:
31507 .code
31508 dnslists = a.b.c&0.0.0.3
31509 .endd
31510 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31511 want to test whether one bit or another bit is present (as opposed to both
31512 being present), you must use multiple values. For example:
31513 .code
31514 dnslists = a.b.c&0.0.0.1,0.0.0.2
31515 .endd
31516 matches if the final component of the address is an odd number or two times
31517 an odd number.
31518
31519
31520
31521 .section "Negated DNS matching conditions" "SECID205"
31522 You can supply a negative list of IP addresses as part of a &%dnslists%&
31523 condition. Whereas
31524 .code
31525 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31526 .endd
31527 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31528 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31529 .code
31530 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31531 .endd
31532 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31533 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31534 words, the result of the test is inverted if an exclamation mark appears before
31535 the &`=`& (or the &`&&`&) sign.
31536
31537 &*Note*&: This kind of negation is not the same as negation in a domain,
31538 host, or address list (which is why the syntax is different).
31539
31540 If you are using just one list, the negation syntax does not gain you much. The
31541 previous example is precisely equivalent to
31542 .code
31543 deny  dnslists = a.b.c
31544      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31545 .endd
31546 However, if you are using multiple lists, the negation syntax is clearer.
31547 Consider this example:
31548 .code
31549 deny  dnslists = sbl.spamhaus.org : \
31550                  list.dsbl.org : \
31551                  dnsbl.njabl.org!=127.0.0.3 : \
31552                  relays.ordb.org
31553 .endd
31554 Using only positive lists, this would have to be:
31555 .code
31556 deny  dnslists = sbl.spamhaus.org : \
31557                  list.dsbl.org
31558 deny  dnslists = dnsbl.njabl.org
31559      !dnslists = dnsbl.njabl.org=127.0.0.3
31560 deny  dnslists = relays.ordb.org
31561 .endd
31562 which is less clear, and harder to maintain.
31563
31564
31565
31566
31567 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31568 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31569 thereby providing more than one IP address. When an item in a &%dnslists%& list
31570 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31571 the match to specific results from the DNS lookup, there are two ways in which
31572 the checking can be handled. For example, consider the condition:
31573 .code
31574 dnslists = a.b.c=127.0.0.1
31575 .endd
31576 What happens if the DNS lookup for the incoming IP address yields both
31577 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31578 condition true because at least one given value was found, or is it false
31579 because at least one of the found values was not listed? And how does this
31580 affect negated conditions? Both possibilities are provided for with the help of
31581 additional separators &`==`& and &`=&&`&.
31582
31583 .ilist
31584 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31585 IP addresses matches one of the listed addresses. For the example above, the
31586 condition is true because 127.0.0.1 matches.
31587 .next
31588 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31589 looked up IP addresses matches one of the listed addresses. If the condition is
31590 changed to:
31591 .code
31592 dnslists = a.b.c==127.0.0.1
31593 .endd
31594 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31595 false because 127.0.0.2 is not listed. You would need to have:
31596 .code
31597 dnslists = a.b.c==127.0.0.1,127.0.0.2
31598 .endd
31599 for the condition to be true.
31600 .endlist
31601
31602 When &`!`& is used to negate IP address matching, it inverts the result, giving
31603 the precise opposite of the behaviour above. Thus:
31604 .ilist
31605 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31606 addresses matches one of the listed addresses. Consider:
31607 .code
31608 dnslists = a.b.c!&0.0.0.1
31609 .endd
31610 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31611 false because 127.0.0.1 matches.
31612 .next
31613 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31614 looked up IP address that does not match. Consider:
31615 .code
31616 dnslists = a.b.c!=&0.0.0.1
31617 .endd
31618 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31619 true, because 127.0.0.2 does not match. You would need to have:
31620 .code
31621 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31622 .endd
31623 for the condition to be false.
31624 .endlist
31625 When the DNS lookup yields only a single IP address, there is no difference
31626 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31627
31628
31629
31630
31631 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31632 .cindex "DNS list" "information from merged"
31633 When the facility for restricting the matching IP values in a DNS list is used,
31634 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31635 the true reason for rejection. This happens when lists are merged and the IP
31636 address in the A record is used to distinguish them; unfortunately there is
31637 only one TXT record. One way round this is not to use merged lists, but that
31638 can be inefficient because it requires multiple DNS lookups where one would do
31639 in the vast majority of cases when the host of interest is not on any of the
31640 lists.
31641
31642 A less inefficient way of solving this problem is available. If
31643 two domain names, comma-separated, are given, the second is used first to
31644 do an initial check, making use of any IP value restrictions that are set.
31645 If there is a match, the first domain is used, without any IP value
31646 restrictions, to get the TXT record. As a byproduct of this, there is also
31647 a check that the IP being tested is indeed on the first list. The first
31648 domain is the one that is put in &$dnslist_domain$&. For example:
31649 .code
31650 deny message  = \
31651          rejected because $sender_host_address is blacklisted \
31652          at $dnslist_domain\n$dnslist_text
31653        dnslists = \
31654          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31655          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31656 .endd
31657 For the first blacklist item, this starts by doing a lookup in
31658 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31659 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31660 value, and as long as something is found, it looks for the corresponding TXT
31661 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31662 The second blacklist item is processed similarly.
31663
31664 If you are interested in more than one merged list, the same list must be
31665 given several times, but because the results of the DNS lookups are cached,
31666 the DNS calls themselves are not repeated. For example:
31667 .code
31668 deny dnslists = \
31669          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31670          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31671          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31672          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31673 .endd
31674 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31675 values matches (or if no record is found), this is the only lookup that is
31676 done. Only if there is a match is one of the more specific lists consulted.
31677
31678
31679
31680 .section "DNS lists and IPv6" "SECTmorednslistslast"
31681 .cindex "IPv6" "DNS black lists"
31682 .cindex "DNS list" "IPv6 usage"
31683 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31684 nibble by nibble. For example, if the calling host's IP address is
31685 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31686 .code
31687 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31688   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31689 .endd
31690 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31691 lists contain wildcard records, intended for IPv4, that interact badly with
31692 IPv6. For example, the DNS entry
31693 .code
31694 *.3.some.list.example.    A    127.0.0.1
31695 .endd
31696 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31697 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31698
31699 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31700 &%condition%& condition, as in this example:
31701 .code
31702 deny   condition = ${if isip4{$sender_host_address}}
31703        dnslists  = some.list.example
31704 .endd
31705
31706 If an explicit key is being used for a DNS lookup and it may be an IPv6
31707 address you should specify alternate list separators for both the outer
31708 (DNS list name) list and inner (lookup keys) list:
31709 .code
31710        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31711 .endd
31712
31713 .section "Rate limiting incoming messages" "SECTratelimiting"
31714 .cindex "rate limiting" "client sending"
31715 .cindex "limiting client sending rates"
31716 .oindex "&%smtp_ratelimit_*%&"
31717 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31718 which clients can send email. This is more powerful than the
31719 &%smtp_ratelimit_*%& options, because those options control the rate of
31720 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31721 works across all connections (concurrent and sequential) from the same client
31722 host. The syntax of the &%ratelimit%& condition is:
31723 .display
31724 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31725 .endd
31726 If the average client sending rate is less than &'m'& messages per time
31727 period &'p'& then the condition is false; otherwise it is true.
31728
31729 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31730 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31731 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31732 of &'p'&.
31733
31734 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31735 time interval, for example, &`8h`& for eight hours. A larger time constant
31736 means that it takes Exim longer to forget a client's past behaviour. The
31737 parameter &'m'& is the maximum number of messages that a client is permitted to
31738 send in each time interval. It also specifies the number of messages permitted
31739 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31740 constant, you can allow a client to send more messages in a burst without
31741 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31742 both small, messages must be sent at an even rate.
31743
31744 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31745 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31746 when deploying the &%ratelimit%& ACL condition. The script prints usage
31747 instructions when it is run with no arguments.
31748
31749 The key is used to look up the data for calculating the client's average
31750 sending rate. This data is stored in Exim's spool directory, alongside the
31751 retry and other hints databases. The default key is &$sender_host_address$&,
31752 which means Exim computes the sending rate of each client host IP address.
31753 By changing the key you can change how Exim identifies clients for the purpose
31754 of ratelimiting. For example, to limit the sending rate of each authenticated
31755 user, independent of the computer they are sending from, set the key to
31756 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31757 example, &$authenticated_id$& is only meaningful if the client has
31758 authenticated (which you can check with the &%authenticated%& ACL condition).
31759
31760 The lookup key does not have to identify clients: If you want to limit the
31761 rate at which a recipient receives messages, you can use the key
31762 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31763 ACL.
31764
31765 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31766 specifies what Exim measures the rate of, for example, messages or recipients
31767 or bytes. You can adjust the measurement using the &%unique=%& and/or
31768 &%count=%& options. You can also control when Exim updates the recorded rate
31769 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31770 separated by a slash, like the other parameters. They may appear in any order.
31771
31772 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31773 any options that alter the meaning of the stored data. The limit &'m'& is not
31774 stored, so you can alter the configured maximum rate and Exim will still
31775 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31776 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31777 behaviour. The lookup key is not affected by changes to the update mode and
31778 the &%count=%& option.
31779
31780
31781 .section "Ratelimit options for what is being measured" "ratoptmea"
31782 .cindex "rate limiting" "per_* options"
31783 The &%per_conn%& option limits the client's connection rate. It is not
31784 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31785 &%acl_not_smtp_start%& ACLs.
31786
31787 The &%per_mail%& option limits the client's rate of sending messages. This is
31788 the default if none of the &%per_*%& options is specified. It can be used in
31789 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31790 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31791
31792 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31793 the same ACLs as the &%per_mail%& option, though it is best to use this option
31794 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31795 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31796 in its MAIL command, which may be inaccurate or completely missing. You can
31797 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31798 in kilobytes, megabytes, or gigabytes, respectively.
31799
31800 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31801 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31802 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31803 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31804 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31805 in either case the rate limiting engine will see a message with many
31806 recipients as a large high-speed burst.
31807
31808 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31809 number of different recipients that the client has sent messages to in the
31810 last time period. That is, if the client repeatedly sends messages to the same
31811 recipient, its measured rate is not increased. This option can only be used in
31812 &%acl_smtp_rcpt%&.
31813
31814 The &%per_cmd%& option causes Exim to recompute the rate every time the
31815 condition is processed. This can be used to limit the rate of any SMTP
31816 command. If it is used in multiple ACLs it can limit the aggregate rate of
31817 multiple different commands.
31818
31819 The &%count=%& option can be used to alter how much Exim adds to the client's
31820 measured rate. For example, the &%per_byte%& option is equivalent to
31821 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31822 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31823 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31824
31825 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31826
31827
31828 .section "Ratelimit update modes" "ratoptupd"
31829 .cindex "rate limiting" "reading data without updating"
31830 You can specify one of three options with the &%ratelimit%& condition to
31831 control when its database is updated. This section describes the &%readonly%&
31832 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31833
31834 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31835 previously-computed rate to check against the limit.
31836
31837 For example, you can test the client's sending rate and deny it access (when
31838 it is too fast) in the connect ACL. If the client passes this check then it
31839 can go on to send a message, in which case its recorded rate will be updated
31840 in the MAIL ACL. Subsequent connections from the same client will check this
31841 new rate.
31842 .code
31843 acl_check_connect:
31844  deny ratelimit = 100 / 5m / readonly
31845     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31846                   (max $sender_rate_limit)
31847 # ...
31848 acl_check_mail:
31849  warn ratelimit = 100 / 5m / strict
31850     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31851                   (max $sender_rate_limit)
31852 .endd
31853
31854 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31855 processing a message then it may increase the client's measured rate more than
31856 it should. For example, this will happen if you check the &%per_rcpt%& option
31857 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31858 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31859 multiple update problems by using the &%readonly%& option on later ratelimit
31860 checks.
31861
31862 The &%per_*%& options described above do not make sense in some ACLs. If you
31863 use a &%per_*%& option in an ACL where it is not normally permitted then the
31864 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31865 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31866 next section) so you must specify the &%readonly%& option explicitly.
31867
31868
31869 .section "Ratelimit options for handling fast clients" "ratoptfast"
31870 .cindex "rate limiting" "strict and leaky modes"
31871 If a client's average rate is greater than the maximum, the rate limiting
31872 engine can react in two possible ways, depending on the presence of the
31873 &%strict%& or &%leaky%& update modes. This is independent of the other
31874 counter-measures (such as rejecting the message) that may be specified by the
31875 rest of the ACL.
31876
31877 The &%leaky%& (default) option means that the client's recorded rate is not
31878 updated if it is above the limit. The effect of this is that Exim measures the
31879 client's average rate of successfully sent email,
31880 up to the given limit.
31881 This is appropriate if the countermeasure when the condition is true
31882 consists of refusing the message, and
31883 is generally the better choice if you have clients that retry automatically.
31884 If the action when true is anything more complex then this option is
31885 likely not what is wanted.
31886
31887 The &%strict%& option means that the client's recorded rate is always
31888 updated. The effect of this is that Exim measures the client's average rate
31889 of attempts to send email, which can be much higher than the maximum it is
31890 actually allowed. If the client is over the limit it may be subjected to
31891 counter-measures by the ACL. It must slow down and allow sufficient time to
31892 pass that its computed rate falls below the maximum before it can send email
31893 again. The time (the number of smoothing periods) it must wait and not
31894 attempt to send mail can be calculated with this formula:
31895 .code
31896         ln(peakrate/maxrate)
31897 .endd
31898
31899
31900 .section "Limiting the rate of different events" "ratoptuniq"
31901 .cindex "rate limiting" "counting unique events"
31902 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31903 rate of different events. For example, the &%per_addr%& option uses this
31904 mechanism to count the number of different recipients that the client has
31905 sent messages to in the last time period; it is equivalent to
31906 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31907 measure the rate that a client uses different sender addresses with the
31908 options &`per_mail/unique=$sender_address`&.
31909
31910 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31911 has seen for that key. The whole set is thrown away when it is older than the
31912 rate smoothing period &'p'&, so each different event is counted at most once
31913 per period. In the &%leaky%& update mode, an event that causes the client to
31914 go over the limit is not added to the set, in the same way that the client's
31915 recorded rate is not updated in the same situation.
31916
31917 When you combine the &%unique=%& and &%readonly%& options, the specific
31918 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31919 rate.
31920
31921 The &%unique=%& mechanism needs more space in the ratelimit database than the
31922 other &%ratelimit%& options in order to store the event set. The number of
31923 unique values is potentially as large as the rate limit, so the extra space
31924 required increases with larger limits.
31925
31926 The uniqueification is not perfect: there is a small probability that Exim
31927 will think a new event has happened before. If the sender's rate is less than
31928 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31929 the measured rate can go above the limit, in which case Exim may under-count
31930 events by a significant margin. Fortunately, if the rate is high enough (2.7
31931 times the limit) that the false positive rate goes above 9%, then Exim will
31932 throw away the over-full event set before the measured rate falls below the
31933 limit. Therefore the only harm should be that exceptionally high sending rates
31934 are logged incorrectly; any countermeasures you configure will be as effective
31935 as intended.
31936
31937
31938 .section "Using rate limiting" "useratlim"
31939 Exim's other ACL facilities are used to define what counter-measures are taken
31940 when the rate limit is exceeded. This might be anything from logging a warning
31941 (for example, while measuring existing sending rates in order to define
31942 policy), through time delays to slow down fast senders, up to rejecting the
31943 message. For example:
31944 .code
31945 # Log all senders' rates
31946 warn ratelimit = 0 / 1h / strict
31947      log_message = Sender rate $sender_rate / $sender_rate_period
31948
31949 # Slow down fast senders; note the need to truncate $sender_rate
31950 # at the decimal point.
31951 warn ratelimit = 100 / 1h / per_rcpt / strict
31952      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31953                    $sender_rate_limit }s
31954
31955 # Keep authenticated users under control
31956 deny authenticated = *
31957      ratelimit = 100 / 1d / strict / $authenticated_id
31958
31959 # System-wide rate limit
31960 defer message = Sorry, too busy. Try again later.
31961      ratelimit = 10 / 1s / $primary_hostname
31962
31963 # Restrict incoming rate from each host, with a default
31964 # set using a macro and special cases looked up in a table.
31965 defer message = Sender rate exceeds $sender_rate_limit \
31966                messages per $sender_rate_period
31967      ratelimit = ${lookup {$sender_host_address} \
31968                    cdb {DB/ratelimits.cdb} \
31969                    {$value} {RATELIMIT} }
31970 .endd
31971 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31972 especially with the &%per_rcpt%& option, you may suffer from a performance
31973 bottleneck caused by locking on the ratelimit hints database. Apart from
31974 making your ACLs less complicated, you can reduce the problem by using a
31975 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31976 this means that Exim will lose its hints data after a reboot (including retry
31977 hints, the callout cache, and ratelimit data).
31978
31979
31980
31981 .section "Address verification" "SECTaddressverification"
31982 .cindex "verifying address" "options for"
31983 .cindex "policy control" "address verification"
31984 Several of the &%verify%& conditions described in section
31985 &<<SECTaclconditions>>& cause addresses to be verified. Section
31986 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31987 The verification conditions can be followed by options that modify the
31988 verification process. The options are separated from the keyword and from each
31989 other by slashes, and some of them contain parameters. For example:
31990 .code
31991 verify = sender/callout
31992 verify = recipient/defer_ok/callout=10s,defer_ok
31993 .endd
31994 The first stage of address verification, which always happens, is to run the
31995 address through the routers, in &"verify mode"&. Routers can detect the
31996 difference between verification and routing for delivery, and their actions can
31997 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31998 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31999 The available options are as follows:
32000
32001 .ilist
32002 If the &%callout%& option is specified, successful routing to one or more
32003 remote hosts is followed by a &"callout"& to those hosts as an additional
32004 check. Callouts and their sub-options are discussed in the next section.
32005 .next
32006 If there is a defer error while doing verification routing, the ACL
32007 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32008 options, the condition is forced to be true instead. Note that this is a main
32009 verification option as well as a suboption for callouts.
32010 .next
32011 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32012 discusses the reporting of sender address verification failures.
32013 .next
32014 The &%success_on_redirect%& option causes verification always to succeed
32015 immediately after a successful redirection. By default, if a redirection
32016 generates just one address, that address is also verified. See further
32017 discussion in section &<<SECTredirwhilveri>>&.
32018 .endlist
32019
32020 .cindex "verifying address" "differentiating failures"
32021 .vindex "&$recipient_verify_failure$&"
32022 .vindex "&$sender_verify_failure$&"
32023 .vindex "&$acl_verify_message$&"
32024 After an address verification failure, &$acl_verify_message$& contains the
32025 error message that is associated with the failure. It can be preserved by
32026 coding like this:
32027 .code
32028 warn  !verify = sender
32029        set acl_m0 = $acl_verify_message
32030 .endd
32031 If you are writing your own custom rejection message or log message when
32032 denying access, you can use this variable to include information about the
32033 verification failure.
32034
32035 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32036 appropriate) contains one of the following words:
32037
32038 .ilist
32039 &%qualify%&: The address was unqualified (no domain), and the message
32040 was neither local nor came from an exempted host.
32041 .next
32042 &%route%&: Routing failed.
32043 .next
32044 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32045 occurred at or before the MAIL command (that is, on initial
32046 connection, HELO, or MAIL).
32047 .next
32048 &%recipient%&: The RCPT command in a callout was rejected.
32049 .next
32050 &%postmaster%&: The postmaster check in a callout was rejected.
32051 .endlist
32052
32053 The main use of these variables is expected to be to distinguish between
32054 rejections of MAIL and rejections of RCPT in callouts.
32055
32056 The above variables may also be set after a &*successful*&
32057 address verification to:
32058
32059 .ilist
32060 &%random%&: A random local-part callout succeeded
32061 .endlist
32062
32063
32064
32065
32066 .section "Callout verification" "SECTcallver"
32067 .cindex "verifying address" "by callout"
32068 .cindex "callout" "verification"
32069 .cindex "SMTP" "callout verification"
32070 For non-local addresses, routing verifies the domain, but is unable to do any
32071 checking of the local part. There are situations where some means of verifying
32072 the local part is desirable. One way this can be done is to make an SMTP
32073 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32074 a subsequent host for a recipient address, to see if the host accepts the
32075 address. We use the term &'callout'& to cover both cases. Note that for a
32076 sender address, the callback is not to the client host that is trying to
32077 deliver the message, but to one of the hosts that accepts incoming mail for the
32078 sender's domain.
32079
32080 Exim does not do callouts by default. If you want them to happen, you must
32081 request them by setting appropriate options on the &%verify%& condition, as
32082 described below. This facility should be used with care, because it can add a
32083 lot of resource usage to the cost of verifying an address. However, Exim does
32084 cache the results of callouts, which helps to reduce the cost. Details of
32085 caching are in section &<<SECTcallvercache>>&.
32086
32087 Recipient callouts are usually used only between hosts that are controlled by
32088 the same administration. For example, a corporate gateway host could use
32089 callouts to check for valid recipients on an internal mailserver. A successful
32090 callout does not guarantee that a real delivery to the address would succeed;
32091 on the other hand, a failing callout does guarantee that a delivery would fail.
32092
32093 If the &%callout%& option is present on a condition that verifies an address, a
32094 second stage of verification occurs if the address is successfully routed to
32095 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32096 &(manualroute)& router, where the router specifies the hosts. However, if a
32097 router that does not set up hosts routes to an &(smtp)& transport with a
32098 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32099 &%hosts_override%& set, its hosts are always used, whether or not the router
32100 supplies a host list.
32101 Callouts are only supported on &(smtp)& transports.
32102
32103 The port that is used is taken from the transport, if it is specified and is a
32104 remote transport. (For routers that do verification only, no transport need be
32105 specified.) Otherwise, the default SMTP port is used. If a remote transport
32106 specifies an outgoing interface, this is used; otherwise the interface is not
32107 specified. Likewise, the text that is used for the HELO command is taken from
32108 the transport's &%helo_data%& option; if there is no transport, the value of
32109 &$smtp_active_hostname$& is used.
32110
32111 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32112 test whether a bounce message could be delivered to the sender address. The
32113 following SMTP commands are sent:
32114 .display
32115 &`HELO `&<&'local host name'&>
32116 &`MAIL FROM:<>`&
32117 &`RCPT TO:`&<&'the address to be tested'&>
32118 &`QUIT`&
32119 .endd
32120 LHLO is used instead of HELO if the transport's &%protocol%& option is
32121 set to &"lmtp"&.
32122
32123 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32124 settings.
32125
32126 A recipient callout check is similar. By default, it also uses an empty address
32127 for the sender. This default is chosen because most hosts do not make use of
32128 the sender address when verifying a recipient. Using the same address means
32129 that a single cache entry can be used for each recipient. Some sites, however,
32130 do make use of the sender address when verifying. These are catered for by the
32131 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32132
32133 If the response to the RCPT command is a 2&'xx'& code, the verification
32134 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32135 Exim tries the next host, if any. If there is a problem with all the remote
32136 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32137 &%callout%& option is given, in which case the condition is forced to succeed.
32138
32139 .cindex "SMTP" "output flushing, disabling for callout"
32140 A callout may take a little time. For this reason, Exim normally flushes SMTP
32141 output before performing a callout in an ACL, to avoid unexpected timeouts in
32142 clients when the SMTP PIPELINING extension is in use. The flushing can be
32143 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32144
32145
32146
32147
32148 .section "Additional parameters for callouts" "CALLaddparcall"
32149 .cindex "callout" "additional parameters for"
32150 The &%callout%& option can be followed by an equals sign and a number of
32151 optional parameters, separated by commas. For example:
32152 .code
32153 verify = recipient/callout=10s,defer_ok
32154 .endd
32155 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32156 separate verify options, is retained for backwards compatibility, but is now
32157 deprecated. The additional parameters for &%callout%& are as follows:
32158
32159
32160 .vlist
32161 .vitem <&'a&~time&~interval'&>
32162 .cindex "callout" "timeout, specifying"
32163 This specifies the timeout that applies for the callout attempt to each host.
32164 For example:
32165 .code
32166 verify = sender/callout=5s
32167 .endd
32168 The default is 30 seconds. The timeout is used for each response from the
32169 remote host. It is also used for the initial connection, unless overridden by
32170 the &%connect%& parameter.
32171
32172
32173 .vitem &*connect&~=&~*&<&'time&~interval'&>
32174 .cindex "callout" "connection timeout, specifying"
32175 This parameter makes it possible to set a different (usually smaller) timeout
32176 for making the SMTP connection. For example:
32177 .code
32178 verify = sender/callout=5s,connect=1s
32179 .endd
32180 If not specified, this timeout defaults to the general timeout value.
32181
32182 .vitem &*defer_ok*&
32183 .cindex "callout" "defer, action on"
32184 When this parameter is present, failure to contact any host, or any other kind
32185 of temporary error, is treated as success by the ACL. However, the cache is not
32186 updated in this circumstance.
32187
32188 .vitem &*fullpostmaster*&
32189 .cindex "callout" "full postmaster check"
32190 This operates like the &%postmaster%& option (see below), but if the check for
32191 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32192 accordance with the specification in RFC 2821. The RFC states that the
32193 unqualified address &'postmaster'& should be accepted.
32194
32195
32196 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32197 .cindex "callout" "sender when verifying header"
32198 When verifying addresses in header lines using the &%header_sender%&
32199 verification option, Exim behaves by default as if the addresses are envelope
32200 sender addresses from a message. Callout verification therefore tests to see
32201 whether a bounce message could be delivered, by using an empty address in the
32202 MAIL command. However, it is arguable that these addresses might never be used
32203 as envelope senders, and could therefore justifiably reject bounce messages
32204 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32205 address to use in the MAIL command. For example:
32206 .code
32207 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32208 .endd
32209 This parameter is available only for the &%header_sender%& verification option.
32210
32211
32212 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32213 .cindex "callout" "overall timeout, specifying"
32214 This parameter sets an overall timeout for performing a callout verification.
32215 For example:
32216 .code
32217 verify = sender/callout=5s,maxwait=30s
32218 .endd
32219 This timeout defaults to four times the callout timeout for individual SMTP
32220 commands. The overall timeout applies when there is more than one host that can
32221 be tried. The timeout is checked before trying the next host. This prevents
32222 very long delays if there are a large number of hosts and all are timing out
32223 (for example, when network connections are timing out).
32224
32225
32226 .vitem &*no_cache*&
32227 .cindex "callout" "cache, suppressing"
32228 .cindex "caching callout, suppressing"
32229 When this parameter is given, the callout cache is neither read nor updated.
32230
32231 .vitem &*postmaster*&
32232 .cindex "callout" "postmaster; checking"
32233 When this parameter is set, a successful callout check is followed by a similar
32234 check for the local part &'postmaster'& at the same domain. If this address is
32235 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32236 the postmaster check is recorded in a cache record; if it is a failure, this is
32237 used to fail subsequent callouts for the domain without a connection being
32238 made, until the cache record expires.
32239
32240 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32241 The postmaster check uses an empty sender in the MAIL command by default.
32242 You can use this parameter to do a postmaster check using a different address.
32243 For example:
32244 .code
32245 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32246 .endd
32247 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32248 one overrides. The &%postmaster%& parameter is equivalent to this example:
32249 .code
32250 require  verify = sender/callout=postmaster_mailfrom=
32251 .endd
32252 &*Warning*&: The caching arrangements for postmaster checking do not take
32253 account of the sender address. It is assumed that either the empty address or
32254 a fixed non-empty address will be used. All that Exim remembers is that the
32255 postmaster check for the domain succeeded or failed.
32256
32257
32258 .vitem &*random*&
32259 .cindex "callout" "&""random""& check"
32260 When this parameter is set, before doing the normal callout check, Exim does a
32261 check for a &"random"& local part at the same domain. The local part is not
32262 really random &-- it is defined by the expansion of the option
32263 &%callout_random_local_part%&, which defaults to
32264 .code
32265 $primary_hostname-$tod_epoch-testing
32266 .endd
32267 The idea here is to try to determine whether the remote host accepts all local
32268 parts without checking. If it does, there is no point in doing callouts for
32269 specific local parts. If the &"random"& check succeeds, the result is saved in
32270 a cache record, and used to force the current and subsequent callout checks to
32271 succeed without a connection being made, until the cache record expires.
32272
32273 .vitem &*use_postmaster*&
32274 .cindex "callout" "sender for recipient check"
32275 This parameter applies to recipient callouts only. For example:
32276 .code
32277 deny  !verify = recipient/callout=use_postmaster
32278 .endd
32279 .vindex "&$qualify_domain$&"
32280 It causes a non-empty postmaster address to be used in the MAIL command when
32281 performing the callout for the recipient, and also for a &"random"& check if
32282 that is configured. The local part of the address is &`postmaster`& and the
32283 domain is the contents of &$qualify_domain$&.
32284
32285 .vitem &*use_sender*&
32286 This option applies to recipient callouts only. For example:
32287 .code
32288 require  verify = recipient/callout=use_sender
32289 .endd
32290 It causes the message's actual sender address to be used in the MAIL
32291 command when performing the callout, instead of an empty address. There is no
32292 need to use this option unless you know that the called hosts make use of the
32293 sender when checking recipients. If used indiscriminately, it reduces the
32294 usefulness of callout caching.
32295
32296 .vitem &*hold*&
32297 This option applies to recipient callouts only. For example:
32298 .code
32299 require  verify = recipient/callout=use_sender,hold
32300 .endd
32301 It causes the connection to be held open and used for any further recipients
32302 and for eventual delivery (should that be done quickly).
32303 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32304 when that is used for the connections.
32305 The advantage is only gained if there are no callout cache hits
32306 (which could be enforced by the no_cache option),
32307 if the use_sender option is used,
32308 if neither the random nor the use_postmaster option is used,
32309 and if no other callouts intervene.
32310 .endlist
32311
32312 If you use any of the parameters that set a non-empty sender for the MAIL
32313 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32314 &%use_sender%&), you should think about possible loops. Recipient checking is
32315 usually done between two hosts that are under the same management, and the host
32316 that receives the callouts is not normally configured to do callouts itself.
32317 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32318 these circumstances.
32319
32320 However, if you use a non-empty sender address for a callout to an arbitrary
32321 host, there is the likelihood that the remote host will itself initiate a
32322 callout check back to your host. As it is checking what appears to be a message
32323 sender, it is likely to use an empty address in MAIL, thus avoiding a
32324 callout loop. However, to be on the safe side it would be best to set up your
32325 own ACLs so that they do not do sender verification checks when the recipient
32326 is the address you use for header sender or postmaster callout checking.
32327
32328 Another issue to think about when using non-empty senders for callouts is
32329 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32330 by the sender/recipient combination; thus, for any given recipient, many more
32331 actual callouts are performed than when an empty sender or postmaster is used.
32332
32333
32334
32335
32336 .section "Callout caching" "SECTcallvercache"
32337 .cindex "hints database" "callout cache"
32338 .cindex "callout" "cache, description of"
32339 .cindex "caching" "callout"
32340 Exim caches the results of callouts in order to reduce the amount of resources
32341 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32342 option. A hints database called &"callout"& is used for the cache. Two
32343 different record types are used: one records the result of a callout check for
32344 a specific address, and the other records information that applies to the
32345 entire domain (for example, that it accepts the local part &'postmaster'&).
32346
32347 When an original callout fails, a detailed SMTP error message is given about
32348 the failure. However, for subsequent failures use the cache data, this message
32349 is not available.
32350
32351 The expiry times for negative and positive address cache records are
32352 independent, and can be set by the global options &%callout_negative_expire%&
32353 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32354
32355 If a host gives a negative response to an SMTP connection, or rejects any
32356 commands up to and including
32357 .code
32358 MAIL FROM:<>
32359 .endd
32360 (but not including the MAIL command with a non-empty address),
32361 any callout attempt is bound to fail. Exim remembers such failures in a
32362 domain cache record, which it uses to fail callouts for the domain without
32363 making new connections, until the domain record times out. There are two
32364 separate expiry times for domain cache records:
32365 &%callout_domain_negative_expire%& (default 3h) and
32366 &%callout_domain_positive_expire%& (default 7d).
32367
32368 Domain records expire when the negative expiry time is reached if callouts
32369 cannot be made for the domain, or if the postmaster check failed.
32370 Otherwise, they expire when the positive expiry time is reached. This
32371 ensures that, for example, a host that stops accepting &"random"& local parts
32372 will eventually be noticed.
32373
32374 The callout caching mechanism is based on the domain of the address that is
32375 being tested. If the domain routes to several hosts, it is assumed that their
32376 behaviour will be the same.
32377
32378
32379
32380 .section "Sender address verification reporting" "SECTsenaddver"
32381 .cindex "verifying" "suppressing error details"
32382 See section &<<SECTaddressverification>>& for a general discussion of
32383 verification. When sender verification fails in an ACL, the details of the
32384 failure are given as additional output lines before the 550 response to the
32385 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32386 you might see:
32387 .code
32388 MAIL FROM:<xyz@abc.example>
32389 250 OK
32390 RCPT TO:<pqr@def.example>
32391 550-Verification failed for <xyz@abc.example>
32392 550-Called:   192.168.34.43
32393 550-Sent:     RCPT TO:<xyz@abc.example>
32394 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32395 550 Sender verification failed
32396 .endd
32397 If more than one RCPT command fails in the same way, the details are given
32398 only for the first of them. However, some administrators do not want to send
32399 out this much information. You can suppress the details by adding
32400 &`/no_details`& to the ACL statement that requests sender verification. For
32401 example:
32402 .code
32403 verify = sender/no_details
32404 .endd
32405
32406 .section "Redirection while verifying" "SECTredirwhilveri"
32407 .cindex "verifying" "redirection while"
32408 .cindex "address redirection" "while verifying"
32409 A dilemma arises when a local address is redirected by aliasing or forwarding
32410 during verification: should the generated addresses themselves be verified,
32411 or should the successful expansion of the original address be enough to verify
32412 it? By default, Exim takes the following pragmatic approach:
32413
32414 .ilist
32415 When an incoming address is redirected to just one child address, verification
32416 continues with the child address, and if that fails to verify, the original
32417 verification also fails.
32418 .next
32419 When an incoming address is redirected to more than one child address,
32420 verification does not continue. A success result is returned.
32421 .endlist
32422
32423 This seems the most reasonable behaviour for the common use of aliasing as a
32424 way of redirecting different local parts to the same mailbox. It means, for
32425 example, that a pair of alias entries of the form
32426 .code
32427 A.Wol:   aw123
32428 aw123:   :fail: Gone away, no forwarding address
32429 .endd
32430 work as expected, with both local parts causing verification failure. When a
32431 redirection generates more than one address, the behaviour is more like a
32432 mailing list, where the existence of the alias itself is sufficient for
32433 verification to succeed.
32434
32435 It is possible, however, to change the default behaviour so that all successful
32436 redirections count as successful verifications, however many new addresses are
32437 generated. This is specified by the &%success_on_redirect%& verification
32438 option. For example:
32439 .code
32440 require verify = recipient/success_on_redirect/callout=10s
32441 .endd
32442 In this example, verification succeeds if a router generates a new address, and
32443 the callout does not occur, because no address was routed to a remote host.
32444
32445 When verification is being tested via the &%-bv%& option, the treatment of
32446 redirections is as just described, unless the &%-v%& or any debugging option is
32447 also specified. In that case, full verification is done for every generated
32448 address and a report is output for each of them.
32449
32450
32451
32452 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32453 .cindex "CSA" "verifying"
32454 Client SMTP Authorization is a system that allows a site to advertise
32455 which machines are and are not permitted to send email. This is done by placing
32456 special SRV records in the DNS; these are looked up using the client's HELO
32457 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32458 Authorization checks in Exim are performed by the ACL condition:
32459 .code
32460 verify = csa
32461 .endd
32462 This fails if the client is not authorized. If there is a DNS problem, or if no
32463 valid CSA SRV record is found, or if the client is authorized, the condition
32464 succeeds. These three cases can be distinguished using the expansion variable
32465 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32466 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32467 be likely to cause problems for legitimate email.
32468
32469 The error messages produced by the CSA code include slightly more
32470 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32471 looking up the CSA SRV record, or problems looking up the CSA target
32472 address record. There are four reasons for &$csa_status$& being &"fail"&:
32473
32474 .ilist
32475 The client's host name is explicitly not authorized.
32476 .next
32477 The client's IP address does not match any of the CSA target IP addresses.
32478 .next
32479 The client's host name is authorized but it has no valid target IP addresses
32480 (for example, the target's addresses are IPv6 and the client is using IPv4).
32481 .next
32482 The client's host name has no CSA SRV record but a parent domain has asserted
32483 that all subdomains must be explicitly authorized.
32484 .endlist
32485
32486 The &%csa%& verification condition can take an argument which is the domain to
32487 use for the DNS query. The default is:
32488 .code
32489 verify = csa/$sender_helo_name
32490 .endd
32491 This implementation includes an extension to CSA. If the query domain
32492 is an address literal such as [192.0.2.95], or if it is a bare IP
32493 address, Exim searches for CSA SRV records in the reverse DNS as if
32494 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32495 meaningful to say:
32496 .code
32497 verify = csa/$sender_host_address
32498 .endd
32499 In fact, this is the check that Exim performs if the client does not say HELO.
32500 This extension can be turned off by setting the main configuration option
32501 &%dns_csa_use_reverse%& to be false.
32502
32503 If a CSA SRV record is not found for the domain itself, a search
32504 is performed through its parent domains for a record which might be
32505 making assertions about subdomains. The maximum depth of this search is limited
32506 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32507 default. Exim does not look for CSA SRV records in a top level domain, so the
32508 default settings handle HELO domains as long as seven
32509 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32510 of legitimate HELO domains.
32511
32512 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32513 direct SRV lookups, this is not sufficient because of the extra parent domain
32514 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32515 addresses into lookups in the reverse DNS space. The result of a successful
32516 lookup such as:
32517 .code
32518 ${lookup dnsdb {csa=$sender_helo_name}}
32519 .endd
32520 has two space-separated fields: an authorization code and a target host name.
32521 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32522 authorization required but absent, or &"?"& for unknown.
32523
32524
32525
32526
32527 .section "Bounce address tag validation" "SECTverifyPRVS"
32528 .cindex "BATV, verifying"
32529 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32530 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32531 Genuine incoming bounce messages should therefore always be addressed to
32532 recipients that have a valid tag. This scheme is a way of detecting unwanted
32533 bounce messages caused by sender address forgeries (often called &"collateral
32534 spam"&), because the recipients of such messages do not include valid tags.
32535
32536 There are two expansion items to help with the implementation of the BATV
32537 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32538 the original envelope sender address by using a simple key to add a hash of the
32539 address and some time-based randomizing information. The &%prvs%& expansion
32540 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32541 The syntax of these expansion items is described in section
32542 &<<SECTexpansionitems>>&.
32543 The validity period on signed addresses is seven days.
32544
32545 As an example, suppose the secret per-address keys are stored in an MySQL
32546 database. A query to look up the key for an address could be defined as a macro
32547 like this:
32548 .code
32549 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32550                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32551                 }{$value}}
32552 .endd
32553 Suppose also that the senders who make use of BATV are defined by an address
32554 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32555 use this:
32556 .code
32557 # Bounces: drop unsigned addresses for BATV senders
32558 deny message = This address does not send an unsigned reverse path
32559      senders = :
32560      recipients = +batv_senders
32561
32562 # Bounces: In case of prvs-signed address, check signature.
32563 deny message = Invalid reverse path signature.
32564      senders = :
32565      condition  = ${prvscheck {$local_part@$domain}\
32566                   {PRVSCHECK_SQL}{1}}
32567      !condition = $prvscheck_result
32568 .endd
32569 The first statement rejects recipients for bounce messages that are addressed
32570 to plain BATV sender addresses, because it is known that BATV senders do not
32571 send out messages with plain sender addresses. The second statement rejects
32572 recipients that are prvs-signed, but with invalid signatures (either because
32573 the key is wrong, or the signature has timed out).
32574
32575 A non-prvs-signed address is not rejected by the second statement, because the
32576 &%prvscheck%& expansion yields an empty string if its first argument is not a
32577 prvs-signed address, thus causing the &%condition%& condition to be false. If
32578 the first argument is a syntactically valid prvs-signed address, the yield is
32579 the third string (in this case &"1"&), whether or not the cryptographic and
32580 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32581 of the checks (empty for failure, &"1"& for success).
32582
32583 There is one more issue you must consider when implementing prvs-signing:
32584 you have to ensure that the routers accept prvs-signed addresses and
32585 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32586 router to remove the signature with a configuration along these lines:
32587 .code
32588 batv_redirect:
32589   driver = redirect
32590   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32591 .endd
32592 This works because, if the third argument of &%prvscheck%& is empty, the result
32593 of the expansion of a prvs-signed address is the decoded value of the original
32594 address. This router should probably be the first of your routers that handles
32595 local addresses.
32596
32597 To create BATV-signed addresses in the first place, a transport of this form
32598 can be used:
32599 .code
32600 external_smtp_batv:
32601   driver = smtp
32602   return_path = ${prvs {$return_path} \
32603                        {${lookup mysql{SELECT \
32604                        secret FROM batv_prvs WHERE \
32605                        sender='${quote_mysql:$sender_address}'} \
32606                        {$value}fail}}}
32607 .endd
32608 If no key can be found for the existing return path, no signing takes place.
32609
32610
32611
32612 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32613 .cindex "&ACL;" "relay control"
32614 .cindex "relaying" "control by ACL"
32615 .cindex "policy control" "relay control"
32616 An MTA is said to &'relay'& a message if it receives it from some host and
32617 delivers it directly to another host as a result of a remote address contained
32618 within it. Redirecting a local address via an alias or forward file and then
32619 passing the message on to another host is not relaying,
32620 .cindex "&""percent hack""&"
32621 but a redirection as a result of the &"percent hack"& is.
32622
32623 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32624 A host which is acting as a gateway or an MX backup is concerned with incoming
32625 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32626 a host which is acting as a smart host for a number of clients is concerned
32627 with outgoing relaying from those clients to the Internet at large. Often the
32628 same host is fulfilling both functions,
32629 . ///
32630 . as illustrated in the diagram below,
32631 . ///
32632 but in principle these two kinds of relaying are entirely independent. What is
32633 not wanted is the transmission of mail from arbitrary remote hosts through your
32634 system to arbitrary domains.
32635
32636
32637 You can implement relay control by means of suitable statements in the ACL that
32638 runs for each RCPT command. For convenience, it is often easiest to use
32639 Exim's named list facility to define the domains and hosts involved. For
32640 example, suppose you want to do the following:
32641
32642 .ilist
32643 Deliver a number of domains to mailboxes on the local host (or process them
32644 locally in some other way). Let's say these are &'my.dom1.example'& and
32645 &'my.dom2.example'&.
32646 .next
32647 Relay mail for a number of other domains for which you are the secondary MX.
32648 These might be &'friend1.example'& and &'friend2.example'&.
32649 .next
32650 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32651 Suppose your LAN is 192.168.45.0/24.
32652 .endlist
32653
32654
32655 In the main part of the configuration, you put the following definitions:
32656 .code
32657 domainlist local_domains    = my.dom1.example : my.dom2.example
32658 domainlist relay_to_domains = friend1.example : friend2.example
32659 hostlist   relay_from_hosts = 192.168.45.0/24
32660 .endd
32661 Now you can use these definitions in the ACL that is run for every RCPT
32662 command:
32663 .code
32664 acl_check_rcpt:
32665   accept domains = +local_domains : +relay_to_domains
32666   accept hosts   = +relay_from_hosts
32667 .endd
32668 The first statement accepts any RCPT command that contains an address in
32669 the local or relay domains. For any other domain, control passes to the second
32670 statement, which accepts the command only if it comes from one of the relay
32671 hosts. In practice, you will probably want to make your ACL more sophisticated
32672 than this, for example, by including sender and recipient verification. The
32673 default configuration includes a more comprehensive example, which is described
32674 in chapter &<<CHAPdefconfil>>&.
32675
32676
32677
32678 .section "Checking a relay configuration" "SECTcheralcon"
32679 .cindex "relaying" "checking control of"
32680 You can check the relay characteristics of your configuration in the same way
32681 that you can test any ACL behaviour for an incoming SMTP connection, by using
32682 the &%-bh%& option to run a fake SMTP session with which you interact.
32683 .ecindex IIDacl
32684
32685
32686
32687 . ////////////////////////////////////////////////////////////////////////////
32688 . ////////////////////////////////////////////////////////////////////////////
32689
32690 .chapter "Content scanning at ACL time" "CHAPexiscan"
32691 .scindex IIDcosca "content scanning" "at ACL time"
32692 The extension of Exim to include content scanning at ACL time, formerly known
32693 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32694 was integrated into the main source for Exim release 4.50, and Tom continues to
32695 maintain it. Most of the wording of this chapter is taken from Tom's
32696 specification.
32697
32698 It is also possible to scan the content of messages at other times. The
32699 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32700 scanning after all the ACLs have run. A transport filter can be used to scan
32701 messages at delivery time (see the &%transport_filter%& option, described in
32702 chapter &<<CHAPtransportgeneric>>&).
32703
32704 If you want to include the ACL-time content-scanning features when you compile
32705 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32706 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32707
32708 .ilist
32709 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32710 for all MIME parts for SMTP and non-SMTP messages, respectively.
32711 .next
32712 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32713 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32714 run at the end of message reception (the &%acl_smtp_data%& ACL).
32715 .next
32716 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32717 of messages, or parts of messages, for debugging purposes.
32718 .next
32719 Additional expansion variables that are set in the new ACL and by the new
32720 conditions.
32721 .next
32722 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32723 .endlist
32724
32725 Content-scanning is continually evolving, and new features are still being
32726 added. While such features are still unstable and liable to incompatible
32727 changes, they are made available in Exim by setting options whose names begin
32728 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32729 this manual. You can find out about them by reading the file called
32730 &_doc/experimental.txt_&.
32731
32732 All the content-scanning facilities work on a MBOX copy of the message that is
32733 temporarily created in a file called:
32734 .display
32735 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32736 .endd
32737 The &_.eml_& extension is a friendly hint to virus scanners that they can
32738 expect an MBOX-like structure inside that file. The file is created when the
32739 first content scanning facility is called. Subsequent calls to content
32740 scanning conditions open the same file again. The directory is recursively
32741 removed when the &%acl_smtp_data%& ACL has finished running, unless
32742 .code
32743 control = no_mbox_unspool
32744 .endd
32745 has been encountered. When the MIME ACL decodes files, they are put into the
32746 same directory by default.
32747
32748
32749
32750 .section "Scanning for viruses" "SECTscanvirus"
32751 .cindex "virus scanning"
32752 .cindex "content scanning" "for viruses"
32753 .cindex "content scanning" "the &%malware%& condition"
32754 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32755 It supports a &"generic"& interface to scanners called via the shell, and
32756 specialized interfaces for &"daemon"& type virus scanners, which are resident
32757 in memory and thus are much faster.
32758
32759 Since message data needs to have arrived,
32760 the condition may be only called in ACL defined by
32761 &%acl_smtp_data%&,
32762 &%acl_smtp_data_prdr%&,
32763 &%acl_smtp_mime%& or
32764 &%acl_smtp_dkim%&
32765
32766 A timeout of 2 minutes is applied to a scanner call (by default);
32767 if it expires then a defer action is taken.
32768
32769 .oindex "&%av_scanner%&"
32770 You can set the &%av_scanner%& option in the main part of the configuration
32771 to specify which scanner to use, together with any additional options that
32772 are needed. The basic syntax is as follows:
32773 .display
32774 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32775 .endd
32776 If you do not set &%av_scanner%&, it defaults to
32777 .code
32778 av_scanner = sophie:/var/run/sophie
32779 .endd
32780 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32781 before use.
32782 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32783 The following scanner types are supported in this release,
32784 though individual ones can be included or not at build time:
32785
32786 .vlist
32787 .vitem &%avast%&
32788 .cindex "virus scanners" "avast"
32789 This is the scanner daemon of Avast. It has been tested with Avast Core
32790 Security (currently at version 2.2.0).
32791 You can get a trial version at &url(https://www.avast.com) or for Linux
32792 at &url(https://www.avast.com/linux-server-antivirus).
32793 This scanner type takes one option,
32794 which can be either a full path to a UNIX socket,
32795 or host and port specifiers separated by white space.
32796 The host may be a name or an IP address; the port is either a
32797 single number or a pair of numbers with a dash between.
32798 A list of options may follow. These options are interpreted on the
32799 Exim's side of the malware scanner, or are given on separate lines to
32800 the daemon as options before the main scan command.
32801
32802 .cindex &`pass_unscanned`& "avast"
32803 If &`pass_unscanned`&
32804 is set, any files the Avast scanner can't scan (e.g.
32805 decompression bombs, or invalid archives) are considered clean. Use with
32806 care.
32807
32808 For example:
32809 .code
32810 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32811 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32812 av_scanner = avast:192.168.2.22 5036
32813 .endd
32814 If you omit the argument, the default path
32815 &_/var/run/avast/scan.sock_&
32816 is used.
32817 If you use a remote host,
32818 you need to make Exim's spool directory available to it,
32819 as the scanner is passed a file path, not file contents.
32820 For information about available commands and their options you may use
32821 .code
32822 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32823     FLAGS
32824     SENSITIVITY
32825     PACK
32826 .endd
32827
32828 If the scanner returns a temporary failure (e.g. license issues, or
32829 permission problems), the message is deferred and a paniclog entry is
32830 written.  The usual &`defer_ok`& option is available.
32831
32832 .vitem &%aveserver%&
32833 .cindex "virus scanners" "Kaspersky"
32834 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32835 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32836 which is the path to the daemon's UNIX socket. The default is shown in this
32837 example:
32838 .code
32839 av_scanner = aveserver:/var/run/aveserver
32840 .endd
32841
32842
32843 .vitem &%clamd%&
32844 .cindex "virus scanners" "clamd"
32845 This daemon-type scanner is GPL and free. You can get it at
32846 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32847 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32848 in the MIME ACL. This is no longer believed to be necessary.
32849
32850 The options are a list of server specifiers, which may be
32851 a UNIX socket specification,
32852 a TCP socket specification,
32853 or a (global) option.
32854
32855 A socket specification consists of a space-separated list.
32856 For a Unix socket the first element is a full path for the socket,
32857 for a TCP socket the first element is the IP address
32858 and the second a port number,
32859 Any further elements are per-server (non-global) options.
32860 These per-server options are supported:
32861 .code
32862 retry=<timespec>        Retry on connect fail
32863 .endd
32864
32865 The &`retry`& option specifies a time after which a single retry for
32866 a failed connect is made.  The default is to not retry.
32867
32868 If a Unix socket file is specified, only one server is supported.
32869
32870 Examples:
32871 .code
32872 av_scanner = clamd:/opt/clamd/socket
32873 av_scanner = clamd:192.0.2.3 1234
32874 av_scanner = clamd:192.0.2.3 1234:local
32875 av_scanner = clamd:192.0.2.3 1234 retry=10s
32876 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32877 .endd
32878 If the value of av_scanner points to a UNIX socket file or contains the
32879 &`local`&
32880 option, then the ClamAV interface will pass a filename containing the data
32881 to be scanned, which should normally result in less I/O happening and be
32882 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32883 Exim does not assume that there is a common filesystem with the remote host.
32884
32885 The final example shows that multiple TCP targets can be specified.  Exim will
32886 randomly use one for each incoming email (i.e. it load balances them).  Note
32887 that only TCP targets may be used if specifying a list of scanners; a UNIX
32888 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32889 unavailable, Exim will try the remaining one(s) until it finds one that works.
32890 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32891 not keep track of scanner state between multiple messages, and the scanner
32892 selection is random, so the message will get logged in the mainlog for each
32893 email that the down scanner gets chosen first (message wrapped to be readable):
32894 .code
32895 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32896    clamd: connection to localhost, port 3310 failed
32897    (Connection refused)
32898 .endd
32899
32900 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32901 contributing the code for this scanner.
32902
32903 .vitem &%cmdline%&
32904 .cindex "virus scanners" "command line interface"
32905 This is the keyword for the generic command line scanner interface. It can be
32906 used to attach virus scanners that are invoked from the shell. This scanner
32907 type takes 3 mandatory options:
32908
32909 .olist
32910 The full path and name of the scanner binary, with all command line options,
32911 and a placeholder (&`%s`&) for the directory to scan.
32912
32913 .next
32914 A regular expression to match against the STDOUT and STDERR output of the
32915 virus scanner. If the expression matches, a virus was found. You must make
32916 absolutely sure that this expression matches on &"virus found"&. This is called
32917 the &"trigger"& expression.
32918
32919 .next
32920 Another regular expression, containing exactly one pair of parentheses, to
32921 match the name of the virus found in the scanners output. This is called the
32922 &"name"& expression.
32923 .endlist olist
32924
32925 For example, Sophos Sweep reports a virus on a line like this:
32926 .code
32927 Virus 'W32/Magistr-B' found in file ./those.bat
32928 .endd
32929 For the trigger expression, we can match the phrase &"found in file"&. For the
32930 name expression, we want to extract the W32/Magistr-B string, so we can match
32931 for the single quotes left and right of it. Altogether, this makes the
32932 configuration setting:
32933 .code
32934 av_scanner = cmdline:\
32935              /path/to/sweep -ss -all -rec -archive %s:\
32936              found in file:'(.+)'
32937 .endd
32938 .vitem &%drweb%&
32939 .cindex "virus scanners" "DrWeb"
32940 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32941 takes one option,
32942 either a full path to a UNIX socket,
32943 or host and port specifiers separated by white space.
32944 The host may be a name or an IP address; the port is either a
32945 single number or a pair of numbers with a dash between.
32946 For example:
32947 .code
32948 av_scanner = drweb:/var/run/drwebd.sock
32949 av_scanner = drweb:192.168.2.20 31337
32950 .endd
32951 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32952 is used. Thanks to Alex Miller for contributing the code for this scanner.
32953
32954 .vitem &%f-protd%&
32955 .cindex "virus scanners" "f-protd"
32956 The f-protd scanner is accessed via HTTP over TCP.
32957 One argument is taken, being a space-separated hostname and port number
32958 (or port-range).
32959 For example:
32960 .code
32961 av_scanner = f-protd:localhost 10200-10204
32962 .endd
32963 If you omit the argument, the default values shown above are used.
32964
32965 .vitem &%f-prot6d%&
32966 .cindex "virus scanners" "f-prot6d"
32967 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32968 One argument is taken, being a space-separated hostname and port number.
32969 For example:
32970 .code
32971 av_scanner = f-prot6d:localhost 10200
32972 .endd
32973 If you omit the argument, the default values show above are used.
32974
32975 .vitem &%fsecure%&
32976 .cindex "virus scanners" "F-Secure"
32977 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32978 argument which is the path to a UNIX socket. For example:
32979 .code
32980 av_scanner = fsecure:/path/to/.fsav
32981 .endd
32982 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32983 Thelmen for contributing the code for this scanner.
32984
32985 .vitem &%kavdaemon%&
32986 .cindex "virus scanners" "Kaspersky"
32987 This is the scanner daemon of Kaspersky Version 4. This version of the
32988 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32989 scanner type takes one option, which is the path to the daemon's UNIX socket.
32990 For example:
32991 .code
32992 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32993 .endd
32994 The default path is &_/var/run/AvpCtl_&.
32995
32996 .vitem &%mksd%&
32997 .cindex "virus scanners" "mksd"
32998 This was a daemon type scanner that is aimed mainly at Polish users,
32999 though some documentation was available in English.
33000 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33001 and this appears to be a candidate for removal from Exim, unless
33002 we are informed of other virus scanners which use the same protocol
33003 to integrate.
33004 The only option for this scanner type is
33005 the maximum number of processes used simultaneously to scan the attachments,
33006 provided that mksd has
33007 been run with at least the same number of child processes. For example:
33008 .code
33009 av_scanner = mksd:2
33010 .endd
33011 You can safely omit this option (the default value is 1).
33012
33013 .vitem &%sock%&
33014 .cindex "virus scanners" "simple socket-connected"
33015 This is a general-purpose way of talking to simple scanner daemons
33016 running on the local machine.
33017 There are four options:
33018 an address (which may be an IP address and port, or the path of a Unix socket),
33019 a commandline to send (may include a single %s which will be replaced with
33020 the path to the mail file to be scanned),
33021 an RE to trigger on from the returned data,
33022 and an RE to extract malware_name from the returned data.
33023 For example:
33024 .code
33025 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33026 .endd
33027 Note that surrounding whitespace is stripped from each option, meaning
33028 there is no way to specify a trailing newline.
33029 The socket specifier and both regular-expressions are required.
33030 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33031 specify an empty element to get this.
33032
33033 .vitem &%sophie%&
33034 .cindex "virus scanners" "Sophos and Sophie"
33035 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33036 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33037 for this scanner type is the path to the UNIX socket that Sophie uses for
33038 client communication. For example:
33039 .code
33040 av_scanner = sophie:/tmp/sophie
33041 .endd
33042 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33043 the option.
33044 .endlist
33045
33046 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33047 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33048 ACL.
33049
33050 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33051 makes it possible to use different scanners. See further below for an example.
33052 The &%malware%& condition caches its results, so when you use it multiple times
33053 for the same message, the actual scanning process is only carried out once.
33054 However, using expandable items in &%av_scanner%& disables this caching, in
33055 which case each use of the &%malware%& condition causes a new scan of the
33056 message.
33057
33058 The &%malware%& condition takes a right-hand argument that is expanded before
33059 use and taken as a list, slash-separated by default.
33060 The first element can then be one of
33061
33062 .ilist
33063 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33064 The condition succeeds if a virus was found, and fail otherwise. This is the
33065 recommended usage.
33066 .next
33067 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33068 the condition fails immediately.
33069 .next
33070 A regular expression, in which case the message is scanned for viruses. The
33071 condition succeeds if a virus is found and its name matches the regular
33072 expression. This allows you to take special actions on certain types of virus.
33073 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33074 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33075 .endlist
33076
33077 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33078 messages even if there is a problem with the virus scanner.
33079 Otherwise, such a problem causes the ACL to defer.
33080
33081 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33082 specify a non-default timeout.  The default is two minutes.
33083 For example:
33084 .code
33085 malware = * / defer_ok / tmo=10s
33086 .endd
33087 A timeout causes the ACL to defer.
33088
33089 .vindex "&$callout_address$&"
33090 When a connection is made to the scanner the expansion variable &$callout_address$&
33091 is set to record the actual address used.
33092
33093 .vindex "&$malware_name$&"
33094 When a virus is found, the condition sets up an expansion variable called
33095 &$malware_name$& that contains the name of the virus. You can use it in a
33096 &%message%& modifier that specifies the error returned to the sender, and/or in
33097 logging data.
33098
33099 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33100 imposed by your anti-virus scanner.
33101
33102 Here is a very simple scanning example:
33103 .code
33104 deny message = This message contains malware ($malware_name)
33105      malware = *
33106 .endd
33107 The next example accepts messages when there is a problem with the scanner:
33108 .code
33109 deny message = This message contains malware ($malware_name)
33110      malware = */defer_ok
33111 .endd
33112 The next example shows how to use an ACL variable to scan with both sophie and
33113 aveserver. It assumes you have set:
33114 .code
33115 av_scanner = $acl_m0
33116 .endd
33117 in the main Exim configuration.
33118 .code
33119 deny message = This message contains malware ($malware_name)
33120      set acl_m0 = sophie
33121      malware = *
33122
33123 deny message = This message contains malware ($malware_name)
33124      set acl_m0 = aveserver
33125      malware = *
33126 .endd
33127
33128
33129 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33130 .cindex "content scanning" "for spam"
33131 .cindex "spam scanning"
33132 .cindex "SpamAssassin"
33133 .cindex "Rspamd"
33134 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33135 score and a report for the message.
33136 Support is also provided for Rspamd.
33137
33138 For more information about installation and configuration of SpamAssassin or
33139 Rspamd refer to their respective websites at
33140 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33141
33142 SpamAssassin can be installed with CPAN by running:
33143 .code
33144 perl -MCPAN -e 'install Mail::SpamAssassin'
33145 .endd
33146 SpamAssassin has its own set of configuration files. Please review its
33147 documentation to see how you can tweak it. The default installation should work
33148 nicely, however.
33149
33150 .oindex "&%spamd_address%&"
33151 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33152 intend to use an instance running on the local host you do not need to set
33153 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33154 you must set the &%spamd_address%& option in the global part of the Exim
33155 configuration as follows (example):
33156 .code
33157 spamd_address = 192.168.99.45 783
33158 .endd
33159 The SpamAssassin protocol relies on a TCP half-close from the client.
33160 If your SpamAssassin client side is running a Linux system with an
33161 iptables firewall, consider setting
33162 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33163 timeout, Exim uses when waiting for a response from the SpamAssassin
33164 server (currently defaulting to 120s).  With a lower value the Linux
33165 connection tracking may consider your half-closed connection as dead too
33166 soon.
33167
33168
33169 To use Rspamd (which by default listens on all local addresses
33170 on TCP port 11333)
33171 you should add &%variant=rspamd%& after the address/port pair, for example:
33172 .code
33173 spamd_address = 127.0.0.1 11333 variant=rspamd
33174 .endd
33175
33176 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33177 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33178 filename instead of an address/port pair:
33179 .code
33180 spamd_address = /var/run/spamd_socket
33181 .endd
33182 You can have multiple &%spamd%& servers to improve scalability. These can
33183 reside on other hardware reachable over the network. To specify multiple
33184 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33185 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33186 .code
33187 spamd_address = 192.168.2.10 783 : \
33188                 192.168.2.11 783 : \
33189                 192.168.2.12 783
33190 .endd
33191 Up to 32 &%spamd%& servers are supported.
33192 When a server fails to respond to the connection attempt, all other
33193 servers are tried until one succeeds. If no server responds, the &%spam%&
33194 condition defers.
33195
33196 Unix and TCP socket specifications may be mixed in any order.
33197 Each element of the list is a list itself, space-separated by default
33198 and changeable in the usual way (&<<SECTlistsepchange>>&);
33199 take care to not double the separator.
33200
33201 For TCP socket specifications a host name or IP (v4 or v6, but
33202 subject to list-separator quoting rules) address can be used,
33203 and the port can be one or a dash-separated pair.
33204 In the latter case, the range is tried in strict order.
33205
33206 Elements after the first for Unix sockets, or second for TCP socket,
33207 are options.
33208 The supported options are:
33209 .code
33210 pri=<priority>      Selection priority
33211 weight=<value>      Selection bias
33212 time=<start>-<end>  Use only between these times of day
33213 retry=<timespec>    Retry on connect fail
33214 tmo=<timespec>      Connection time limit
33215 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33216 .endd
33217
33218 The &`pri`& option specifies a priority for the server within the list,
33219 higher values being tried first.
33220 The default priority is 1.
33221
33222 The &`weight`& option specifies a selection bias.
33223 Within a priority set
33224 servers are queried in a random fashion, weighted by this value.
33225 The default value for selection bias is 1.
33226
33227 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33228 in the local time zone; each element being one or more digits.
33229 Either the seconds or both minutes and seconds, plus the leading &`.`&
33230 characters, may be omitted and will be taken as zero.
33231
33232 Timeout specifications for the &`retry`& and &`tmo`& options
33233 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33234
33235 The &`tmo`& option specifies an overall timeout for communication.
33236 The default value is two minutes.
33237
33238 The &`retry`& option specifies a time after which a single retry for
33239 a failed connect is made.
33240 The default is to not retry.
33241
33242 The &%spamd_address%& variable is expanded before use if it starts with
33243 a dollar sign. In this case, the expansion may return a string that is
33244 used as the list so that multiple spamd servers can be the result of an
33245 expansion.
33246
33247 .vindex "&$callout_address$&"
33248 When a connection is made to the server the expansion variable &$callout_address$&
33249 is set to record the actual address used.
33250
33251 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33252 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33253 .code
33254 deny message = This message was classified as SPAM
33255      spam = joe
33256 .endd
33257 The right-hand side of the &%spam%& condition specifies a name. This is
33258 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33259 to scan using a specific profile, but rather use the SpamAssassin system-wide
33260 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33261 Rspamd does not use this setting. However, you must put something on the
33262 right-hand side.
33263
33264 The name allows you to use per-domain or per-user antispam profiles in
33265 principle, but this is not straightforward in practice, because a message may
33266 have multiple recipients, not necessarily all in the same domain. Because the
33267 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33268 read the contents of the message, the variables &$local_part$& and &$domain$&
33269 are not set.
33270 Careful enforcement of single-recipient messages
33271 (e.g. by responding with defer in the recipient ACL for all recipients
33272 after the first),
33273 or the use of PRDR,
33274 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33275 are needed to use this feature.
33276
33277 The right-hand side of the &%spam%& condition is expanded before being used, so
33278 you can put lookups or conditions there. When the right-hand side evaluates to
33279 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33280
33281
33282 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33283 large ones may cause significant performance degradation. As most spam messages
33284 are quite small, it is recommended that you do not scan the big ones. For
33285 example:
33286 .code
33287 deny message = This message was classified as SPAM
33288      condition = ${if < {$message_size}{10K}}
33289      spam = nobody
33290 .endd
33291
33292 The &%spam%& condition returns true if the threshold specified in the user's
33293 SpamAssassin profile has been matched or exceeded. If you want to use the
33294 &%spam%& condition for its side effects (see the variables below), you can make
33295 it always return &"true"& by appending &`:true`& to the username.
33296
33297 .cindex "spam scanning" "returned variables"
33298 When the &%spam%& condition is run, it sets up a number of expansion
33299 variables.
33300 Except for &$spam_report$&,
33301 these variables are saved with the received message so are
33302 available for use at delivery time.
33303
33304 .vlist
33305 .vitem &$spam_score$&
33306 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33307 for inclusion in log or reject messages.
33308
33309 .vitem &$spam_score_int$&
33310 The spam score of the message, multiplied by ten, as an integer value. For
33311 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33312 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33313 The integer value is useful for numeric comparisons in conditions.
33314
33315 .vitem &$spam_bar$&
33316 A string consisting of a number of &"+"& or &"-"& characters, representing the
33317 integer part of the spam score value. A spam score of 4.4 would have a
33318 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33319 headers, since MUAs can match on such strings. The maximum length of the
33320 spam bar is 50 characters.
33321
33322 .vitem &$spam_report$&
33323 A multiline text table, containing the full SpamAssassin report for the
33324 message. Useful for inclusion in headers or reject messages.
33325 This variable is only usable in a DATA-time ACL.
33326 Beware that SpamAssassin may return non-ASCII characters, especially
33327 when running in country-specific locales, which are not legal
33328 unencoded in headers.
33329
33330 .vitem &$spam_action$&
33331 For SpamAssassin either 'reject' or 'no action' depending on the
33332 spam score versus threshold.
33333 For Rspamd, the recommended action.
33334
33335 .endlist
33336
33337 The &%spam%& condition caches its results unless expansion in
33338 spamd_address was used. If you call it again with the same user name, it
33339 does not scan again, but rather returns the same values as before.
33340
33341 The &%spam%& condition returns DEFER if there is any error while running
33342 the message through SpamAssassin or if the expansion of spamd_address
33343 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33344 statement block), append &`/defer_ok`& to the right-hand side of the
33345 spam condition, like this:
33346 .code
33347 deny message = This message was classified as SPAM
33348      spam    = joe/defer_ok
33349 .endd
33350 This causes messages to be accepted even if there is a problem with &%spamd%&.
33351
33352 Here is a longer, commented example of the use of the &%spam%&
33353 condition:
33354 .code
33355 # put headers in all messages (no matter if spam or not)
33356 warn  spam = nobody:true
33357       add_header = X-Spam-Score: $spam_score ($spam_bar)
33358       add_header = X-Spam-Report: $spam_report
33359
33360 # add second subject line with *SPAM* marker when message
33361 # is over threshold
33362 warn  spam = nobody
33363       add_header = Subject: *SPAM* $h_Subject:
33364
33365 # reject spam at high scores (> 12)
33366 deny  message = This message scored $spam_score spam points.
33367       spam = nobody:true
33368       condition = ${if >{$spam_score_int}{120}{1}{0}}
33369 .endd
33370
33371
33372
33373 .section "Scanning MIME parts" "SECTscanmimepart"
33374 .cindex "content scanning" "MIME parts"
33375 .cindex "MIME content scanning"
33376 .oindex "&%acl_smtp_mime%&"
33377 .oindex "&%acl_not_smtp_mime%&"
33378 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33379 each MIME part of an SMTP message, including multipart types, in the sequence
33380 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33381 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33382 options may both refer to the same ACL if you want the same processing in both
33383 cases.
33384
33385 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33386 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33387 the case of a non-SMTP message. However, a MIME ACL is called only if the
33388 message contains a &'Content-Type:'& header line. When a call to a MIME
33389 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33390 result code is sent to the client. In the case of an SMTP message, the
33391 &%acl_smtp_data%& ACL is not called when this happens.
33392
33393 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33394 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33395 condition to match against the raw MIME part. You can also use the
33396 &%mime_regex%& condition to match against the decoded MIME part (see section
33397 &<<SECTscanregex>>&).
33398
33399 At the start of a MIME ACL, a number of variables are set from the header
33400 information for the relevant MIME part. These are described below. The contents
33401 of the MIME part are not by default decoded into a disk file except for MIME
33402 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33403 part into a disk file, you can use the &%decode%& condition. The general
33404 syntax is:
33405 .display
33406 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33407 .endd
33408 The right hand side is expanded before use. After expansion,
33409 the value can be:
33410
33411 .olist
33412 &"0"& or &"false"&, in which case no decoding is done.
33413 .next
33414 The string &"default"&. In that case, the file is put in the temporary
33415 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33416 a sequential filename consisting of the message id and a sequence number. The
33417 full path and name is available in &$mime_decoded_filename$& after decoding.
33418 .next
33419 A full path name starting with a slash. If the full name is an existing
33420 directory, it is used as a replacement for the default directory. The filename
33421 is then sequentially assigned. If the path does not exist, it is used as
33422 the full path and filename.
33423 .next
33424 If the string does not start with a slash, it is used as the
33425 filename, and the default path is then used.
33426 .endlist
33427 The &%decode%& condition normally succeeds. It is only false for syntax
33428 errors or unusual circumstances such as memory shortages. You can easily decode
33429 a file with its original, proposed filename using
33430 .code
33431 decode = $mime_filename
33432 .endd
33433 However, you should keep in mind that &$mime_filename$& might contain
33434 anything. If you place files outside of the default path, they are not
33435 automatically unlinked.
33436
33437 For RFC822 attachments (these are messages attached to messages, with a
33438 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33439 as for the primary message, only that the &$mime_is_rfc822$& expansion
33440 variable is set (see below). Attached messages are always decoded to disk
33441 before being checked, and the files are unlinked once the check is done.
33442
33443 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33444 used to match regular expressions against raw and decoded MIME parts,
33445 respectively. They are described in section &<<SECTscanregex>>&.
33446
33447 .cindex "MIME content scanning" "returned variables"
33448 The following list describes all expansion variables that are
33449 available in the MIME ACL:
33450
33451 .vlist
33452 .vitem &$mime_boundary$&
33453 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33454 have a boundary string, which is stored in this variable. If the current part
33455 has no boundary parameter in the &'Content-Type:'& header, this variable
33456 contains the empty string.
33457
33458 .vitem &$mime_charset$&
33459 This variable contains the character set identifier, if one was found in the
33460 &'Content-Type:'& header. Examples for charset identifiers are:
33461 .code
33462 us-ascii
33463 gb2312 (Chinese)
33464 iso-8859-1
33465 .endd
33466 Please note that this value is not normalized, so you should do matches
33467 case-insensitively.
33468
33469 .vitem &$mime_content_description$&
33470 This variable contains the normalized content of the &'Content-Description:'&
33471 header. It can contain a human-readable description of the parts content. Some
33472 implementations repeat the filename for attachments here, but they are usually
33473 only used for display purposes.
33474
33475 .vitem &$mime_content_disposition$&
33476 This variable contains the normalized content of the &'Content-Disposition:'&
33477 header. You can expect strings like &"attachment"& or &"inline"& here.
33478
33479 .vitem &$mime_content_id$&
33480 This variable contains the normalized content of the &'Content-ID:'& header.
33481 This is a unique ID that can be used to reference a part from another part.
33482
33483 .vitem &$mime_content_size$&
33484 This variable is set only after the &%decode%& modifier (see above) has been
33485 successfully run. It contains the size of the decoded part in kilobytes. The
33486 size is always rounded up to full kilobytes, so only a completely empty part
33487 has a &$mime_content_size$& of zero.
33488
33489 .vitem &$mime_content_transfer_encoding$&
33490 This variable contains the normalized content of the
33491 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33492 type. Typical values are &"base64"& and &"quoted-printable"&.
33493
33494 .vitem &$mime_content_type$&
33495 If the MIME part has a &'Content-Type:'& header, this variable contains its
33496 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33497 are some examples of popular MIME types, as they may appear in this variable:
33498 .code
33499 text/plain
33500 text/html
33501 application/octet-stream
33502 image/jpeg
33503 audio/midi
33504 .endd
33505 If the MIME part has no &'Content-Type:'& header, this variable contains the
33506 empty string.
33507
33508 .vitem &$mime_decoded_filename$&
33509 This variable is set only after the &%decode%& modifier (see above) has been
33510 successfully run. It contains the full path and filename of the file
33511 containing the decoded data.
33512 .endlist
33513
33514 .cindex "RFC 2047"
33515 .vlist
33516 .vitem &$mime_filename$&
33517 This is perhaps the most important of the MIME variables. It contains a
33518 proposed filename for an attachment, if one was found in either the
33519 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33520 RFC2047
33521 or RFC2231
33522 decoded, but no additional sanity checks are done.
33523  If no filename was
33524 found, this variable contains the empty string.
33525
33526 .vitem &$mime_is_coverletter$&
33527 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33528 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33529 content in the cover letter, while not restricting attachments at all.
33530
33531 The variable contains 1 (true) for a MIME part believed to be part of the
33532 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33533 follows:
33534
33535 .olist
33536 The outermost MIME part of a message is always a cover letter.
33537
33538 .next
33539 If a multipart/alternative or multipart/related MIME part is a cover letter,
33540 so are all MIME subparts within that multipart.
33541
33542 .next
33543 If any other multipart is a cover letter, the first subpart is a cover letter,
33544 and the rest are attachments.
33545
33546 .next
33547 All parts contained within an attachment multipart are attachments.
33548 .endlist olist
33549
33550 As an example, the following will ban &"HTML mail"& (including that sent with
33551 alternative plain text), while allowing HTML files to be attached. HTML
33552 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33553 .code
33554 deny message = HTML mail is not accepted here
33555 !condition = $mime_is_rfc822
33556 condition = $mime_is_coverletter
33557 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33558 .endd
33559 .vitem &$mime_is_multipart$&
33560 This variable has the value 1 (true) when the current part has the main type
33561 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33562 Since multipart entities only serve as containers for other parts, you may not
33563 want to carry out specific actions on them.
33564
33565 .vitem &$mime_is_rfc822$&
33566 This variable has the value 1 (true) if the current part is not a part of the
33567 checked message itself, but part of an attached message. Attached message
33568 decoding is fully recursive.
33569
33570 .vitem &$mime_part_count$&
33571 This variable is a counter that is raised for each processed MIME part. It
33572 starts at zero for the very first part (which is usually a multipart). The
33573 counter is per-message, so it is reset when processing RFC822 attachments (see
33574 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33575 complete, so you can use it in the DATA ACL to determine the number of MIME
33576 parts of a message. For non-MIME messages, this variable contains the value -1.
33577 .endlist
33578
33579
33580
33581 .section "Scanning with regular expressions" "SECTscanregex"
33582 .cindex "content scanning" "with regular expressions"
33583 .cindex "regular expressions" "content scanning with"
33584 You can specify your own custom regular expression matches on the full body of
33585 the message, or on individual MIME parts.
33586
33587 The &%regex%& condition takes one or more regular expressions as arguments and
33588 matches them against the full message (when called in the DATA ACL) or a raw
33589 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33590 linewise, with a maximum line length of 32K characters. That means you cannot
33591 have multiline matches with the &%regex%& condition.
33592
33593 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33594 to 32K of decoded content (the whole content at once, not linewise). If the
33595 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33596 is decoded automatically when &%mime_regex%& is executed (using default path
33597 and filename values). If the decoded data is larger than  32K, only the first
33598 32K characters are checked.
33599
33600 The regular expressions are passed as a colon-separated list. To include a
33601 literal colon, you must double it. Since the whole right-hand side string is
33602 expanded before being used, you must also escape dollar signs and backslashes
33603 with more backslashes, or use the &`\N`& facility to disable expansion.
33604 Here is a simple example that contains two regular expressions:
33605 .code
33606 deny message = contains blacklisted regex ($regex_match_string)
33607      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33608 .endd
33609 The conditions returns true if any one of the regular expressions matches. The
33610 &$regex_match_string$& expansion variable is then set up and contains the
33611 matching regular expression.
33612 The expansion variables &$regex1$& &$regex2$& etc
33613 are set to any substrings captured by the regular expression.
33614
33615 &*Warning*&: With large messages, these conditions can be fairly
33616 CPU-intensive.
33617
33618 .ecindex IIDcosca
33619
33620
33621
33622
33623 . ////////////////////////////////////////////////////////////////////////////
33624 . ////////////////////////////////////////////////////////////////////////////
33625
33626 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33627          "Local scan function"
33628 .scindex IIDlosca "&[local_scan()]& function" "description of"
33629 .cindex "customizing" "input scan using C function"
33630 .cindex "policy control" "by local scan function"
33631 In these days of email worms, viruses, and ever-increasing spam, some sites
33632 want to apply a lot of checking to messages before accepting them.
33633
33634 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33635 passing messages to external virus and spam scanning software. You can also do
33636 a certain amount in Exim itself through string expansions and the &%condition%&
33637 condition in the ACL that runs after the SMTP DATA command or the ACL for
33638 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33639
33640 To allow for further customization to a site's own requirements, there is the
33641 possibility of linking Exim with a private message scanning function, written
33642 in C. If you want to run code that is written in something other than C, you
33643 can of course use a little C stub to call it.
33644
33645 The local scan function is run once for every incoming message, at the point
33646 when Exim is just about to accept the message.
33647 It can therefore be used to control non-SMTP messages from local processes as
33648 well as messages arriving via SMTP.
33649
33650 Exim applies a timeout to calls of the local scan function, and there is an
33651 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33652 Zero means &"no timeout"&.
33653 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33654 before calling the local scan function, so that the most common types of crash
33655 are caught. If the timeout is exceeded or one of those signals is caught, the
33656 incoming message is rejected with a temporary error if it is an SMTP message.
33657 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33658 code. The incident is logged on the main and reject logs.
33659
33660
33661
33662 .section "Building Exim to use a local scan function" "SECID207"
33663 .cindex "&[local_scan()]& function" "building Exim to use"
33664 To make use of the local scan function feature, you must tell Exim where your
33665 function is before building Exim, by setting
33666 both HAVE_LOCAL_SCAN and
33667 LOCAL_SCAN_SOURCE in your
33668 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33669 directory, so you might set
33670 .code
33671 HAVE_LOCAL_SCAN=yes
33672 LOCAL_SCAN_SOURCE=Local/local_scan.c
33673 .endd
33674 for example. The function must be called &[local_scan()]&;
33675 .new
33676 the source file(s) for it should first #define LOCAL_SCAN
33677 and then #include "local_scan.h".
33678 .wen
33679 It is called by
33680 Exim after it has received a message, when the success return code is about to
33681 be sent. This is after all the ACLs have been run. The return code from your
33682 function controls whether the message is actually accepted or not. There is a
33683 commented template function (that just accepts the message) in the file
33684 _src/local_scan.c_.
33685
33686 If you want to make use of Exim's runtime configuration file to set options
33687 for your &[local_scan()]& function, you must also set
33688 .code
33689 LOCAL_SCAN_HAS_OPTIONS=yes
33690 .endd
33691 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33692
33693
33694
33695
33696 .section "API for local_scan()" "SECTapiforloc"
33697 .cindex "&[local_scan()]& function" "API description"
33698 .cindex &%dlfunc%& "API description"
33699 You must include this line near the start of your code:
33700 .code
33701 #include "local_scan.h"
33702 .endd
33703 This header file defines a number of variables and other values, and the
33704 prototype for the function itself. Exim is coded to use unsigned char values
33705 almost exclusively, and one of the things this header defines is a shorthand
33706 for &`unsigned char`& called &`uschar`&.
33707 It also contains the following macro definitions, to simplify casting character
33708 strings and pointers to character strings:
33709 .code
33710 #define CS   (char *)
33711 #define CCS  (const char *)
33712 #define CSS  (char **)
33713 #define US   (unsigned char *)
33714 #define CUS  (const unsigned char *)
33715 #define USS  (unsigned char **)
33716 .endd
33717 The function prototype for &[local_scan()]& is:
33718 .code
33719 extern int local_scan(int fd, uschar **return_text);
33720 .endd
33721 The arguments are as follows:
33722
33723 .ilist
33724 &%fd%& is a file descriptor for the file that contains the body of the message
33725 (the -D file). The file is open for reading and writing, but updating it is not
33726 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33727
33728 The descriptor is positioned at character 19 of the file, which is the first
33729 character of the body itself, because the first 19 characters are the message
33730 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33731 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33732 case this changes in some future version.
33733 .next
33734 &%return_text%& is an address which you can use to return a pointer to a text
33735 string at the end of the function. The value it points to on entry is NULL.
33736 .endlist
33737
33738 The function must return an &%int%& value which is one of the following macros:
33739
33740 .vlist
33741 .vitem &`LOCAL_SCAN_ACCEPT`&
33742 .vindex "&$local_scan_data$&"
33743 The message is accepted. If you pass back a string of text, it is saved with
33744 the message, and made available in the variable &$local_scan_data$&. No
33745 newlines are permitted (if there are any, they are turned into spaces) and the
33746 maximum length of text is 1000 characters.
33747
33748 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33749 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33750 queued without immediate delivery, and is frozen.
33751
33752 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33753 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33754 queued without immediate delivery.
33755
33756 .vitem &`LOCAL_SCAN_REJECT`&
33757 The message is rejected; the returned text is used as an error message which is
33758 passed back to the sender and which is also logged. Newlines are permitted &--
33759 they cause a multiline response for SMTP rejections, but are converted to
33760 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33761 used.
33762
33763 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33764 The message is temporarily rejected; the returned text is used as an error
33765 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33766 problem"& is used.
33767
33768 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33769 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33770 message is not written to the reject log. It has the effect of unsetting the
33771 &%rejected_header%& log selector for just this rejection. If
33772 &%rejected_header%& is already unset (see the discussion of the
33773 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33774 same as LOCAL_SCAN_REJECT.
33775
33776 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33777 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33778 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33779 .endlist
33780
33781 If the message is not being received by interactive SMTP, rejections are
33782 reported by writing to &%stderr%& or by sending an email, as configured by the
33783 &%-oe%& command line options.
33784
33785
33786
33787 .section "Configuration options for local_scan()" "SECTconoptloc"
33788 .cindex "&[local_scan()]& function" "configuration options"
33789 It is possible to have option settings in the main configuration file
33790 that set values in static variables in the &[local_scan()]& module. If you
33791 want to do this, you must have the line
33792 .code
33793 LOCAL_SCAN_HAS_OPTIONS=yes
33794 .endd
33795 in your &_Local/Makefile_& when you build Exim. (This line is in
33796 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33797 file, you must define static variables to hold the option values, and a table
33798 to define them.
33799
33800 The table must be a vector called &%local_scan_options%&, of type
33801 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33802 and a pointer to the variable that holds the value. The entries must appear in
33803 alphabetical order. Following &%local_scan_options%& you must also define a
33804 variable called &%local_scan_options_count%& that contains the number of
33805 entries in the table. Here is a short example, showing two kinds of option:
33806 .code
33807 static int my_integer_option = 42;
33808 static uschar *my_string_option = US"a default string";
33809
33810 optionlist local_scan_options[] = {
33811   { "my_integer", opt_int,       &my_integer_option },
33812   { "my_string",  opt_stringptr, &my_string_option }
33813 };
33814
33815 int local_scan_options_count =
33816   sizeof(local_scan_options)/sizeof(optionlist);
33817 .endd
33818 The values of the variables can now be changed from Exim's runtime
33819 configuration file by including a local scan section as in this example:
33820 .code
33821 begin local_scan
33822 my_integer = 99
33823 my_string = some string of text...
33824 .endd
33825 The available types of option data are as follows:
33826
33827 .vlist
33828 .vitem &*opt_bool*&
33829 This specifies a boolean (true/false) option. The address should point to a
33830 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33831 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33832 whether such a variable has been set at all, you can initialize it to
33833 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33834 values.)
33835
33836 .vitem &*opt_fixed*&
33837 This specifies a fixed point number, such as is used for load averages.
33838 The address should point to a variable of type &`int`&. The value is stored
33839 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33840
33841 .vitem &*opt_int*&
33842 This specifies an integer; the address should point to a variable of type
33843 &`int`&. The value may be specified in any of the integer formats accepted by
33844 Exim.
33845
33846 .vitem &*opt_mkint*&
33847 This is the same as &%opt_int%&, except that when such a value is output in a
33848 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33849 printed with the suffix K or M.
33850
33851 .vitem &*opt_octint*&
33852 This also specifies an integer, but the value is always interpreted as an
33853 octal integer, whether or not it starts with the digit zero, and it is
33854 always output in octal.
33855
33856 .vitem &*opt_stringptr*&
33857 This specifies a string value; the address must be a pointer to a
33858 variable that points to a string (for example, of type &`uschar *`&).
33859
33860 .vitem &*opt_time*&
33861 This specifies a time interval value. The address must point to a variable of
33862 type &`int`&. The value that is placed there is a number of seconds.
33863 .endlist
33864
33865 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33866 out the values of all the &[local_scan()]& options.
33867
33868
33869
33870 .section "Available Exim variables" "SECID208"
33871 .cindex "&[local_scan()]& function" "available Exim variables"
33872 The header &_local_scan.h_& gives you access to a number of C variables. These
33873 are the only ones that are guaranteed to be maintained from release to release.
33874 Note, however, that you can obtain the value of any Exim expansion variable,
33875 including &$recipients$&, by calling &'expand_string()'&. The exported
33876 C variables are as follows:
33877
33878 .vlist
33879 .vitem &*int&~body_linecount*&
33880 This variable contains the number of lines in the message's body.
33881 It is not valid if the &%spool_files_wireformat%& option is used.
33882
33883 .vitem &*int&~body_zerocount*&
33884 This variable contains the number of binary zero bytes in the message's body.
33885 It is not valid if the &%spool_files_wireformat%& option is used.
33886
33887 .vitem &*unsigned&~int&~debug_selector*&
33888 This variable is set to zero when no debugging is taking place. Otherwise, it
33889 is a bitmap of debugging selectors. Two bits are identified for use in
33890 &[local_scan()]&; they are defined as macros:
33891
33892 .ilist
33893 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33894 testing option that is not privileged &-- any caller may set it. All the
33895 other selector bits can be set only by admin users.
33896
33897 .next
33898 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33899 by the &`+local_scan`& debug selector. It is not included in the default set
33900 of debugging bits.
33901 .endlist ilist
33902
33903 Thus, to write to the debugging output only when &`+local_scan`& has been
33904 selected, you should use code like this:
33905 .code
33906 if ((debug_selector & D_local_scan) != 0)
33907   debug_printf("xxx", ...);
33908 .endd
33909 .vitem &*uschar&~*expand_string_message*&
33910 After a failing call to &'expand_string()'& (returned value NULL), the
33911 variable &%expand_string_message%& contains the error message, zero-terminated.
33912
33913 .vitem &*header_line&~*header_list*&
33914 A pointer to a chain of header lines. The &%header_line%& structure is
33915 discussed below.
33916
33917 .vitem &*header_line&~*header_last*&
33918 A pointer to the last of the header lines.
33919
33920 .vitem &*uschar&~*headers_charset*&
33921 The value of the &%headers_charset%& configuration option.
33922
33923 .vitem &*BOOL&~host_checking*&
33924 This variable is TRUE during a host checking session that is initiated by the
33925 &%-bh%& command line option.
33926
33927 .vitem &*uschar&~*interface_address*&
33928 The IP address of the interface that received the message, as a string. This
33929 is NULL for locally submitted messages.
33930
33931 .vitem &*int&~interface_port*&
33932 The port on which this message was received. When testing with the &%-bh%&
33933 command line option, the value of this variable is -1 unless a port has been
33934 specified via the &%-oMi%& option.
33935
33936 .vitem &*uschar&~*message_id*&
33937 This variable contains Exim's message id for the incoming message (the value of
33938 &$message_exim_id$&) as a zero-terminated string.
33939
33940 .vitem &*uschar&~*received_protocol*&
33941 The name of the protocol by which the message was received.
33942
33943 .vitem &*int&~recipients_count*&
33944 The number of accepted recipients.
33945
33946 .vitem &*recipient_item&~*recipients_list*&
33947 .cindex "recipient" "adding in local scan"
33948 .cindex "recipient" "removing in local scan"
33949 The list of accepted recipients, held in a vector of length
33950 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33951 can add additional recipients by calling &'receive_add_recipient()'& (see
33952 below). You can delete recipients by removing them from the vector and
33953 adjusting the value in &%recipients_count%&. In particular, by setting
33954 &%recipients_count%& to zero you remove all recipients. If you then return the
33955 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33956 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33957 and then call &'receive_add_recipient()'& as often as needed.
33958
33959 .vitem &*uschar&~*sender_address*&
33960 The envelope sender address. For bounce messages this is the empty string.
33961
33962 .vitem &*uschar&~*sender_host_address*&
33963 The IP address of the sending host, as a string. This is NULL for
33964 locally-submitted messages.
33965
33966 .vitem &*uschar&~*sender_host_authenticated*&
33967 The name of the authentication mechanism that was used, or NULL if the message
33968 was not received over an authenticated SMTP connection.
33969
33970 .vitem &*uschar&~*sender_host_name*&
33971 The name of the sending host, if known.
33972
33973 .vitem &*int&~sender_host_port*&
33974 The port on the sending host.
33975
33976 .vitem &*BOOL&~smtp_input*&
33977 This variable is TRUE for all SMTP input, including BSMTP.
33978
33979 .vitem &*BOOL&~smtp_batched_input*&
33980 This variable is TRUE for BSMTP input.
33981
33982 .vitem &*int&~store_pool*&
33983 The contents of this variable control which pool of memory is used for new
33984 requests. See section &<<SECTmemhanloc>>& for details.
33985 .endlist
33986
33987
33988 .section "Structure of header lines" "SECID209"
33989 The &%header_line%& structure contains the members listed below.
33990 You can add additional header lines by calling the &'header_add()'& function
33991 (see below). You can cause header lines to be ignored (deleted) by setting
33992 their type to *.
33993
33994
33995 .vlist
33996 .vitem &*struct&~header_line&~*next*&
33997 A pointer to the next header line, or NULL for the last line.
33998
33999 .vitem &*int&~type*&
34000 A code identifying certain headers that Exim recognizes. The codes are printing
34001 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34002 Notice in particular that any header line whose type is * is not transmitted
34003 with the message. This flagging is used for header lines that have been
34004 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34005 lines.) Effectively, * means &"deleted"&.
34006
34007 .vitem &*int&~slen*&
34008 The number of characters in the header line, including the terminating and any
34009 internal newlines.
34010
34011 .vitem &*uschar&~*text*&
34012 A pointer to the text of the header. It always ends with a newline, followed by
34013 a zero byte. Internal newlines are preserved.
34014 .endlist
34015
34016
34017
34018 .section "Structure of recipient items" "SECID210"
34019 The &%recipient_item%& structure contains these members:
34020
34021 .vlist
34022 .vitem &*uschar&~*address*&
34023 This is a pointer to the recipient address as it was received.
34024
34025 .vitem &*int&~pno*&
34026 This is used in later Exim processing when top level addresses are created by
34027 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34028 and must always contain -1 at this stage.
34029
34030 .vitem &*uschar&~*errors_to*&
34031 If this value is not NULL, bounce messages caused by failing to deliver to the
34032 recipient are sent to the address it contains. In other words, it overrides the
34033 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34034 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34035 an unqualified address, Exim qualifies it using the domain from
34036 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34037 is NULL for all recipients.
34038 .endlist
34039
34040
34041
34042 .section "Available Exim functions" "SECID211"
34043 .cindex "&[local_scan()]& function" "available Exim functions"
34044 The header &_local_scan.h_& gives you access to a number of Exim functions.
34045 These are the only ones that are guaranteed to be maintained from release to
34046 release:
34047
34048 .vlist
34049 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34050        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34051
34052 This function creates a child process that runs the command specified by
34053 &%argv%&. The environment for the process is specified by &%envp%&, which can
34054 be NULL if no environment variables are to be passed. A new umask is supplied
34055 for the process in &%newumask%&.
34056
34057 Pipes to the standard input and output of the new process are set up
34058 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34059 standard error is cloned to the standard output. If there are any file
34060 descriptors &"in the way"& in the new process, they are closed. If the final
34061 argument is TRUE, the new process is made into a process group leader.
34062
34063 The function returns the pid of the new process, or -1 if things go wrong.
34064
34065 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34066 This function waits for a child process to terminate, or for a timeout (in
34067 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34068 return value is as follows:
34069
34070 .ilist
34071 >= 0
34072
34073 The process terminated by a normal exit and the value is the process
34074 ending status.
34075
34076 .next
34077 < 0 and > &--256
34078
34079 The process was terminated by a signal and the value is the negation of the
34080 signal number.
34081
34082 .next
34083 &--256
34084
34085 The process timed out.
34086 .next
34087 &--257
34088
34089 The was some other error in wait(); &%errno%& is still set.
34090 .endlist
34091
34092 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34093 This function provide you with a means of submitting a new message to
34094 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34095 want, but this packages it all up for you.) The function creates a pipe,
34096 forks a subprocess that is running
34097 .code
34098 exim -t -oem -oi -f <>
34099 .endd
34100 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34101 that is connected to the standard input. The yield of the function is the PID
34102 of the subprocess. You can then write a message to the file descriptor, with
34103 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34104
34105 When you have finished, call &'child_close()'& to wait for the process to
34106 finish and to collect its ending status. A timeout value of zero is usually
34107 fine in this circumstance. Unless you have made a mistake with the recipient
34108 addresses, you should get a return code of zero.
34109
34110
34111 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34112        *sender_authentication)*&
34113 This function is a more sophisticated version of &'child_open()'&. The command
34114 that it runs is:
34115 .display
34116 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34117 .endd
34118 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34119
34120
34121 .vitem &*void&~debug_printf(char&~*,&~...)*&
34122 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34123 output is written to the standard error stream. If no debugging is selected,
34124 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34125 conditional on the &`local_scan`& debug selector by coding like this:
34126 .code
34127 if ((debug_selector & D_local_scan) != 0)
34128   debug_printf("xxx", ...);
34129 .endd
34130
34131 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34132 This is an interface to Exim's string expansion code. The return value is the
34133 expanded string, or NULL if there was an expansion failure.
34134 The C variable &%expand_string_message%& contains an error message after an
34135 expansion failure. If expansion does not change the string, the return value is
34136 the pointer to the input string. Otherwise, the return value points to a new
34137 block of memory that was obtained by a call to &'store_get()'&. See section
34138 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34139
34140 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34141 This function allows you to an add additional header line at the end of the
34142 existing ones. The first argument is the type, and should normally be a space
34143 character. The second argument is a format string and any number of
34144 substitution arguments as for &[sprintf()]&. You may include internal newlines
34145 if you want, and you must ensure that the string ends with a newline.
34146
34147 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34148         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34149 This function adds a new header line at a specified point in the header
34150 chain. The header itself is specified as for &'header_add()'&.
34151
34152 If &%name%& is NULL, the new header is added at the end of the chain if
34153 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34154 NULL, the header lines are searched for the first non-deleted header that
34155 matches the name. If one is found, the new header is added before it if
34156 &%after%& is false. If &%after%& is true, the new header is added after the
34157 found header and any adjacent subsequent ones with the same name (even if
34158 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34159 option controls where the header is added. If it is true, addition is at the
34160 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34161 headers, or at the top if there are no &'Received:'& headers, you could use
34162 .code
34163 header_add_at_position(TRUE, US"Received", TRUE,
34164   ' ', "X-xxx: ...");
34165 .endd
34166 Normally, there is always at least one non-deleted &'Received:'& header, but
34167 there may not be if &%received_header_text%& expands to an empty string.
34168
34169
34170 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34171 This function removes header lines. If &%occurrence%& is zero or negative, all
34172 occurrences of the header are removed. If occurrence is greater than zero, that
34173 particular instance of the header is removed. If no header(s) can be found that
34174 match the specification, the function does nothing.
34175
34176
34177 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34178         int&~length,&~BOOL&~notdel)*&"
34179 This function tests whether the given header has the given name. It is not just
34180 a string comparison, because white space is permitted between the name and the
34181 colon. If the &%notdel%& argument is true, a false return is forced for all
34182 &"deleted"& headers; otherwise they are not treated specially. For example:
34183 .code
34184 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34185 .endd
34186 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34187 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34188 This function base64-encodes a string, which is passed by address and length.
34189 The text may contain bytes of any value, including zero. The result is passed
34190 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34191 zero-terminated.
34192
34193 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34194 This function decodes a base64-encoded string. Its arguments are a
34195 zero-terminated base64-encoded string and the address of a variable that is set
34196 to point to the result, which is in dynamic memory. The length of the decoded
34197 string is the yield of the function. If the input is invalid base64 data, the
34198 yield is -1. A zero byte is added to the end of the output string to make it
34199 easy to interpret as a C string (assuming it contains no zeros of its own). The
34200 added zero byte is not included in the returned count.
34201
34202 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34203 This function checks for a match in a domain list. Domains are always
34204 matched caselessly. The return value is one of the following:
34205 .display
34206 &`OK     `& match succeeded
34207 &`FAIL   `& match failed
34208 &`DEFER  `& match deferred
34209 .endd
34210 DEFER is usually caused by some kind of lookup defer, such as the
34211 inability to contact a database.
34212
34213 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34214         BOOL&~caseless)*&"
34215 This function checks for a match in a local part list. The third argument
34216 controls case-sensitivity. The return values are as for
34217 &'lss_match_domain()'&.
34218
34219 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34220         BOOL&~caseless)*&"
34221 This function checks for a match in an address list. The third argument
34222 controls the case-sensitivity of the local part match. The domain is always
34223 matched caselessly. The return values are as for &'lss_match_domain()'&.
34224
34225 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34226         uschar&~*list)*&"
34227 This function checks for a match in a host list. The most common usage is
34228 expected to be
34229 .code
34230 lss_match_host(sender_host_name, sender_host_address, ...)
34231 .endd
34232 .vindex "&$sender_host_address$&"
34233 An empty address field matches an empty item in the host list. If the host name
34234 is NULL, the name corresponding to &$sender_host_address$& is automatically
34235 looked up if a host name is required to match an item in the list. The return
34236 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34237 returns ERROR in the case when it had to look up a host name, but the lookup
34238 failed.
34239
34240 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34241         *format,&~...)*&"
34242 This function writes to Exim's log files. The first argument should be zero (it
34243 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34244 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34245 them. It specifies to which log or logs the message is written. The remaining
34246 arguments are a format and relevant insertion arguments. The string should not
34247 contain any newlines, not even at the end.
34248
34249
34250 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34251 This function adds an additional recipient to the message. The first argument
34252 is the recipient address. If it is unqualified (has no domain), it is qualified
34253 with the &%qualify_recipient%& domain. The second argument must always be -1.
34254
34255 This function does not allow you to specify a private &%errors_to%& address (as
34256 described with the structure of &%recipient_item%& above), because it pre-dates
34257 the addition of that field to the structure. However, it is easy to add such a
34258 value afterwards. For example:
34259 .code
34260  receive_add_recipient(US"monitor@mydom.example", -1);
34261  recipients_list[recipients_count-1].errors_to =
34262    US"postmaster@mydom.example";
34263 .endd
34264
34265 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34266 This is a convenience function to remove a named recipient from the list of
34267 recipients. It returns true if a recipient was removed, and false if no
34268 matching recipient could be found. The argument must be a complete email
34269 address.
34270 .endlist
34271
34272
34273 .cindex "RFC 2047"
34274 .vlist
34275 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34276   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34277 This function decodes strings that are encoded according to RFC 2047. Typically
34278 these are the contents of header lines. First, each &"encoded word"& is decoded
34279 from the Q or B encoding into a byte-string. Then, if provided with the name of
34280 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34281 made  to translate the result to the named character set. If this fails, the
34282 binary string is returned with an error message.
34283
34284 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34285 maximum MIME word length is enforced. The third argument is the target
34286 encoding, or NULL if no translation is wanted.
34287
34288 .cindex "binary zero" "in RFC 2047 decoding"
34289 .cindex "RFC 2047" "binary zero in"
34290 If a binary zero is encountered in the decoded string, it is replaced by the
34291 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34292 not be 0 because header lines are handled as zero-terminated strings.
34293
34294 The function returns the result of processing the string, zero-terminated; if
34295 &%lenptr%& is not NULL, the length of the result is set in the variable to
34296 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34297
34298 If an error is encountered, the function returns NULL and uses the &%error%&
34299 argument to return an error message. The variable pointed to by &%error%& is
34300 set to NULL if there is no error; it may be set non-NULL even when the function
34301 returns a non-NULL value if decoding was successful, but there was a problem
34302 with translation.
34303
34304
34305 .vitem &*int&~smtp_fflush(void)*&
34306 This function is used in conjunction with &'smtp_printf()'&, as described
34307 below.
34308
34309 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34310 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34311 output stream. You should use this function only when there is an SMTP output
34312 stream, that is, when the incoming message is being received via interactive
34313 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34314 is FALSE. If you want to test for an incoming message from another host (as
34315 opposed to a local process that used the &%-bs%& command line option), you can
34316 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34317 is involved.
34318
34319 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34320 output function, so it can be used for all forms of SMTP connection.
34321
34322 The second argument is used to request that the data be buffered
34323 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34324 This is advisory only, but likely to save on system-calls and packets
34325 sent when a sequence of calls to the function are made.
34326
34327 The argument was added in Exim version 4.90 - changing the API/ABI.
34328 Nobody noticed until 4.93 was imminent, at which point the
34329 ABI version number was incremented.
34330
34331 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34332 must start with an appropriate response code: 550 if you are going to return
34333 LOCAL_SCAN_REJECT, 451 if you are going to return
34334 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34335 initial lines of a multi-line response, the code must be followed by a hyphen
34336 to indicate that the line is not the final response line. You must also ensure
34337 that the lines you write terminate with CRLF. For example:
34338 .code
34339 smtp_printf("550-this is some extra info\r\n");
34340 return LOCAL_SCAN_REJECT;
34341 .endd
34342 Note that you can also create multi-line responses by including newlines in
34343 the data returned via the &%return_text%& argument. The added value of using
34344 &'smtp_printf()'& is that, for instance, you could introduce delays between
34345 multiple output lines.
34346
34347 The &'smtp_printf()'& function does not return any error indication, because it
34348 does not
34349 guarantee a flush of
34350 pending output, and therefore does not test
34351 the state of the stream. (In the main code of Exim, flushing and error
34352 detection is done when Exim is ready for the next SMTP input command.) If
34353 you want to flush the output and check for an error (for example, the
34354 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34355 arguments. It flushes the output stream, and returns a non-zero value if there
34356 is an error.
34357
34358 .new
34359 .vitem &*void&~*store_get(int,BOOL)*&
34360 This function accesses Exim's internal store (memory) manager. It gets a new
34361 chunk of memory whose size is given by the first argument.
34362 The second argument should be given as TRUE if the memory will be used for
34363 data possibly coming from an attacker (eg. the message content),
34364 FALSE if it is locally-sourced.
34365 Exim bombs out if it ever
34366 runs out of memory. See the next section for a discussion of memory handling.
34367 .wen
34368
34369 .vitem &*void&~*store_get_perm(int,BOOL)*&
34370 This function is like &'store_get()'&, but it always gets memory from the
34371 permanent pool. See the next section for a discussion of memory handling.
34372
34373 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34374 See below.
34375
34376 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34377 See below.
34378
34379 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34380 These three functions create strings using Exim's dynamic memory facilities.
34381 The first makes a copy of an entire string. The second copies up to a maximum
34382 number of characters, indicated by the second argument. The third uses a format
34383 and insertion arguments to create a new string. In each case, the result is a
34384 pointer to a new string in the current memory pool. See the next section for
34385 more discussion.
34386 .endlist
34387
34388
34389
34390 .section "More about Exim's memory handling" "SECTmemhanloc"
34391 .cindex "&[local_scan()]& function" "memory handling"
34392 No function is provided for freeing memory, because that is never needed.
34393 The dynamic memory that Exim uses when receiving a message is automatically
34394 recycled if another message is received by the same process (this applies only
34395 to incoming SMTP connections &-- other input methods can supply only one
34396 message at a time). After receiving the last message, a reception process
34397 terminates.
34398
34399 Because it is recycled, the normal dynamic memory cannot be used for holding
34400 data that must be preserved over a number of incoming messages on the same SMTP
34401 connection. However, Exim in fact uses two pools of dynamic memory; the second
34402 one is not recycled, and can be used for this purpose.
34403
34404 If you want to allocate memory that remains available for subsequent messages
34405 in the same SMTP connection, you should set
34406 .code
34407 store_pool = POOL_PERM
34408 .endd
34409 before calling the function that does the allocation. There is no need to
34410 restore the value if you do not need to; however, if you do want to revert to
34411 the normal pool, you can either restore the previous value of &%store_pool%& or
34412 set it explicitly to POOL_MAIN.
34413
34414 The pool setting applies to all functions that get dynamic memory, including
34415 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34416 There is also a convenience function called &'store_get_perm()'& that gets a
34417 block of memory from the permanent pool while preserving the value of
34418 &%store_pool%&.
34419 .ecindex IIDlosca
34420
34421
34422
34423
34424 . ////////////////////////////////////////////////////////////////////////////
34425 . ////////////////////////////////////////////////////////////////////////////
34426
34427 .chapter "System-wide message filtering" "CHAPsystemfilter"
34428 .scindex IIDsysfil1 "filter" "system filter"
34429 .scindex IIDsysfil2 "filtering all mail"
34430 .scindex IIDsysfil3 "system filter"
34431 The previous chapters (on ACLs and the local scan function) describe checks
34432 that can be applied to messages before they are accepted by a host. There is
34433 also a mechanism for checking messages once they have been received, but before
34434 they are delivered. This is called the &'system filter'&.
34435
34436 The system filter operates in a similar manner to users' filter files, but it
34437 is run just once per message (however many recipients the message has).
34438 It should not normally be used as a substitute for routing, because &%deliver%&
34439 commands in a system router provide new envelope recipient addresses.
34440 The system filter must be an Exim filter. It cannot be a Sieve filter.
34441
34442 The system filter is run at the start of a delivery attempt, before any routing
34443 is done. If a message fails to be completely delivered at the first attempt,
34444 the system filter is run again at the start of every retry.
34445 If you want your filter to do something only once per message, you can make use
34446 of the &%first_delivery%& condition in an &%if%& command in the filter to
34447 prevent it happening on retries.
34448
34449 .vindex "&$domain$&"
34450 .vindex "&$local_part$&"
34451 &*Warning*&: Because the system filter runs just once, variables that are
34452 specific to individual recipient addresses, such as &$local_part$& and
34453 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34454 you want to run a centrally-specified filter for each recipient address
34455 independently, you can do so by setting up a suitable &(redirect)& router, as
34456 described in section &<<SECTperaddfil>>& below.
34457
34458
34459 .section "Specifying a system filter" "SECID212"
34460 .cindex "uid (user id)" "system filter"
34461 .cindex "gid (group id)" "system filter"
34462 The name of the file that contains the system filter must be specified by
34463 setting &%system_filter%&. If you want the filter to run under a uid and gid
34464 other than root, you must also set &%system_filter_user%& and
34465 &%system_filter_group%& as appropriate. For example:
34466 .code
34467 system_filter = /etc/mail/exim.filter
34468 system_filter_user = exim
34469 .endd
34470 If a system filter generates any deliveries directly to files or pipes (via the
34471 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34472 specified by setting &%system_filter_file_transport%& and
34473 &%system_filter_pipe_transport%&, respectively. Similarly,
34474 &%system_filter_reply_transport%& must be set to handle any messages generated
34475 by the &%reply%& command.
34476
34477
34478 .section "Testing a system filter" "SECID213"
34479 You can run simple tests of a system filter in the same way as for a user
34480 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34481 are permitted only in system filters are recognized.
34482
34483 If you want to test the combined effect of a system filter and a user filter,
34484 you can use both &%-bF%& and &%-bf%& on the same command line.
34485
34486
34487
34488 .section "Contents of a system filter" "SECID214"
34489 The language used to specify system filters is the same as for users' filter
34490 files. It is described in the separate end-user document &'Exim's interface to
34491 mail filtering'&. However, there are some additional features that are
34492 available only in system filters; these are described in subsequent sections.
34493 If they are encountered in a user's filter file or when testing with &%-bf%&,
34494 they cause errors.
34495
34496 .cindex "frozen messages" "manual thaw; testing in filter"
34497 There are two special conditions which, though available in users' filter
34498 files, are designed for use in system filters. The condition &%first_delivery%&
34499 is true only for the first attempt at delivering a message, and
34500 &%manually_thawed%& is true only if the message has been frozen, and
34501 subsequently thawed by an admin user. An explicit forced delivery counts as a
34502 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34503
34504 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34505 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34506 succeed, it will not be tried again.
34507 If you want Exim to retry an unseen delivery until it succeeds, you should
34508 arrange to set it up every time the filter runs.
34509
34510 When a system filter finishes running, the values of the variables &$n0$& &--
34511 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34512 users' filter files. Thus a system filter can, for example, set up &"scores"&
34513 to which users' filter files can refer.
34514
34515
34516
34517 .section "Additional variable for system filters" "SECID215"
34518 .vindex "&$recipients$&"
34519 The expansion variable &$recipients$&, containing a list of all the recipients
34520 of the message (separated by commas and white space), is available in system
34521 filters. It is not available in users' filters for privacy reasons.
34522
34523
34524
34525 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34526 .cindex "freezing messages"
34527 .cindex "message" "freezing"
34528 .cindex "message" "forced failure"
34529 .cindex "&%fail%&" "in system filter"
34530 .cindex "&%freeze%& in system filter"
34531 .cindex "&%defer%& in system filter"
34532 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34533 always available in system filters, but are not normally enabled in users'
34534 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34535 for the &(redirect)& router.) These commands can optionally be followed by the
34536 word &%text%& and a string containing an error message, for example:
34537 .code
34538 fail text "this message looks like spam to me"
34539 .endd
34540 The keyword &%text%& is optional if the next character is a double quote.
34541
34542 The &%defer%& command defers delivery of the original recipients of the
34543 message. The &%fail%& command causes all the original recipients to be failed,
34544 and a bounce message to be created. The &%freeze%& command suspends all
34545 delivery attempts for the original recipients. In all cases, any new deliveries
34546 that are specified by the filter are attempted as normal after the filter has
34547 run.
34548
34549 The &%freeze%& command is ignored if the message has been manually unfrozen and
34550 not manually frozen since. This means that automatic freezing by a system
34551 filter can be used as a way of checking out suspicious messages. If a message
34552 is found to be all right, manually unfreezing it allows it to be delivered.
34553
34554 .cindex "log" "&%fail%& command log line"
34555 .cindex "&%fail%&" "log line; reducing"
34556 The text given with a fail command is used as part of the bounce message as
34557 well as being written to the log. If the message is quite long, this can fill
34558 up a lot of log space when such failures are common. To reduce the size of the
34559 log message, Exim interprets the text in a special way if it starts with the
34560 two characters &`<<`& and contains &`>>`& later. The text between these two
34561 strings is written to the log, and the rest of the text is used in the bounce
34562 message. For example:
34563 .code
34564 fail "<<filter test 1>>Your message is rejected \
34565      because it contains attachments that we are \
34566      not prepared to receive."
34567 .endd
34568
34569 .cindex "loop" "caused by &%fail%&"
34570 Take great care with the &%fail%& command when basing the decision to fail on
34571 the contents of the message, because the bounce message will of course include
34572 the contents of the original message and will therefore trigger the &%fail%&
34573 command again (causing a mail loop) unless steps are taken to prevent this.
34574 Testing the &%error_message%& condition is one way to prevent this. You could
34575 use, for example
34576 .code
34577 if $message_body contains "this is spam" and not error_message
34578 then fail text "spam is not wanted here" endif
34579 .endd
34580 though of course that might let through unwanted bounce messages. The
34581 alternative is clever checking of the body and/or headers to detect bounces
34582 generated by the filter.
34583
34584 The interpretation of a system filter file ceases after a
34585 &%defer%&,
34586 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34587 set up earlier in the filter file are honoured, so you can use a sequence such
34588 as
34589 .code
34590 mail ...
34591 freeze
34592 .endd
34593 to send a specified message when the system filter is freezing (or deferring or
34594 failing) a message. The normal deliveries for the message do not, of course,
34595 take place.
34596
34597
34598
34599 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34600 .cindex "header lines" "adding; in system filter"
34601 .cindex "header lines" "removing; in system filter"
34602 .cindex "filter" "header lines; adding/removing"
34603 Two filter commands that are available only in system filters are:
34604 .code
34605 headers add <string>
34606 headers remove <string>
34607 .endd
34608 The argument for the &%headers add%& is a string that is expanded and then
34609 added to the end of the message's headers. It is the responsibility of the
34610 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34611 space is ignored, and if the string is otherwise empty, or if the expansion is
34612 forced to fail, the command has no effect.
34613
34614 You can use &"\n"& within the string, followed by white space, to specify
34615 continued header lines. More than one header may be added in one command by
34616 including &"\n"& within the string without any following white space. For
34617 example:
34618 .code
34619 headers add "X-header-1: ....\n  \
34620              continuation of X-header-1 ...\n\
34621              X-header-2: ...."
34622 .endd
34623 Note that the header line continuation white space after the first newline must
34624 be placed before the backslash that continues the input string, because white
34625 space after input continuations is ignored.
34626
34627 The argument for &%headers remove%& is a colon-separated list of header names.
34628 This command applies only to those headers that are stored with the message;
34629 those that are added at delivery time (such as &'Envelope-To:'& and
34630 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34631 header with the same name, they are all removed.
34632
34633 The &%headers%& command in a system filter makes an immediate change to the set
34634 of header lines that was received with the message (with possible additions
34635 from ACL processing). Subsequent commands in the system filter operate on the
34636 modified set, which also forms the basis for subsequent message delivery.
34637 Unless further modified during routing or transporting, this set of headers is
34638 used for all recipients of the message.
34639
34640 During routing and transporting, the variables that refer to the contents of
34641 header lines refer only to those lines that are in this set. Thus, header lines
34642 that are added by a system filter are visible to users' filter files and to all
34643 routers and transports. This contrasts with the manipulation of header lines by
34644 routers and transports, which is not immediate, but which instead is saved up
34645 until the message is actually being written (see section
34646 &<<SECTheadersaddrem>>&).
34647
34648 If the message is not delivered at the first attempt, header lines that were
34649 added by the system filter are stored with the message, and so are still
34650 present at the next delivery attempt. Header lines that were removed are still
34651 present, but marked &"deleted"& so that they are not transported with the
34652 message. For this reason, it is usual to make the &%headers%& command
34653 conditional on &%first_delivery%& so that the set of header lines is not
34654 modified more than once.
34655
34656 Because header modification in a system filter acts immediately, you have to
34657 use an indirect approach if you want to modify the contents of a header line.
34658 For example:
34659 .code
34660 headers add "Old-Subject: $h_subject:"
34661 headers remove "Subject"
34662 headers add "Subject: new subject (was: $h_old-subject:)"
34663 headers remove "Old-Subject"
34664 .endd
34665
34666
34667
34668 .section "Setting an errors address in a system filter" "SECID217"
34669 .cindex "envelope from"
34670 .cindex "envelope sender"
34671 In a system filter, if a &%deliver%& command is followed by
34672 .code
34673 errors_to <some address>
34674 .endd
34675 in order to change the envelope sender (and hence the error reporting) for that
34676 delivery, any address may be specified. (In a user filter, only the current
34677 user's address can be set.) For example, if some mail is being monitored, you
34678 might use
34679 .code
34680 unseen deliver monitor@spying.example errors_to root@local.example
34681 .endd
34682 to take a copy which would not be sent back to the normal error reporting
34683 address if its delivery failed.
34684
34685
34686
34687 .section "Per-address filtering" "SECTperaddfil"
34688 .vindex "&$domain$&"
34689 .vindex "&$local_part$&"
34690 In contrast to the system filter, which is run just once per message for each
34691 delivery attempt, it is also possible to set up a system-wide filtering
34692 operation that runs once for each recipient address. In this case, variables
34693 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34694 filter file could be made dependent on them. This is an example of a router
34695 which implements such a filter:
34696 .code
34697 central_filter:
34698   check_local_user
34699   driver = redirect
34700   domains = +local_domains
34701   file = /central/filters/$local_part
34702   no_verify
34703   allow_filter
34704   allow_freeze
34705 .endd
34706 The filter is run in a separate process under its own uid. Therefore, either
34707 &%check_local_user%& must be set (as above), in which case the filter is run as
34708 the local user, or the &%user%& option must be used to specify which user to
34709 use. If both are set, &%user%& overrides.
34710
34711 Care should be taken to ensure that none of the commands in the filter file
34712 specify a significant delivery if the message is to go on to be delivered to
34713 its intended recipient. The router will not then claim to have dealt with the
34714 address, so it will be passed on to subsequent routers to be delivered in the
34715 normal way.
34716 .ecindex IIDsysfil1
34717 .ecindex IIDsysfil2
34718 .ecindex IIDsysfil3
34719
34720
34721
34722
34723
34724
34725 . ////////////////////////////////////////////////////////////////////////////
34726 . ////////////////////////////////////////////////////////////////////////////
34727
34728 .chapter "Message processing" "CHAPmsgproc"
34729 .scindex IIDmesproc "message" "general processing"
34730 Exim performs various transformations on the sender and recipient addresses of
34731 all messages that it handles, and also on the messages' header lines. Some of
34732 these are optional and configurable, while others always take place. All of
34733 this processing, except rewriting as a result of routing, and the addition or
34734 removal of header lines while delivering, happens when a message is received,
34735 before it is placed on Exim's queue.
34736
34737 Some of the automatic processing takes place by default only for
34738 &"locally-originated"& messages. This adjective is used to describe messages
34739 that are not received over TCP/IP, but instead are passed to an Exim process on
34740 its standard input. This includes the interactive &"local SMTP"& case that is
34741 set up by the &%-bs%& command line option.
34742
34743 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34744 or ::1) are not considered to be locally-originated. Exim does not treat the
34745 loopback interface specially in any way.
34746
34747 If you want the loopback interface to be treated specially, you must ensure
34748 that there are appropriate entries in your ACLs.
34749
34750
34751
34752
34753 .section "Submission mode for non-local messages" "SECTsubmodnon"
34754 .cindex "message" "submission"
34755 .cindex "submission mode"
34756 Processing that happens automatically for locally-originated messages (unless
34757 &%suppress_local_fixups%& is set) can also be requested for messages that are
34758 received over TCP/IP. The term &"submission mode"& is used to describe this
34759 state. Submission mode is set by the modifier
34760 .code
34761 control = submission
34762 .endd
34763 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34764 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34765 a local submission, and is normally used when the source of the message is
34766 known to be an MUA running on a client host (as opposed to an MTA). For
34767 example, to set submission mode for messages originating on the IPv4 loopback
34768 interface, you could include the following in the MAIL ACL:
34769 .code
34770 warn  hosts = 127.0.0.1
34771       control = submission
34772 .endd
34773 .cindex "&%sender_retain%& submission option"
34774 There are some options that can be used when setting submission mode. A slash
34775 is used to separate options. For example:
34776 .code
34777 control = submission/sender_retain
34778 .endd
34779 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34780 true and &%local_from_check%& false for the current incoming message. The first
34781 of these allows an existing &'Sender:'& header in the message to remain, and
34782 the second suppresses the check to ensure that &'From:'& matches the
34783 authenticated sender. With this setting, Exim still fixes up messages by adding
34784 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34785 attempt to check sender authenticity in header lines.
34786
34787 When &%sender_retain%& is not set, a submission mode setting may specify a
34788 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34789 example:
34790 .code
34791 control = submission/domain=some.domain
34792 .endd
34793 The domain may be empty. How this value is used is described in sections
34794 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34795 that allows you to specify the user's full name for inclusion in a created
34796 &'Sender:'& or &'From:'& header line. For example:
34797 .code
34798 accept authenticated = *
34799        control = submission/domain=wonderland.example/\
34800                             name=${lookup {$authenticated_id} \
34801                                    lsearch {/etc/exim/namelist}}
34802 .endd
34803 Because the name may contain any characters, including slashes, the &%name%&
34804 option must be given last. The remainder of the string is used as the name. For
34805 the example above, if &_/etc/exim/namelist_& contains:
34806 .code
34807 bigegg:  Humpty Dumpty
34808 .endd
34809 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34810 line would be:
34811 .code
34812 Sender: Humpty Dumpty <bigegg@wonderland.example>
34813 .endd
34814 .cindex "return path" "in submission mode"
34815 By default, submission mode forces the return path to the same address as is
34816 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34817 specified, the return path is also left unchanged.
34818
34819 &*Note*&: The changes caused by submission mode take effect after the predata
34820 ACL. This means that any sender checks performed before the fix-ups use the
34821 untrusted sender address specified by the user, not the trusted sender address
34822 specified by submission mode. Although this might be slightly unexpected, it
34823 does mean that you can configure ACL checks to spot that a user is trying to
34824 spoof another's address.
34825
34826 .section "Line endings" "SECTlineendings"
34827 .cindex "line endings"
34828 .cindex "carriage return"
34829 .cindex "linefeed"
34830 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34831 linefeed) is the line ending for messages transmitted over the Internet using
34832 SMTP over TCP/IP. However, within individual operating systems, different
34833 conventions are used. For example, Unix-like systems use just LF, but others
34834 use CRLF or just CR.
34835
34836 Exim was designed for Unix-like systems, and internally, it stores messages
34837 using the system's convention of a single LF as a line terminator. When
34838 receiving a message, all line endings are translated to this standard format.
34839 Originally, it was thought that programs that passed messages directly to an
34840 MTA within an operating system would use that system's convention. Experience
34841 has shown that this is not the case; for example, there are Unix applications
34842 that use CRLF in this circumstance. For this reason, and for compatibility with
34843 other MTAs, the way Exim handles line endings for all messages is now as
34844 follows:
34845
34846 .ilist
34847 LF not preceded by CR is treated as a line ending.
34848 .next
34849 CR is treated as a line ending; if it is immediately followed by LF, the LF
34850 is ignored.
34851 .next
34852 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34853 nor a local message in the state where a line containing only a dot is a
34854 terminator.
34855 .next
34856 If a bare CR is encountered within a header line, an extra space is added after
34857 the line terminator so as not to end the header line. The reasoning behind this
34858 is that bare CRs in header lines are most likely either to be mistakes, or
34859 people trying to play silly games.
34860 .next
34861 If the first header line received in a message ends with CRLF, a subsequent
34862 bare LF in a header line is treated in the same way as a bare CR in a header
34863 line.
34864 .endlist
34865
34866
34867
34868
34869
34870 .section "Unqualified addresses" "SECID218"
34871 .cindex "unqualified addresses"
34872 .cindex "address" "qualification"
34873 By default, Exim expects every envelope address it receives from an external
34874 host to be fully qualified. Unqualified addresses cause negative responses to
34875 SMTP commands. However, because SMTP is used as a means of transporting
34876 messages from MUAs running on personal workstations, there is sometimes a
34877 requirement to accept unqualified addresses from specific hosts or IP networks.
34878
34879 Exim has two options that separately control which hosts may send unqualified
34880 sender or recipient addresses in SMTP commands, namely
34881 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34882 cases, if an unqualified address is accepted, it is qualified by adding the
34883 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34884
34885 .oindex "&%qualify_domain%&"
34886 .oindex "&%qualify_recipient%&"
34887 Unqualified addresses in header lines are automatically qualified for messages
34888 that are locally originated, unless the &%-bnq%& option is given on the command
34889 line. For messages received over SMTP, unqualified addresses in header lines
34890 are qualified only if unqualified addresses are permitted in SMTP commands. In
34891 other words, such qualification is also controlled by
34892 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34893
34894
34895
34896
34897 .section "The UUCP From line" "SECID219"
34898 .cindex "&""From""& line"
34899 .cindex "UUCP" "&""From""& line"
34900 .cindex "sender" "address"
34901 .oindex "&%uucp_from_pattern%&"
34902 .oindex "&%uucp_from_sender%&"
34903 .cindex "envelope from"
34904 .cindex "envelope sender"
34905 .cindex "Sendmail compatibility" "&""From""& line"
34906 Messages that have come from UUCP (and some other applications) often begin
34907 with a line containing the envelope sender and a timestamp, following the word
34908 &"From"&. Examples of two common formats are:
34909 .code
34910 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34911 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34912 .endd
34913 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34914 Exim recognizes such lines at the start of messages that are submitted to it
34915 via the command line (that is, on the standard input). It does not recognize
34916 such lines in incoming SMTP messages, unless the sending host matches
34917 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34918 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34919 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34920 default value matches the two common cases shown above and puts the address
34921 that follows &"From"& into &$1$&.
34922
34923 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34924 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34925 a trusted user, the message's sender address is constructed by expanding the
34926 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34927 then parsed as an RFC 2822 address. If there is no domain, the local part is
34928 qualified with &%qualify_domain%& unless it is the empty string. However, if
34929 the command line &%-f%& option is used, it overrides the &"From"& line.
34930
34931 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34932 sender address is not changed. This is also the case for incoming SMTP messages
34933 that are permitted to contain &"From"& lines.
34934
34935 Only one &"From"& line is recognized. If there is more than one, the second is
34936 treated as a data line that starts the body of the message, as it is not valid
34937 as a header line. This also happens if a &"From"& line is present in an
34938 incoming SMTP message from a source that is not permitted to send them.
34939
34940
34941
34942 .section "Resent- header lines" "SECID220"
34943 .cindex "&%Resent-%& header lines"
34944 .cindex "header lines" "Resent-"
34945 RFC 2822 makes provision for sets of header lines starting with the string
34946 &`Resent-`& to be added to a message when it is resent by the original
34947 recipient to somebody else. These headers are &'Resent-Date:'&,
34948 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34949 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34950
34951 .blockquote
34952 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34953 processing of replies or other such automatic actions on messages.'&
34954 .endblockquote
34955
34956 This leaves things a bit vague as far as other processing actions such as
34957 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34958 follows:
34959
34960 .ilist
34961 A &'Resent-From:'& line that just contains the login id of the submitting user
34962 is automatically rewritten in the same way as &'From:'& (see below).
34963 .next
34964 If there's a rewriting rule for a particular header line, it is also applied to
34965 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34966 &'From:'& also rewrites &'Resent-From:'&.
34967 .next
34968 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34969 also removed.
34970 .next
34971 For a locally-submitted message,
34972 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34973 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34974 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34975 included in log lines in this case.
34976 .next
34977 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34978 &%Resent-%& header lines are present.
34979 .endlist
34980
34981
34982
34983
34984 .section "The Auto-Submitted: header line" "SECID221"
34985 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34986 includes the header line:
34987 .code
34988 Auto-Submitted: auto-replied
34989 .endd
34990
34991 .section "The Bcc: header line" "SECID222"
34992 .cindex "&'Bcc:'& header line"
34993 If Exim is called with the &%-t%& option, to take recipient addresses from a
34994 message's header, it removes any &'Bcc:'& header line that may exist (after
34995 extracting its addresses). If &%-t%& is not present on the command line, any
34996 existing &'Bcc:'& is not removed.
34997
34998
34999 .section "The Date: header line" "SECID223"
35000 .cindex "&'Date:'& header line"
35001 .cindex "header lines" "Date:"
35002 If a locally-generated or submission-mode message has no &'Date:'& header line,
35003 Exim adds one, using the current date and time, unless the
35004 &%suppress_local_fixups%& control has been specified.
35005
35006 .section "The Delivery-date: header line" "SECID224"
35007 .cindex "&'Delivery-date:'& header line"
35008 .oindex "&%delivery_date_remove%&"
35009 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35010 set. Exim can be configured to add them to the final delivery of messages. (See
35011 the generic &%delivery_date_add%& transport option.) They should not be present
35012 in messages in transit. If the &%delivery_date_remove%& configuration option is
35013 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35014 messages.
35015
35016
35017 .section "The Envelope-to: header line" "SECID225"
35018 .cindex "&'Envelope-to:'& header line"
35019 .cindex "header lines" "Envelope-to:"
35020 .oindex "&%envelope_to_remove%&"
35021 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35022 Exim can be configured to add them to the final delivery of messages. (See the
35023 generic &%envelope_to_add%& transport option.) They should not be present in
35024 messages in transit. If the &%envelope_to_remove%& configuration option is set
35025 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35026 messages.
35027
35028
35029 .section "The From: header line" "SECTthefrohea"
35030 .cindex "&'From:'& header line"
35031 .cindex "header lines" "From:"
35032 .cindex "Sendmail compatibility" "&""From""& line"
35033 .cindex "message" "submission"
35034 .cindex "submission mode"
35035 If a submission-mode message does not contain a &'From:'& header line, Exim
35036 adds one if either of the following conditions is true:
35037
35038 .ilist
35039 The envelope sender address is not empty (that is, this is not a bounce
35040 message). The added header line copies the envelope sender address.
35041 .next
35042 .vindex "&$authenticated_id$&"
35043 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35044 .olist
35045 .vindex "&$qualify_domain$&"
35046 If no domain is specified by the submission control, the local part is
35047 &$authenticated_id$& and the domain is &$qualify_domain$&.
35048 .next
35049 If a non-empty domain is specified by the submission control, the local
35050 part is &$authenticated_id$&, and the domain is the specified domain.
35051 .next
35052 If an empty domain is specified by the submission control,
35053 &$authenticated_id$& is assumed to be the complete address.
35054 .endlist
35055 .endlist
35056
35057 A non-empty envelope sender takes precedence.
35058
35059 If a locally-generated incoming message does not contain a &'From:'& header
35060 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35061 containing the sender's address. The calling user's login name and full name
35062 are used to construct the address, as described in section &<<SECTconstr>>&.
35063 They are obtained from the password data by calling &[getpwuid()]& (but see the
35064 &%unknown_login%& configuration option). The address is qualified with
35065 &%qualify_domain%&.
35066
35067 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35068 &'From:'& header line containing just the unqualified login name of the calling
35069 user, this is replaced by an address containing the user's login name and full
35070 name as described in section &<<SECTconstr>>&.
35071
35072
35073 .section "The Message-ID: header line" "SECID226"
35074 .cindex "&'Message-ID:'& header line"
35075 .cindex "header lines" "Message-ID:"
35076 .cindex "message" "submission"
35077 .oindex "&%message_id_header_text%&"
35078 If a locally-generated or submission-mode incoming message does not contain a
35079 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35080 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35081 to the message. If there are any &'Resent-:'& headers in the message, it
35082 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35083 message id, preceded by the letter E to ensure it starts with a letter, and
35084 followed by @ and the primary host name. Additional information can be included
35085 in this header line by setting the &%message_id_header_text%& and/or
35086 &%message_id_header_domain%& options.
35087
35088
35089 .section "The Received: header line" "SECID227"
35090 .cindex "&'Received:'& header line"
35091 .cindex "header lines" "Received:"
35092 A &'Received:'& header line is added at the start of every message. The
35093 contents are defined by the &%received_header_text%& configuration option, and
35094 Exim automatically adds a semicolon and a timestamp to the configured string.
35095
35096 The &'Received:'& header is generated as soon as the message's header lines
35097 have been received. At this stage, the timestamp in the &'Received:'& header
35098 line is the time that the message started to be received. This is the value
35099 that is seen by the DATA ACL and by the &[local_scan()]& function.
35100
35101 Once a message is accepted, the timestamp in the &'Received:'& header line is
35102 changed to the time of acceptance, which is (apart from a small delay while the
35103 -H spool file is written) the earliest time at which delivery could start.
35104
35105
35106 .section "The References: header line" "SECID228"
35107 .cindex "&'References:'& header line"
35108 .cindex "header lines" "References:"
35109 Messages created by the &(autoreply)& transport include a &'References:'&
35110 header line. This is constructed according to the rules that are described in
35111 section 3.64 of RFC 2822 (which states that replies should contain such a
35112 header line), and section 3.14 of RFC 3834 (which states that automatic
35113 responses are not different in this respect). However, because some mail
35114 processing software does not cope well with very long header lines, no more
35115 than 12 message IDs are copied from the &'References:'& header line in the
35116 incoming message. If there are more than 12, the first one and then the final
35117 11 are copied, before adding the message ID of the incoming message.
35118
35119
35120
35121 .section "The Return-path: header line" "SECID229"
35122 .cindex "&'Return-path:'& header line"
35123 .cindex "header lines" "Return-path:"
35124 .oindex "&%return_path_remove%&"
35125 &'Return-path:'& header lines are defined as something an MTA may insert when
35126 it does the final delivery of messages. (See the generic &%return_path_add%&
35127 transport option.) Therefore, they should not be present in messages in
35128 transit. If the &%return_path_remove%& configuration option is set (the
35129 default), Exim removes &'Return-path:'& header lines from incoming messages.
35130
35131
35132
35133 .section "The Sender: header line" "SECTthesenhea"
35134 .cindex "&'Sender:'& header line"
35135 .cindex "message" "submission"
35136 .cindex "header lines" "Sender:"
35137 For a locally-originated message from an untrusted user, Exim may remove an
35138 existing &'Sender:'& header line, and it may add a new one. You can modify
35139 these actions by setting the &%local_sender_retain%& option true, the
35140 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35141 control setting.
35142
35143 When a local message is received from an untrusted user and
35144 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35145 control has not been set, a check is made to see if the address given in the
35146 &'From:'& header line is the correct (local) sender of the message. The address
35147 that is expected has the login name as the local part and the value of
35148 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35149 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35150 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35151 line is added to the message.
35152
35153 If you set &%local_from_check%& false, this checking does not occur. However,
35154 the removal of an existing &'Sender:'& line still happens, unless you also set
35155 &%local_sender_retain%& to be true. It is not possible to set both of these
35156 options true at the same time.
35157
35158 .cindex "submission mode"
35159 By default, no processing of &'Sender:'& header lines is done for messages
35160 received over TCP/IP or for messages submitted by trusted users. However, when
35161 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35162 not specified on the submission control, the following processing takes place:
35163
35164 .vindex "&$authenticated_id$&"
35165 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35166 authenticated, and &$authenticated_id$& is not empty, a sender address is
35167 created as follows:
35168
35169 .ilist
35170 .vindex "&$qualify_domain$&"
35171 If no domain is specified by the submission control, the local part is
35172 &$authenticated_id$& and the domain is &$qualify_domain$&.
35173 .next
35174 If a non-empty domain is specified by the submission control, the local part
35175 is &$authenticated_id$&, and the domain is the specified domain.
35176 .next
35177 If an empty domain is specified by the submission control,
35178 &$authenticated_id$& is assumed to be the complete address.
35179 .endlist
35180
35181 This address is compared with the address in the &'From:'& header line. If they
35182 are different, a &'Sender:'& header line containing the created address is
35183 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35184 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35185
35186 .cindex "return path" "created from &'Sender:'&"
35187 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35188 the message (the envelope sender address) is changed to be the same address,
35189 except in the case of submission mode when &%sender_retain%& is specified.
35190
35191
35192
35193 .section "Adding and removing header lines in routers and transports" &&&
35194          "SECTheadersaddrem"
35195 .cindex "header lines" "adding; in router or transport"
35196 .cindex "header lines" "removing; in router or transport"
35197 When a message is delivered, the addition and removal of header lines can be
35198 specified in a system filter, or on any of the routers and transports that
35199 process the message. Section &<<SECTaddremheasys>>& contains details about
35200 modifying headers in a system filter. Header lines can also be added in an ACL
35201 as a message is received (see section &<<SECTaddheadacl>>&).
35202
35203 In contrast to what happens in a system filter, header modifications that are
35204 specified on routers and transports apply only to the particular recipient
35205 addresses that are being processed by those routers and transports. These
35206 changes do not actually take place until a copy of the message is being
35207 transported. Therefore, they do not affect the basic set of header lines, and
35208 they do not affect the values of the variables that refer to header lines.
35209
35210 &*Note*&: In particular, this means that any expansions in the configuration of
35211 the transport cannot refer to the modified header lines, because such
35212 expansions all occur before the message is actually transported.
35213
35214 For both routers and transports, the argument of a &%headers_add%&
35215 option must be in the form of one or more RFC 2822 header lines, separated by
35216 newlines (coded as &"\n"&). For example:
35217 .code
35218 headers_add = X-added-header: added by $primary_hostname\n\
35219               X-added-second: another added header line
35220 .endd
35221 Exim does not check the syntax of these added header lines.
35222
35223 Multiple &%headers_add%& options for a single router or transport can be
35224 specified; the values will append to a single list of header lines.
35225 Each header-line is separately expanded.
35226
35227 The argument of a &%headers_remove%& option must consist of a colon-separated
35228 list of header names. This is confusing, because header names themselves are
35229 often terminated by colons. In this case, the colons are the list separators,
35230 not part of the names. For example:
35231 .code
35232 headers_remove = return-receipt-to:acknowledge-to
35233 .endd
35234
35235 Multiple &%headers_remove%& options for a single router or transport can be
35236 specified; the arguments will append to a single header-names list.
35237 Each item is separately expanded.
35238 Note that colons in complex expansions which are used to
35239 form all or part of a &%headers_remove%& list
35240 will act as list separators.
35241
35242 When &%headers_add%& or &%headers_remove%& is specified on a router,
35243 items are expanded at routing time,
35244 and then associated with all addresses that are
35245 accepted by that router, and also with any new addresses that it generates. If
35246 an address passes through several routers as a result of aliasing or
35247 forwarding, the changes are cumulative.
35248
35249 .oindex "&%unseen%&"
35250 However, this does not apply to multiple routers that result from the use of
35251 the &%unseen%& option. Any header modifications that were specified by the
35252 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35253
35254 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35255 settings cannot be delivered together in a batch, so a transport is always
35256 dealing with a set of addresses that have the same header-processing
35257 requirements.
35258
35259 The transport starts by writing the original set of header lines that arrived
35260 with the message, possibly modified by the system filter. As it writes out
35261 these lines, it consults the list of header names that were attached to the
35262 recipient address(es) by &%headers_remove%& options in routers, and it also
35263 consults the transport's own &%headers_remove%& option. Header lines whose
35264 names are on either of these lists are not written out. If there are multiple
35265 instances of any listed header, they are all skipped.
35266
35267 After the remaining original header lines have been written, new header
35268 lines that were specified by routers' &%headers_add%& options are written, in
35269 the order in which they were attached to the address. These are followed by any
35270 header lines specified by the transport's &%headers_add%& option.
35271
35272 This way of handling header line modifications in routers and transports has
35273 the following consequences:
35274
35275 .ilist
35276 The original set of header lines, possibly modified by the system filter,
35277 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35278 to it, at all times.
35279 .next
35280 Header lines that are added by a router's
35281 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35282 expansion syntax in subsequent routers or the transport.
35283 .next
35284 Conversely, header lines that are specified for removal by &%headers_remove%&
35285 in a router remain visible to subsequent routers and the transport.
35286 .next
35287 Headers added to an address by &%headers_add%& in a router cannot be removed by
35288 a later router or by a transport.
35289 .next
35290 An added header can refer to the contents of an original header that is to be
35291 removed, even it has the same name as the added header. For example:
35292 .code
35293 headers_remove = subject
35294 headers_add = Subject: new subject (was: $h_subject:)
35295 .endd
35296 .endlist
35297
35298 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35299 for a &(redirect)& router that has the &%one_time%& option set.
35300
35301
35302
35303
35304
35305 .section "Constructed addresses" "SECTconstr"
35306 .cindex "address" "constructed"
35307 .cindex "constructed address"
35308 When Exim constructs a sender address for a locally-generated message, it uses
35309 the form
35310 .display
35311 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35312 .endd
35313 For example:
35314 .code
35315 Zaphod Beeblebrox <zaphod@end.univ.example>
35316 .endd
35317 The user name is obtained from the &%-F%& command line option if set, or
35318 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35319 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35320 ampersand character, this is replaced by the login name with the first letter
35321 upper cased, as is conventional in a number of operating systems. See the
35322 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35323 The &%unknown_username%& option can be used to specify user names in cases when
35324 there is no password file entry.
35325
35326 .cindex "RFC 2047"
35327 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35328 parts of it if necessary. In addition, if it contains any non-printing
35329 characters, it is encoded as described in RFC 2047, which defines a way of
35330 including non-ASCII characters in header lines. The value of the
35331 &%headers_charset%& option specifies the name of the encoding that is used (the
35332 characters are assumed to be in this encoding). The setting of
35333 &%print_topbitchars%& controls whether characters with the top bit set (that
35334 is, with codes greater than 127) count as printing characters or not.
35335
35336
35337
35338 .section "Case of local parts" "SECID230"
35339 .cindex "case of local parts"
35340 .cindex "local part" "case of"
35341 RFC 2822 states that the case of letters in the local parts of addresses cannot
35342 be assumed to be non-significant. Exim preserves the case of local parts of
35343 addresses, but by default it uses a lower-cased form when it is routing,
35344 because on most Unix systems, usernames are in lower case and case-insensitive
35345 routing is required. However, any particular router can be made to use the
35346 original case for local parts by setting the &%caseful_local_part%& generic
35347 router option.
35348
35349 .cindex "mixed-case login names"
35350 If you must have mixed-case user names on your system, the best way to proceed,
35351 assuming you want case-independent handling of incoming email, is to set up
35352 your first router to convert incoming local parts in your domains to the
35353 correct case by means of a file lookup. For example:
35354 .code
35355 correct_case:
35356   driver = redirect
35357   domains = +local_domains
35358   data = ${lookup{$local_part}cdb\
35359               {/etc/usercased.cdb}{$value}fail}\
35360               @$domain
35361 .endd
35362 For this router, the local part is forced to lower case by the default action
35363 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35364 up a new local part in the correct case. If you then set &%caseful_local_part%&
35365 on any subsequent routers which process your domains, they will operate on
35366 local parts with the correct case in a case-sensitive manner.
35367
35368
35369
35370 .section "Dots in local parts" "SECID231"
35371 .cindex "dot" "in local part"
35372 .cindex "local part" "dots in"
35373 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35374 part may not begin or end with a dot, nor have two consecutive dots in the
35375 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35376 empty components for compatibility.
35377
35378
35379
35380 .section "Rewriting addresses" "SECID232"
35381 .cindex "rewriting" "addresses"
35382 Rewriting of sender and recipient addresses, and addresses in headers, can
35383 happen automatically, or as the result of configuration options, as described
35384 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35385 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35386
35387 Automatic rewriting includes qualification, as mentioned above. The other case
35388 in which it can happen is when an incomplete non-local domain is given. The
35389 routing process may cause this to be expanded into the full domain name. For
35390 example, a header such as
35391 .code
35392 To: hare@teaparty
35393 .endd
35394 might get rewritten as
35395 .code
35396 To: hare@teaparty.wonderland.fict.example
35397 .endd
35398 Rewriting as a result of routing is the one kind of message processing that
35399 does not happen at input time, as it cannot be done until the address has
35400 been routed.
35401
35402 Strictly, one should not do &'any'& deliveries of a message until all its
35403 addresses have been routed, in case any of the headers get changed as a
35404 result of routing. However, doing this in practice would hold up many
35405 deliveries for unreasonable amounts of time, just because one address could not
35406 immediately be routed. Exim therefore does not delay other deliveries when
35407 routing of one or more addresses is deferred.
35408 .ecindex IIDmesproc
35409
35410
35411
35412 . ////////////////////////////////////////////////////////////////////////////
35413 . ////////////////////////////////////////////////////////////////////////////
35414
35415 .chapter "SMTP processing" "CHAPSMTP"
35416 .scindex IIDsmtpproc1 "SMTP" "processing details"
35417 .scindex IIDsmtpproc2 "LMTP" "processing details"
35418 Exim supports a number of different ways of using the SMTP protocol, and its
35419 LMTP variant, which is an interactive protocol for transferring messages into a
35420 closed mail store application. This chapter contains details of how SMTP is
35421 processed. For incoming mail, the following are available:
35422
35423 .ilist
35424 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35425 .next
35426 SMTP over the standard input and output (the &%-bs%& option);
35427 .next
35428 Batched SMTP on the standard input (the &%-bS%& option).
35429 .endlist
35430
35431 For mail delivery, the following are available:
35432
35433 .ilist
35434 SMTP over TCP/IP (the &(smtp)& transport);
35435 .next
35436 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35437 &"lmtp"&);
35438 .next
35439 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35440 transport);
35441 .next
35442 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35443 the &%use_bsmtp%& option set).
35444 .endlist
35445
35446 &'Batched SMTP'& is the name for a process in which batches of messages are
35447 stored in or read from files (or pipes), in a format in which SMTP commands are
35448 used to contain the envelope information.
35449
35450
35451
35452 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35453 .cindex "SMTP" "outgoing over TCP/IP"
35454 .cindex "outgoing SMTP over TCP/IP"
35455 .cindex "LMTP" "over TCP/IP"
35456 .cindex "outgoing LMTP over TCP/IP"
35457 .cindex "EHLO"
35458 .cindex "HELO"
35459 .cindex "SIZE option on MAIL command"
35460 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35461 The &%protocol%& option selects which protocol is to be used, but the actual
35462 processing is the same in both cases.
35463
35464 If, in response to its EHLO command, Exim is told that the SIZE
35465 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35466 command. The value of <&'n'&> is the message size plus the value of the
35467 &%size_addition%& option (default 1024) to allow for additions to the message
35468 such as per-transport header lines, or changes made in a
35469 .cindex "transport" "filter"
35470 .cindex "filter" "transport filter"
35471 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35472 suppressed.
35473
35474 If the remote server advertises support for PIPELINING, Exim uses the
35475 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35476 required for the transaction.
35477
35478 If the remote server advertises support for the STARTTLS command, and Exim
35479 was built to support TLS encryption, it tries to start a TLS session unless the
35480 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35481 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35482 is called for verification.
35483
35484 If the remote server advertises support for the AUTH command, Exim scans
35485 the authenticators configuration for any suitable client settings, as described
35486 in chapter &<<CHAPSMTPAUTH>>&.
35487
35488 .cindex "carriage return"
35489 .cindex "linefeed"
35490 Responses from the remote host are supposed to be terminated by CR followed by
35491 LF. However, there are known to be hosts that do not send CR characters, so in
35492 order to be able to interwork with such hosts, Exim treats LF on its own as a
35493 line terminator.
35494
35495 If a message contains a number of different addresses, all those with the same
35496 characteristics (for example, the same envelope sender) that resolve to the
35497 same set of hosts, in the same order, are sent in a single SMTP transaction,
35498 even if they are for different domains, unless there are more than the setting
35499 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35500 they are split into groups containing no more than &%max_rcpt%&s addresses
35501 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35502 in parallel sessions. The order of hosts with identical MX values is not
35503 significant when checking whether addresses can be batched in this way.
35504
35505 When the &(smtp)& transport suffers a temporary failure that is not
35506 message-related, Exim updates its transport-specific database, which contains
35507 records indexed by host name that remember which messages are waiting for each
35508 particular host. It also updates the retry database with new retry times.
35509
35510 .cindex "hints database" "retry keys"
35511 Exim's retry hints are based on host name plus IP address, so if one address of
35512 a multi-homed host is broken, it will soon be skipped most of the time.
35513 See the next section for more detail about error handling.
35514
35515 .cindex "SMTP" "passed connection"
35516 .cindex "SMTP" "batching over TCP/IP"
35517 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35518 looks in the hints database for the transport to see if there are any queued
35519 messages waiting for the host to which it is connected. If it finds one, it
35520 creates a new Exim process using the &%-MC%& option (which can only be used by
35521 a process running as root or the Exim user) and passes the TCP/IP socket to it
35522 so that it can deliver another message using the same socket. The new process
35523 does only those deliveries that are routed to the connected host, and may in
35524 turn pass the socket on to a third process, and so on.
35525
35526 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35527 limit the number of messages sent down a single TCP/IP connection.
35528
35529 .cindex "asterisk" "after IP address"
35530 The second and subsequent messages delivered down an existing connection are
35531 identified in the main log by the addition of an asterisk after the closing
35532 square bracket of the IP address.
35533
35534
35535
35536
35537 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35538 .cindex "error" "in outgoing SMTP"
35539 .cindex "SMTP" "errors in outgoing"
35540 .cindex "host" "error"
35541 Three different kinds of error are recognized for outgoing SMTP: host errors,
35542 message errors, and recipient errors.
35543
35544 .vlist
35545 .vitem "&*Host errors*&"
35546 A host error is not associated with a particular message or with a
35547 particular recipient of a message. The host errors are:
35548
35549 .ilist
35550 Connection refused or timed out,
35551 .next
35552 Any error response code on connection,
35553 .next
35554 Any error response code to EHLO or HELO,
35555 .next
35556 Loss of connection at any time, except after &"."&,
35557 .next
35558 I/O errors at any time,
35559 .next
35560 Timeouts during the session, other than in response to MAIL, RCPT or
35561 the &"."& at the end of the data.
35562 .endlist ilist
35563
35564 For a host error, a permanent error response on connection, or in response to
35565 EHLO, causes all addresses routed to the host to be failed. Any other host
35566 error causes all addresses to be deferred, and retry data to be created for the
35567 host. It is not tried again, for any message, until its retry time arrives. If
35568 the current set of addresses are not all delivered in this run (to some
35569 alternative host), the message is added to the list of those waiting for this
35570 host, so if it is still undelivered when a subsequent successful delivery is
35571 made to the host, it will be sent down the same SMTP connection.
35572
35573 .vitem "&*Message errors*&"
35574 .cindex "message" "error"
35575 A message error is associated with a particular message when sent to a
35576 particular host, but not with a particular recipient of the message. The
35577 message errors are:
35578
35579 .ilist
35580 Any error response code to MAIL, DATA, or the &"."& that terminates
35581 the data,
35582 .next
35583 Timeout after MAIL,
35584 .next
35585 Timeout or loss of connection after the &"."& that terminates the data. A
35586 timeout after the DATA command itself is treated as a host error, as is loss of
35587 connection at any other time.
35588 .endlist ilist
35589
35590 For a message error, a permanent error response (5&'xx'&) causes all addresses
35591 to be failed, and a delivery error report to be returned to the sender. A
35592 temporary error response (4&'xx'&), or one of the timeouts, causes all
35593 addresses to be deferred. Retry data is not created for the host, but instead,
35594 a retry record for the combination of host plus message id is created. The
35595 message is not added to the list of those waiting for this host. This ensures
35596 that the failing message will not be sent to this host again until the retry
35597 time arrives. However, other messages that are routed to the host are not
35598 affected, so if it is some property of the message that is causing the error,
35599 it will not stop the delivery of other mail.
35600
35601 If the remote host specified support for the SIZE parameter in its response
35602 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35603 over-large message will cause a message error because the error arrives as a
35604 response to MAIL.
35605
35606 .vitem "&*Recipient errors*&"
35607 .cindex "recipient" "error"
35608 A recipient error is associated with a particular recipient of a message. The
35609 recipient errors are:
35610
35611 .ilist
35612 Any error response to RCPT,
35613 .next
35614 Timeout after RCPT.
35615 .endlist
35616
35617 For a recipient error, a permanent error response (5&'xx'&) causes the
35618 recipient address to be failed, and a bounce message to be returned to the
35619 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35620 address to be deferred, and routing retry data to be created for it. This is
35621 used to delay processing of the address in subsequent queue runs, until its
35622 routing retry time arrives. This applies to all messages, but because it
35623 operates only in queue runs, one attempt will be made to deliver a new message
35624 to the failing address before the delay starts to operate. This ensures that,
35625 if the failure is really related to the message rather than the recipient
35626 (&"message too big for this recipient"& is a possible example), other messages
35627 have a chance of getting delivered. If a delivery to the address does succeed,
35628 the retry information gets cleared, so all stuck messages get tried again, and
35629 the retry clock is reset.
35630
35631 The message is not added to the list of those waiting for this host. Use of the
35632 host for other messages is unaffected, and except in the case of a timeout,
35633 other recipients are processed independently, and may be successfully delivered
35634 in the current SMTP session. After a timeout it is of course impossible to
35635 proceed with the session, so all addresses get deferred. However, those other
35636 than the one that failed do not suffer any subsequent retry delays. Therefore,
35637 if one recipient is causing trouble, the others have a chance of getting
35638 through when a subsequent delivery attempt occurs before the failing
35639 recipient's retry time.
35640 .endlist
35641
35642 In all cases, if there are other hosts (or IP addresses) available for the
35643 current set of addresses (for example, from multiple MX records), they are
35644 tried in this run for any undelivered addresses, subject of course to their
35645 own retry data. In other words, recipient error retry data does not take effect
35646 until the next delivery attempt.
35647
35648 Some hosts have been observed to give temporary error responses to every
35649 MAIL command at certain times (&"insufficient space"& has been seen). It
35650 would be nice if such circumstances could be recognized, and defer data for the
35651 host itself created, but this is not possible within the current Exim design.
35652 What actually happens is that retry data for every (host, message) combination
35653 is created.
35654
35655 The reason that timeouts after MAIL and RCPT are treated specially is that
35656 these can sometimes arise as a result of the remote host's verification
35657 procedures. Exim makes this assumption, and treats them as if a temporary error
35658 response had been received. A timeout after &"."& is treated specially because
35659 it is known that some broken implementations fail to recognize the end of the
35660 message if the last character of the last line is a binary zero. Thus, it is
35661 helpful to treat this case as a message error.
35662
35663 Timeouts at other times are treated as host errors, assuming a problem with the
35664 host, or the connection to it. If a timeout after MAIL, RCPT,
35665 or &"."& is really a connection problem, the assumption is that at the next try
35666 the timeout is likely to occur at some other point in the dialogue, causing it
35667 then to be treated as a host error.
35668
35669 There is experimental evidence that some MTAs drop the connection after the
35670 terminating &"."& if they do not like the contents of the message for some
35671 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35672 should be given. That is why Exim treats this case as a message rather than a
35673 host error, in order not to delay other messages to the same host.
35674
35675
35676
35677
35678 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35679 .cindex "SMTP" "incoming over TCP/IP"
35680 .cindex "incoming SMTP over TCP/IP"
35681 .cindex "inetd"
35682 .cindex "daemon"
35683 Incoming SMTP messages can be accepted in one of two ways: by running a
35684 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35685 &_/etc/inetd.conf_& should be like this:
35686 .code
35687 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35688 .endd
35689 Exim distinguishes between this case and the case of a locally running user
35690 agent using the &%-bs%& option by checking whether or not the standard input is
35691 a socket. When it is, either the port must be privileged (less than 1024), or
35692 the caller must be root or the Exim user. If any other user passes a socket
35693 with an unprivileged port number, Exim prints a message on the standard error
35694 stream and exits with an error code.
35695
35696 By default, Exim does not make a log entry when a remote host connects or
35697 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35698 unexpected. It can be made to write such log entries by setting the
35699 &%smtp_connection%& log selector.
35700
35701 .cindex "carriage return"
35702 .cindex "linefeed"
35703 Commands from the remote host are supposed to be terminated by CR followed by
35704 LF. However, there are known to be hosts that do not send CR characters. In
35705 order to be able to interwork with such hosts, Exim treats LF on its own as a
35706 line terminator.
35707 Furthermore, because common code is used for receiving messages from all
35708 sources, a CR on its own is also interpreted as a line terminator. However, the
35709 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35710
35711 .cindex "EHLO" "invalid data"
35712 .cindex "HELO" "invalid data"
35713 One area that sometimes gives rise to problems concerns the EHLO or
35714 HELO commands. Some clients send syntactically invalid versions of these
35715 commands, which Exim rejects by default. (This is nothing to do with verifying
35716 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35717 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35718 match the broken hosts that send invalid commands.
35719
35720 .cindex "SIZE option on MAIL command"
35721 .cindex "MAIL" "SIZE option"
35722 The amount of disk space available is checked whenever SIZE is received on
35723 a MAIL command, independently of whether &%message_size_limit%& or
35724 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35725 false. A temporary error is given if there is not enough space. If
35726 &%check_spool_space%& is set, the check is for that amount of space plus the
35727 value given with SIZE, that is, it checks that the addition of the incoming
35728 message will not reduce the space below the threshold.
35729
35730 When a message is successfully received, Exim includes the local message id in
35731 its response to the final &"."& that terminates the data. If the remote host
35732 logs this text it can help with tracing what has happened to a message.
35733
35734 The Exim daemon can limit the number of simultaneous incoming connections it is
35735 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35736 number of simultaneous incoming connections from a single remote host (see the
35737 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35738 rejected using the SMTP temporary error code 421.
35739
35740 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35741 subprocess has finished, as this can get lost at busy times. Instead, it looks
35742 for completed subprocesses every time it wakes up. Provided there are other
35743 things happening (new incoming calls, starts of queue runs), completed
35744 processes will be noticed and tidied away. On very quiet systems you may
35745 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35746 it will be noticed when the daemon next wakes up.
35747
35748 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35749 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35750 high system load &-- for details see the &%smtp_accept_reserve%&,
35751 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35752 applies in both the daemon and &'inetd'& cases.
35753
35754 Exim normally starts a delivery process for each message received, though this
35755 can be varied by means of the &%-odq%& command line option and the
35756 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35757 number of simultaneously running delivery processes started in this way from
35758 SMTP input can be limited by the &%smtp_accept_queue%& and
35759 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35760 subsequently received messages are just put on the input queue without starting
35761 a delivery process.
35762
35763 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35764 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35765 started up from the &'inetd'& daemon, because in that case each connection is
35766 handled by an entirely independent Exim process. Control by load average is,
35767 however, available with &'inetd'&.
35768
35769 Exim can be configured to verify addresses in incoming SMTP commands as they
35770 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35771 to rewrite addresses at this time &-- before any syntax checking is done. See
35772 section &<<SECTrewriteS>>&.
35773
35774 Exim can also be configured to limit the rate at which a client host submits
35775 MAIL and RCPT commands in a single SMTP session. See the
35776 &%smtp_ratelimit_hosts%& option.
35777
35778
35779
35780 .section "Unrecognized SMTP commands" "SECID234"
35781 .cindex "SMTP" "unrecognized commands"
35782 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35783 commands during a single SMTP connection, it drops the connection after sending
35784 the error response to the last command. The default value for
35785 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35786 abuse that subvert web servers into making connections to SMTP ports; in these
35787 circumstances, a number of non-SMTP lines are sent first.
35788
35789
35790 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35791 .cindex "SMTP" "syntax errors"
35792 .cindex "SMTP" "protocol errors"
35793 A syntax error is detected if an SMTP command is recognized, but there is
35794 something syntactically wrong with its data, for example, a malformed email
35795 address in a RCPT command. Protocol errors include invalid command
35796 sequencing such as RCPT before MAIL. If Exim receives more than
35797 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35798 drops the connection after sending the error response to the last command. The
35799 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35800 broken clients that loop sending bad commands (yes, it has been seen).
35801
35802
35803
35804 .section "Use of non-mail SMTP commands" "SECID236"
35805 .cindex "SMTP" "non-mail commands"
35806 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35807 DATA. Exim counts such commands, and drops the connection if there are too
35808 many of them in a single SMTP session. This action catches some
35809 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35810 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35811 defines what &"too many"& means. Its default value is 10.
35812
35813 When a new message is expected, one occurrence of RSET is not counted. This
35814 allows a client to send one RSET between messages (this is not necessary,
35815 but some clients do it). Exim also allows one uncounted occurrence of HELO
35816 or EHLO, and one occurrence of STARTTLS between messages. After
35817 starting up a TLS session, another EHLO is expected, and so it too is not
35818 counted.
35819
35820 The first occurrence of AUTH in a connection, or immediately following
35821 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35822 RCPT, DATA, and QUIT are counted.
35823
35824 You can control which hosts are subject to the limit set by
35825 &%smtp_accept_max_nonmail%& by setting
35826 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35827 the limit apply to all hosts. This option means that you can exclude any
35828 specific badly-behaved hosts that you have to live with.
35829
35830
35831
35832
35833 .section "The VRFY and EXPN commands" "SECID237"
35834 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35835 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35836 appropriate) in order to decide whether the command should be accepted or not.
35837
35838 .cindex "VRFY" "processing"
35839 When no ACL is defined for VRFY, or if it rejects without
35840 setting an explicit response code, the command is accepted
35841 (with a 252 SMTP response code)
35842 in order to support awkward clients that do a VRFY before every RCPT.
35843 When VRFY is accepted, it runs exactly the same code as when Exim is
35844 called with the &%-bv%& option, and returns 250/451/550
35845 SMTP response codes.
35846
35847 .cindex "EXPN" "processing"
35848 If no ACL for EXPN is defined, the command is rejected.
35849 When EXPN is accepted, a single-level expansion of the address is done.
35850 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35851 than a verification (the &%-bv%& option). If an unqualified local part is given
35852 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35853 of VRFY and EXPN commands are logged on the main and reject logs, and
35854 VRFY verification failures are logged on the main log for consistency with
35855 RCPT failures.
35856
35857
35858
35859 .section "The ETRN command" "SECTETRN"
35860 .cindex "ETRN" "processing"
35861 RFC 1985 describes an SMTP command called ETRN that is designed to
35862 overcome the security problems of the TURN command (which has fallen into
35863 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35864 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35865 should be accepted or not. If no ACL is defined, the command is rejected.
35866
35867 The ETRN command is concerned with &"releasing"& messages that are awaiting
35868 delivery to certain hosts. As Exim does not organize its message queue by host,
35869 the only form of ETRN that is supported by default is the one where the
35870 text starts with the &"#"& prefix, in which case the remainder of the text is
35871 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35872 the &%-R%& option to happen, with the remainder of the ETRN text as its
35873 argument. For example,
35874 .code
35875 ETRN #brigadoon
35876 .endd
35877 runs the command
35878 .code
35879 exim -R brigadoon
35880 .endd
35881 which causes a delivery attempt on all messages with undelivered addresses
35882 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35883 default), Exim prevents the simultaneous execution of more than one queue run
35884 for the same argument string as a result of an ETRN command. This stops
35885 a misbehaving client from starting more than one queue runner at once.
35886
35887 .cindex "hints database" "ETRN serialization"
35888 Exim implements the serialization by means of a hints database in which a
35889 record is written whenever a process is started by ETRN, and deleted when
35890 the process completes. However, Exim does not keep the SMTP session waiting for
35891 the ETRN process to complete. Once ETRN is accepted, the client is sent
35892 a &"success"& return code. Obviously there is scope for hints records to get
35893 left lying around if there is a system or program crash. To guard against this,
35894 Exim ignores any records that are more than six hours old.
35895
35896 .oindex "&%smtp_etrn_command%&"
35897 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35898 used. This specifies a command that is run whenever ETRN is received,
35899 whatever the form of its argument. For
35900 example:
35901 .code
35902 smtp_etrn_command = /etc/etrn_command $domain \
35903                     $sender_host_address
35904 .endd
35905 .vindex "&$domain$&"
35906 The string is split up into arguments which are independently expanded. The
35907 expansion variable &$domain$& is set to the argument of the ETRN command,
35908 and no syntax checking is done on the contents of this argument. Exim does not
35909 wait for the command to complete, so its status code is not checked. Exim runs
35910 under its own uid and gid when receiving incoming SMTP, so it is not possible
35911 for it to change them before running the command.
35912
35913
35914
35915 .section "Incoming local SMTP" "SECID238"
35916 .cindex "SMTP" "local incoming"
35917 Some user agents use SMTP to pass messages to their local MTA using the
35918 standard input and output, as opposed to passing the envelope on the command
35919 line and writing the message to the standard input. This is supported by the
35920 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35921 messages over TCP/IP (including the use of ACLs), except that the envelope
35922 sender given in a MAIL command is ignored unless the caller is trusted. In
35923 an ACL you can detect this form of SMTP input by testing for an empty host
35924 identification. It is common to have this as the first line in the ACL that
35925 runs for RCPT commands:
35926 .code
35927 accept hosts = :
35928 .endd
35929 This accepts SMTP messages from local processes without doing any other tests.
35930
35931
35932
35933 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35934 .cindex "SMTP" "batched outgoing"
35935 .cindex "batched SMTP output"
35936 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35937 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35938 be output in BSMTP format. No SMTP responses are possible for this form of
35939 delivery. All it is doing is using SMTP commands as a way of transmitting the
35940 envelope along with the message.
35941
35942 The message is written to the file or pipe preceded by the SMTP commands
35943 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35944 the message that start with a dot have an extra dot added. The SMTP command
35945 HELO is not normally used. If it is required, the &%message_prefix%& option
35946 can be used to specify it.
35947
35948 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35949 one recipient address at a time by default. However, you can arrange for them
35950 to handle several addresses at once by setting the &%batch_max%& option. When
35951 this is done for BSMTP, messages may contain multiple RCPT commands. See
35952 chapter &<<CHAPbatching>>& for more details.
35953
35954 .vindex "&$host$&"
35955 When one or more addresses are routed to a BSMTP transport by a router that
35956 sets up a host list, the name of the first host on the list is available to the
35957 transport in the variable &$host$&. Here is an example of such a transport and
35958 router:
35959 .code
35960 begin routers
35961 route_append:
35962   driver = manualroute
35963   transport = smtp_appendfile
35964   route_list = domain.example  batch.host.example
35965
35966 begin transports
35967 smtp_appendfile:
35968   driver = appendfile
35969   directory = /var/bsmtp/$host
35970   batch_max = 1000
35971   use_bsmtp
35972   user = exim
35973 .endd
35974 This causes messages addressed to &'domain.example'& to be written in BSMTP
35975 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35976 message (unless there are more than 1000 recipients).
35977
35978
35979
35980 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35981 .cindex "SMTP" "batched incoming"
35982 .cindex "batched SMTP input"
35983 The &%-bS%& command line option causes Exim to accept one or more messages by
35984 reading SMTP on the standard input, but to generate no responses. If the caller
35985 is trusted, the senders in the MAIL commands are believed; otherwise the
35986 sender is always the caller of Exim. Unqualified senders and receivers are not
35987 rejected (there seems little point) but instead just get qualified. HELO
35988 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35989 as NOOP; QUIT quits.
35990
35991 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35992 ACL is run in the same way as for non-SMTP local input.
35993
35994 If an error is detected while reading a message, including a missing &"."& at
35995 the end, Exim gives up immediately. It writes details of the error to the
35996 standard output in a stylized way that the calling program should be able to
35997 make some use of automatically, for example:
35998 .code
35999 554 Unexpected end of file
36000 Transaction started in line 10
36001 Error detected in line 14
36002 .endd
36003 It writes a more verbose version, for human consumption, to the standard error
36004 file, for example:
36005 .code
36006 An error was detected while processing a file of BSMTP input.
36007 The error message was:
36008
36009 501 '>' missing at end of address
36010
36011 The SMTP transaction started in line 10.
36012 The error was detected in line 12.
36013 The SMTP command at fault was:
36014
36015 rcpt to:<malformed@in.com.plete
36016
36017 1 previous message was successfully processed.
36018 The rest of the batch was abandoned.
36019 .endd
36020 The return code from Exim is zero only if there were no errors. It is 1 if some
36021 messages were accepted before an error was detected, and 2 if no messages were
36022 accepted.
36023 .ecindex IIDsmtpproc1
36024 .ecindex IIDsmtpproc2
36025
36026
36027
36028 . ////////////////////////////////////////////////////////////////////////////
36029 . ////////////////////////////////////////////////////////////////////////////
36030
36031 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36032          "Customizing messages"
36033 When a message fails to be delivered, or remains in the queue for more than a
36034 configured amount of time, Exim sends a message to the original sender, or
36035 to an alternative configured address. The text of these messages is built into
36036 the code of Exim, but it is possible to change it, either by adding a single
36037 string, or by replacing each of the paragraphs by text supplied in a file.
36038
36039 The &'From:'& and &'To:'& header lines are automatically generated; you can
36040 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36041 option. Exim also adds the line
36042 .code
36043 Auto-Submitted: auto-generated
36044 .endd
36045 to all warning and bounce messages,
36046
36047
36048 .section "Customizing bounce messages" "SECID239"
36049 .cindex "customizing" "bounce message"
36050 .cindex "bounce message" "customizing"
36051 If &%bounce_message_text%& is set, its contents are included in the default
36052 message immediately after &"This message was created automatically by mail
36053 delivery software."& The string is not expanded. It is not used if
36054 &%bounce_message_file%& is set.
36055
36056 When &%bounce_message_file%& is set, it must point to a template file for
36057 constructing error messages. The file consists of a series of text items,
36058 separated by lines consisting of exactly four asterisks. If the file cannot be
36059 opened, default text is used and a message is written to the main and panic
36060 logs. If any text item in the file is empty, default text is used for that
36061 item.
36062
36063 .vindex "&$bounce_recipient$&"
36064 .vindex "&$bounce_return_size_limit$&"
36065 Each item of text that is read from the file is expanded, and there are two
36066 expansion variables which can be of use here: &$bounce_recipient$& is set to
36067 the recipient of an error message while it is being created, and
36068 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36069 option, rounded to a whole number.
36070
36071 The items must appear in the file in the following order:
36072
36073 .ilist
36074 The first item is included in the headers, and should include at least a
36075 &'Subject:'& header. Exim does not check the syntax of these headers.
36076 .next
36077 The second item forms the start of the error message. After it, Exim lists the
36078 failing addresses with their error messages.
36079 .next
36080 The third item is used to introduce any text from pipe transports that is to be
36081 returned to the sender. It is omitted if there is no such text.
36082 .next
36083 The fourth, fifth and sixth items will be ignored and may be empty.
36084 The fields exist for back-compatibility
36085 .endlist
36086
36087 The default state (&%bounce_message_file%& unset) is equivalent to the
36088 following file, in which the sixth item is empty. The &'Subject:'& and some
36089 other lines have been split in order to fit them on the page:
36090 .code
36091 Subject: Mail delivery failed
36092   ${if eq{$sender_address}{$bounce_recipient}
36093   {: returning message to sender}}
36094 ****
36095 This message was created automatically by mail delivery software.
36096
36097 A message ${if eq{$sender_address}{$bounce_recipient}
36098   {that you sent }{sent by
36099
36100 <$sender_address>
36101
36102 }}could not be delivered to all of its recipients.
36103 This is a permanent error. The following address(es) failed:
36104 ****
36105 The following text was generated during the delivery attempt(s):
36106 ****
36107 ------ This is a copy of the message, including all the headers.
36108   ------
36109 ****
36110 ------ The body of the message is $message_size characters long;
36111   only the first
36112 ------ $bounce_return_size_limit or so are included here.
36113 ****
36114 .endd
36115 .section "Customizing warning messages" "SECTcustwarn"
36116 .cindex "customizing" "warning message"
36117 .cindex "warning of delay" "customizing the message"
36118 The option &%warn_message_file%& can be pointed at a template file for use when
36119 warnings about message delays are created. In this case there are only three
36120 text sections:
36121
36122 .ilist
36123 The first item is included in the headers, and should include at least a
36124 &'Subject:'& header. Exim does not check the syntax of these headers.
36125 .next
36126 The second item forms the start of the warning message. After it, Exim lists
36127 the delayed addresses.
36128 .next
36129 The third item then ends the message.
36130 .endlist
36131
36132 The default state is equivalent to the following file, except that some lines
36133 have been split here, in order to fit them on the page:
36134 .code
36135 Subject: Warning: message $message_exim_id delayed
36136   $warn_message_delay
36137 ****
36138 This message was created automatically by mail delivery software.
36139
36140 A message ${if eq{$sender_address}{$warn_message_recipients}
36141 {that you sent }{sent by
36142
36143 <$sender_address>
36144
36145 }}has not been delivered to all of its recipients after
36146 more than $warn_message_delay in the queue on $primary_hostname.
36147
36148 The message identifier is:     $message_exim_id
36149 The subject of the message is: $h_subject
36150 The date of the message is:    $h_date
36151
36152 The following address(es) have not yet been delivered:
36153 ****
36154 No action is required on your part. Delivery attempts will
36155 continue for some time, and this warning may be repeated at
36156 intervals if the message remains undelivered. Eventually the
36157 mail delivery software will give up, and when that happens,
36158 the message will be returned to you.
36159 .endd
36160 .vindex "&$warn_message_delay$&"
36161 .vindex "&$warn_message_recipients$&"
36162 However, in the default state the subject and date lines are omitted if no
36163 appropriate headers exist. During the expansion of this file,
36164 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36165 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36166 of recipients for the warning message. There may be more than one if there are
36167 multiple addresses with different &%errors_to%& settings on the routers that
36168 handled them.
36169
36170
36171
36172
36173 . ////////////////////////////////////////////////////////////////////////////
36174 . ////////////////////////////////////////////////////////////////////////////
36175
36176 .chapter "Some common configuration settings" "CHAPcomconreq"
36177 This chapter discusses some configuration settings that seem to be fairly
36178 common. More examples and discussion can be found in the Exim book.
36179
36180
36181
36182 .section "Sending mail to a smart host" "SECID240"
36183 .cindex "smart host" "example router"
36184 If you want to send all mail for non-local domains to a &"smart host"&, you
36185 should replace the default &(dnslookup)& router with a router which does the
36186 routing explicitly:
36187 .code
36188 send_to_smart_host:
36189   driver = manualroute
36190   route_list = !+local_domains smart.host.name
36191   transport = remote_smtp
36192 .endd
36193 You can use the smart host's IP address instead of the name if you wish.
36194 If you are using Exim only to submit messages to a smart host, and not for
36195 receiving incoming messages, you can arrange for it to do the submission
36196 synchronously by setting the &%mua_wrapper%& option (see chapter
36197 &<<CHAPnonqueueing>>&).
36198
36199
36200
36201
36202 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36203 .cindex "mailing lists"
36204 Exim can be used to run simple mailing lists, but for large and/or complicated
36205 requirements, the use of additional specialized mailing list software such as
36206 Majordomo or Mailman is recommended.
36207
36208 The &(redirect)& router can be used to handle mailing lists where each list
36209 is maintained in a separate file, which can therefore be managed by an
36210 independent manager. The &%domains%& router option can be used to run these
36211 lists in a separate domain from normal mail. For example:
36212 .code
36213 lists:
36214   driver = redirect
36215   domains = lists.example
36216   file = /usr/lists/$local_part
36217   forbid_pipe
36218   forbid_file
36219   errors_to = $local_part-request@lists.example
36220   no_more
36221 .endd
36222 This router is skipped for domains other than &'lists.example'&. For addresses
36223 in that domain, it looks for a file that matches the local part. If there is no
36224 such file, the router declines, but because &%no_more%& is set, no subsequent
36225 routers are tried, and so the whole delivery fails.
36226
36227 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36228 expanded into a filename or a pipe delivery, which is usually inappropriate in
36229 a mailing list.
36230
36231 .oindex "&%errors_to%&"
36232 The &%errors_to%& option specifies that any delivery errors caused by addresses
36233 taken from a mailing list are to be sent to the given address rather than the
36234 original sender of the message. However, before acting on this, Exim verifies
36235 the error address, and ignores it if verification fails.
36236
36237 For example, using the configuration above, mail sent to
36238 &'dicts@lists.example'& is passed on to those addresses contained in
36239 &_/usr/lists/dicts_&, with error reports directed to
36240 &'dicts-request@lists.example'&, provided that this address can be verified.
36241 There could be a file called &_/usr/lists/dicts-request_& containing
36242 the address(es) of this particular list's manager(s), but other approaches,
36243 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36244 or &%local_part_suffix%& options) to handle addresses of the form
36245 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36246
36247
36248
36249 .section "Syntax errors in mailing lists" "SECID241"
36250 .cindex "mailing lists" "syntax errors in"
36251 If an entry in redirection data contains a syntax error, Exim normally defers
36252 delivery of the original address. That means that a syntax error in a mailing
36253 list holds up all deliveries to the list. This may not be appropriate when a
36254 list is being maintained automatically from data supplied by users, and the
36255 addresses are not rigorously checked.
36256
36257 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36258 entries that fail to parse, noting the incident in the log. If in addition
36259 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36260 whenever a broken address is skipped. It is usually appropriate to set
36261 &%syntax_errors_to%& to the same address as &%errors_to%&.
36262
36263
36264
36265 .section "Re-expansion of mailing lists" "SECID242"
36266 .cindex "mailing lists" "re-expansion of"
36267 Exim remembers every individual address to which a message has been delivered,
36268 in order to avoid duplication, but it normally stores only the original
36269 recipient addresses with a message. If all the deliveries to a mailing list
36270 cannot be done at the first attempt, the mailing list is re-expanded when the
36271 delivery is next tried. This means that alterations to the list are taken into
36272 account at each delivery attempt, so addresses that have been added to
36273 the list since the message arrived will therefore receive a copy of the
36274 message, even though it pre-dates their subscription.
36275
36276 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36277 on the &(redirect)& router. If this is done, any addresses generated by the
36278 router that fail to deliver at the first attempt are added to the message as
36279 &"top level"& addresses, and the parent address that generated them is marked
36280 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36281 subsequent delivery attempts. The disadvantage of this is that if any of the
36282 failing addresses are incorrect, correcting them in the file has no effect on
36283 pre-existing messages.
36284
36285 The original top-level address is remembered with each of the generated
36286 addresses, and is output in any log messages. However, any intermediate parent
36287 addresses are not recorded. This makes a difference to the log only if the
36288 &%all_parents%& selector is set, but for mailing lists there is normally only
36289 one level of expansion anyway.
36290
36291
36292
36293 .section "Closed mailing lists" "SECID243"
36294 .cindex "mailing lists" "closed"
36295 The examples so far have assumed open mailing lists, to which anybody may
36296 send mail. It is also possible to set up closed lists, where mail is accepted
36297 from specified senders only. This is done by making use of the generic
36298 &%senders%& option to restrict the router that handles the list.
36299
36300 The following example uses the same file as a list of recipients and as a list
36301 of permitted senders. It requires three routers:
36302 .code
36303 lists_request:
36304   driver = redirect
36305   domains = lists.example
36306   local_part_suffix = -request
36307   file = /usr/lists/$local_part$local_part_suffix
36308   no_more
36309
36310 lists_post:
36311   driver = redirect
36312   domains = lists.example
36313   senders = ${if exists {/usr/lists/$local_part}\
36314              {lsearch;/usr/lists/$local_part}{*}}
36315   file = /usr/lists/$local_part
36316   forbid_pipe
36317   forbid_file
36318   errors_to = $local_part-request@lists.example
36319   no_more
36320
36321 lists_closed:
36322   driver = redirect
36323   domains = lists.example
36324   allow_fail
36325   data = :fail: $local_part@lists.example is a closed mailing list
36326 .endd
36327 All three routers have the same &%domains%& setting, so for any other domains,
36328 they are all skipped. The first router runs only if the local part ends in
36329 &%-request%&. It handles messages to the list manager(s) by means of an open
36330 mailing list.
36331
36332 The second router runs only if the &%senders%& precondition is satisfied. It
36333 checks for the existence of a list that corresponds to the local part, and then
36334 checks that the sender is on the list by means of a linear search. It is
36335 necessary to check for the existence of the file before trying to search it,
36336 because otherwise Exim thinks there is a configuration error. If the file does
36337 not exist, the expansion of &%senders%& is *, which matches all senders. This
36338 means that the router runs, but because there is no list, declines, and
36339 &%no_more%& ensures that no further routers are run. The address fails with an
36340 &"unrouteable address"& error.
36341
36342 The third router runs only if the second router is skipped, which happens when
36343 a mailing list exists, but the sender is not on it. This router forcibly fails
36344 the address, giving a suitable error message.
36345
36346
36347
36348
36349 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36350 .cindex "VERP"
36351 .cindex "Variable Envelope Return Paths"
36352 .cindex "envelope from"
36353 .cindex "envelope sender"
36354 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36355 are a way of helping mailing list administrators discover which subscription
36356 address is the cause of a particular delivery failure. The idea is to encode
36357 the original recipient address in the outgoing envelope sender address, so that
36358 if the message is forwarded by another host and then subsequently bounces, the
36359 original recipient can be extracted from the recipient address of the bounce.
36360
36361 .oindex &%errors_to%&
36362 .oindex &%return_path%&
36363 Envelope sender addresses can be modified by Exim using two different
36364 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36365 list examples), or the &%return_path%& option on a transport. The second of
36366 these is effective only if the message is successfully delivered to another
36367 host; it is not used for errors detected on the local host (see the description
36368 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36369 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36370 .code
36371 verp_smtp:
36372   driver = smtp
36373   max_rcpt = 1
36374   return_path = \
36375     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36376       {$1-request+$local_part=$domain@your.dom.example}fail}
36377 .endd
36378 This has the effect of rewriting the return path (envelope sender) on outgoing
36379 SMTP messages, if the local part of the original return path ends in
36380 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36381 local part and domain of the recipient into the return path. Suppose, for
36382 example, that a message whose return path has been set to
36383 &'somelist-request@your.dom.example'& is sent to
36384 &'subscriber@other.dom.example'&. In the transport, the return path is
36385 rewritten as
36386 .code
36387 somelist-request+subscriber=other.dom.example@your.dom.example
36388 .endd
36389 .vindex "&$local_part$&"
36390 For this to work, you must tell Exim to send multiple copies of messages that
36391 have more than one recipient, so that each copy has just one recipient. This is
36392 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36393 might be sent to several different recipients in the same domain, in which case
36394 &$local_part$& is not available in the transport, because it is not unique.
36395
36396 Unless your host is doing nothing but mailing list deliveries, you should
36397 probably use a separate transport for the VERP deliveries, so as not to use
36398 extra resources in making one-per-recipient copies for other deliveries. This
36399 can easily be done by expanding the &%transport%& option in the router:
36400 .code
36401 dnslookup:
36402   driver = dnslookup
36403   domains = ! +local_domains
36404   transport = \
36405     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36406       {verp_smtp}{remote_smtp}}
36407   no_more
36408 .endd
36409 If you want to change the return path using &%errors_to%& in a router instead
36410 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36411 routers that handle mailing list addresses. This will ensure that all delivery
36412 errors, including those detected on the local host, are sent to the VERP
36413 address.
36414
36415 On a host that does no local deliveries and has no manual routing, only the
36416 &(dnslookup)& router needs to be changed. A special transport is not needed for
36417 SMTP deliveries. Every mailing list recipient has its own return path value,
36418 and so Exim must hand them to the transport one at a time. Here is an example
36419 of a &(dnslookup)& router that implements VERP:
36420 .code
36421 verp_dnslookup:
36422   driver = dnslookup
36423   domains = ! +local_domains
36424   transport = remote_smtp
36425   errors_to = \
36426     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36427      {$1-request+$local_part=$domain@your.dom.example}fail}
36428   no_more
36429 .endd
36430 Before you start sending out messages with VERPed return paths, you must also
36431 configure Exim to accept the bounce messages that come back to those paths.
36432 Typically this is done by setting a &%local_part_suffix%& option for a
36433 router, and using this to route the messages to wherever you want to handle
36434 them.
36435
36436 The overhead incurred in using VERP depends very much on the size of the
36437 message, the number of recipient addresses that resolve to the same remote
36438 host, and the speed of the connection over which the message is being sent. If
36439 a lot of addresses resolve to the same host and the connection is slow, sending
36440 a separate copy of the message for each address may take substantially longer
36441 than sending a single copy with many recipients (for which VERP cannot be
36442 used).
36443
36444
36445
36446
36447
36448
36449 .section "Virtual domains" "SECTvirtualdomains"
36450 .cindex "virtual domains"
36451 .cindex "domain" "virtual"
36452 The phrase &'virtual domain'& is unfortunately used with two rather different
36453 meanings:
36454
36455 .ilist
36456 A domain for which there are no real mailboxes; all valid local parts are
36457 aliases for other email addresses. Common examples are organizational
36458 top-level domains and &"vanity"& domains.
36459 .next
36460 One of a number of independent domains that are all handled by the same host,
36461 with mailboxes on that host, but where the mailbox owners do not necessarily
36462 have login accounts on that host.
36463 .endlist
36464
36465 The first usage is probably more common, and does seem more &"virtual"& than
36466 the second. This kind of domain can be handled in Exim with a straightforward
36467 aliasing router. One approach is to create a separate alias file for each
36468 virtual domain. Exim can test for the existence of the alias file to determine
36469 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36470 to a router of this form:
36471 .code
36472 virtual:
36473   driver = redirect
36474   domains = dsearch;/etc/mail/virtual
36475   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36476   no_more
36477 .endd
36478 The &%domains%& option specifies that the router is to be skipped, unless there
36479 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36480 domain that is being processed. When the router runs, it looks up the local
36481 part in the file to find a new address (or list of addresses). The &%no_more%&
36482 setting ensures that if the lookup fails (leading to &%data%& being an empty
36483 string), Exim gives up on the address without trying any subsequent routers.
36484
36485 This one router can handle all the virtual domains because the alias filenames
36486 follow a fixed pattern. Permissions can be arranged so that appropriate people
36487 can edit the different alias files. A successful aliasing operation results in
36488 a new envelope recipient address, which is then routed from scratch.
36489
36490 The other kind of &"virtual"& domain can also be handled in a straightforward
36491 way. One approach is to create a file for each domain containing a list of
36492 valid local parts, and use it in a router like this:
36493 .code
36494 my_domains:
36495   driver = accept
36496   domains = dsearch;/etc/mail/domains
36497   local_parts = lsearch;/etc/mail/domains/$domain
36498   transport = my_mailboxes
36499 .endd
36500 The address is accepted if there is a file for the domain, and the local part
36501 can be found in the file. The &%domains%& option is used to check for the
36502 file's existence because &%domains%& is tested before the &%local_parts%&
36503 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36504 because that option is tested after &%local_parts%&. The transport is as
36505 follows:
36506 .code
36507 my_mailboxes:
36508   driver = appendfile
36509   file = /var/mail/$domain/$local_part
36510   user = mail
36511 .endd
36512 This uses a directory of mailboxes for each domain. The &%user%& setting is
36513 required, to specify which uid is to be used for writing to the mailboxes.
36514
36515 The configuration shown here is just one example of how you might support this
36516 requirement. There are many other ways this kind of configuration can be set
36517 up, for example, by using a database instead of separate files to hold all the
36518 information about the domains.
36519
36520
36521
36522 .section "Multiple user mailboxes" "SECTmulbox"
36523 .cindex "multiple mailboxes"
36524 .cindex "mailbox" "multiple"
36525 .cindex "local part" "prefix"
36526 .cindex "local part" "suffix"
36527 Heavy email users often want to operate with multiple mailboxes, into which
36528 incoming mail is automatically sorted. A popular way of handling this is to
36529 allow users to use multiple sender addresses, so that replies can easily be
36530 identified. Users are permitted to add prefixes or suffixes to their local
36531 parts for this purpose. The wildcard facility of the generic router options
36532 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36533 example, consider this router:
36534 .code
36535 userforward:
36536   driver = redirect
36537   check_local_user
36538   file = $home/.forward
36539   local_part_suffix = -*
36540   local_part_suffix_optional
36541   allow_filter
36542 .endd
36543 .vindex "&$local_part_suffix$&"
36544 It runs a user's &_.forward_& file for all local parts of the form
36545 &'username-*'&. Within the filter file the user can distinguish different
36546 cases by testing the variable &$local_part_suffix$&. For example:
36547 .code
36548 if $local_part_suffix contains -special then
36549 save /home/$local_part/Mail/special
36550 endif
36551 .endd
36552 If the filter file does not exist, or does not deal with such addresses, they
36553 fall through to subsequent routers, and, assuming no subsequent use of the
36554 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36555 control over which suffixes are valid.
36556
36557 Alternatively, a suffix can be used to trigger the use of a different
36558 &_.forward_& file &-- which is the way a similar facility is implemented in
36559 another MTA:
36560 .code
36561 userforward:
36562   driver = redirect
36563   check_local_user
36564   file = $home/.forward$local_part_suffix
36565   local_part_suffix = -*
36566   local_part_suffix_optional
36567   allow_filter
36568 .endd
36569 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36570 example, &_.forward-special_& is used. Once again, if the appropriate file
36571 does not exist, or does not deal with the address, it is passed on to
36572 subsequent routers, which could, if required, look for an unqualified
36573 &_.forward_& file to use as a default.
36574
36575
36576
36577 .section "Simplified vacation processing" "SECID244"
36578 .cindex "vacation processing"
36579 The traditional way of running the &'vacation'& program is for a user to set up
36580 a pipe command in a &_.forward_& file
36581 (see section &<<SECTspecitredli>>& for syntax details).
36582 This is prone to error by inexperienced users. There are two features of Exim
36583 that can be used to make this process simpler for users:
36584
36585 .ilist
36586 A local part prefix such as &"vacation-"& can be specified on a router which
36587 can cause the message to be delivered directly to the &'vacation'& program, or
36588 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36589 &_.forward_& file are then much simpler. For example:
36590 .code
36591 spqr, vacation-spqr
36592 .endd
36593 .next
36594 The &%require_files%& generic router option can be used to trigger a
36595 vacation delivery by checking for the existence of a certain file in the
36596 user's home directory. The &%unseen%& generic option should also be used, to
36597 ensure that the original delivery also proceeds. In this case, all the user has
36598 to do is to create a file called, say, &_.vacation_&, containing a vacation
36599 message.
36600 .endlist
36601
36602 Another advantage of both these methods is that they both work even when the
36603 use of arbitrary pipes by users is locked out.
36604
36605
36606
36607 .section "Taking copies of mail" "SECID245"
36608 .cindex "message" "copying every"
36609 Some installations have policies that require archive copies of all messages to
36610 be made. A single copy of each message can easily be taken by an appropriate
36611 command in a system filter, which could, for example, use a different file for
36612 each day's messages.
36613
36614 There is also a shadow transport mechanism that can be used to take copies of
36615 messages that are successfully delivered by local transports, one copy per
36616 delivery. This could be used, &'inter alia'&, to implement automatic
36617 notification of delivery by sites that insist on doing such things.
36618
36619
36620
36621 .section "Intermittently connected hosts" "SECID246"
36622 .cindex "intermittently connected hosts"
36623 It has become quite common (because it is cheaper) for hosts to connect to the
36624 Internet periodically rather than remain connected all the time. The normal
36625 arrangement is that mail for such hosts accumulates on a system that is
36626 permanently connected.
36627
36628 Exim was designed for use on permanently connected hosts, and so it is not
36629 particularly well-suited to use in an intermittently connected environment.
36630 Nevertheless there are some features that can be used.
36631
36632
36633 .section "Exim on the upstream server host" "SECID247"
36634 It is tempting to arrange for incoming mail for the intermittently connected
36635 host to remain in Exim's queue until the client connects. However, this
36636 approach does not scale very well. Two different kinds of waiting message are
36637 being mixed up in the same queue &-- those that cannot be delivered because of
36638 some temporary problem, and those that are waiting for their destination host
36639 to connect. This makes it hard to manage the queue, as well as wasting
36640 resources, because each queue runner scans the entire queue.
36641
36642 A better approach is to separate off those messages that are waiting for an
36643 intermittently connected host. This can be done by delivering these messages
36644 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36645 format, from where they are transmitted by other software when their
36646 destination connects. This makes it easy to collect all the mail for one host
36647 in a single directory, and to apply local timeout rules on a per-message basis
36648 if required.
36649
36650 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36651 you are doing this, you should configure Exim with a long retry period for the
36652 intermittent host. For example:
36653 .code
36654 cheshire.wonderland.fict.example    *   F,5d,24h
36655 .endd
36656 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36657 which messages it has queued up for that host. Once the intermittent host comes
36658 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36659 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36660 causes all the queued up messages to be delivered, often down a single SMTP
36661 connection. While the host remains connected, any new messages get delivered
36662 immediately.
36663
36664 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36665 issued with a different IP address each time it connects, Exim's retry
36666 mechanisms on the holding host get confused, because the IP address is normally
36667 used as part of the key string for holding retry information. This can be
36668 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36669 Since this has disadvantages for permanently connected hosts, it is best to
36670 arrange a separate transport for the intermittently connected ones.
36671
36672
36673
36674 .section "Exim on the intermittently connected client host" "SECID248"
36675 The value of &%smtp_accept_queue_per_connection%& should probably be
36676 increased, or even set to zero (that is, disabled) on the intermittently
36677 connected host, so that all incoming messages down a single connection get
36678 delivered immediately.
36679
36680 .cindex "SMTP" "passed connection"
36681 .cindex "SMTP" "multiple deliveries"
36682 .cindex "multiple SMTP deliveries"
36683 Mail waiting to be sent from an intermittently connected host will probably
36684 not have been routed, because without a connection DNS lookups are not
36685 possible. This means that if a normal queue run is done at connection time,
36686 each message is likely to be sent in a separate SMTP session. This can be
36687 avoided by starting the queue run with a command line option beginning with
36688 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36689 first pass, routing is done but no deliveries take place. The second pass is a
36690 normal queue run; since all the messages have been previously routed, those
36691 destined for the same host are likely to get sent as multiple deliveries in a
36692 single SMTP connection.
36693
36694
36695
36696 . ////////////////////////////////////////////////////////////////////////////
36697 . ////////////////////////////////////////////////////////////////////////////
36698
36699 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36700          "Exim as a non-queueing client"
36701 .cindex "client, non-queueing"
36702 .cindex "smart host" "suppressing queueing"
36703 On a personal computer, it is a common requirement for all
36704 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36705 configured to operate that way, for all the popular operating systems.
36706 However, there are some MUAs for Unix-like systems that cannot be so
36707 configured: they submit messages using the command line interface of
36708 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36709 messages this way.
36710
36711 If the personal computer runs continuously, there is no problem, because it can
36712 run a conventional MTA that handles delivery to the smart host, and deal with
36713 any delays via its queueing mechanism. However, if the computer does not run
36714 continuously or runs different operating systems at different times, queueing
36715 email is not desirable.
36716
36717 There is therefore a requirement for something that can provide the
36718 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36719 any queueing or retrying facilities. Furthermore, the delivery to the smart
36720 host should be synchronous, so that if it fails, the sending MUA is immediately
36721 informed. In other words, we want something that extends an MUA that submits
36722 to a local MTA via the command line so that it behaves like one that submits
36723 to a remote smart host using TCP/SMTP.
36724
36725 There are a number of applications (for example, there is one called &'ssmtp'&)
36726 that do this job. However, people have found them to be lacking in various
36727 ways. For instance, you might want to allow aliasing and forwarding to be done
36728 before sending a message to the smart host.
36729
36730 Exim already had the necessary infrastructure for doing this job. Just a few
36731 tweaks were needed to make it behave as required, though it is somewhat of an
36732 overkill to use a fully-featured MTA for this purpose.
36733
36734 .oindex "&%mua_wrapper%&"
36735 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36736 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36737 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36738 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36739 compatible router and transport configuration. Typically there will be just one
36740 router and one transport, sending everything to a smart host.
36741
36742 When run in MUA wrapping mode, the behaviour of Exim changes in the
36743 following ways:
36744
36745 .ilist
36746 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36747 In other words, the only way to submit messages is via the command line.
36748 .next
36749 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36750 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36751 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36752 does not finish until the delivery attempt is complete. If the delivery is
36753 successful, a zero return code is given.
36754 .next
36755 Address redirection is permitted, but the final routing for all addresses must
36756 be to the same remote transport, and to the same list of hosts. Furthermore,
36757 the return address (envelope sender) must be the same for all recipients, as
36758 must any added or deleted header lines. In other words, it must be possible to
36759 deliver the message in a single SMTP transaction, however many recipients there
36760 are.
36761 .next
36762 If these conditions are not met, or if routing any address results in a
36763 failure or defer status, or if Exim is unable to deliver all the recipients
36764 successfully to one of the smart hosts, delivery of the entire message fails.
36765 .next
36766 Because no queueing is allowed, all failures are treated as permanent; there
36767 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36768 smart host. Furthermore, because only a single yes/no response can be given to
36769 the caller, it is not possible to deliver to some recipients and not others. If
36770 there is an error (temporary or permanent) for any recipient, all are failed.
36771 .next
36772 If more than one smart host is listed, Exim will try another host after a
36773 connection failure or a timeout, in the normal way. However, if this kind of
36774 failure happens for all the hosts, the delivery fails.
36775 .next
36776 When delivery fails, an error message is written to the standard error stream
36777 (as well as to Exim's log), and Exim exits to the caller with a return code
36778 value 1. The message is expunged from Exim's spool files. No bounce messages
36779 are ever generated.
36780 .next
36781 No retry data is maintained, and any retry rules are ignored.
36782 .next
36783 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36784 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36785 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36786 .endlist
36787
36788 The overall effect is that Exim makes a single synchronous attempt to deliver
36789 the message, failing if there is any kind of problem. Because no local
36790 deliveries are done and no daemon can be run, Exim does not need root
36791 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36792 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36793 the advantages and disadvantages of running without root privilege.
36794
36795
36796
36797
36798 . ////////////////////////////////////////////////////////////////////////////
36799 . ////////////////////////////////////////////////////////////////////////////
36800
36801 .chapter "Log files" "CHAPlog"
36802 .scindex IIDloggen "log" "general description"
36803 .cindex "log" "types of"
36804 Exim writes three different logs, referred to as the main log, the reject log,
36805 and the panic log:
36806
36807 .ilist
36808 .cindex "main log"
36809 The main log records the arrival of each message and each delivery in a single
36810 line in each case. The format is as compact as possible, in an attempt to keep
36811 down the size of log files. Two-character flag sequences make it easy to pick
36812 out these lines. A number of other events are recorded in the main log. Some of
36813 them are optional, in which case the &%log_selector%& option controls whether
36814 they are included or not. A Perl script called &'eximstats'&, which does simple
36815 analysis of main log files, is provided in the Exim distribution (see section
36816 &<<SECTmailstat>>&).
36817 .next
36818 .cindex "reject log"
36819 The reject log records information from messages that are rejected as a result
36820 of a configuration option (that is, for policy reasons).
36821 The first line of each rejection is a copy of the line that is also written to
36822 the main log. Then, if the message's header has been read at the time the log
36823 is written, its contents are written to this log. Only the original header
36824 lines are available; header lines added by ACLs are not logged. You can use the
36825 reject log to check that your policy controls are working correctly; on a busy
36826 host this may be easier than scanning the main log for rejection messages. You
36827 can suppress the writing of the reject log by setting &%write_rejectlog%&
36828 false.
36829 .next
36830 .cindex "panic log"
36831 .cindex "system log"
36832 When certain serious errors occur, Exim writes entries to its panic log. If the
36833 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36834 are usually written to the main log as well, but can get lost amid the mass of
36835 other entries. The panic log should be empty under normal circumstances. It is
36836 therefore a good idea to check it (or to have a &'cron'& script check it)
36837 regularly, in order to become aware of any problems. When Exim cannot open its
36838 panic log, it tries as a last resort to write to the system log (syslog). This
36839 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36840 message itself is written at priority LOG_CRIT.
36841 .endlist
36842
36843 Every log line starts with a timestamp, in the format shown in the following
36844 example. Note that many of the examples shown in this chapter are line-wrapped.
36845 In the log file, this would be all on one line:
36846 .code
36847 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36848   by QUIT
36849 .endd
36850 By default, the timestamps are in the local timezone. There are two
36851 ways of changing this:
36852
36853 .ilist
36854 You can set the &%timezone%& option to a different time zone; in particular, if
36855 you set
36856 .code
36857 timezone = UTC
36858 .endd
36859 the timestamps will be in UTC (aka GMT).
36860 .next
36861 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36862 example:
36863 .code
36864 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36865 .endd
36866 .endlist
36867
36868 .cindex "log" "process ids in"
36869 .cindex "pid (process id)" "in log lines"
36870 Exim does not include its process id in log lines by default, but you can
36871 request that it does so by specifying the &`pid`& log selector (see section
36872 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36873 brackets, immediately after the time and date.
36874
36875
36876
36877
36878 .section "Where the logs are written" "SECTwhelogwri"
36879 .cindex "log" "destination"
36880 .cindex "log" "to file"
36881 .cindex "log" "to syslog"
36882 .cindex "syslog"
36883 The logs may be written to local files, or to syslog, or both. However, it
36884 should be noted that many syslog implementations use UDP as a transport, and
36885 are therefore unreliable in the sense that messages are not guaranteed to
36886 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36887 It has also been reported that on large log files (tens of megabytes) you may
36888 need to tweak syslog to prevent it syncing the file with each write &-- on
36889 Linux this has been seen to make syslog take 90% plus of CPU time.
36890
36891 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36892 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36893 configuration. This latter string is expanded, so it can contain, for example,
36894 references to the host name:
36895 .code
36896 log_file_path = /var/log/$primary_hostname/exim_%slog
36897 .endd
36898 It is generally advisable, however, to set the string in &_Local/Makefile_&
36899 rather than at runtime, because then the setting is available right from the
36900 start of Exim's execution. Otherwise, if there's something it wants to log
36901 before it has read the configuration file (for example, an error in the
36902 configuration file) it will not use the path you want, and may not be able to
36903 log at all.
36904
36905 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36906 list, currently limited to at most two items. This is one option where the
36907 facility for changing a list separator may not be used. The list must always be
36908 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36909 otherwise the item must either be an absolute path, containing &`%s`& at the
36910 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36911 implying the use of a default path.
36912
36913 When Exim encounters an empty item in the list, it searches the list defined by
36914 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36915 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36916 mean &"use the path specified at build time"&. It no such item exists, log
36917 files are written in the &_log_& subdirectory of the spool directory. This is
36918 equivalent to the setting:
36919 .code
36920 log_file_path = $spool_directory/log/%slog
36921 .endd
36922 If you do not specify anything at build time or runtime,
36923 or if you unset the option at runtime (i.e. &`log_file_path = `&),
36924 that is where the logs are written.
36925
36926 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
36927 are in use &-- see section &<<SECTdatlogfil>>& below.
36928
36929 Here are some examples of possible settings:
36930 .display
36931 &`LOG_FILE_PATH=syslog                    `& syslog only
36932 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36933 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36934 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36935 .endd
36936 If there are more than two paths in the list, the first is used and a panic
36937 error is logged.
36938
36939
36940
36941 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36942 .cindex "log" "cycling local files"
36943 .cindex "cycling logs"
36944 .cindex "&'exicyclog'&"
36945 .cindex "log" "local files; writing to"
36946 Some operating systems provide centralized and standardized methods for cycling
36947 log files. For those that do not, a utility script called &'exicyclog'& is
36948 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36949 main and reject logs each time it is called. The maximum number of old logs to
36950 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36951
36952 An Exim delivery process opens the main log when it first needs to write to it,
36953 and it keeps the file open in case subsequent entries are required &-- for
36954 example, if a number of different deliveries are being done for the same
36955 message. However, remote SMTP deliveries can take a long time, and this means
36956 that the file may be kept open long after it is renamed if &'exicyclog'& or
36957 something similar is being used to rename log files on a regular basis. To
36958 ensure that a switch of log files is noticed as soon as possible, Exim calls
36959 &[stat()]& on the main log's name before reusing an open file, and if the file
36960 does not exist, or its inode has changed, the old file is closed and Exim
36961 tries to open the main log from scratch. Thus, an old log file may remain open
36962 for quite some time, but no Exim processes should write to it once it has been
36963 renamed.
36964
36965
36966
36967 .section "Datestamped log files" "SECTdatlogfil"
36968 .cindex "log" "datestamped files"
36969 Instead of cycling the main and reject log files by renaming them
36970 periodically, some sites like to use files whose names contain a datestamp,
36971 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36972 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36973 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36974 point where the datestamp is required. For example:
36975 .code
36976 log_file_path = /var/spool/exim/log/%slog-%D
36977 log_file_path = /var/log/exim-%s-%D.log
36978 log_file_path = /var/spool/exim/log/%D-%slog
36979 log_file_path = /var/log/exim/%s.%M
36980 .endd
36981 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36982 examples of names generated by the above examples:
36983 .code
36984 /var/spool/exim/log/mainlog-20021225
36985 /var/log/exim-reject-20021225.log
36986 /var/spool/exim/log/20021225-mainlog
36987 /var/log/exim/main.200212
36988 .endd
36989 When this form of log file is specified, Exim automatically switches to new
36990 files at midnight. It does not make any attempt to compress old logs; you
36991 will need to write your own script if you require this. You should not
36992 run &'exicyclog'& with this form of logging.
36993
36994 The location of the panic log is also determined by &%log_file_path%&, but it
36995 is not datestamped, because rotation of the panic log does not make sense.
36996 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36997 the string. In addition, if it immediately follows a slash, a following
36998 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36999 character is removed. Thus, the four examples above would give these panic
37000 log names:
37001 .code
37002 /var/spool/exim/log/paniclog
37003 /var/log/exim-panic.log
37004 /var/spool/exim/log/paniclog
37005 /var/log/exim/panic
37006 .endd
37007
37008
37009 .section "Logging to syslog" "SECID249"
37010 .cindex "log" "syslog; writing to"
37011 The use of syslog does not change what Exim logs or the format of its messages,
37012 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37013 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37014 that, the same strings are written to syslog as to log files. The syslog
37015 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37016 by default, but you can change these by setting the &%syslog_facility%& and
37017 &%syslog_processname%& options, respectively. If Exim was compiled with
37018 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37019 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37020 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37021 the time and host name to each line.
37022 The three log streams are mapped onto syslog priorities as follows:
37023
37024 .ilist
37025 &'mainlog'& is mapped to LOG_INFO
37026 .next
37027 &'rejectlog'& is mapped to LOG_NOTICE
37028 .next
37029 &'paniclog'& is mapped to LOG_ALERT
37030 .endlist
37031
37032 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37033 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37034 these are routed by syslog to the same place. You can suppress this duplication
37035 by setting &%syslog_duplication%& false.
37036
37037 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37038 entries contain multiple lines when headers are included. To cope with both
37039 these cases, entries written to syslog are split into separate &[syslog()]&
37040 calls at each internal newline, and also after a maximum of
37041 870 data characters. (This allows for a total syslog line length of 1024, when
37042 additions such as timestamps are added.) If you are running a syslog
37043 replacement that can handle lines longer than the 1024 characters allowed by
37044 RFC 3164, you should set
37045 .code
37046 SYSLOG_LONG_LINES=yes
37047 .endd
37048 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37049 lines, but it still splits at internal newlines in &'reject'& log entries.
37050
37051 To make it easy to re-assemble split lines later, each component of a split
37052 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37053 where <&'n'&> is the component number and <&'m'&> is the total number of
37054 components in the entry. The / delimiter is used when the line was split
37055 because it was too long; if it was split because of an internal newline, the \
37056 delimiter is used. For example, supposing the length limit to be 50 instead of
37057 870, the following would be the result of a typical rejection message to
37058 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37059 name, and pid as added by syslog:
37060 .code
37061 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37062 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37063 [3/5]  when scanning for sender: missing or malformed lo
37064 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37065 [5/5] mple>)
37066 .endd
37067 The same error might cause the following lines to be written to &"rejectlog"&
37068 (LOG_NOTICE):
37069 .code
37070 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37071 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37072 [3/18] er when scanning for sender: missing or malformed
37073 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37074 [5\18] .example>)
37075 [6\18] Recipients: ph10@some.domain.cam.example
37076 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37077 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37078 [9\18]        id 16RdAL-0006pc-00
37079 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37080 [11\18] 09:43 +0100
37081 [12\18] F From: <>
37082 [13\18]   Subject: this is a test header
37083 [18\18]   X-something: this is another header
37084 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37085 [16\18] le>
37086 [17\18] B Bcc:
37087 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37088 .endd
37089 Log lines that are neither too long nor contain newlines are written to syslog
37090 without modification.
37091
37092 If only syslog is being used, the Exim monitor is unable to provide a log tail
37093 display, unless syslog is routing &'mainlog'& to a file on the local host and
37094 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37095 where it is.
37096
37097
37098
37099 .section "Log line flags" "SECID250"
37100 One line is written to the main log for each message received, and for each
37101 successful, unsuccessful, and delayed delivery. These lines can readily be
37102 picked out by the distinctive two-character flags that immediately follow the
37103 timestamp. The flags are:
37104 .display
37105 &`<=`&     message arrival
37106 &`(=`&     message fakereject
37107 &`=>`&     normal message delivery
37108 &`->`&     additional address in same delivery
37109 &`>>`&     cutthrough message delivery
37110 &`*>`&     delivery suppressed by &%-N%&
37111 &`**`&     delivery failed; address bounced
37112 &`==`&     delivery deferred; temporary problem
37113 .endd
37114
37115
37116 .section "Logging message reception" "SECID251"
37117 .cindex "log" "reception line"
37118 The format of the single-line entry in the main log that is written for every
37119 message received is shown in the basic example below, which is split over
37120 several lines in order to fit it on the page:
37121 .code
37122 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37123   H=mailer.fict.example [192.168.123.123] U=exim
37124   P=smtp S=5678 id=<incoming message id>
37125 .endd
37126 The address immediately following &"<="& is the envelope sender address. A
37127 bounce message is shown with the sender address &"<>"&, and if it is locally
37128 generated, this is followed by an item of the form
37129 .code
37130 R=<message id>
37131 .endd
37132 which is a reference to the message that caused the bounce to be sent.
37133
37134 .cindex "HELO"
37135 .cindex "EHLO"
37136 For messages from other hosts, the H and U fields identify the remote host and
37137 record the RFC 1413 identity of the user that sent the message, if one was
37138 received. The number given in square brackets is the IP address of the sending
37139 host. If there is a single, unparenthesized  host name in the H field, as
37140 above, it has been verified to correspond to the IP address (see the
37141 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37142 by the remote host in the SMTP HELO or EHLO command, and has not been
37143 verified. If verification yields a different name to that given for HELO or
37144 EHLO, the verified name appears first, followed by the HELO or EHLO
37145 name in parentheses.
37146
37147 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37148 without brackets, in the HELO or EHLO command, leading to entries in
37149 the log containing text like these examples:
37150 .code
37151 H=(10.21.32.43) [192.168.8.34]
37152 H=([10.21.32.43]) [192.168.8.34]
37153 .endd
37154 This can be confusing. Only the final address in square brackets can be relied
37155 on.
37156
37157 For locally generated messages (that is, messages not received over TCP/IP),
37158 the H field is omitted, and the U field contains the login name of the caller
37159 of Exim.
37160
37161 .cindex "authentication" "logging"
37162 .cindex "AUTH" "logging"
37163 For all messages, the P field specifies the protocol used to receive the
37164 message. This is the value that is stored in &$received_protocol$&. In the case
37165 of incoming SMTP messages, the value indicates whether or not any SMTP
37166 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37167 session was encrypted, there is an additional X field that records the cipher
37168 suite that was used.
37169
37170 .cindex log protocol
37171 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37172 hosts that have authenticated themselves using the SMTP AUTH command. The first
37173 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37174 there is an additional item A= followed by the name of the authenticator that
37175 was used. If an authenticated identification was set up by the authenticator's
37176 &%server_set_id%& option, this is logged too, separated by a colon from the
37177 authenticator name.
37178
37179 .cindex "size" "of message"
37180 The id field records the existing message id, if present. The size of the
37181 received message is given by the S field. When the message is delivered,
37182 headers may be removed or added, so that the size of delivered copies of the
37183 message may not correspond with this value (and indeed may be different to each
37184 other).
37185
37186 The &%log_selector%& option can be used to request the logging of additional
37187 data when a message is received. See section &<<SECTlogselector>>& below.
37188
37189
37190
37191 .section "Logging deliveries" "SECID252"
37192 .cindex "log" "delivery line"
37193 The format of the single-line entry in the main log that is written for every
37194 delivery is shown in one of the examples below, for local and remote
37195 deliveries, respectively. Each example has been split into multiple lines in order
37196 to fit it on the page:
37197 .code
37198 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37199   <marv@hitch.fict.example> R=localuser T=local_delivery
37200 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37201   monk@holistic.fict.example R=dnslookup T=remote_smtp
37202   H=holistic.fict.example [192.168.234.234]
37203 .endd
37204 For ordinary local deliveries, the original address is given in angle brackets
37205 after the final delivery address, which might be a pipe or a file. If
37206 intermediate address(es) exist between the original and the final address, the
37207 last of these is given in parentheses after the final address. The R and T
37208 fields record the router and transport that were used to process the address.
37209
37210 If SMTP AUTH was used for the delivery there is an additional item A=
37211 followed by the name of the authenticator that was used.
37212 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37213 option, this is logged too, separated by a colon from the authenticator name.
37214
37215 If a shadow transport was run after a successful local delivery, the log line
37216 for the successful delivery has an item added on the end, of the form
37217 .display
37218 &`ST=<`&&'shadow transport name'&&`>`&
37219 .endd
37220 If the shadow transport did not succeed, the error message is put in
37221 parentheses afterwards.
37222
37223 .cindex "asterisk" "after IP address"
37224 When more than one address is included in a single delivery (for example, two
37225 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37226 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37227 down a single SMTP connection, an asterisk follows the IP address in the log
37228 lines for the second and subsequent messages.
37229 When two or more messages are delivered down a single TLS connection, the
37230 DNS and some TLS-related information logged for the first message delivered
37231 will not be present in the log lines for the second and subsequent messages.
37232 TLS cipher information is still available.
37233
37234 .cindex "delivery" "cutthrough; logging"
37235 .cindex "cutthrough" "logging"
37236 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37237 line precedes the reception line, since cutthrough waits for a possible
37238 rejection from the destination in case it can reject the sourced item.
37239
37240 The generation of a reply message by a filter file gets logged as a
37241 &"delivery"& to the addressee, preceded by &">"&.
37242
37243 The &%log_selector%& option can be used to request the logging of additional
37244 data when a message is delivered. See section &<<SECTlogselector>>& below.
37245
37246
37247 .section "Discarded deliveries" "SECID253"
37248 .cindex "discarded messages"
37249 .cindex "message" "discarded"
37250 .cindex "delivery" "discarded; logging"
37251 When a message is discarded as a result of the command &"seen finish"& being
37252 obeyed in a filter file which generates no deliveries, a log entry of the form
37253 .code
37254 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37255   <low.club@bridge.example> R=userforward
37256 .endd
37257 is written, to record why no deliveries are logged. When a message is discarded
37258 because it is aliased to &":blackhole:"& the log line is like this:
37259 .code
37260 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37261   <hole@nowhere.example> R=blackhole_router
37262 .endd
37263
37264
37265 .section "Deferred deliveries" "SECID254"
37266 When a delivery is deferred, a line of the following form is logged:
37267 .code
37268 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37269   R=dnslookup T=smtp defer (146): Connection refused
37270 .endd
37271 In the case of remote deliveries, the error is the one that was given for the
37272 last IP address that was tried. Details of individual SMTP failures are also
37273 written to the log, so the above line would be preceded by something like
37274 .code
37275 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37276   mail1.endrest.example [192.168.239.239]: Connection refused
37277 .endd
37278 When a deferred address is skipped because its retry time has not been reached,
37279 a message is written to the log, but this can be suppressed by setting an
37280 appropriate value in &%log_selector%&.
37281
37282
37283
37284 .section "Delivery failures" "SECID255"
37285 .cindex "delivery" "failure; logging"
37286 If a delivery fails because an address cannot be routed, a line of the
37287 following form is logged:
37288 .code
37289 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37290   <jim@trek99.example>: unknown mail domain
37291 .endd
37292 If a delivery fails at transport time, the router and transport are shown, and
37293 the response from the remote host is included, as in this example:
37294 .code
37295 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37296   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37297   after pipelined RCPT TO:<ace400@pb.example>: host
37298   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37299   <ace400@pb.example>...Addressee unknown
37300 .endd
37301 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37302 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37303 disabling PIPELINING. The log lines for all forms of delivery failure are
37304 flagged with &`**`&.
37305
37306
37307
37308 .section "Fake deliveries" "SECID256"
37309 .cindex "delivery" "fake; logging"
37310 If a delivery does not actually take place because the &%-N%& option has been
37311 used to suppress it, a normal delivery line is written to the log, except that
37312 &"=>"& is replaced by &"*>"&.
37313
37314
37315
37316 .section "Completion" "SECID257"
37317 A line of the form
37318 .code
37319 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37320 .endd
37321 is written to the main log when a message is about to be removed from the spool
37322 at the end of its processing.
37323
37324
37325
37326
37327 .section "Summary of Fields in Log Lines" "SECID258"
37328 .cindex "log" "summary of fields"
37329 A summary of the field identifiers that are used in log lines is shown in
37330 the following table:
37331 .display
37332 &`A   `&        authenticator name (and optional id and sender)
37333 &`C   `&        SMTP confirmation on delivery
37334 &`    `&        command list for &"no mail in SMTP session"&
37335 &`CV  `&        certificate verification status
37336 &`D   `&        duration of &"no mail in SMTP session"&
37337 &`DKIM`&        domain verified in incoming message
37338 &`DN  `&        distinguished name from peer certificate
37339 &`DS  `&        DNSSEC secured lookups
37340 &`DT  `&        on &`=>`& lines: time taken for a delivery
37341 &`F   `&        sender address (on delivery lines)
37342 &`H   `&        host name and IP address
37343 &`I   `&        local interface used
37344 &`id  `&        message id (from header) for incoming message
37345 &`K   `&        CHUNKING extension used
37346 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37347 &`M8S `&        8BITMIME status for incoming message
37348 &`P   `&        on &`<=`& lines: protocol used
37349 &`    `&        on &`=>`& and &`**`& lines: return path
37350 &`PRDR`&        PRDR extension used
37351 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37352 &`Q   `&        alternate queue name
37353 &`QT  `&        on &`=>`& lines: time spent on queue so far
37354 &`    `&        on &"Completed"& lines: time spent on queue
37355 &`R   `&        on &`<=`& lines: reference for local bounce
37356 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37357 &`RT  `&        on &`<=`& lines: time taken for reception
37358 &`S   `&        size of message in bytes
37359 &`SNI `&        server name indication from TLS client hello
37360 &`ST  `&        shadow transport name
37361 &`T   `&        on &`<=`& lines: message subject (topic)
37362 &`TFO `&        connection took advantage of TCP Fast Open
37363 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37364 &`U   `&        local user or RFC 1413 identity
37365 &`X   `&        TLS cipher suite
37366 .endd
37367
37368
37369 .section "Other log entries" "SECID259"
37370 Various other types of log entry are written from time to time. Most should be
37371 self-explanatory. Among the more common are:
37372
37373 .ilist
37374 .cindex "retry" "time not reached"
37375 &'retry time not reached'&&~&~An address previously suffered a temporary error
37376 during routing or local delivery, and the time to retry has not yet arrived.
37377 This message is not written to an individual message log file unless it happens
37378 during the first delivery attempt.
37379 .next
37380 &'retry time not reached for any host'&&~&~An address previously suffered
37381 temporary errors during remote delivery, and the retry time has not yet arrived
37382 for any of the hosts to which it is routed.
37383 .next
37384 .cindex "spool directory" "file locked"
37385 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37386 some other Exim process is already working on the message. This can be quite
37387 common if queue running processes are started at frequent intervals. The
37388 &'exiwhat'& utility script can be used to find out what Exim processes are
37389 doing.
37390 .next
37391 .cindex "error" "ignored"
37392 &'error ignored'&&~&~There are several circumstances that give rise to this
37393 message:
37394 .olist
37395 Exim failed to deliver a bounce message whose age was greater than
37396 &%ignore_bounce_errors_after%&. The bounce was discarded.
37397 .next
37398 A filter file set up a delivery using the &"noerror"& option, and the delivery
37399 failed. The delivery was discarded.
37400 .next
37401 A delivery set up by a router configured with
37402 . ==== As this is a nested list, any displays it contains must be indented
37403 . ==== as otherwise they are too far to the left.
37404 .code
37405     errors_to = <>
37406 .endd
37407 failed. The delivery was discarded.
37408 .endlist olist
37409 .next
37410 .cindex DKIM "log line"
37411 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37412 logging and the message has a DKIM signature header.
37413 .endlist ilist
37414
37415
37416
37417
37418
37419 .section "Reducing or increasing what is logged" "SECTlogselector"
37420 .cindex "log" "selectors"
37421 By setting the &%log_selector%& global option, you can disable some of Exim's
37422 default logging, or you can request additional logging. The value of
37423 &%log_selector%& is made up of names preceded by plus or minus characters. For
37424 example:
37425 .code
37426 log_selector = +arguments -retry_defer
37427 .endd
37428 The list of optional log items is in the following table, with the default
37429 selection marked by asterisks:
37430 .display
37431 &` 8bitmime                   `&  received 8BITMIME status
37432 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37433 &` address_rewrite            `&  address rewriting
37434 &` all_parents                `&  all parents in => lines
37435 &` arguments                  `&  command line arguments
37436 &`*connection_reject          `&  connection rejections
37437 &`*delay_delivery             `&  immediate delivery delayed
37438 &` deliver_time               `&  time taken to perform delivery
37439 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37440 &`*dkim                       `&  DKIM verified domain on <= lines
37441 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37442 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37443 &` dnssec                     `&  DNSSEC secured lookups
37444 &`*etrn                       `&  ETRN commands
37445 &`*host_lookup_failed         `&  as it says
37446 &` ident_timeout              `&  timeout for ident connection
37447 &` incoming_interface         `&  local interface on <= and => lines
37448 &` incoming_port              `&  remote port on <= lines
37449 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37450 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37451 &`*msg_id                     `&  on <= lines, Message-ID: header value
37452 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37453 &` outgoing_interface         `&  local interface on => lines
37454 &` outgoing_port              `&  add remote port to => lines
37455 &`*queue_run                  `&  start and end queue runs
37456 &` queue_time                 `&  time on queue for one recipient
37457 &` queue_time_overall         `&  time on queue for whole message
37458 &` pid                        `&  Exim process id
37459 &` pipelining                 `&  PIPELINING use, on <= and => lines
37460 &` proxy                      `&  proxy address on <= and => lines
37461 &` receive_time               `&  time taken to receive message
37462 &` received_recipients        `&  recipients on <= lines
37463 &` received_sender            `&  sender on <= lines
37464 &`*rejected_header            `&  header contents on reject log
37465 &`*retry_defer                `&  &"retry time not reached"&
37466 &` return_path_on_delivery    `&  put return path on => and ** lines
37467 &` sender_on_delivery         `&  add sender to => lines
37468 &`*sender_verify_fail         `&  sender verification failures
37469 &`*size_reject                `&  rejection because too big
37470 &`*skip_delivery              `&  delivery skipped in a queue run
37471 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37472 &` smtp_connection            `&  incoming SMTP connections
37473 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37474 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37475 &` smtp_no_mail               `&  session with no MAIL commands
37476 &` smtp_protocol_error        `&  SMTP protocol errors
37477 &` smtp_syntax_error          `&  SMTP syntax errors
37478 &` subject                    `&  contents of &'Subject:'& on <= lines
37479 &`*tls_certificate_verified   `&  certificate verification status
37480 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37481 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37482 &` tls_sni                    `&  TLS SNI on <= lines
37483 &` unknown_in_list            `&  DNS lookup failed in list match
37484
37485 &` all                        `&  all of the above
37486 .endd
37487 See also the &%slow_lookup_log%& main configuration option,
37488 section &<<SECID99>>&
37489
37490 More details on each of these items follows:
37491
37492 .ilist
37493 .cindex "8BITMIME"
37494 .cindex "log" "8BITMIME"
37495 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37496 which may help in tracking down interoperability issues with ancient MTAs
37497 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37498 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37499 &`7BIT`& and &`8BITMIME`& respectively.
37500 .next
37501 .cindex "&%warn%& ACL verb" "log when skipping"
37502 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37503 its conditions cannot be evaluated, a log line to this effect is written if
37504 this log selector is set.
37505 .next
37506 .cindex "log" "rewriting"
37507 .cindex "rewriting" "logging"
37508 &%address_rewrite%&: This applies both to global rewrites and per-transport
37509 rewrites, but not to rewrites in filters run as an unprivileged user (because
37510 such users cannot access the log).
37511 .next
37512 .cindex "log" "full parentage"
37513 &%all_parents%&: Normally only the original and final addresses are logged on
37514 delivery lines; with this selector, intermediate parents are given in
37515 parentheses between them.
37516 .next
37517 .cindex "log" "Exim arguments"
37518 .cindex "Exim arguments, logging"
37519 &%arguments%&: This causes Exim to write the arguments with which it was called
37520 to the main log, preceded by the current working directory. This is a debugging
37521 feature, added to make it easier to find out how certain MUAs call
37522 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37523 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37524 that are empty or that contain white space are quoted. Non-printing characters
37525 are shown as escape sequences. This facility cannot log unrecognized arguments,
37526 because the arguments are checked before the configuration file is read. The
37527 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37528 between the caller and Exim.
37529 .next
37530 .cindex "log" "connection rejections"
37531 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37532 connection is rejected, for whatever reason.
37533 .next
37534 .cindex "log" "delayed delivery"
37535 .cindex "delayed delivery, logging"
37536 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37537 started for an incoming message because the load is too high or too many
37538 messages were received on one connection. Logging does not occur if no delivery
37539 process is started because &%queue_only%& is set or &%-odq%& was used.
37540 .next
37541 .cindex "log" "delivery duration"
37542 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37543 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37544 If millisecond logging is enabled, short times will be shown with greater
37545 precision, eg. &`DT=0.304s`&.
37546 .next
37547 .cindex "log" "message size on delivery"
37548 .cindex "size" "of message"
37549 &%delivery_size%&: For each delivery, the size of message delivered is added to
37550 the &"=>"& line, tagged with S=.
37551 .next
37552 .cindex log "DKIM verification"
37553 .cindex DKIM "verification logging"
37554 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37555 verifies successfully a tag of DKIM is added, with one of the verified domains.
37556 .next
37557 .cindex log "DKIM verification"
37558 .cindex DKIM "verification logging"
37559 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37560 .next
37561 .cindex "log" "dnslist defer"
37562 .cindex "DNS list" "logging defer"
37563 .cindex "black list (DNS)"
37564 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37565 DNS black list suffers a temporary error.
37566 .next
37567 .cindex log dnssec
37568 .cindex dnssec logging
37569 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37570 dns lookups gave secure results a tag of DS is added.
37571 For acceptance this covers the reverse and forward lookups for host name verification.
37572 It does not cover helo-name verification.
37573 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37574 .next
37575 .cindex "log" "ETRN commands"
37576 .cindex "ETRN" "logging"
37577 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37578 is run to determine whether or not it is actually accepted. An invalid ETRN
37579 command, or one received within a message transaction is not logged by this
37580 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37581 .next
37582 .cindex "log" "host lookup failure"
37583 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37584 any addresses, or when a lookup of an IP address fails to find a host name, a
37585 log line is written. This logging does not apply to direct DNS lookups when
37586 routing email addresses, but it does apply to &"byname"& lookups.
37587 .next
37588 .cindex "log" "ident timeout"
37589 .cindex "RFC 1413" "logging timeout"
37590 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37591 client's ident port times out.
37592 .next
37593 .cindex "log" "incoming interface"
37594 .cindex "log" "local interface"
37595 .cindex "log" "local address and port"
37596 .cindex "TCP/IP" "logging local address and port"
37597 .cindex "interface" "logging"
37598 &%incoming_interface%&: The interface on which a message was received is added
37599 to the &"<="& line as an IP address in square brackets, tagged by I= and
37600 followed by a colon and the port number. The local interface and port are also
37601 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37602 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37603 The latter can be disabled by turning off the &%outgoing_interface%& option.
37604 .next
37605 .cindex log "incoming proxy address"
37606 .cindex proxy "logging proxy address"
37607 .cindex "TCP/IP" "logging proxy address"
37608 &%proxy%&: The internal (closest to the system running Exim) IP address
37609 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37610 on a proxied connection
37611 or the &"=>"& line for a message delivered on a proxied connection.
37612 See &<<SECTproxyInbound>>& for more information.
37613 .next
37614 .cindex "log" "incoming remote port"
37615 .cindex "port" "logging remote"
37616 .cindex "TCP/IP" "logging incoming remote port"
37617 .vindex "&$sender_fullhost$&"
37618 .vindex "&$sender_rcvhost$&"
37619 &%incoming_port%&: The remote port number from which a message was received is
37620 added to log entries and &'Received:'& header lines, following the IP address
37621 in square brackets, and separated from it by a colon. This is implemented by
37622 changing the value that is put in the &$sender_fullhost$& and
37623 &$sender_rcvhost$& variables. Recording the remote port number has become more
37624 important with the widening use of NAT (see RFC 2505).
37625 .next
37626 .cindex "log" "dropped connection"
37627 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37628 connection is unexpectedly dropped.
37629 .next
37630 .cindex "log" "millisecond timestamps"
37631 .cindex millisecond logging
37632 .cindex timestamps "millisecond, in logs"
37633 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37634 appended to the seconds value.
37635 .next
37636 .cindex "log" "message id"
37637 &%msg_id%&: The value of the Message-ID: header.
37638 .next
37639 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37640 This will be either because the message is a bounce, or was submitted locally
37641 (submission mode) without one.
37642 The field identifier will have an asterix appended: &"id*="&.
37643 .next
37644 .cindex "log" "outgoing interface"
37645 .cindex "log" "local interface"
37646 .cindex "log" "local address and port"
37647 .cindex "TCP/IP" "logging local address and port"
37648 .cindex "interface" "logging"
37649 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37650 interface on which a message was sent is added to delivery lines as an I= tag
37651 followed by IP address in square brackets. You can disable this by turning
37652 off the &%outgoing_interface%& option.
37653 .next
37654 .cindex "log" "outgoing remote port"
37655 .cindex "port" "logging outgoing remote"
37656 .cindex "TCP/IP" "logging outgoing remote port"
37657 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37658 containing => tags) following the IP address.
37659 The local port is also added if &%incoming_interface%& and
37660 &%outgoing_interface%& are both enabled.
37661 This option is not included in the default setting, because for most ordinary
37662 configurations, the remote port number is always 25 (the SMTP port), and the
37663 local port is a random ephemeral port.
37664 .next
37665 .cindex "log" "process ids in"
37666 .cindex "pid (process id)" "in log lines"
37667 &%pid%&: The current process id is added to every log line, in square brackets,
37668 immediately after the time and date.
37669 .next
37670 .cindex log pipelining
37671 .cindex pipelining "logging outgoing"
37672 &%pipelining%&: A field is added to delivery and accept
37673 log lines when the ESMTP PIPELINING extension was used.
37674 The field is a single "L".
37675
37676 On accept lines, where PIPELINING was offered but not used by the client,
37677 the field has a minus appended.
37678
37679 .cindex "pipelining" "early connection"
37680 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37681 accept "L" fields have a period appended if the feature was
37682 offered but not used, or an asterisk appended if used.
37683 Delivery "L" fields have an asterisk appended if used.
37684
37685 .next
37686 .cindex "log" "queue run"
37687 .cindex "queue runner" "logging"
37688 &%queue_run%&: The start and end of every queue run are logged.
37689 .next
37690 .cindex "log" "queue time"
37691 &%queue_time%&: The amount of time the message has been in the queue on the
37692 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37693 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37694 includes reception time as well as the delivery time for the current address.
37695 This means that it may be longer than the difference between the arrival and
37696 delivery log line times, because the arrival log line is not written until the
37697 message has been successfully received.
37698 If millisecond logging is enabled, short times will be shown with greater
37699 precision, eg. &`QT=1.578s`&.
37700 .next
37701 &%queue_time_overall%&: The amount of time the message has been in the queue on
37702 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37703 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37704 message, so it includes reception time as well as the total delivery time.
37705 .next
37706 .cindex "log" "receive duration"
37707 &%receive_time%&: For each message, the amount of real time it has taken to
37708 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37709 If millisecond logging is enabled, short times will be shown with greater
37710 precision, eg. &`RT=0.204s`&.
37711 .next
37712 .cindex "log" "recipients"
37713 &%received_recipients%&: The recipients of a message are listed in the main log
37714 as soon as the message is received. The list appears at the end of the log line
37715 that is written when a message is received, preceded by the word &"for"&. The
37716 addresses are listed after they have been qualified, but before any rewriting
37717 has taken place.
37718 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37719 in the list.
37720 .next
37721 .cindex "log" "sender reception"
37722 &%received_sender%&: The unrewritten original sender of a message is added to
37723 the end of the log line that records the message's arrival, after the word
37724 &"from"& (before the recipients if &%received_recipients%& is also set).
37725 .next
37726 .cindex "log" "header lines for rejection"
37727 &%rejected_header%&: If a message's header has been received at the time a
37728 rejection is written to the reject log, the complete header is added to the
37729 log. Header logging can be turned off individually for messages that are
37730 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37731 .next
37732 .cindex "log" "retry defer"
37733 &%retry_defer%&: A log line is written if a delivery is deferred because a
37734 retry time has not yet been reached. However, this &"retry time not reached"&
37735 message is always omitted from individual message logs after the first delivery
37736 attempt.
37737 .next
37738 .cindex "log" "return path"
37739 &%return_path_on_delivery%&: The return path that is being transmitted with
37740 the message is included in delivery and bounce lines, using the tag P=.
37741 This is omitted if no delivery actually happens, for example, if routing fails,
37742 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37743 .next
37744 .cindex "log" "sender on delivery"
37745 &%sender_on_delivery%&: The message's sender address is added to every delivery
37746 and bounce line, tagged by F= (for &"from"&).
37747 This is the original sender that was received with the message; it is not
37748 necessarily the same as the outgoing return path.
37749 .next
37750 .cindex "log" "sender verify failure"
37751 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37752 gives details of a sender verification failure is not written. Log lines for
37753 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37754 detail is lost.
37755 .next
37756 .cindex "log" "size rejection"
37757 &%size_reject%&: A log line is written whenever a message is rejected because
37758 it is too big.
37759 .next
37760 .cindex "log" "frozen messages; skipped"
37761 .cindex "frozen messages" "logging skipping"
37762 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37763 queue run because it is frozen or because another process is already delivering
37764 it.
37765 .cindex "&""spool file is locked""&"
37766 The message that is written is &"spool file is locked"&.
37767 .next
37768 .cindex "log" "smtp confirmation"
37769 .cindex "SMTP" "logging confirmation"
37770 .cindex "LMTP" "logging confirmation"
37771 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37772 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37773 A number of MTAs (including Exim) return an identifying string in this
37774 response.
37775 .next
37776 .cindex "log" "SMTP connections"
37777 .cindex "SMTP" "logging connections"
37778 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37779 established or closed, unless the connection is from a host that matches
37780 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37781 only when the closure is unexpected.) This applies to connections from local
37782 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37783 dropped in the middle of a message, a log line is always written, whether or
37784 not this selector is set, but otherwise nothing is written at the start and end
37785 of connections unless this selector is enabled.
37786
37787 For TCP/IP connections to an Exim daemon, the current number of connections is
37788 included in the log message for each new connection, but note that the count is
37789 reset if the daemon is restarted.
37790 Also, because connections are closed (and the closure is logged) in
37791 subprocesses, the count may not include connections that have been closed but
37792 whose termination the daemon has not yet noticed. Thus, while it is possible to
37793 match up the opening and closing of connections in the log, the value of the
37794 logged counts may not be entirely accurate.
37795 .next
37796 .cindex "log" "SMTP transaction; incomplete"
37797 .cindex "SMTP" "logging incomplete transactions"
37798 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37799 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37800 and the message sender plus any accepted recipients are included in the log
37801 line. This can provide evidence of dictionary attacks.
37802 .next
37803 .cindex "log" "non-MAIL SMTP sessions"
37804 .cindex "MAIL" "logging session without"
37805 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37806 connection terminates without having issued a MAIL command. This includes both
37807 the case when the connection is dropped, and the case when QUIT is used. It
37808 does not include cases where the connection is rejected right at the start (by
37809 an ACL, or because there are too many connections, or whatever). These cases
37810 already have their own log lines.
37811
37812 The log line that is written contains the identity of the client in the usual
37813 way, followed by D= and a time, which records the duration of the connection.
37814 If the connection was authenticated, this fact is logged exactly as it is for
37815 an incoming message, with an A= item. If the connection was encrypted, CV=,
37816 DN=, and X= items may appear as they do for an incoming message, controlled by
37817 the same logging options.
37818
37819 Finally, if any SMTP commands were issued during the connection, a C= item
37820 is added to the line, listing the commands that were used. For example,
37821 .code
37822 C=EHLO,QUIT
37823 .endd
37824 shows that the client issued QUIT straight after EHLO. If there were fewer
37825 than 20 commands, they are all listed. If there were more than 20 commands,
37826 the last 20 are listed, preceded by &"..."&. However, with the default
37827 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37828 have been aborted before 20 non-mail commands are processed.
37829 .next
37830 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37831 colon-separated, is appended to the A= item for a message arrival or delivery
37832 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37833 was accepted or used.
37834 .next
37835 .cindex "log" "SMTP protocol error"
37836 .cindex "SMTP" "logging protocol error"
37837 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37838 encountered. Exim does not have perfect detection of all protocol errors
37839 because of transmission delays and the use of pipelining. If PIPELINING has
37840 been advertised to a client, an Exim server assumes that the client will use
37841 it, and therefore it does not count &"expected"& errors (for example, RCPT
37842 received after rejecting MAIL) as protocol errors.
37843 .next
37844 .cindex "SMTP" "logging syntax errors"
37845 .cindex "SMTP" "syntax errors; logging"
37846 .cindex "SMTP" "unknown command; logging"
37847 .cindex "log" "unknown SMTP command"
37848 .cindex "log" "SMTP syntax error"
37849 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37850 encountered. An unrecognized command is treated as a syntax error. For an
37851 external connection, the host identity is given; for an internal connection
37852 using &%-bs%& the sender identification (normally the calling user) is given.
37853 .next
37854 .cindex "log" "subject"
37855 .cindex "subject, logging"
37856 &%subject%&: The subject of the message is added to the arrival log line,
37857 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37858 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37859 specifies whether characters with values greater than 127 should be logged
37860 unchanged, or whether they should be rendered as escape sequences.
37861 .next
37862 .cindex "log" "certificate verification"
37863 .cindex log DANE
37864 .cindex DANE logging
37865 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37866 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37867 verified
37868 using a CA trust anchor,
37869 &`CA=dane`& if using a DNS trust anchor,
37870 and &`CV=no`& if not.
37871 .next
37872 .cindex "log" "TLS cipher"
37873 .cindex "TLS" "logging cipher"
37874 &%tls_cipher%&: When a message is sent or received over an encrypted
37875 connection, the cipher suite used is added to the log line, preceded by X=.
37876 .next
37877 .cindex "log" "TLS peer DN"
37878 .cindex "TLS" "logging peer DN"
37879 &%tls_peerdn%&: When a message is sent or received over an encrypted
37880 connection, and a certificate is supplied by the remote host, the peer DN is
37881 added to the log line, preceded by DN=.
37882 .next
37883 .cindex "log" "TLS SNI"
37884 .cindex "TLS" "logging SNI"
37885 &%tls_sni%&: When a message is received over an encrypted connection, and
37886 the remote host provided the Server Name Indication extension, the SNI is
37887 added to the log line, preceded by SNI=.
37888 .next
37889 .cindex "log" "DNS failure in list"
37890 &%unknown_in_list%&: This setting causes a log entry to be written when the
37891 result of a list match is failure because a DNS lookup failed.
37892 .endlist
37893
37894
37895 .section "Message log" "SECID260"
37896 .cindex "message" "log file for"
37897 .cindex "log" "message log; description of"
37898 .cindex "&_msglog_& directory"
37899 .oindex "&%preserve_message_logs%&"
37900 In addition to the general log files, Exim writes a log file for each message
37901 that it handles. The names of these per-message logs are the message ids, and
37902 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37903 message log contains copies of the log lines that apply to the message. This
37904 makes it easier to inspect the status of an individual message without having
37905 to search the main log. A message log is deleted when processing of the message
37906 is complete, unless &%preserve_message_logs%& is set, but this should be used
37907 only with great care because they can fill up your disk very quickly.
37908
37909 On a heavily loaded system, it may be desirable to disable the use of
37910 per-message logs, in order to reduce disk I/O. This can be done by setting the
37911 &%message_logs%& option false.
37912 .ecindex IIDloggen
37913
37914
37915
37916
37917 . ////////////////////////////////////////////////////////////////////////////
37918 . ////////////////////////////////////////////////////////////////////////////
37919
37920 .chapter "Exim utilities" "CHAPutils"
37921 .scindex IIDutils "utilities"
37922 A number of utility scripts and programs are supplied with Exim and are
37923 described in this chapter. There is also the Exim Monitor, which is covered in
37924 the next chapter. The utilities described here are:
37925
37926 .itable none 0 0 3  7* left  15* left  40* left
37927 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37928   "list what Exim processes are doing"
37929 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37930 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37931 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37932 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37933                                                 various criteria"
37934 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37935 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37936   "extract statistics from the log"
37937 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37938   "check address acceptance from given IP"
37939 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37940 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37941 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37942 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37943 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37944 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37945 .endtable
37946
37947 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37948 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37949 &url(https://duncanthrax.net/exilog/) for details.
37950
37951
37952
37953
37954 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37955 .cindex "&'exiwhat'&"
37956 .cindex "process, querying"
37957 .cindex "SIGUSR1"
37958 On operating systems that can restart a system call after receiving a signal
37959 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37960 a line describing what it is doing to the file &_exim-process.info_& in the
37961 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37962 processes it can find, having first emptied the file. It then waits for one
37963 second to allow the Exim processes to react before displaying the results. In
37964 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37965 send the signal to the Exim processes, so it is normally run as root.
37966
37967 &*Warning*&: This is not an efficient process. It is intended for occasional
37968 use by system administrators. It is not sensible, for example, to set up a
37969 script that sends SIGUSR1 signals to Exim processes at short intervals.
37970
37971
37972 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37973 varies in different operating systems. Not only are different options used,
37974 but the format of the output is different. For this reason, there are some
37975 system configuration options that configure exactly how &'exiwhat'& works. If
37976 it doesn't seem to be working for you, check the following compile-time
37977 options:
37978 .display
37979 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37980 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37981 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37982 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37983 .endd
37984 An example of typical output from &'exiwhat'& is
37985 .code
37986 164 daemon: -q1h, listening on port 25
37987 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37988 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37989   [10.19.42.42] (editor@ref.example)
37990 10592 handling incoming call from [192.168.243.242]
37991 10628 accepting a local non-SMTP message
37992 .endd
37993 The first number in the output line is the process number. The third line has
37994 been split here, in order to fit it on the page.
37995
37996
37997
37998 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37999 .cindex "&'exiqgrep'&"
38000 .cindex "queue" "grepping"
38001 This utility is a Perl script contributed by Matt Hubbard. It runs
38002 .code
38003 exim -bpu
38004 .endd
38005 or (in case &*-a*& switch is specified)
38006 .code
38007 exim -bp
38008 .endd
38009 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38010 contain alternate exim configuration the queue management might be using.
38011
38012 to obtain a queue listing, and then greps the output to select messages
38013 that match given criteria. The following selection options are available:
38014
38015 .vlist
38016 .vitem &*-f*&&~<&'regex'&>
38017 Match the sender address using a case-insensitive search. The field that is
38018 tested is enclosed in angle brackets, so you can test for bounce messages with
38019 .code
38020 exiqgrep -f '^<>$'
38021 .endd
38022 .vitem &*-r*&&~<&'regex'&>
38023 Match a recipient address using a case-insensitive search. The field that is
38024 tested is not enclosed in angle brackets.
38025
38026 .vitem &*-s*&&~<&'regex'&>
38027 Match against the size field.
38028
38029 .vitem &*-y*&&~<&'seconds'&>
38030 Match messages that are younger than the given time.
38031
38032 .vitem &*-o*&&~<&'seconds'&>
38033 Match messages that are older than the given time.
38034
38035 .vitem &*-z*&
38036 Match only frozen messages.
38037
38038 .vitem &*-x*&
38039 Match only non-frozen messages.
38040
38041 .vitem &*-G*&&~<&'queuename'&>
38042 Match only messages in the given queue.  Without this, the default queue is searched.
38043 .endlist
38044
38045 The following options control the format of the output:
38046
38047 .vlist
38048 .vitem &*-c*&
38049 Display only the count of matching messages.
38050
38051 .vitem &*-l*&
38052 Long format &-- display the full message information as output by Exim. This is
38053 the default.
38054
38055 .vitem &*-i*&
38056 Display message ids only.
38057
38058 .vitem &*-b*&
38059 Brief format &-- one line per message.
38060
38061 .vitem &*-R*&
38062 Display messages in reverse order.
38063
38064 .vitem &*-a*&
38065 Include delivered recipients in queue listing.
38066 .endlist
38067
38068 There is one more option, &%-h%&, which outputs a list of options.
38069
38070
38071
38072 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38073 .cindex "&'exiqsumm'&"
38074 .cindex "queue" "summary"
38075 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38076 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38077 running a command such as
38078 .code
38079 exim -bp | exiqsumm
38080 .endd
38081 The output consists of one line for each domain that has messages waiting for
38082 it, as in the following example:
38083 .code
38084 3   2322   74m   66m  msn.com.example
38085 .endd
38086 Each line lists the number of pending deliveries for a domain, their total
38087 volume, and the length of time that the oldest and the newest messages have
38088 been waiting. Note that the number of pending deliveries is greater than the
38089 number of messages when messages have more than one recipient.
38090
38091 A summary line is output at the end. By default the output is sorted on the
38092 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38093 the output to be sorted by oldest message and by count of messages,
38094 respectively. There are also three options that split the messages for each
38095 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38096 separates frozen messages, and &%-s%& separates messages according to their
38097 sender.
38098
38099 The output of &'exim -bp'& contains the original addresses in the message, so
38100 this also applies to the output from &'exiqsumm'&. No domains from addresses
38101 generated by aliasing or forwarding are included (unless the &%one_time%&
38102 option of the &(redirect)& router has been used to convert them into &"top
38103 level"& addresses).
38104
38105
38106
38107
38108 .section "Extracting specific information from the log (exigrep)" &&&
38109          "SECTextspeinf"
38110 .cindex "&'exigrep'&"
38111 .cindex "log" "extracts; grepping for"
38112 The &'exigrep'& utility is a Perl script that searches one or more main log
38113 files for entries that match a given pattern. When it finds a match, it
38114 extracts all the log entries for the relevant message, not just those that
38115 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38116 given message, or all mail for a given user, or for a given host, for example.
38117 The input files can be in Exim log format or syslog format.
38118 If a matching log line is not associated with a specific message, it is
38119 included in &'exigrep'&'s output without any additional lines. The usage is:
38120 .display
38121 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38122 .endd
38123 If no log filenames are given on the command line, the standard input is read.
38124
38125 The &%-t%& argument specifies a number of seconds. It adds an additional
38126 condition for message selection. Messages that are complete are shown only if
38127 they spent more than <&'n'&> seconds in the queue.
38128
38129 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38130 makes it case-sensitive. This may give a performance improvement when searching
38131 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38132 option; with &%-I%& they do not. In both cases it is possible to change the
38133 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38134
38135 The &%-l%& option means &"literal"&, that is, treat all characters in the
38136 pattern as standing for themselves. Otherwise the pattern must be a Perl
38137 regular expression.
38138
38139 The &%-v%& option inverts the matching condition. That is, a line is selected
38140 if it does &'not'& match the pattern.
38141
38142 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38143 that are generated as a result/response to a message that &'exigrep'& matched
38144 normally.
38145
38146 Example of &%-M%&:
38147 user_a sends a message to user_b, which generates a bounce back to user_b. If
38148 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38149 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38150 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38151 when searching for &"user_a"& will show both messages since the bounce is
38152 &"related"& to or a &"result"& of the first message that was found by the
38153 search term.
38154
38155 If the location of a &'zcat'& command is known from the definition of
38156 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38157 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38158 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38159 autodetection of some well known compression extensions.
38160
38161
38162 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38163 .cindex "&'exipick'&"
38164 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38165 lists messages from the queue according to a variety of criteria. For details
38166 of &'exipick'&'s facilities, run &'exipick'& with
38167 the &%--help%& option.
38168
38169
38170 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38171 .cindex "log" "cycling local files"
38172 .cindex "cycling logs"
38173 .cindex "&'exicyclog'&"
38174 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38175 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38176 you are using log files with datestamps in their names (see section
38177 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38178 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38179 There are two command line options for &'exicyclog'&:
38180 .ilist
38181 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38182 default that is set when Exim is built. The default default is 10.
38183 .next
38184 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38185 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38186 overriding the script's default, which is to find the setting from Exim's
38187 configuration.
38188 .endlist
38189
38190 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38191 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38192 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38193 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38194 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38195 logs are handled similarly.
38196
38197 If the limit is greater than 99, the script uses 3-digit numbers such as
38198 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38199 to one that is greater, or &'vice versa'&, you will have to fix the names of
38200 any existing log files.
38201
38202 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38203 the end are deleted. All files with numbers greater than 01 are compressed,
38204 using a compression command which is configured by the COMPRESS_COMMAND
38205 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38206 root &%crontab%& entry of the form
38207 .code
38208 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38209 .endd
38210 assuming you have used the name &"exim"& for the Exim user. You can run
38211 &'exicyclog'& as root if you wish, but there is no need.
38212
38213
38214
38215 .section "Mail statistics (eximstats)" "SECTmailstat"
38216 .cindex "statistics"
38217 .cindex "&'eximstats'&"
38218 A Perl script called &'eximstats'& is provided for extracting statistical
38219 information from log files. The output is either plain text, or HTML.
38220 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38221 . --- 404 error and everything else points to that.
38222
38223 The &'eximstats'& script has been hacked about quite a bit over time. The
38224 latest version is the result of some extensive revision by Steve Campbell. A
38225 lot of information is given by default, but there are options for suppressing
38226 various parts of it. Following any options, the arguments to the script are a
38227 list of files, which should be main log files. For example:
38228 .code
38229 eximstats -nr /var/spool/exim/log/mainlog.01
38230 .endd
38231 By default, &'eximstats'& extracts information about the number and volume of
38232 messages received from or delivered to various hosts. The information is sorted
38233 both by message count and by volume, and the top fifty hosts in each category
38234 are listed on the standard output. Similar information, based on email
38235 addresses or domains instead of hosts can be requested by means of various
38236 options. For messages delivered and received locally, similar statistics are
38237 also produced per user.
38238
38239 The output also includes total counts and statistics about delivery errors, and
38240 histograms showing the number of messages received and deliveries made in each
38241 hour of the day. A delivery with more than one address in its envelope (for
38242 example, an SMTP transaction with more than one RCPT command) is counted
38243 as a single delivery by &'eximstats'&.
38244
38245 Though normally more deliveries than receipts are reported (as messages may
38246 have multiple recipients), it is possible for &'eximstats'& to report more
38247 messages received than delivered, even though the queue is empty at the start
38248 and end of the period in question. If an incoming message contains no valid
38249 recipients, no deliveries are recorded for it. A bounce message is handled as
38250 an entirely separate message.
38251
38252 &'eximstats'& always outputs a grand total summary giving the volume and number
38253 of messages received and deliveries made, and the number of hosts involved in
38254 each case. It also outputs the number of messages that were delayed (that is,
38255 not completely delivered at the first attempt), and the number that had at
38256 least one address that failed.
38257
38258 The remainder of the output is in sections that can be independently disabled
38259 or modified by various options. It consists of a summary of deliveries by
38260 transport, histograms of messages received and delivered per time interval
38261 (default per hour), information about the time messages spent in the queue,
38262 a list of relayed messages, lists of the top fifty sending hosts, local
38263 senders, destination hosts, and destination local users by count and by volume,
38264 and a list of delivery errors that occurred.
38265
38266 The relay information lists messages that were actually relayed, that is, they
38267 came from a remote host and were directly delivered to some other remote host,
38268 without being processed (for example, for aliasing or forwarding) locally.
38269
38270 There are quite a few options for &'eximstats'& to control exactly what it
38271 outputs. These are documented in the Perl script itself, and can be extracted
38272 by running the command &(perldoc)& on the script. For example:
38273 .code
38274 perldoc /usr/exim/bin/eximstats
38275 .endd
38276
38277 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38278 .cindex "&'exim_checkaccess'&"
38279 .cindex "policy control" "checking access"
38280 .cindex "checking access"
38281 The &%-bh%& command line argument allows you to run a fake SMTP session with
38282 debugging output, in order to check what Exim is doing when it is applying
38283 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38284 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38285 sometimes you just want to answer the question &"Does this address have
38286 access?"& without bothering with any further details.
38287
38288 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38289 two arguments, an IP address and an email address:
38290 .code
38291 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38292 .endd
38293 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38294 given email address would be accepted in a RCPT command in a TCP/IP
38295 connection from the host with the given IP address. The output of the utility
38296 is either the word &"accepted"&, or the SMTP error response, for example:
38297 .code
38298 Rejected:
38299 550 Relay not permitted
38300 .endd
38301 When running this test, the utility uses &`<>`& as the envelope sender address
38302 for the MAIL command, but you can change this by providing additional
38303 options. These are passed directly to the Exim command. For example, to specify
38304 that the test is to be run with the sender address &'himself@there.example'&
38305 you can use:
38306 .code
38307 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38308                  -f himself@there.example
38309 .endd
38310 Note that these additional Exim command line items must be given after the two
38311 mandatory arguments.
38312
38313 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38314 while running its checks. You can run checks that include callouts by using
38315 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38316
38317
38318
38319 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38320 .cindex "DBM" "building dbm files"
38321 .cindex "building DBM files"
38322 .cindex "&'exim_dbmbuild'&"
38323 .cindex "lower casing"
38324 .cindex "binary zero" "in lookup key"
38325 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38326 the format used by the &(lsearch)& lookup (see section
38327 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38328 names as keys and the remainder of the information as data. The lower-casing
38329 can be prevented by calling the program with the &%-nolc%& option.
38330
38331 A terminating zero is included as part of the key string. This is expected by
38332 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38333 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38334 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38335 files.
38336
38337 The program requires two arguments: the name of the input file (which can be a
38338 single hyphen to indicate the standard input), and the name of the output file.
38339 It creates the output under a temporary name, and then renames it if all went
38340 well.
38341
38342 .cindex "USE_DB"
38343 If the native DB interface is in use (USE_DB is set in a compile-time
38344 configuration file &-- this is common in free versions of Unix) the two
38345 filenames must be different, because in this mode the Berkeley DB functions
38346 create a single output file using exactly the name given. For example,
38347 .code
38348 exim_dbmbuild /etc/aliases /etc/aliases.db
38349 .endd
38350 reads the system alias file and creates a DBM version of it in
38351 &_/etc/aliases.db_&.
38352
38353 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38354 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38355 environment, the suffixes are added to the second argument of
38356 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38357 when the Berkeley functions are used in compatibility mode (though this is not
38358 recommended), because in that case it adds a &_.db_& suffix to the filename.
38359
38360 If a duplicate key is encountered, the program outputs a warning, and when it
38361 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38362 option is used. By default, only the first of a set of duplicates is used &--
38363 this makes it compatible with &(lsearch)& lookups. There is an option
38364 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38365 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38366 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38367 return code is 2.
38368
38369
38370
38371
38372 .section "Finding individual retry times (exinext)" "SECTfinindret"
38373 .cindex "retry" "times"
38374 .cindex "&'exinext'&"
38375 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38376 fish specific information out of the retry database. Given a mail domain (or a
38377 complete address), it looks up the hosts for that domain, and outputs any retry
38378 information for the hosts or for the domain. At present, the retry information
38379 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38380 output. For example:
38381 .code
38382 $ exinext piglet@milne.fict.example
38383 kanga.milne.example:192.168.8.1 error 146: Connection refused
38384   first failed: 21-Feb-1996 14:57:34
38385   last tried:   21-Feb-1996 14:57:34
38386   next try at:  21-Feb-1996 15:02:34
38387 roo.milne.example:192.168.8.3 error 146: Connection refused
38388   first failed: 20-Jan-1996 13:12:08
38389   last tried:   21-Feb-1996 11:42:03
38390   next try at:  21-Feb-1996 19:42:03
38391   past final cutoff time
38392 .endd
38393 You can also give &'exinext'& a local part, without a domain, and it
38394 will give any retry information for that local part in your default domain.
38395 A message id can be used to obtain retry information pertaining to a specific
38396 message. This exists only when an attempt to deliver a message to a remote host
38397 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38398 &'exinext'& is not particularly efficient, but then it is not expected to be
38399 run very often.
38400
38401 The &'exinext'& utility calls Exim to find out information such as the location
38402 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38403 passed on to the &'exim'& commands. The first specifies an alternate Exim
38404 configuration file, and the second sets macros for use within the configuration
38405 file. These features are mainly to help in testing, but might also be useful in
38406 environments where more than one configuration file is in use.
38407
38408
38409
38410 .section "Hints database maintenance" "SECThindatmai"
38411 .cindex "hints database" "maintenance"
38412 .cindex "maintaining Exim's hints database"
38413 Three utility programs are provided for maintaining the DBM files that Exim
38414 uses to contain its delivery hint information. Each program requires two
38415 arguments. The first specifies the name of Exim's spool directory, and the
38416 second is the name of the database it is to operate on. These are as follows:
38417
38418 .ilist
38419 &'retry'&: the database of retry information
38420 .next
38421 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38422 for remote hosts
38423 .next
38424 &'callout'&: the callout cache
38425 .next
38426 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38427 .next
38428 &'misc'&: other hints data
38429 .endlist
38430
38431 The &'misc'& database is used for
38432
38433 .ilist
38434 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38435 .next
38436 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38437 &(smtp)& transport)
38438 .next
38439 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38440 in a transport)
38441 .endlist
38442
38443
38444
38445 .section "exim_dumpdb" "SECID261"
38446 .cindex "&'exim_dumpdb'&"
38447 The entire contents of a database are written to the standard output by the
38448 &'exim_dumpdb'& program, which has no options or arguments other than the
38449 spool and database names. For example, to dump the retry database:
38450 .code
38451 exim_dumpdb /var/spool/exim retry
38452 .endd
38453 Two lines of output are produced for each entry:
38454 .code
38455 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38456 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38457 .endd
38458 The first item on the first line is the key of the record. It starts with one
38459 of the letters R, or T, depending on whether it refers to a routing or
38460 transport retry. For a local delivery, the next part is the local address; for
38461 a remote delivery it is the name of the remote host, followed by its failing IP
38462 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38463 transport). If the remote port is not the standard one (port 25), it is added
38464 to the IP address. Then there follows an error code, an additional error code,
38465 and a textual description of the error.
38466
38467 The three times on the second line are the time of first failure, the time of
38468 the last delivery attempt, and the computed time for the next attempt. The line
38469 ends with an asterisk if the cutoff time for the last retry rule has been
38470 exceeded.
38471
38472 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38473 consists of a host name followed by a list of ids for messages that are or were
38474 waiting to be delivered to that host. If there are a very large number for any
38475 one host, continuation records, with a sequence number added to the host name,
38476 may be seen. The data in these records is often out of date, because a message
38477 may be routed to several alternative hosts, and Exim makes no effort to keep
38478 cross-references.
38479
38480
38481
38482 .section "exim_tidydb" "SECID262"
38483 .cindex "&'exim_tidydb'&"
38484 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38485 database. If run with no options, it removes all records that are more than 30
38486 days old. The age is calculated from the date and time that the record was last
38487 updated. Note that, in the case of the retry database, it is &'not'& the time
38488 since the first delivery failure. Information about a host that has been down
38489 for more than 30 days will remain in the database, provided that the record is
38490 updated sufficiently often.
38491
38492 The cutoff date can be altered by means of the &%-t%& option, which must be
38493 followed by a time. For example, to remove all records older than a week from
38494 the retry database:
38495 .code
38496 exim_tidydb -t 7d /var/spool/exim retry
38497 .endd
38498 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38499 message ids. In the former these appear as data in records keyed by host &--
38500 they were messages that were waiting for that host &-- and in the latter they
38501 are the keys for retry information for messages that have suffered certain
38502 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38503 message ids in database records are those of messages that are still on the
38504 queue. Message ids for messages that no longer exist are removed from
38505 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38506 For the &'retry'& database, records whose keys are non-existent message ids are
38507 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38508 whenever it removes information from the database.
38509
38510 Certain records are automatically removed by Exim when they are no longer
38511 needed, but others are not. For example, if all the MX hosts for a domain are
38512 down, a retry record is created for each one. If the primary MX host comes back
38513 first, its record is removed when Exim successfully delivers to it, but the
38514 records for the others remain because Exim has not tried to use those hosts.
38515
38516 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38517 hints databases. You should do this at a quiet time of day, because it requires
38518 a database to be locked (and therefore inaccessible to Exim) while it does its
38519 work. Removing records from a DBM file does not normally make the file smaller,
38520 but all the common DBM libraries are able to re-use the space that is released.
38521 After an initial phase of increasing in size, the databases normally reach a
38522 point at which they no longer get any bigger, as long as they are regularly
38523 tidied.
38524
38525 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38526 databases is likely to keep on increasing.
38527
38528
38529
38530
38531 .section "exim_fixdb" "SECID263"
38532 .cindex "&'exim_fixdb'&"
38533 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38534 Its main use is for testing Exim, but it might also be occasionally useful for
38535 getting round problems in a live system. It has no options, and its interface
38536 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38537 key of a database record can then be entered, and the data for that record is
38538 displayed.
38539
38540 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38541 except the &'retry'& database, that is the only operation that can be carried
38542 out. For the &'retry'& database, each field is output preceded by a number, and
38543 data for individual fields can be changed by typing the field number followed
38544 by new data, for example:
38545 .code
38546 > 4 951102:1000
38547 .endd
38548 resets the time of the next delivery attempt. Time values are given as a
38549 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38550 used as optional separators.
38551
38552
38553
38554
38555 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38556 .cindex "mailbox" "maintenance"
38557 .cindex "&'exim_lock'&"
38558 .cindex "locking mailboxes"
38559 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38560 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38561 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38562 a user agent while investigating a problem. The utility requires the name of
38563 the file as its first argument. If the locking is successful, the second
38564 argument is run as a command (using C's &[system()]& function); if there is no
38565 second argument, the value of the SHELL environment variable is used; if this
38566 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38567 is unlocked and the utility ends. The following options are available:
38568
38569 .vlist
38570 .vitem &%-fcntl%&
38571 Use &[fcntl()]& locking on the open mailbox.
38572
38573 .vitem &%-flock%&
38574 Use &[flock()]& locking on the open mailbox, provided the operating system
38575 supports it.
38576
38577 .vitem &%-interval%&
38578 This must be followed by a number, which is a number of seconds; it sets the
38579 interval to sleep between retries (default 3).
38580
38581 .vitem &%-lockfile%&
38582 Create a lock file before opening the mailbox.
38583
38584 .vitem &%-mbx%&
38585 Lock the mailbox using MBX rules.
38586
38587 .vitem &%-q%&
38588 Suppress verification output.
38589
38590 .vitem &%-retries%&
38591 This must be followed by a number; it sets the number of times to try to get
38592 the lock (default 10).
38593
38594 .vitem &%-restore_time%&
38595 This option causes &%exim_lock%& to restore the modified and read times to the
38596 locked file before exiting. This allows you to access a locked mailbox (for
38597 example, to take a backup copy) without disturbing the times that the user
38598 subsequently sees.
38599
38600 .vitem &%-timeout%&
38601 This must be followed by a number, which is a number of seconds; it sets a
38602 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38603 default), a non-blocking call is used.
38604
38605 .vitem &%-v%&
38606 Generate verbose output.
38607 .endlist
38608
38609 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38610 default is to create a lock file and also to use &[fcntl()]& locking on the
38611 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38612 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38613 requires that the directory containing the file be writeable. Locking by lock
38614 file does not last forever; Exim assumes that a lock file is expired if it is
38615 more than 30 minutes old.
38616
38617 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38618 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38619 to be taken out on the open mailbox, and an exclusive lock on the file
38620 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38621 number of the mailbox file. When the locking is released, if an exclusive lock
38622 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38623
38624 The default output contains verification of the locking that takes place. The
38625 &%-v%& option causes some additional information to be given. The &%-q%& option
38626 suppresses all output except error messages.
38627
38628 A command such as
38629 .code
38630 exim_lock /var/spool/mail/spqr
38631 .endd
38632 runs an interactive shell while the file is locked, whereas
38633 .display
38634 &`exim_lock -q /var/spool/mail/spqr <<End`&
38635 <&'some commands'&>
38636 &`End`&
38637 .endd
38638 runs a specific non-interactive sequence of commands while the file is locked,
38639 suppressing all verification output. A single command can be run by a command
38640 such as
38641 .code
38642 exim_lock -q /var/spool/mail/spqr \
38643   "cp /var/spool/mail/spqr /some/where"
38644 .endd
38645 Note that if a command is supplied, it must be entirely contained within the
38646 second argument &-- hence the quotes.
38647 .ecindex IIDutils
38648
38649
38650 . ////////////////////////////////////////////////////////////////////////////
38651 . ////////////////////////////////////////////////////////////////////////////
38652
38653 .chapter "The Exim monitor" "CHAPeximon"
38654 .scindex IIDeximon "Exim monitor" "description"
38655 .cindex "X-windows"
38656 .cindex "&'eximon'&"
38657 .cindex "Local/eximon.conf"
38658 .cindex "&_exim_monitor/EDITME_&"
38659 The Exim monitor is an application which displays in an X window information
38660 about the state of Exim's queue and what Exim is doing. An admin user can
38661 perform certain operations on messages from this GUI interface; however all
38662 such facilities are also available from the command line, and indeed, the
38663 monitor itself makes use of the command line to perform any actions requested.
38664
38665
38666
38667 .section "Running the monitor" "SECID264"
38668 The monitor is started by running the script called &'eximon'&. This is a shell
38669 script that sets up a number of environment variables, and then runs the
38670 binary called &_eximon.bin_&. The default appearance of the monitor window can
38671 be changed by editing the &_Local/eximon.conf_& file created by editing
38672 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38673 parameters are for.
38674
38675 The parameters that get built into the &'eximon'& script can be overridden for
38676 a particular invocation by setting up environment variables of the same names,
38677 preceded by &`EXIMON_`&. For example, a shell command such as
38678 .code
38679 EXIMON_LOG_DEPTH=400 eximon
38680 .endd
38681 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38682 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38683 overrides the Exim log file configuration. This makes it possible to have
38684 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38685 syslog messages are routed to a file on the local host.
38686
38687 X resources can be used to change the appearance of the window in the normal
38688 way. For example, a resource setting of the form
38689 .code
38690 Eximon*background: gray94
38691 .endd
38692 changes the colour of the background to light grey rather than white. The
38693 stripcharts are drawn with both the data lines and the reference lines in
38694 black. This means that the reference lines are not visible when on top of the
38695 data. However, their colour can be changed by setting a resource called
38696 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38697 For example, if your X server is running Unix, you could set up lighter
38698 reference lines in the stripcharts by obeying
38699 .code
38700 xrdb -merge <<End
38701 Eximon*highlight: gray
38702 End
38703 .endd
38704 .cindex "admin user"
38705 In order to see the contents of messages in the queue, and to operate on them,
38706 &'eximon'& must either be run as root or by an admin user.
38707
38708 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38709 contain X11 resource parameters interpreted by the X11 library.  In addition,
38710 if the first parameter starts with the string "gdb" then it is removed and the
38711 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38712 versioned variants of gdb can be invoked).
38713
38714 The monitor's window is divided into three parts. The first contains one or
38715 more stripcharts and two action buttons, the second contains a &"tail"& of the
38716 main log file, and the third is a display of the queue of messages awaiting
38717 delivery, with two more action buttons. The following sections describe these
38718 different parts of the display.
38719
38720
38721
38722
38723 .section "The stripcharts" "SECID265"
38724 .cindex "stripchart"
38725 The first stripchart is always a count of messages in the queue. Its name can
38726 be configured by setting QUEUE_STRIPCHART_NAME in the
38727 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38728 configuration script by regular expression matches on log file entries, making
38729 it possible to display, for example, counts of messages delivered to certain
38730 hosts or using certain transports. The supplied defaults display counts of
38731 received and delivered messages, and of local and SMTP deliveries. The default
38732 period between stripchart updates is one minute; this can be adjusted by a
38733 parameter in the &_Local/eximon.conf_& file.
38734
38735 The stripchart displays rescale themselves automatically as the value they are
38736 displaying changes. There are always 10 horizontal lines in each chart; the
38737 title string indicates the value of each division when it is greater than one.
38738 For example, &"x2"& means that each division represents a value of 2.
38739
38740 It is also possible to have a stripchart which shows the percentage fullness of
38741 a particular disk partition, which is useful when local deliveries are confined
38742 to a single partition.
38743
38744 .cindex "&%statvfs%& function"
38745 This relies on the availability of the &[statvfs()]& function or equivalent in
38746 the operating system. Most, but not all versions of Unix that support Exim have
38747 this. For this particular stripchart, the top of the chart always represents
38748 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38749 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38750 &_Local/eximon.conf_& file.
38751
38752
38753
38754
38755 .section "Main action buttons" "SECID266"
38756 .cindex "size" "of monitor window"
38757 .cindex "Exim monitor" "window size"
38758 .cindex "window size"
38759 Below the stripcharts there is an action button for quitting the monitor. Next
38760 to this is another button marked &"Size"&. They are placed here so that
38761 shrinking the window to its default minimum size leaves just the queue count
38762 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38763 the window to expand to its maximum size, unless it is already at the maximum,
38764 in which case it is reduced to its minimum.
38765
38766 When expanding to the maximum, if the window cannot be fully seen where it
38767 currently is, it is moved back to where it was the last time it was at full
38768 size. When it is expanding from its minimum size, the old position is
38769 remembered, and next time it is reduced to the minimum it is moved back there.
38770
38771 The idea is that you can keep a reduced window just showing one or two
38772 stripcharts at a convenient place on your screen, easily expand it to show
38773 the full window when required, and just as easily put it back to what it was.
38774 The idea is copied from what the &'twm'& window manager does for its
38775 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38776 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38777
38778 Normally, the monitor starts up with the window at its full size, but it can be
38779 built so that it starts up with the window at its smallest size, by setting
38780 START_SMALL=yes in &_Local/eximon.conf_&.
38781
38782
38783
38784 .section "The log display" "SECID267"
38785 .cindex "log" "tail of; in monitor"
38786 The second section of the window is an area in which a display of the tail of
38787 the main log is maintained.
38788 To save space on the screen, the timestamp on each log line is shortened by
38789 removing the date and, if &%log_timezone%& is set, the timezone.
38790 The log tail is not available when the only destination for logging data is
38791 syslog, unless the syslog lines are routed to a local file whose name is passed
38792 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38793
38794 The log sub-window has a scroll bar at its lefthand side which can be used to
38795 move back to look at earlier text, and the up and down arrow keys also have a
38796 scrolling effect. The amount of log that is kept depends on the setting of
38797 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38798 to use. When this is full, the earlier 50% of data is discarded &-- this is
38799 much more efficient than throwing it away line by line. The sub-window also has
38800 a horizontal scroll bar for accessing the ends of long log lines. This is the
38801 only means of horizontal scrolling; the right and left arrow keys are not
38802 available. Text can be cut from this part of the window using the mouse in the
38803 normal way. The size of this subwindow is controlled by parameters in the
38804 configuration file &_Local/eximon.conf_&.
38805
38806 Searches of the text in the log window can be carried out by means of the ^R
38807 and ^S keystrokes, which default to a reverse and a forward search,
38808 respectively. The search covers only the text that is displayed in the window.
38809 It cannot go further back up the log.
38810
38811 The point from which the search starts is indicated by a caret marker. This is
38812 normally at the end of the text in the window, but can be positioned explicitly
38813 by pointing and clicking with the left mouse button, and is moved automatically
38814 by a successful search. If new text arrives in the window when it is scrolled
38815 back, the caret remains where it is, but if the window is not scrolled back,
38816 the caret is moved to the end of the new text.
38817
38818 Pressing ^R or ^S pops up a window into which the search text can be typed.
38819 There are buttons for selecting forward or reverse searching, for carrying out
38820 the search, and for cancelling. If the &"Search"& button is pressed, the search
38821 happens and the window remains so that further searches can be done. If the
38822 &"Return"& key is pressed, a single search is done and the window is closed. If
38823 ^C is typed the search is cancelled.
38824
38825 The searching facility is implemented using the facilities of the Athena text
38826 widget. By default this pops up a window containing both &"search"& and
38827 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38828 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38829 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38830 provided version of &%TextPop%& when the remaining parts of the text widget
38831 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38832 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38833 on these systems, at the expense of having unwanted items in the search popup
38834 window.
38835
38836
38837
38838 .section "The queue display" "SECID268"
38839 .cindex "queue" "display in monitor"
38840 The bottom section of the monitor window contains a list of all messages that
38841 are in the queue, which includes those currently being received or delivered,
38842 as well as those awaiting delivery. The size of this subwindow is controlled by
38843 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38844 at which it is updated is controlled by another parameter in the same file &--
38845 the default is 5 minutes, since queue scans can be quite expensive. However,
38846 there is an &"Update"& action button just above the display which can be used
38847 to force an update of the queue display at any time.
38848
38849 When a host is down for some time, a lot of pending mail can build up for it,
38850 and this can make it hard to deal with other messages in the queue. To help
38851 with this situation there is a button next to &"Update"& called &"Hide"&. If
38852 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38853 type anything in here and press &"Return"&, the text is added to a chain of
38854 such texts, and if every undelivered address in a message matches at least one
38855 of the texts, the message is not displayed.
38856
38857 If there is an address that does not match any of the texts, all the addresses
38858 are displayed as normal. The matching happens on the ends of addresses so, for
38859 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38860 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38861 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38862 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38863 a hide request is automatically cancelled after one hour.
38864
38865 While the dialogue box is displayed, you can't press any buttons or do anything
38866 else to the monitor window. For this reason, if you want to cut text from the
38867 queue display to use in the dialogue box, you have to do the cutting before
38868 pressing the &"Hide"& button.
38869
38870 The queue display contains, for each unhidden queued message, the length of
38871 time it has been in the queue, the size of the message, the message id, the
38872 message sender, and the first undelivered recipient, all on one line. If it is
38873 a bounce message, the sender is shown as &"<>"&. If there is more than one
38874 recipient to which the message has not yet been delivered, subsequent ones are
38875 listed on additional lines, up to a maximum configured number, following which
38876 an ellipsis is displayed. Recipients that have already received the message are
38877 not shown.
38878
38879 .cindex "frozen messages" "display"
38880 If a message is frozen, an asterisk is displayed at the left-hand side.
38881
38882 The queue display has a vertical scroll bar, and can also be scrolled by means
38883 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38884 The text searching facilities, as described above for the log window, are also
38885 available, but the caret is always moved to the end of the text when the queue
38886 display is updated.
38887
38888
38889
38890 .section "The queue menu" "SECID269"
38891 .cindex "queue" "menu in monitor"
38892 If the &%shift%& key is held down and the left button is clicked when the mouse
38893 pointer is over the text for any message, an action menu pops up, and the first
38894 line of the queue display for the message is highlighted. This does not affect
38895 any selected text.
38896
38897 If you want to use some other event for popping up the menu, you can set the
38898 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38899 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38900 value set in this parameter is a standard X event description. For example, to
38901 run eximon using &%ctrl%& rather than &%shift%& you could use
38902 .code
38903 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38904 .endd
38905 The title of the menu is the message id, and it contains entries which act as
38906 follows:
38907
38908 .ilist
38909 &'message log'&: The contents of the message log for the message are displayed
38910 in a new text window.
38911 .next
38912 &'headers'&: Information from the spool file that contains the envelope
38913 information and headers is displayed in a new text window. See chapter
38914 &<<CHAPspool>>& for a description of the format of spool files.
38915 .next
38916 &'body'&: The contents of the spool file containing the body of the message are
38917 displayed in a new text window. There is a default limit of 20,000 bytes to the
38918 amount of data displayed. This can be changed by setting the BODY_MAX
38919 option at compile time, or the EXIMON_BODY_MAX option at runtime.
38920 .next
38921 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38922 delivery of the message. This causes an automatic thaw if the message is
38923 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38924 a new text window. The delivery is run in a separate process, to avoid holding
38925 up the monitor while the delivery proceeds.
38926 .next
38927 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38928 that the message be frozen.
38929 .next
38930 .cindex "thawing messages"
38931 .cindex "unfreezing messages"
38932 .cindex "frozen messages" "thawing"
38933 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38934 that the message be thawed.
38935 .next
38936 .cindex "delivery" "forcing failure"
38937 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38938 that Exim gives up trying to deliver the message. A bounce message is generated
38939 for any remaining undelivered addresses.
38940 .next
38941 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38942 that the message be deleted from the system without generating a bounce
38943 message.
38944 .next
38945 &'add recipient'&: A dialog box is displayed into which a recipient address can
38946 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38947 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38948 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38949 causes a call to Exim to be made using the &%-Mar%& option to request that an
38950 additional recipient be added to the message, unless the entry box is empty, in
38951 which case no action is taken.
38952 .next
38953 &'mark delivered'&: A dialog box is displayed into which a recipient address
38954 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38955 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38956 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38957 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38958 recipient address as already delivered, unless the entry box is empty, in which
38959 case no action is taken.
38960 .next
38961 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38962 mark all recipient addresses as already delivered.
38963 .next
38964 &'edit sender'&: A dialog box is displayed initialized with the current
38965 sender's address. Pressing RETURN causes a call to Exim to be made using the
38966 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38967 in which case no action is taken. If you want to set an empty sender (as in
38968 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38969 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38970 the address is qualified with that domain.
38971 .endlist
38972
38973 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38974 other cases when a call to Exim is made, if there is any output from Exim (in
38975 particular, if the command fails) a window containing the command and the
38976 output is displayed. Otherwise, the results of the action are normally apparent
38977 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38978 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38979 if no output is generated.
38980
38981 The queue display is automatically updated for actions such as freezing and
38982 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38983 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38984 force an update of the display after one of these actions.
38985
38986 In any text window that is displayed as result of a menu action, the normal
38987 cut-and-paste facility is available, and searching can be carried out using ^R
38988 and ^S, as described above for the log tail window.
38989 .ecindex IIDeximon
38990
38991
38992
38993
38994
38995 . ////////////////////////////////////////////////////////////////////////////
38996 . ////////////////////////////////////////////////////////////////////////////
38997
38998 .chapter "Security considerations" "CHAPsecurity"
38999 .scindex IIDsecurcon "security" "discussion of"
39000 This chapter discusses a number of issues concerned with security, some of
39001 which are also covered in other parts of this manual.
39002
39003 For reasons that this author does not understand, some people have promoted
39004 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39005 existence of this chapter in the documentation. However, the intent of the
39006 chapter is simply to describe the way Exim works in relation to certain
39007 security concerns, not to make any specific claims about the effectiveness of
39008 its security as compared with other MTAs.
39009
39010 What follows is a description of the way Exim is supposed to be. Best efforts
39011 have been made to try to ensure that the code agrees with the theory, but an
39012 absence of bugs can never be guaranteed. Any that are reported will get fixed
39013 as soon as possible.
39014
39015
39016 .section "Building a more &""hardened""& Exim" "SECID286"
39017 .cindex "security" "build-time features"
39018 There are a number of build-time options that can be set in &_Local/Makefile_&
39019 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39020 Exim administrator who does not have the root password, or by someone who has
39021 penetrated the Exim (but not the root) account. These options are as follows:
39022
39023 .ilist
39024 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39025 start of any filenames used with the &%-C%& option. When it is set, these
39026 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39027 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39028 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39029 default setting for &%ALT_CONFIG_PREFIX%&.
39030
39031 If the permitted configuration files are confined to a directory to
39032 which only root has access, this guards against someone who has broken
39033 into the Exim account from running a privileged Exim with an arbitrary
39034 configuration file, and using it to break into other accounts.
39035 .next
39036
39037 If a non-trusted configuration file (i.e. not the default configuration file
39038 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39039 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39040 the next item), then root privilege is retained only if the caller of Exim is
39041 root. This locks out the possibility of testing a configuration using &%-C%&
39042 right through message reception and delivery, even if the caller is root. The
39043 reception works, but by that time, Exim is running as the Exim user, so when
39044 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39045 privilege to be lost. However, root can test reception and delivery using two
39046 separate commands.
39047
39048 .next
39049 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39050 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39051 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39052 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39053 the restrictive side.  Requiring build-time selection of safe macros is onerous
39054 but this option is intended solely as a transition mechanism to permit
39055 previously-working configurations to continue to work after release 4.73.
39056 .next
39057 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39058 is disabled.
39059 .next
39060 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39061 never to be used for any deliveries. This is like the &%never_users%& runtime
39062 option, but it cannot be overridden; the runtime option adds additional users
39063 to the list. The default setting is &"root"&; this prevents a non-root user who
39064 is permitted to modify the runtime file from using Exim as a way to get root.
39065 .endlist
39066
39067
39068
39069 .section "Root privilege" "SECID270"
39070 .cindex "setuid"
39071 .cindex "root privilege"
39072 The Exim binary is normally setuid to root, which means that it gains root
39073 privilege (runs as root) when it starts execution. In some special cases (for
39074 example, when the daemon is not in use and there are no local deliveries), it
39075 may be possible to run Exim setuid to some user other than root. This is
39076 discussed in the next section. However, in most installations, root privilege
39077 is required for two things:
39078
39079 .ilist
39080 To set up a socket connected to the standard SMTP port (25) when initialising
39081 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39082 not required.
39083 .next
39084 To be able to change uid and gid in order to read users' &_.forward_& files and
39085 perform local deliveries as the receiving user or as specified in the
39086 configuration.
39087 .endlist
39088
39089 It is not necessary to be root to do any of the other things Exim does, such as
39090 receiving messages and delivering them externally over SMTP, and it is
39091 obviously more secure if Exim does not run as root except when necessary.
39092 For this reason, a user and group for Exim to use must be defined in
39093 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39094 group"&. Their values can be changed by the runtime configuration, though this
39095 is not recommended. Often a user called &'exim'& is used, but some sites use
39096 &'mail'& or another user name altogether.
39097
39098 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39099 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39100 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39101
39102 After a new Exim process has interpreted its command line options, it changes
39103 uid and gid in the following cases:
39104
39105 .ilist
39106 .oindex "&%-C%&"
39107 .oindex "&%-D%&"
39108 If the &%-C%& option is used to specify an alternate configuration file, or if
39109 the &%-D%& option is used to define macro values for the configuration, and the
39110 calling process is not running as root, the uid and gid are changed to those of
39111 the calling process.
39112 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39113 option may not be used at all.
39114 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39115 can be supplied if the calling process is running as root, the Exim run-time
39116 user or CONFIGURE_OWNER, if defined.
39117 .next
39118 .oindex "&%-be%&"
39119 .oindex "&%-bf%&"
39120 .oindex "&%-bF%&"
39121 If the expansion test option (&%-be%&) or one of the filter testing options
39122 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39123 calling process.
39124 .next
39125 If the process is not a daemon process or a queue runner process or a delivery
39126 process or a process for testing address routing (started with &%-bt%&), the
39127 uid and gid are changed to the Exim user and group. This means that Exim always
39128 runs under its own uid and gid when receiving messages. This also applies when
39129 testing address verification
39130 .oindex "&%-bv%&"
39131 .oindex "&%-bh%&"
39132 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39133 option).
39134 .next
39135 For a daemon, queue runner, delivery, or address testing process, the uid
39136 remains as root at this stage, but the gid is changed to the Exim group.
39137 .endlist
39138
39139 The processes that initially retain root privilege behave as follows:
39140
39141 .ilist
39142 A daemon process changes the gid to the Exim group and the uid to the Exim
39143 user after setting up one or more listening sockets. The &[initgroups()]&
39144 function is called, so that if the Exim user is in any additional groups, they
39145 will be used during message reception.
39146 .next
39147 A queue runner process retains root privilege throughout its execution. Its
39148 job is to fork a controlled sequence of delivery processes.
39149 .next
39150 A delivery process retains root privilege throughout most of its execution,
39151 but any actual deliveries (that is, the transports themselves) are run in
39152 subprocesses which always change to a non-root uid and gid. For local
39153 deliveries this is typically the uid and gid of the owner of the mailbox; for
39154 remote deliveries, the Exim uid and gid are used. Once all the delivery
39155 subprocesses have been run, a delivery process changes to the Exim uid and gid
39156 while doing post-delivery tidying up such as updating the retry database and
39157 generating bounce and warning messages.
39158
39159 While the recipient addresses in a message are being routed, the delivery
39160 process runs as root. However, if a user's filter file has to be processed,
39161 this is done in a subprocess that runs under the individual user's uid and
39162 gid. A system filter is run as root unless &%system_filter_user%& is set.
39163 .next
39164 A process that is testing addresses (the &%-bt%& option) runs as root so that
39165 the routing is done in the same environment as a message delivery.
39166 .endlist
39167
39168
39169
39170
39171 .section "Running Exim without privilege" "SECTrunexiwitpri"
39172 .cindex "privilege, running without"
39173 .cindex "unprivileged running"
39174 .cindex "root privilege" "running without"
39175 Some installations like to run Exim in an unprivileged state for more of its
39176 operation, for added security. Support for this mode of operation is provided
39177 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39178 gid are changed to the Exim user and group at the start of a delivery process
39179 (and also queue runner and address testing processes). This means that address
39180 routing is no longer run as root, and the deliveries themselves cannot change
39181 to any other uid.
39182
39183 .cindex SIGHUP
39184 .cindex "daemon" "restarting"
39185 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39186 that the daemon can still be started in the usual way, and it can respond
39187 correctly to SIGHUP because the re-invocation regains root privilege.
39188
39189 An alternative approach is to make Exim setuid to the Exim user and also setgid
39190 to the Exim group. If you do this, the daemon must be started from a root
39191 process. (Calling Exim from a root process makes it behave in the way it does
39192 when it is setuid root.) However, the daemon cannot restart itself after a
39193 SIGHUP signal because it cannot regain privilege.
39194
39195 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39196 stops Exim from trying to re-invoke itself to do a delivery after a message has
39197 been received. Such a re-invocation is a waste of resources because it has no
39198 effect.
39199
39200 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39201 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39202 to the Exim user seems a clean approach, but there is one complication:
39203
39204 In this style of operation, Exim is running with the real uid and gid set to
39205 those of the calling process, and the effective uid/gid set to Exim's values.
39206 Ideally, any association with the calling process' uid/gid should be dropped,
39207 that is, the real uid/gid should be reset to the effective values so as to
39208 discard any privileges that the caller may have. While some operating systems
39209 have a function that permits this action for a non-root effective uid, quite a
39210 number of them do not. Because of this lack of standardization, Exim does not
39211 address this problem at this time.
39212
39213 For this reason, the recommended approach for &"mostly unprivileged"& running
39214 is to keep the Exim binary setuid to root, and to set
39215 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39216 be used in the most straightforward way.
39217
39218 If you configure Exim not to run delivery processes as root, there are a
39219 number of restrictions on what you can do:
39220
39221 .ilist
39222 You can deliver only as the Exim user/group. You should  explicitly use the
39223 &%user%& and &%group%& options to override routers or local transports that
39224 normally deliver as the recipient. This makes sure that configurations that
39225 work in this mode function the same way in normal mode. Any implicit or
39226 explicit specification of another user causes an error.
39227 .next
39228 Use of &_.forward_& files is severely restricted, such that it is usually
39229 not worthwhile to include them in the configuration.
39230 .next
39231 Users who wish to use &_.forward_& would have to make their home directory and
39232 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39233 and their equivalents in Exim filters, cannot be used. While they could be
39234 enabled in the Exim user's name, that would be insecure and not very useful.
39235 .next
39236 Unless the local user mailboxes are all owned by the Exim user (possible in
39237 some POP3 or IMAP-only environments):
39238
39239 .olist
39240 They must be owned by the Exim group and be writeable by that group. This
39241 implies you must set &%mode%& in the appendfile configuration, as well as the
39242 mode of the mailbox files themselves.
39243 .next
39244 You must set &%no_check_owner%&, since most or all of the files will not be
39245 owned by the Exim user.
39246 .next
39247 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39248 on a newly created mailbox when unprivileged. This also implies that new
39249 mailboxes need to be created manually.
39250 .endlist olist
39251 .endlist ilist
39252
39253
39254 These restrictions severely restrict what can be done in local deliveries.
39255 However, there are no restrictions on remote deliveries. If you are running a
39256 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39257 gives more security at essentially no cost.
39258
39259 If you are using the &%mua_wrapper%& facility (see chapter
39260 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39261
39262
39263
39264
39265 .section "Delivering to local files" "SECID271"
39266 Full details of the checks applied by &(appendfile)& before it writes to a file
39267 are given in chapter &<<CHAPappendfile>>&.
39268
39269
39270
39271 .section "Running local commands" "SECTsecconslocalcmds"
39272 .cindex "security" "local commands"
39273 .cindex "security" "command injection attacks"
39274 There are a number of ways in which an administrator can configure Exim to run
39275 commands based upon received, untrustworthy, data. Further, in some
39276 configurations a user who can control a &_.forward_& file can also arrange to
39277 run commands. Configuration to check includes, but is not limited to:
39278
39279 .ilist
39280 Use of &%use_shell%& in the pipe transport: various forms of shell command
39281 injection may be possible with this option present. It is dangerous and should
39282 be used only with considerable caution. Consider constraints which whitelist
39283 allowed characters in a variable which is to be used in a pipe transport that
39284 has &%use_shell%& enabled.
39285 .next
39286 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39287 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39288 &_.forward_& files in a redirect router. If Exim is running on a central mail
39289 hub to which ordinary users do not have shell access, but home directories are
39290 NFS mounted (for instance) then administrators should review the list of these
39291 forbid options available, and should bear in mind that the options that may
39292 need forbidding can change as new features are added between releases.
39293 .next
39294 The &%${run...}%& expansion item does not use a shell by default, but
39295 administrators can configure use of &_/bin/sh_& as part of the command.
39296 Such invocations should be viewed with prejudicial suspicion.
39297 .next
39298 Administrators who use embedded Perl are advised to explore how Perl's
39299 taint checking might apply to their usage.
39300 .next
39301 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39302 administrators are well advised to view its use with suspicion, in case (for
39303 instance) it allows a local-part to contain embedded Exim directives.
39304 .next
39305 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39306 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39307 each can reference arbitrary lists and files, rather than just being a list
39308 of opaque strings.
39309 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39310 real-world security vulnerabilities caused by its use with untrustworthy data
39311 injected in, for SQL injection attacks.
39312 Consider the use of the &%inlisti%& expansion condition instead.
39313 .endlist
39314
39315
39316
39317
39318 .section "Trust in configuration data" "SECTsecconfdata"
39319 .cindex "security" "data sources"
39320 .cindex "security" "regular expressions"
39321 .cindex "regular expressions" "security"
39322 .cindex "PCRE" "security"
39323 If configuration data for Exim can come from untrustworthy sources, there
39324 are some issues to be aware of:
39325
39326 .ilist
39327 Use of &%${expand...}%& may provide a path for shell injection attacks.
39328 .next
39329 Letting untrusted data provide a regular expression is unwise.
39330 .next
39331 Using &%${match...}%& to apply a fixed regular expression against untrusted
39332 data may result in pathological behaviour within PCRE.  Be aware of what
39333 "backtracking" means and consider options for being more strict with a regular
39334 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39335 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39336 possessive quantifiers or just not using regular expressions against untrusted
39337 data.
39338 .next
39339 It can be important to correctly use &%${quote:...}%&,
39340 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39341 items to ensure that data is correctly constructed.
39342 .next
39343 Some lookups might return multiple results, even though normal usage is only
39344 expected to yield one result.
39345 .endlist
39346
39347
39348
39349
39350 .section "IPv4 source routing" "SECID272"
39351 .cindex "source routing" "in IP packets"
39352 .cindex "IP source routing"
39353 Many operating systems suppress IP source-routed packets in the kernel, but
39354 some cannot be made to do this, so Exim does its own check. It logs incoming
39355 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39356 IPv6. No special checking is currently done.
39357
39358
39359
39360 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39361 Support for these SMTP commands is disabled by default. If required, they can
39362 be enabled by defining suitable ACLs.
39363
39364
39365
39366
39367 .section "Privileged users" "SECID274"
39368 .cindex "trusted users"
39369 .cindex "admin user"
39370 .cindex "privileged user"
39371 .cindex "user" "trusted"
39372 .cindex "user" "admin"
39373 Exim recognizes two sets of users with special privileges. Trusted users are
39374 able to submit new messages to Exim locally, but supply their own sender
39375 addresses and information about a sending host. For other users submitting
39376 local messages, Exim sets up the sender address from the uid, and doesn't
39377 permit a remote host to be specified.
39378
39379 .oindex "&%-f%&"
39380 However, an untrusted user is permitted to use the &%-f%& command line option
39381 in the special form &%-f <>%& to indicate that a delivery failure for the
39382 message should not cause an error report. This affects the message's envelope,
39383 but it does not affect the &'Sender:'& header. Untrusted users may also be
39384 permitted to use specific forms of address with the &%-f%& option by setting
39385 the &%untrusted_set_sender%& option.
39386
39387 Trusted users are used to run processes that receive mail messages from some
39388 other mail domain and pass them on to Exim for delivery either locally, or over
39389 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39390 as any user listed in the &%trusted_users%& configuration option, or under any
39391 group listed in the &%trusted_groups%& option.
39392
39393 Admin users are permitted to do things to the messages on Exim's queue. They
39394 can freeze or thaw messages, cause them to be returned to their senders, remove
39395 them entirely, or modify them in various ways. In addition, admin users can run
39396 the Exim monitor and see all the information it is capable of providing, which
39397 includes the contents of files on the spool.
39398
39399 .oindex "&%-M%&"
39400 .oindex "&%-q%&"
39401 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39402 delivery of messages on its queue is restricted to admin users. This
39403 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39404 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39405 queue is also restricted to admin users. This restriction can be relaxed by
39406 setting &%no_queue_list_requires_admin%&.
39407
39408 Exim recognizes an admin user if the calling process is running as root or as
39409 the Exim user or if any of the groups associated with the calling process is
39410 the Exim group. It is not necessary actually to be running under the Exim
39411 group. However, if admin users who are not root or the Exim user are to access
39412 the contents of files on the spool via the Exim monitor (which runs
39413 unprivileged), Exim must be built to allow group read access to its spool
39414 files.
39415
39416 By default, regular users are trusted to perform basic testing and
39417 introspection commands, as themselves.  This setting can be tightened by
39418 setting the &%commandline_checks_require_admin%& option.
39419 This affects most of the checking options,
39420 such as &%-be%& and anything else &%-b*%&.
39421
39422
39423 .section "Spool files" "SECID275"
39424 .cindex "spool directory" "files"
39425 Exim's spool directory and everything it contains is owned by the Exim user and
39426 set to the Exim group. The mode for spool files is defined in the
39427 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39428 any user who is a member of the Exim group can access these files.
39429
39430
39431
39432 .section "Use of argv[0]" "SECID276"
39433 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39434 of specific strings, Exim assumes certain options. For example, calling Exim
39435 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39436 to calling it with the option &%-bS%&. There are no security implications in
39437 this.
39438
39439
39440
39441 .section "Use of %f formatting" "SECID277"
39442 The only use made of &"%f"& by Exim is in formatting load average values. These
39443 are actually stored in integer variables as 1000 times the load average.
39444 Consequently, their range is limited and so therefore is the length of the
39445 converted output.
39446
39447
39448
39449 .section "Embedded Exim path" "SECID278"
39450 Exim uses its own path name, which is embedded in the code, only when it needs
39451 to re-exec in order to regain root privilege. Therefore, it is not root when it
39452 does so. If some bug allowed the path to get overwritten, it would lead to an
39453 arbitrary program's being run as exim, not as root.
39454
39455
39456
39457 .section "Dynamic module directory" "SECTdynmoddir"
39458 Any dynamically loadable modules must be installed into the directory
39459 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39460 loading it.
39461
39462
39463 .section "Use of sprintf()" "SECID279"
39464 .cindex "&[sprintf()]&"
39465 A large number of occurrences of &"sprintf"& in the code are actually calls to
39466 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39467 The intermediate formatting is done into a large fixed buffer by a function
39468 that runs through the format string itself, and checks the length of each
39469 conversion before performing it, thus preventing buffer overruns.
39470
39471 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39472 the output buffer is known to be sufficiently long to contain the converted
39473 string.
39474
39475
39476
39477 .section "Use of debug_printf() and log_write()" "SECID280"
39478 Arbitrary strings are passed to both these functions, but they do their
39479 formatting by calling the function &'string_vformat()'&, which runs through
39480 the format string itself, and checks the length of each conversion.
39481
39482
39483
39484 .section "Use of strcat() and strcpy()" "SECID281"
39485 These are used only in cases where the output buffer is known to be large
39486 enough to hold the result.
39487 .ecindex IIDsecurcon
39488
39489
39490
39491
39492 . ////////////////////////////////////////////////////////////////////////////
39493 . ////////////////////////////////////////////////////////////////////////////
39494
39495 .chapter "Format of spool files" "CHAPspool"
39496 .scindex IIDforspo1 "format" "spool files"
39497 .scindex IIDforspo2 "spool directory" "format of files"
39498 .scindex IIDforspo3 "spool files" "format of"
39499 .cindex "spool files" "editing"
39500 A message on Exim's queue consists of two files, whose names are the message id
39501 followed by -D and -H, respectively. The data portion of the message is kept in
39502 the -D file on its own. The message's envelope, status, and headers are all
39503 kept in the -H file, whose format is described in this chapter. Each of these
39504 two files contains the final component of its own name as its first line. This
39505 is insurance against disk crashes where the directory is lost but the files
39506 themselves are recoverable.
39507
39508 The file formats may be changed, or new formats added, at any release.
39509 Spool files are not intended as an interface to other programs
39510 and should not be used as such.
39511
39512 Some people are tempted into editing -D files in order to modify messages. You
39513 need to be extremely careful if you do this; it is not recommended and you are
39514 on your own if you do it. Here are some of the pitfalls:
39515
39516 .ilist
39517 You must ensure that Exim does not try to deliver the message while you are
39518 fiddling with it. The safest way is to take out a write lock on the -D file,
39519 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39520 place, the lock will be retained. If you write a new file and rename it, the
39521 lock will be lost at the instant of rename.
39522 .next
39523 .vindex "&$body_linecount$&"
39524 If you change the number of lines in the file, the value of
39525 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39526 cause incomplete transmission of messages or undeliverable messages.
39527 .next
39528 If the message is in MIME format, you must take care not to break it.
39529 .next
39530 If the message is cryptographically signed, any change will invalidate the
39531 signature.
39532 .endlist
39533 All in all, modifying -D files is fraught with danger.
39534
39535 Files whose names end with -J may also be seen in the &_input_& directory (or
39536 its subdirectories when &%split_spool_directory%& is set). These are journal
39537 files, used to record addresses to which the message has been delivered during
39538 the course of a delivery attempt. If there are still undelivered recipients at
39539 the end, the -H file is updated, and the -J file is deleted. If, however, there
39540 is some kind of crash (for example, a power outage) before this happens, the -J
39541 file remains in existence. When Exim next processes the message, it notices the
39542 -J file and uses it to update the -H file before starting the next delivery
39543 attempt.
39544
39545 Files whose names end with -K or .eml may also be seen in the spool.
39546 These are temporaries used for DKIM or malware processing, when that is used.
39547 They should be tidied up by normal operations; any old ones are probably
39548 relics of crashes and can be removed.
39549
39550 .section "Format of the -H file" "SECID282"
39551 .cindex "uid (user id)" "in spool file"
39552 .cindex "gid (group id)" "in spool file"
39553 The second line of the -H file contains the login name for the uid of the
39554 process that called Exim to read the message, followed by the numerical uid and
39555 gid. For a locally generated message, this is normally the user who sent the
39556 message. For a message received over TCP/IP via the daemon, it is
39557 normally the Exim user.
39558
39559 The third line of the file contains the address of the message's sender as
39560 transmitted in the envelope, contained in angle brackets. The sender address is
39561 empty for bounce messages. For incoming SMTP mail, the sender address is given
39562 in the MAIL command. For locally generated mail, the sender address is
39563 created by Exim from the login name of the current user and the configured
39564 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39565 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39566 &"<>"& or an address that matches &%untrusted_set_senders%&.
39567
39568 The fourth line contains two numbers. The first is the time that the message
39569 was received, in the conventional Unix form &-- the number of seconds since the
39570 start of the epoch. The second number is a count of the number of messages
39571 warning of delayed delivery that have been sent to the sender.
39572
39573 There follow a number of lines starting with a hyphen. These can appear in any
39574 order, and are omitted when not relevant:
39575
39576 .vlist
39577 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39578 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39579 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39580 recognized, to provide backward compatibility. In the old format, a line of
39581 this form is present for every ACL variable that is not empty. The number
39582 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39583 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39584 the data string for the variable. The string itself starts at the beginning of
39585 the next line, and is followed by a newline character. It may contain internal
39586 newlines.
39587
39588 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39589 A line of this form is present for every ACL connection variable that is
39590 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39591 The length is the length of the data string for the variable. The string itself
39592 starts at the beginning of the next line, and is followed by a newline
39593 character. It may contain internal newlines.
39594
39595 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39596 A line of this form is present for every ACL message variable that is defined.
39597 Note that there is a space between &%-aclm%& and the rest of the name. The
39598 length is the length of the data string for the variable. The string itself
39599 starts at the beginning of the next line, and is followed by a newline
39600 character. It may contain internal newlines.
39601
39602 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39603 This is present if, when the message was received over SMTP, the value of
39604 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39605
39606 .vitem &%-allow_unqualified_recipient%&
39607 This is present if unqualified recipient addresses are permitted in header
39608 lines (to stop such addresses from being qualified if rewriting occurs at
39609 transport time). Local messages that were input using &%-bnq%& and remote
39610 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39611
39612 .vitem &%-allow_unqualified_sender%&
39613 This is present if unqualified sender addresses are permitted in header lines
39614 (to stop such addresses from being qualified if rewriting occurs at transport
39615 time). Local messages that were input using &%-bnq%& and remote messages from
39616 hosts that match &%sender_unqualified_hosts%& set this flag.
39617
39618 .vitem "&%-auth_id%&&~<&'text'&>"
39619 The id information for a message received on an authenticated SMTP connection
39620 &-- the value of the &$authenticated_id$& variable.
39621
39622 .vitem "&%-auth_sender%&&~<&'address'&>"
39623 The address of an authenticated sender &-- the value of the
39624 &$authenticated_sender$& variable.
39625
39626 .vitem "&%-body_linecount%&&~<&'number'&>"
39627 This records the number of lines in the body of the message, and is
39628 present unless &%-spool_file_wireformat%& is.
39629
39630 .vitem "&%-body_zerocount%&&~<&'number'&>"
39631 This records the number of binary zero bytes in the body of the message, and is
39632 present if the number is greater than zero.
39633
39634 .vitem &%-deliver_firsttime%&
39635 This is written when a new message is first added to the spool. When the spool
39636 file is updated after a deferral, it is omitted.
39637
39638 .vitem "&%-frozen%&&~<&'time'&>"
39639 .cindex "frozen messages" "spool data"
39640 The message is frozen, and the freezing happened at <&'time'&>.
39641
39642 .vitem "&%-helo_name%&&~<&'text'&>"
39643 This records the host name as specified by a remote host in a HELO or EHLO
39644 command.
39645
39646 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39647 This records the IP address of the host from which the message was received and
39648 the remote port number that was used. It is omitted for locally generated
39649 messages.
39650
39651 .vitem "&%-host_auth%&&~<&'text'&>"
39652 If the message was received on an authenticated SMTP connection, this records
39653 the name of the authenticator &-- the value of the
39654 &$sender_host_authenticated$& variable.
39655
39656 .vitem &%-host_lookup_failed%&
39657 This is present if an attempt to look up the sending host's name from its IP
39658 address failed. It corresponds to the &$host_lookup_failed$& variable.
39659
39660 .vitem "&%-host_name%&&~<&'text'&>"
39661 .cindex "reverse DNS lookup"
39662 .cindex "DNS" "reverse lookup"
39663 This records the name of the remote host from which the message was received,
39664 if the host name was looked up from the IP address when the message was being
39665 received. It is not present if no reverse lookup was done.
39666
39667 .vitem "&%-ident%&&~<&'text'&>"
39668 For locally submitted messages, this records the login of the originating user,
39669 unless it was a trusted user and the &%-oMt%& option was used to specify an
39670 ident value. For messages received over TCP/IP, this records the ident string
39671 supplied by the remote host, if any.
39672
39673 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39674 This records the IP address of the local interface and the port number through
39675 which a message was received from a remote host. It is omitted for locally
39676 generated messages.
39677
39678 .vitem &%-local%&
39679 The message is from a local sender.
39680
39681 .vitem &%-localerror%&
39682 The message is a locally-generated bounce message.
39683
39684 .vitem "&%-local_scan%&&~<&'string'&>"
39685 This records the data string that was returned by the &[local_scan()]& function
39686 when the message was received &-- the value of the &$local_scan_data$&
39687 variable. It is omitted if no data was returned.
39688
39689 .vitem &%-manual_thaw%&
39690 The message was frozen but has been thawed manually, that is, by an explicit
39691 Exim command rather than via the auto-thaw process.
39692
39693 .vitem &%-N%&
39694 A testing delivery process was started using the &%-N%& option to suppress any
39695 actual deliveries, but delivery was deferred. At any further delivery attempts,
39696 &%-N%& is assumed.
39697
39698 .vitem &%-received_protocol%&
39699 This records the value of the &$received_protocol$& variable, which contains
39700 the name of the protocol by which the message was received.
39701
39702 .vitem &%-sender_set_untrusted%&
39703 The envelope sender of this message was set by an untrusted local caller (used
39704 to ensure that the caller is displayed in queue listings).
39705
39706 .vitem "&%-spam_score_int%&&~<&'number'&>"
39707 If a message was scanned by SpamAssassin, this is present. It records the value
39708 of &$spam_score_int$&.
39709
39710 .vitem &%-spool_file_wireformat%&
39711 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39712 rather than Unix-format.
39713 The line-ending is CRLF rather than newline.
39714 There is still, however, no leading-dot-stuffing.
39715
39716 .vitem &%-tls_certificate_verified%&
39717 A TLS certificate was received from the client that sent this message, and the
39718 certificate was verified by the server.
39719
39720 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39721 When the message was received over an encrypted connection, this records the
39722 name of the cipher suite that was used.
39723
39724 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39725 When the message was received over an encrypted connection, and a certificate
39726 was received from the client, this records the Distinguished Name from that
39727 certificate.
39728 .endlist
39729
39730 Any of the above may have an extra hyphen prepended, to indicate the the
39731 corresponding data is untrusted.
39732
39733 Following the options there is a list of those addresses to which the message
39734 is not to be delivered. This set of addresses is initialized from the command
39735 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39736 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39737 the address is added to this set. The addresses are kept internally as a
39738 balanced binary tree, and it is a representation of that tree which is written
39739 to the spool file. If an address is expanded via an alias or forward file, the
39740 original address is added to the tree when deliveries to all its child
39741 addresses are complete.
39742
39743 If the tree is empty, there is a single line in the spool file containing just
39744 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39745 Y or N, followed by an address. The address is the value for the node of the
39746 tree, and the letters indicate whether the node has a left branch and/or a
39747 right branch attached to it, respectively. If branches exist, they immediately
39748 follow. Here is an example of a three-node tree:
39749 .code
39750 YY darcy@austen.fict.example
39751 NN alice@wonderland.fict.example
39752 NN editor@thesaurus.ref.example
39753 .endd
39754 After the non-recipients tree, there is a list of the message's recipients.
39755 This is a simple list, preceded by a count. It includes all the original
39756 recipients of the message, including those to whom the message has already been
39757 delivered. In the simplest case, the list contains one address per line. For
39758 example:
39759 .code
39760 4
39761 editor@thesaurus.ref.example
39762 darcy@austen.fict.example
39763 rdo@foundation
39764 alice@wonderland.fict.example
39765 .endd
39766 However, when a child address has been added to the top-level addresses as a
39767 result of the use of the &%one_time%& option on a &(redirect)& router, each
39768 line is of the following form:
39769 .display
39770 <&'top-level address'&> <&'errors_to address'&> &&&
39771   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39772 .endd
39773 The 01 flag bit indicates the presence of the three other fields that follow
39774 the top-level address. Other bits may be used in future to support additional
39775 fields. The <&'parent number'&> is the offset in the recipients list of the
39776 original parent of the &"one time"& address. The first two fields are the
39777 envelope sender that is associated with this address and its length. If the
39778 length is zero, there is no special envelope sender (there are then two space
39779 characters in the line). A non-empty field can arise from a &(redirect)& router
39780 that has an &%errors_to%& setting.
39781
39782
39783 A blank line separates the envelope and status information from the headers
39784 which follow. A header may occupy several lines of the file, and to save effort
39785 when reading it in, each header is preceded by a number and an identifying
39786 character. The number is the number of characters in the header, including any
39787 embedded newlines and the terminating newline. The character is one of the
39788 following:
39789
39790 .table2 50pt
39791 .row <&'blank'&>         "header in which Exim has no special interest"
39792 .row &`B`&               "&'Bcc:'& header"
39793 .row &`C`&               "&'Cc:'& header"
39794 .row &`F`&               "&'From:'& header"
39795 .row &`I`&               "&'Message-id:'& header"
39796 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39797 .row &`R`&               "&'Reply-To:'& header"
39798 .row &`S`&               "&'Sender:'& header"
39799 .row &`T`&               "&'To:'& header"
39800 .row &`*`&               "replaced or deleted header"
39801 .endtable
39802
39803 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39804 purposes. They are not transmitted when the message is delivered. Here is a
39805 typical set of headers:
39806 .code
39807 111P Received: by hobbit.fict.example with local (Exim 4.00)
39808 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39809 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39810 038* X-rewrote-sender: bb@hobbit.fict.example
39811 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39812 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39813 099* To: alice@wonderland.fict.example, rdo@foundation,
39814 darcy@austen.fict.example, editor@thesaurus.ref.example
39815 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39816 darcy@austen.fict.example, editor@thesaurus.ref.example
39817 038  Date: Fri, 11 May 2001 10:28:59 +0100
39818 .endd
39819 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39820 &'To:'& header have been rewritten, the last one because routing expanded the
39821 unqualified domain &'foundation'&.
39822 .ecindex IIDforspo1
39823 .ecindex IIDforspo2
39824 .ecindex IIDforspo3
39825
39826 .section "Format of the -D file" "SECID282a"
39827 The data file is traditionally in Unix-standard format: lines are ended with
39828 an ASCII newline character.
39829 However, when the &%spool_wireformat%& main option is used some -D files
39830 can have an alternate format.
39831 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39832 The -D file lines (not including the first name-component line) are
39833 suitable for direct copying to the wire when transmitting using the
39834 ESMTP CHUNKING option, meaning lower processing overhead.
39835 Lines are terminated with an ASCII CRLF pair.
39836 There is no dot-stuffing (and no dot-termination).
39837
39838 . ////////////////////////////////////////////////////////////////////////////
39839 . ////////////////////////////////////////////////////////////////////////////
39840
39841 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
39842          "DKIM, SPF and DMARC Support"
39843
39844 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39845 .cindex "DKIM"
39846
39847 DKIM is a mechanism by which messages sent by some entity can be provably
39848 linked to a domain which that entity controls.  It permits reputation to
39849 be tracked on a per-domain basis, rather than merely upon source IP address.
39850 DKIM is documented in RFC 6376.
39851
39852 As DKIM relies on the message being unchanged in transit, messages handled
39853 by a mailing-list (which traditionally adds to the message) will not match
39854 any original DKIM signature.
39855
39856 DKIM support is compiled into Exim by default if TLS support is present.
39857 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39858
39859 Exim's DKIM implementation allows for
39860 .olist
39861 Signing outgoing messages: This function is implemented in the SMTP transport.
39862 It can co-exist with all other Exim features
39863 (including transport filters)
39864 except cutthrough delivery.
39865 .next
39866 Verifying signatures in incoming messages: This is implemented by an additional
39867 ACL (acl_smtp_dkim), which can be called several times per message, with
39868 different signature contexts.
39869 .endlist
39870
39871 In typical Exim style, the verification implementation does not include any
39872 default "policy". Instead it enables you to build your own policy using
39873 Exim's standard controls.
39874
39875 Please note that verification of DKIM signatures in incoming mail is turned
39876 on by default for logging (in the <= line) purposes.
39877
39878 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39879 When set, for each signature in incoming email,
39880 exim will log a line displaying the most important signature details, and the
39881 signature status. Here is an example (with line-breaks added for clarity):
39882 .code
39883 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39884     d=facebookmail.com s=q1-2009b
39885     c=relaxed/relaxed a=rsa-sha1
39886     i=@facebookmail.com t=1252484542 [verification succeeded]
39887 .endd
39888
39889 You might want to turn off DKIM verification processing entirely for internal
39890 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39891 control modifier. This should typically be done in the RCPT ACL, at points
39892 where you accept mail from relay sources (internal hosts or authenticated
39893 senders).
39894
39895
39896 .section "Signing outgoing messages" "SECDKIMSIGN"
39897 .cindex "DKIM" "signing"
39898
39899 For signing to be usable you must have published a DKIM record in DNS.
39900 Note that RFC 8301 (which does not cover EC keys) says:
39901 .code
39902 rsa-sha1 MUST NOT be used for signing or verifying.
39903
39904 Signers MUST use RSA keys of at least 1024 bits for all keys.
39905 Signers SHOULD use RSA keys of at least 2048 bits.
39906 .endd
39907
39908 Note also that the key content (the 'p=' field)
39909 in the DNS record is different between RSA and EC keys;
39910 for the former it is the base64 of the ASN.1 for the RSA public key
39911 (equivalent to the private-key .pem with the header/trailer stripped)
39912 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39913
39914 Signing is enabled by setting private options on the SMTP transport.
39915 These options take (expandable) strings as arguments.
39916
39917 .option dkim_domain smtp string list&!! unset
39918 The domain(s) you want to sign with.
39919 After expansion, this can be a list.
39920 Each element in turn,
39921 lowercased,
39922 is put into the &%$dkim_domain%& expansion variable
39923 while expanding the remaining signing options.
39924 If it is empty after expansion, DKIM signing is not done,
39925 and no error will result even if &%dkim_strict%& is set.
39926
39927 .option dkim_selector smtp string list&!! unset
39928 This sets the key selector string.
39929 After expansion, which can use &$dkim_domain$&, this can be a list.
39930 Each element in turn is put in the expansion
39931 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39932 option along with &%$dkim_domain%&.
39933 If the option is empty after expansion, DKIM signing is not done for this domain,
39934 and no error will result even if &%dkim_strict%& is set.
39935
39936 .option dkim_private_key smtp string&!! unset
39937 This sets the private key to use.
39938 You can use the &%$dkim_domain%& and
39939 &%$dkim_selector%& expansion variables to determine the private key to use.
39940 The result can either
39941 .ilist
39942 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39943 .next
39944 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39945 be a valid Ed25519 private key (same format as above)
39946 .next
39947 start with a slash, in which case it is treated as a file that contains
39948 the private key
39949 .next
39950 be "0", "false" or the empty string, in which case the message will not
39951 be signed. This case will not result in an error, even if &%dkim_strict%&
39952 is set.
39953 .endlist
39954
39955 To generate keys under OpenSSL:
39956 .code
39957 openssl genrsa -out dkim_rsa.private 2048
39958 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39959 .endd
39960 Take the base-64 lines from the output of the second command, concatenated,
39961 for the DNS TXT record.
39962 See section 3.6 of RFC6376 for the record specification.
39963
39964 Under GnuTLS:
39965 .code
39966 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39967 certtool --load-privkey=dkim_rsa.private --pubkey-info
39968 .endd
39969
39970 Note that RFC 8301 says:
39971 .code
39972 Signers MUST use RSA keys of at least 1024 bits for all keys.
39973 Signers SHOULD use RSA keys of at least 2048 bits.
39974 .endd
39975
39976 EC keys for DKIM are defined by RFC 8463.
39977 They are considerably smaller than RSA keys for equivalent protection.
39978 As they are a recent development, users should consider dual-signing
39979 (by setting a list of selectors, and an expansion for this option)
39980 for some transition period.
39981 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39982 for EC keys.
39983
39984 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39985 .code
39986 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39987 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39988 .endd
39989
39990 To produce the required public key value for a DNS record:
39991 .code
39992 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39993 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39994 .endd
39995
39996 Exim also supports an alternate format
39997 of Ed25519 keys in DNS which was a candidate during development
39998 of the standard, but not adopted.
39999 A future release will probably drop that support.
40000
40001 .option dkim_hash smtp string&!! sha256
40002 Can be set to any one of the supported hash methods, which are:
40003 .ilist
40004 &`sha1`& &-- should not be used, is old and insecure
40005 .next
40006 &`sha256`& &-- the default
40007 .next
40008 &`sha512`& &-- possibly more secure but less well supported
40009 .endlist
40010
40011 Note that RFC 8301 says:
40012 .code
40013 rsa-sha1 MUST NOT be used for signing or verifying.
40014 .endd
40015
40016 .option dkim_identity smtp string&!! unset
40017 If set after expansion, the value is used to set an "i=" tag in
40018 the signing header.  The DKIM standards restrict the permissible
40019 syntax of this optional tag to a mail address, with possibly-empty
40020 local part, an @, and a domain identical to or subdomain of the "d="
40021 tag value.  Note that Exim does not check the value.
40022
40023 .option dkim_canon smtp string&!! unset
40024 This option sets the canonicalization method used when signing a message.
40025 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40026 The option defaults to "relaxed" when unset. Note: the current implementation
40027 only supports signing with the same canonicalization method for both headers and body.
40028
40029 .option dkim_strict smtp string&!! unset
40030 This  option  defines  how  Exim  behaves  when  signing a message that
40031 should be signed fails for some reason.  When the expansion evaluates to
40032 either "1" or "true", Exim will defer. Otherwise Exim will send the message
40033 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40034 variables here.
40035
40036 .option dkim_sign_headers smtp string&!! "see below"
40037 If set, this option must expand to a colon-separated
40038 list of header names.
40039 Headers with these names, or the absence or such a header, will be included
40040 in the message signature.
40041 When unspecified, the header names listed in RFC4871 will be used,
40042 whether or not each header is present in the message.
40043 The default list is available for the expansion in the macro
40044 "_DKIM_SIGN_HEADERS".
40045
40046 If a name is repeated, multiple headers by that name (or the absence thereof)
40047 will be signed.  The textually later headers in the headers part of the
40048 message are signed first, if there are multiples.
40049
40050 A name can be prefixed with either an '=' or a '+' character.
40051 If an '=' prefix is used, all headers that are present with this name
40052 will be signed.
40053 If a '+' prefix if used, all headers that are present with this name
40054 will be signed, and one signature added for a missing header with the
40055 name will be appended.
40056
40057 .option dkim_timestamps smtp integer&!! unset
40058 This option controls the inclusion of timestamp information in the signature.
40059 If not set, no such information will be included.
40060 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40061 for the expiry tag
40062 (eg. 1209600 for two weeks);
40063 both creation (t=) and expiry (x=) tags will be included.
40064
40065 RFC 6376 lists these tags as RECOMMENDED.
40066
40067
40068 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40069 .cindex "DKIM" "verification"
40070
40071 Verification of DKIM signatures in SMTP incoming email is done for all
40072 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40073 .cindex DKIM "selecting signature algorithms"
40074 Individual classes of signature algorithm can be ignored by changing
40075 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40076 The &%dkim_verify_minimal%& option can be set to cease verification
40077 processing for a message once the first passing signature is found.
40078
40079 .cindex authentication "expansion item"
40080 Performing verification sets up information used by the
40081 &%authresults%& expansion item.
40082
40083 For most purposes the default option settings suffice and the remainder
40084 of this section can be ignored.
40085
40086 The results of verification are made available to the
40087 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40088 A missing ACL definition defaults to accept.
40089 By default, the ACL is called once for each
40090 syntactically(!) correct signature in the incoming message.
40091 If any ACL call does not accept, the message is not accepted.
40092 If a cutthrough delivery was in progress for the message, that is
40093 summarily dropped (having wasted the transmission effort).
40094
40095 To evaluate the verification result in the ACL
40096 a large number of expansion variables
40097 containing the signature status and its details are set up during the
40098 runtime of the ACL.
40099
40100 Calling the ACL only for existing signatures is not sufficient to build
40101 more advanced policies. For that reason, the main option
40102 &%dkim_verify_signers%&, and an expansion variable
40103 &%$dkim_signers%& exist.
40104
40105 The main option &%dkim_verify_signers%& can be set to a colon-separated
40106 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40107 called. It is expanded when the message has been received. At this point,
40108 the expansion variable &%$dkim_signers%& already contains a colon-separated
40109 list of signer domains and identities for the message. When
40110 &%dkim_verify_signers%& is not specified in the main configuration,
40111 it defaults as:
40112 .code
40113 dkim_verify_signers = $dkim_signers
40114 .endd
40115 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40116 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40117 call the ACL for known domains or identities. This would be achieved as follows:
40118 .code
40119 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40120 .endd
40121 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40122 and "ebay.com", plus all domains and identities that have signatures in the message.
40123 You can also be more creative in constructing your policy. For example:
40124 .code
40125 dkim_verify_signers = $sender_address_domain:$dkim_signers
40126 .endd
40127
40128 If a domain or identity is listed several times in the (expanded) value of
40129 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40130
40131 Note that if the option is set using untrustworthy data
40132 (such as the From: header)
40133 care should be taken to force lowercase for domains
40134 and for the domain part if identities.
40135 The default setting can be regarded as trustworthy in this respect.
40136
40137 If multiple signatures match a domain (or identity), the ACL is called once
40138 for each matching signature.
40139
40140
40141 Inside the DKIM ACL, the following expansion variables are
40142 available (from most to least important):
40143
40144
40145 .vlist
40146 .vitem &%$dkim_cur_signer%&
40147 The signer that is being evaluated in this ACL run. This can be a domain or
40148 an identity. This is one of the list items from the expanded main option
40149 &%dkim_verify_signers%& (see above).
40150
40151 .vitem &%$dkim_verify_status%&
40152 Within the DKIM ACL,
40153 a string describing the general status of the signature. One of
40154 .ilist
40155 &%none%&: There is no signature in the message for the current domain or
40156 identity (as reflected by &%$dkim_cur_signer%&).
40157 .next
40158 &%invalid%&: The signature could not be verified due to a processing error.
40159 More detail is available in &%$dkim_verify_reason%&.
40160 .next
40161 &%fail%&: Verification of the signature failed.  More detail is
40162 available in &%$dkim_verify_reason%&.
40163 .next
40164 &%pass%&: The signature passed verification. It is valid.
40165 .endlist
40166
40167 This variable can be overwritten using an ACL 'set' modifier.
40168 This might, for instance, be done to enforce a policy restriction on
40169 hash-method or key-size:
40170 .code
40171   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40172        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40173        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40174                                   {< {$dkim_key_length}{1024}}}}
40175        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40176        set dkim_verify_status = fail
40177        set dkim_verify_reason = hash too weak or key too short
40178 .endd
40179
40180 So long as a DKIM ACL is defined (it need do no more than accept),
40181 after all the DKIM ACL runs have completed, the value becomes a
40182 colon-separated list of the values after each run.
40183 This is maintained for the mime, prdr and data ACLs.
40184
40185 .vitem &%$dkim_verify_reason%&
40186 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40187 "fail" or "invalid". One of
40188 .ilist
40189 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40190 key for the domain could not be retrieved. This may be a temporary problem.
40191 .next
40192 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40193 record for the domain is syntactically invalid.
40194 .next
40195 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40196 body hash does not match the one specified in the signature header. This
40197 means that the message body was modified in transit.
40198 .next
40199 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40200 could not be verified. This may mean that headers were modified,
40201 re-written or otherwise changed in a way which is incompatible with
40202 DKIM verification. It may of course also mean that the signature is forged.
40203 .endlist
40204
40205 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40206
40207 .vitem &%$dkim_domain%&
40208 The signing domain. IMPORTANT: This variable is only populated if there is
40209 an actual signature in the message for the current domain or identity (as
40210 reflected by &%$dkim_cur_signer%&).
40211
40212 .vitem &%$dkim_identity%&
40213 The signing identity, if present. IMPORTANT: This variable is only populated
40214 if there is an actual signature in the message for the current domain or
40215 identity (as reflected by &%$dkim_cur_signer%&).
40216
40217 .vitem &%$dkim_selector%&
40218 The key record selector string.
40219
40220 .vitem &%$dkim_algo%&
40221 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40222 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40223 may also be 'ed25519-sha256'.
40224 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40225 for EC keys.
40226
40227 Note that RFC 8301 says:
40228 .code
40229 rsa-sha1 MUST NOT be used for signing or verifying.
40230
40231 DKIM signatures identified as having been signed with historic
40232 algorithms (currently, rsa-sha1) have permanently failed evaluation
40233 .endd
40234
40235 To enforce this you must either have a DKIM ACL which checks this variable
40236 and overwrites the &$dkim_verify_status$& variable as discussed above,
40237 or have set the main option &%dkim_verify_hashes%& to exclude
40238 processing of such signatures.
40239
40240 .vitem &%$dkim_canon_body%&
40241 The body canonicalization method. One of 'relaxed' or 'simple'.
40242
40243 .vitem &%$dkim_canon_headers%&
40244 The header canonicalization method. One of 'relaxed' or 'simple'.
40245
40246 .vitem &%$dkim_copiedheaders%&
40247 A transcript of headers and their values which are included in the signature
40248 (copied from the 'z=' tag of the signature).
40249 Note that RFC6376 requires that verification fail if the From: header is
40250 not included in the signature.  Exim does not enforce this; sites wishing
40251 strict enforcement should code the check explicitly.
40252
40253 .vitem &%$dkim_bodylength%&
40254 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40255 limit was set by the signer, "9999999999999" is returned. This makes sure
40256 that this variable always expands to an integer value.
40257 &*Note:*& The presence of the signature tag specifying a signing body length
40258 is one possible route to spoofing of valid DKIM signatures.
40259 A paranoid implementation might wish to regard signature where this variable
40260 shows less than the "no limit" return as being invalid.
40261
40262 .vitem &%$dkim_created%&
40263 UNIX timestamp reflecting the date and time when the signature was created.
40264 When this was not specified by the signer, "0" is returned.
40265
40266 .vitem &%$dkim_expires%&
40267 UNIX timestamp reflecting the date and time when the signer wants the
40268 signature to be treated as "expired". When this was not specified by the
40269 signer, "9999999999999" is returned. This makes it possible to do useful
40270 integer size comparisons against this value.
40271 Note that Exim does not check this value.
40272
40273 .vitem &%$dkim_headernames%&
40274 A colon-separated list of names of headers included in the signature.
40275
40276 .vitem &%$dkim_key_testing%&
40277 "1" if the key record has the "testing" flag set, "0" if not.
40278
40279 .vitem &%$dkim_key_nosubdomains%&
40280 "1" if the key record forbids subdomaining, "0" otherwise.
40281
40282 .vitem &%$dkim_key_srvtype%&
40283 Service type (tag s=) from the key record. Defaults to "*" if not specified
40284 in the key record.
40285
40286 .vitem &%$dkim_key_granularity%&
40287 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40288 in the key record.
40289
40290 .vitem &%$dkim_key_notes%&
40291 Notes from the key record (tag n=).
40292
40293 .vitem &%$dkim_key_length%&
40294 Number of bits in the key.
40295
40296 Note that RFC 8301 says:
40297 .code
40298 Verifiers MUST NOT consider signatures using RSA keys of
40299 less than 1024 bits as valid signatures.
40300 .endd
40301
40302 To enforce this you must have a DKIM ACL which checks this variable
40303 and overwrites the &$dkim_verify_status$& variable as discussed above.
40304 As EC keys are much smaller, the check should only do this for RSA keys.
40305
40306 .endlist
40307
40308 In addition, two ACL conditions are provided:
40309
40310 .vlist
40311 .vitem &%dkim_signers%&
40312 ACL condition that checks a colon-separated list of domains or identities
40313 for a match against the domain or identity that the ACL is currently verifying
40314 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40315 verb to a group of domains or identities. For example:
40316
40317 .code
40318 # Warn when Mail purportedly from GMail has no gmail signature
40319 warn log_message = GMail sender without gmail.com DKIM signature
40320      sender_domains = gmail.com
40321      dkim_signers = gmail.com
40322      dkim_status = none
40323 .endd
40324
40325 Note that the above does not check for a total lack of DKIM signing;
40326 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40327
40328 .vitem &%dkim_status%&
40329 ACL condition that checks a colon-separated list of possible DKIM verification
40330 results against the actual result of verification. This is typically used
40331 to restrict an ACL verb to a list of verification outcomes, for example:
40332
40333 .code
40334 deny message = Mail from Paypal with invalid/missing signature
40335      sender_domains = paypal.com:paypal.de
40336      dkim_signers = paypal.com:paypal.de
40337      dkim_status = none:invalid:fail
40338 .endd
40339
40340 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40341 see the documentation of the &%$dkim_verify_status%& expansion variable above
40342 for more information of what they mean.
40343 .endlist
40344
40345
40346
40347
40348 .section "SPF (Sender Policy Framework)" SECSPF
40349 .cindex SPF verification
40350
40351 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40352 messages with its domain in the envelope from, documented by RFC 7208.
40353 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40354 the &url(http://openspf.org).
40355 . --- 2019-10-28: still not https, open-spf.org is told to be a
40356 . --- web-archive copy of the now dead openspf.org site
40357 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40358 . --- discussion.
40359
40360 Messages sent by a system not authorised will fail checking of such assertions.
40361 This includes retransmissions done by traditional forwarders.
40362
40363 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40364 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40365 &url(https://www.libspf2.org/).
40366 There is no Exim involvement in the transmission of messages;
40367 publishing certain DNS records is all that is required.
40368
40369 For verification, an ACL condition and an expansion lookup are provided.
40370 .cindex authentication "expansion item"
40371 Performing verification sets up information used by the
40372 &%authresults%& expansion item.
40373
40374
40375 .cindex SPF "ACL condition"
40376 .cindex ACL "spf condition"
40377 The ACL condition "spf" can be used at or after the MAIL ACL.
40378 It takes as an argument a list of strings giving the outcome of the SPF check,
40379 and will succeed for any matching outcome.
40380 Valid strings are:
40381 .vlist
40382 .vitem &%pass%&
40383 The SPF check passed, the sending host is positively verified by SPF.
40384
40385 .vitem &%fail%&
40386 The SPF check failed, the sending host is NOT allowed to send mail for the
40387 domain in the envelope-from address.
40388
40389 .vitem &%softfail%&
40390 The SPF check failed, but the queried domain can't absolutely confirm that this
40391 is a forgery.
40392
40393 .vitem &%none%&
40394 The queried domain does not publish SPF records.
40395
40396 .vitem &%neutral%&
40397 The SPF check returned a "neutral" state.  This means the queried domain has
40398 published a SPF record, but wants to allow outside servers to send mail under
40399 its domain as well.  This should be treated like "none".
40400
40401 .vitem &%permerror%&
40402 This indicates a syntax error in the SPF record of the queried domain.
40403 You may deny messages when this occurs.
40404
40405 .vitem &%temperror%&
40406 This indicates a temporary error during all processing, including Exim's
40407 SPF processing.  You may defer messages when this occurs.
40408 .endlist
40409
40410 You can prefix each string with an exclamation mark to  invert
40411 its meaning,  for example  "!fail" will  match all  results but
40412 "fail".  The  string  list is  evaluated  left-to-right,  in a
40413 short-circuit fashion.
40414
40415 Example:
40416 .code
40417 deny spf = fail
40418      message = $sender_host_address is not allowed to send mail from \
40419                ${if def:sender_address_domain \
40420                     {$sender_address_domain}{$sender_helo_name}}.  \
40421                Please see http://www.open-spf.org/Why?scope=\
40422                ${if def:sender_address_domain {mfrom}{helo}};\
40423                identity=${if def:sender_address_domain \
40424                              {$sender_address}{$sender_helo_name}};\
40425                ip=$sender_host_address
40426 .endd
40427
40428 When the spf condition has run, it sets up several expansion
40429 variables:
40430
40431 .cindex SPF "verification variables"
40432 .vlist
40433 .vitem &$spf_header_comment$&
40434 .vindex &$spf_header_comment$&
40435   This contains a human-readable string describing the outcome
40436   of the SPF check. You can add it to a custom header or use
40437   it for logging purposes.
40438
40439 .vitem &$spf_received$&
40440 .vindex &$spf_received$&
40441   This contains a complete Received-SPF: header that can be
40442   added to the message. Please note that according to the SPF
40443   draft, this header must be added at the top of the header
40444   list. Please see section 10 on how you can do this.
40445
40446   Note: in case of "Best-guess" (see below), the convention is
40447   to put this string in a header called X-SPF-Guess: instead.
40448
40449 .vitem &$spf_result$&
40450 .vindex &$spf_result$&
40451   This contains the outcome of the SPF check in string form,
40452   one of pass, fail, softfail, none, neutral, permerror or
40453   temperror.
40454
40455 .vitem &$spf_result_guessed$&
40456 .vindex &$spf_result_guessed$&
40457   This boolean is true only if a best-guess operation was used
40458   and required in order to obtain a result.
40459
40460 .vitem &$spf_smtp_comment$&
40461 .vindex &$spf_smtp_comment$&
40462   This contains a string that can be used in a SMTP response
40463   to the calling party. Useful for "fail".
40464 .endlist
40465
40466
40467 .cindex SPF "ACL condition"
40468 .cindex ACL "spf_guess condition"
40469 .cindex SPF "best guess"
40470 In addition to SPF, you can also perform checks for so-called
40471 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40472 SPF, but it is supported by the same framework that enables SPF
40473 capability.
40474 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
40475 for a description of what it means.
40476 . --- 2019-10-28: still not https:
40477
40478 To access this feature, simply use the spf_guess condition in place
40479 of the spf one.  For example:
40480
40481 .code
40482 deny spf_guess = fail
40483      message = $sender_host_address doesn't look trustworthy to me
40484 .endd
40485
40486 In case you decide to reject messages based on this check, you
40487 should note that although it uses the same framework, "Best-guess"
40488 is not SPF, and therefore you should not mention SPF at all in your
40489 reject message.
40490
40491 When the spf_guess condition has run, it sets up the same expansion
40492 variables as when spf condition is run, described above.
40493
40494 Additionally, since Best-guess is not standardized, you may redefine
40495 what "Best-guess" means to you by redefining the main configuration
40496 &%spf_guess%& option.
40497 For example, the following:
40498
40499 .code
40500 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40501 .endd
40502
40503 would relax host matching rules to a broader network range.
40504
40505
40506 .cindex SPF "lookup expansion"
40507 .cindex lookup spf
40508 A lookup expansion is also available. It takes an email
40509 address as the key and an IP address
40510 (v4 or v6)
40511 as the database:
40512
40513 .code
40514   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40515 .endd
40516
40517 The lookup will return the same result strings as can appear in
40518 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40519
40520
40521
40522
40523
40524 .section DMARC SECDMARC
40525 .cindex DMARC verification
40526
40527 DMARC combines feedback from SPF, DKIM, and header From: in order
40528 to attempt to provide better indicators of the authenticity of an
40529 email.  This document does not explain the fundamentals; you
40530 should read and understand how it works by visiting the website at
40531 &url(http://www.dmarc.org/).
40532
40533 If Exim is built with DMARC support,
40534 the libopendmarc library is used.
40535
40536 For building Exim yourself, obtain the library from
40537 &url(http://sourceforge.net/projects/opendmarc/)
40538 to obtain a copy, or find it in your favorite package
40539 repository.  You will need to attend to the local/Makefile feature
40540 SUPPORT_DMARC and the associated LDFLAGS addition.
40541 This description assumes
40542 that headers will be in /usr/local/include, and that the libraries
40543 are in /usr/local/lib.
40544
40545 . subsection
40546
40547 There are three main-configuration options:
40548 .cindex DMARC "configuration options"
40549
40550 The &%dmarc_tld_file%& option
40551 .oindex &%dmarc_tld_file%&
40552 defines the location of a text file of valid
40553 top level domains the opendmarc library uses
40554 during domain parsing. Maintained by Mozilla,
40555 the most current version can be downloaded
40556 from a link at &url(https://publicsuffix.org/list/, currently pointing
40557 at https://publicsuffix.org/list/public_suffix_list.dat)
40558 See also util/renew-opendmarc-tlds.sh script.
40559 .new
40560 The default for the option is unset.
40561 If not set, DMARC processing is disabled.
40562 .wen
40563
40564
40565 The &%dmarc_history_file%& option, if set
40566 .oindex &%dmarc_history_file%&
40567 defines the location of a file to log results
40568 of dmarc verification on inbound emails. The
40569 contents are importable by the opendmarc tools
40570 which will manage the data, send out DMARC
40571 reports, and expire the data. Make sure the
40572 directory of this file is writable by the user
40573 exim runs as.
40574 The default is unset.
40575
40576 The &%dmarc_forensic_sender%& option
40577 .oindex &%dmarc_forensic_sender%&
40578 defines an alternate email address to use when sending a
40579 forensic report detailing alignment failures
40580 if a sender domain's dmarc record specifies it
40581 and you have configured Exim to send them.
40582 If set, this is expanded and used for the
40583 From: header line; the address is extracted
40584 from it and used for the envelope from.
40585 If not set (the default), the From: header is expanded from
40586 the dsn_from option, and <> is used for the
40587 envelope from.
40588
40589 . I wish we had subsections...
40590
40591 .cindex DMARC controls
40592 By default, the DMARC processing will run for any remote,
40593 non-authenticated user.  It makes sense to only verify DMARC
40594 status of messages coming from remote, untrusted sources.  You can
40595 use standard conditions such as hosts, senders, etc, to decide that
40596 DMARC verification should *not* be performed for them and disable
40597 DMARC with an ACL control modifier:
40598 .code
40599   control = dmarc_disable_verify
40600 .endd
40601 A DMARC record can also specify a "forensic address", which gives
40602 exim an email address to submit reports about failed alignment.
40603 Exim does not do this by default because in certain conditions it
40604 results in unintended information leakage (what lists a user might
40605 be subscribed to, etc).  You must configure exim to submit forensic
40606 reports to the owner of the domain.  If the DMARC record contains a
40607 forensic address and you specify the control statement below, then
40608 exim will send these forensic emails.  It is also advised that you
40609 configure a &%dmarc_forensic_sender%& because the default sender address
40610 construction might be inadequate.
40611 .code
40612   control = dmarc_enable_forensic
40613 .endd
40614 (AGAIN: You can choose not to send these forensic reports by simply
40615 not putting the dmarc_enable_forensic control line at any point in
40616 your exim config.  If you don't tell exim to send them, it will not
40617 send them.)
40618
40619 There are no options to either control.  Both must appear before
40620 the DATA acl.
40621
40622 . subsection
40623
40624 DMARC checks cam be run on incoming SMTP  messages by using the
40625 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
40626 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
40627 condition.  Putting this condition in the ACLs is required in order
40628 for a DMARC check to actually occur.  All of the variables are set
40629 up before the DATA ACL, but there is no actual DMARC check that
40630 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
40631
40632 The &"dmarc_status"& condition takes a list of strings on its
40633 right-hand side.  These strings describe recommended action based
40634 on the DMARC check.  To understand what the policy recommendations
40635 mean, refer to the DMARC website above.  Valid strings are:
40636 .display
40637 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40638 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40639 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40640 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40641 &'norecord    '& No policy section in the DMARC record for this sender domain.
40642 &'nofrom      '& Unable to determine the domain of the sender.
40643 &'temperror   '& Library error or dns error.
40644 &'off         '& The DMARC check was disabled for this email.
40645 .endd
40646 You can prefix each string with an exclamation mark to invert its
40647 meaning, for example "!accept" will match all results but
40648 "accept".  The string list is evaluated left-to-right in a
40649 short-circuit fashion.  When a string matches the outcome of the
40650 DMARC check, the condition succeeds.  If none of the listed
40651 strings matches the outcome of the DMARC check, the condition
40652 fails.
40653
40654 Of course, you can also use any other lookup method that Exim
40655 supports, including LDAP, Postgres, MySQL, etc, as long as the
40656 result is a list of colon-separated strings.
40657
40658 Performing the check sets up information used by the
40659 &%authresults%& expansion item.
40660
40661 Several expansion variables are set before the DATA ACL is
40662 processed, and you can use them in this ACL.  The following
40663 expansion variables are available:
40664
40665 .vlist
40666 .vitem &$dmarc_status$&
40667 .vindex &$dmarc_status$&
40668 .cindex DMARC result
40669 A one word status indicating what the DMARC library
40670 thinks of the email.  It is a combination of the results of
40671 DMARC record lookup and the SPF/DKIM/DMARC processing results
40672 (if a DMARC record was found).  The actual policy declared
40673 in the DMARC record is in a separate expansion variable.
40674
40675 .vitem &$dmarc_status_text$&
40676 .vindex &$dmarc_status_text$&
40677 Slightly longer, human readable status.
40678
40679 .vitem &$dmarc_used_domain$&
40680 .vindex &$dmarc_used_domain$&
40681 The domain which DMARC used to look up the DMARC policy record.
40682
40683 .vitem &$dmarc_domain_policy$&
40684 .vindex &$dmarc_domain_policy$&
40685 The policy declared in the DMARC record.  Valid values
40686 are "none", "reject" and "quarantine".  It is blank when there
40687 is any error, including no DMARC record.
40688 .endlist
40689
40690 . subsection
40691
40692 By default, Exim's DMARC configuration is intended to be
40693 non-intrusive and conservative.  To facilitate this, Exim will not
40694 create any type of logging files without explicit configuration by
40695 you, the admin.  Nor will Exim send out any emails/reports about
40696 DMARC issues without explicit configuration by you, the admin (other
40697 than typical bounce messages that may come about due to ACL
40698 processing or failure delivery issues).
40699
40700 In order to log statistics suitable to be imported by the opendmarc
40701 tools, you need to:
40702 .ilist
40703 Configure the global option &%dmarc_history_file%&
40704 .next
40705 Configure cron jobs to call the appropriate opendmarc history
40706 import scripts and truncating the dmarc_history_file
40707 .endlist
40708
40709 In order to send forensic reports, you need to:
40710 .ilist
40711 Configure the global option &%dmarc_forensic_sender%&
40712 .next
40713 Configure, somewhere before the DATA ACL, the control option to
40714 enable sending DMARC forensic reports
40715 .endlist
40716
40717 . subsection
40718
40719 Example usage:
40720 .code
40721 (RCPT ACL)
40722   warn    domains        = +local_domains
40723           hosts          = +local_hosts
40724           control        = dmarc_disable_verify
40725
40726   warn    !domains       = +screwed_up_dmarc_records
40727           control        = dmarc_enable_forensic
40728
40729   warn    condition      = (lookup if destined to mailing list)
40730           set acl_m_mailing_list = 1
40731
40732 (DATA ACL)
40733   warn    dmarc_status   = accept : none : off
40734           !authenticated = *
40735           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40736
40737   warn    dmarc_status   = !accept
40738           !authenticated = *
40739           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40740
40741   warn    dmarc_status   = quarantine
40742           !authenticated = *
40743           set $acl_m_quarantine = 1
40744           # Do something in a transport with this flag variable
40745
40746   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40747           condition      = ${if eq{$acl_m_mailing_list}{1}}
40748           message        = Messages from $dmarc_used_domain break mailing lists
40749
40750   deny    dmarc_status   = reject
40751           !authenticated = *
40752           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40753
40754   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40755 .endd
40756
40757
40758
40759
40760
40761 . ////////////////////////////////////////////////////////////////////////////
40762 . ////////////////////////////////////////////////////////////////////////////
40763
40764 .chapter "Proxies" "CHAPproxies" &&&
40765          "Proxy support"
40766 .cindex "proxy support"
40767 .cindex "proxy" "access via"
40768
40769 A proxy is an intermediate system through which communication is passed.
40770 Proxies may provide a security, availability or load-distribution function.
40771
40772
40773 .section "Inbound proxies" SECTproxyInbound
40774 .cindex proxy inbound
40775 .cindex proxy "server side"
40776 .cindex proxy "Proxy protocol"
40777 .cindex "Proxy protocol" proxy
40778
40779 Exim has support for receiving inbound SMTP connections via a proxy
40780 that uses &"Proxy Protocol"& to speak to it.
40781 To include this support, include &"SUPPORT_PROXY=yes"&
40782 in Local/Makefile.
40783
40784 It was built on the HAProxy specification, found at
40785 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40786
40787 The purpose of this facility is so that an application load balancer,
40788 such as HAProxy, can sit in front of several Exim servers
40789 to distribute load.
40790 Exim uses the local protocol communication with the proxy to obtain
40791 the remote SMTP system IP address and port information.
40792 There is no logging if a host passes or
40793 fails Proxy Protocol negotiation, but it can easily be determined and
40794 recorded in an ACL (example is below).
40795
40796 Use of a proxy is enabled by setting the &%hosts_proxy%&
40797 main configuration option to a hostlist; connections from these
40798 hosts will use Proxy Protocol.
40799 Exim supports both version 1 and version 2 of the Proxy Protocol and
40800 automatically determines which version is in use.
40801
40802 The Proxy Protocol header is the first data received on a TCP connection
40803 and is inserted before any TLS-on-connect handshake from the client; Exim
40804 negotiates TLS between Exim-as-server and the remote client, not between
40805 Exim and the proxy server.
40806
40807 The following expansion variables are usable
40808 (&"internal"& and &"external"& here refer to the interfaces
40809 of the proxy):
40810 .display
40811 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40812 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40813 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40814 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40815 &'proxy_session            '& boolean: SMTP connection via proxy
40816 .endd
40817 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40818 there was a protocol error.
40819 The variables &$sender_host_address$& and &$sender_host_port$&
40820 will have values for the actual client system, not the proxy.
40821
40822 Since the real connections are all coming from the proxy, and the
40823 per host connection tracking is done before Proxy Protocol is
40824 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40825 handle all of the parallel volume you expect per inbound proxy.
40826 With the option set so high, you lose the ability
40827 to protect your server from many connections from one IP.
40828 In order to prevent your server from overload, you
40829 need to add a per connection ratelimit to your connect ACL.
40830 A possible solution is:
40831 .display
40832   # Set max number of connections per host
40833   LIMIT   = 5
40834   # Or do some kind of IP lookup in a flat file or database
40835   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40836
40837   defer   message        = Too many connections from this IP right now
40838           ratelimit      = LIMIT / 5s / per_conn / strict
40839 .endd
40840
40841
40842
40843 .section "Outbound proxies" SECTproxySOCKS
40844 .cindex proxy outbound
40845 .cindex proxy "client side"
40846 .cindex proxy SOCKS
40847 .cindex SOCKS proxy
40848 Exim has support for sending outbound SMTP via a proxy
40849 using a protocol called SOCKS5 (defined by RFC1928).
40850 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40851 Local/Makefile.
40852
40853 Use of a proxy is enabled by setting the &%socks_proxy%& option
40854 on an smtp transport.
40855 The option value is expanded and should then be a list
40856 (colon-separated by default) of proxy specifiers.
40857 Each proxy specifier is a list
40858 (space-separated by default) where the initial element
40859 is an IP address and any subsequent elements are options.
40860
40861 Options are a string <name>=<value>.
40862 The list of options is in the following table:
40863 .display
40864 &'auth   '& authentication method
40865 &'name   '& authentication username
40866 &'pass   '& authentication password
40867 &'port   '& tcp port
40868 &'tmo    '& connection timeout
40869 &'pri    '& priority
40870 &'weight '& selection bias
40871 .endd
40872
40873 More details on each of these options follows:
40874
40875 .ilist
40876 .cindex authentication "to proxy"
40877 .cindex proxy authentication
40878 &%auth%&: Either &"none"& (default) or &"name"&.
40879 Using &"name"& selects username/password authentication per RFC 1929
40880 for access to the proxy.
40881 Default is &"none"&.
40882 .next
40883 &%name%&: sets the username for the &"name"& authentication method.
40884 Default is empty.
40885 .next
40886 &%pass%&: sets the password for the &"name"& authentication method.
40887 Default is empty.
40888 .next
40889 &%port%&: the TCP port number to use for the connection to the proxy.
40890 Default is 1080.
40891 .next
40892 &%tmo%&: sets a connection timeout in seconds for this proxy.
40893 Default is 5.
40894 .next
40895 &%pri%&: specifies a priority for the proxy within the list,
40896 higher values being tried first.
40897 The default priority is 1.
40898 .next
40899 &%weight%&: specifies a selection bias.
40900 Within a priority set servers are queried in a random fashion,
40901 weighted by this value.
40902 The default value for selection bias is 1.
40903 .endlist
40904
40905 Proxies from the list are tried according to their priority
40906 and weight settings until one responds.  The timeout for the
40907 overall connection applies to the set of proxied attempts.
40908
40909 .section Logging SECTproxyLog
40910 To log the (local) IP of a proxy in the incoming or delivery logline,
40911 add &"+proxy"& to the &%log_selector%& option.
40912 This will add a component tagged with &"PRX="& to the line.
40913
40914 . ////////////////////////////////////////////////////////////////////////////
40915 . ////////////////////////////////////////////////////////////////////////////
40916
40917 .chapter "Internationalisation" "CHAPi18n" &&&
40918          "Internationalisation""
40919 .cindex internationalisation "email address"
40920 .cindex EAI
40921 .cindex i18n
40922 .cindex utf8 "mail name handling"
40923
40924 Exim has support for Internationalised mail names.
40925 To include this it must be built with SUPPORT_I18N and the libidn library.
40926 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40927
40928 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40929 instead of it) then IDNA2008 is supported; this adds an extra library
40930 requirement, upon libidn2.
40931
40932 .section "MTA operations" SECTi18nMTA
40933 .cindex SMTPUTF8 "ESMTP option"
40934 The main configuration option &%smtputf8_advertise_hosts%& specifies
40935 a host list.  If this matches the sending host and
40936 accept_8bitmime is true (the default) then the ESMTP option
40937 SMTPUTF8 will be advertised.
40938
40939 If the sender specifies the SMTPUTF8 option on a MAIL command
40940 international handling for the message is enabled and
40941 the expansion variable &$message_smtputf8$& will have value TRUE.
40942
40943 The option &%allow_utf8_domains%& is set to true for this
40944 message. All DNS lookups are converted to a-label form
40945 whatever the setting of &%allow_utf8_domains%&
40946 when Exim is built with SUPPORT_I18N.
40947
40948 Both localparts and domain are maintained as the original
40949 UTF-8 form internally; any comparison or regular-expression use will
40950 require appropriate care.  Filenames created, eg. by
40951 the appendfile transport, will have UTF-8 names.
40952
40953 HELO names sent by the smtp transport will have any UTF-8
40954 components expanded to a-label form,
40955 and any certificate name checks will be done using the a-label
40956 form of the name.
40957
40958 .cindex log protocol
40959 .cindex SMTPUTF8 logging
40960 .cindex i18n logging
40961 Log lines and Received-by: header lines will acquire a "utf8"
40962 prefix on the protocol element, eg. utf8esmtp.
40963
40964 The following expansion operators can be used:
40965 .code
40966 ${utf8_domain_to_alabel:str}
40967 ${utf8_domain_from_alabel:str}
40968 ${utf8_localpart_to_alabel:str}
40969 ${utf8_localpart_from_alabel:str}
40970 .endd
40971
40972 .cindex utf8 "address downconversion"
40973 .cindex i18n "utf8 address downconversion"
40974 The RCPT ACL
40975 may use the following modifier:
40976 .display
40977 control = utf8_downconvert
40978 control = utf8_downconvert/<value>
40979 .endd
40980 This sets a flag requiring that addresses are converted to
40981 a-label form before smtp delivery, for use in a
40982 Message Submission Agent context.
40983 If a value is appended it may be:
40984 .display
40985 &`1  `& (default) mandatory downconversion
40986 &`0  `& no downconversion
40987 &`-1 `& if SMTPUTF8 not supported by destination host
40988 .endd
40989
40990 If mua_wrapper is set, the utf8_downconvert control
40991 is initially set to -1.
40992
40993 The smtp transport has an option &%utf8_downconvert%&.
40994 If set it must expand to one of the three values described above,
40995 and it overrides any previously set value.
40996
40997
40998 There is no explicit support for VRFY and EXPN.
40999 Configurations supporting these should inspect
41000 &$smtp_command_argument$& for an SMTPUTF8 argument.
41001
41002 There is no support for LMTP on Unix sockets.
41003 Using the "lmtp" protocol option on an smtp transport,
41004 for LMTP over TCP, should work as expected.
41005
41006 There is no support for DSN unitext handling,
41007 and no provision for converting logging from or to UTF-8.
41008
41009
41010
41011 .section "MDA operations" SECTi18nMDA
41012 To aid in constructing names suitable for IMAP folders
41013 the following expansion operator can be used:
41014 .code
41015 ${imapfolder {<string>} {<sep>} {<specials>}}
41016 .endd
41017
41018 The string is converted from the charset specified by
41019 the "headers charset" command (in a filter file)
41020 or &%headers_charset%& main configuration option (otherwise),
41021 to the
41022 modified UTF-7 encoding specified by RFC 2060,
41023 with the following exception: All occurrences of <sep>
41024 (which has to be a single character)
41025 are replaced with periods ("."), and all periods and slashes that are not
41026 <sep> and are not in the <specials> string are BASE64 encoded.
41027
41028 The third argument can be omitted, defaulting to an empty string.
41029 The second argument can be omitted, defaulting to "/".
41030
41031 This is the encoding used by Courier for Maildir names on disk, and followed
41032 by many other IMAP servers.
41033
41034 Examples:
41035 .display
41036 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41037 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41038 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41039 .endd
41040
41041 Note that the source charset setting is vital, and also that characters
41042 must be representable in UTF-16.
41043
41044
41045 . ////////////////////////////////////////////////////////////////////////////
41046 . ////////////////////////////////////////////////////////////////////////////
41047
41048 .chapter "Events" "CHAPevents" &&&
41049          "Events"
41050 .cindex events
41051
41052 The events mechanism in Exim can be used to intercept processing at a number
41053 of points.  It was originally invented to give a way to do customised logging
41054 actions (for example, to a database) but can also be used to modify some
41055 processing actions.
41056
41057 Most installations will never need to use Events.
41058 The support can be left out of a build by defining DISABLE_EVENT=yes
41059 in &_Local/Makefile_&.
41060
41061 There are two major classes of events: main and transport.
41062 The main configuration option &%event_action%& controls reception events;
41063 a transport option &%event_action%& controls delivery events.
41064
41065 Both options are a string which is expanded when the event fires.
41066 An example might look like:
41067 .cindex logging custom
41068 .code
41069 event_action = ${if eq {msg:delivery}{$event_name} \
41070 {${lookup pgsql {SELECT * FROM record_Delivery( \
41071     '${quote_pgsql:$sender_address_domain}',\
41072     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41073     '${quote_pgsql:$domain}', \
41074     '${quote_pgsql:${lc:$local_part}}', \
41075     '${quote_pgsql:$host_address}', \
41076     '${quote_pgsql:${lc:$host}}', \
41077     '${quote_pgsql:$message_exim_id}')}} \
41078 } {}}
41079 .endd
41080
41081 Events have names which correspond to the point in process at which they fire.
41082 The name is placed in the variable &$event_name$& and the event action
41083 expansion must check this, as it will be called for every possible event type.
41084
41085 .new
41086 The current list of events is:
41087 .wen
41088 .display
41089 &`dane:fail              after    transport  `& per connection
41090 &`msg:complete           after    main       `& per message
41091 &`msg:defer              after    transport  `& per message per delivery try
41092 &`msg:delivery           after    transport  `& per recipient
41093 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41094 &`msg:rcpt:defer         after    transport  `& per recipient
41095 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41096 &`msg:fail:delivery      after    transport  `& per recipient
41097 &`msg:fail:internal      after    main       `& per recipient
41098 &`tcp:connect            before   transport  `& per connection
41099 &`tcp:close              after    transport  `& per connection
41100 &`tls:cert               before   both       `& per certificate in verification chain
41101 &`smtp:connect           after    transport  `& per connection
41102 &`smtp:ehlo              after    transport  `& per connection
41103 .endd
41104 New event types may be added in future.
41105
41106 The event name is a colon-separated list, defining the type of
41107 event in a tree of possibilities.  It may be used as a list
41108 or just matched on as a whole.  There will be no spaces in the name.
41109
41110 The second column in the table above describes whether the event fires
41111 before or after the action is associates with.  Those which fire before
41112 can be used to affect that action (more on this below).
41113
41114 The third column in the table above says what section of the configuration
41115 should define the event action.
41116
41117 An additional variable, &$event_data$&, is filled with information varying
41118 with the event type:
41119 .display
41120 &`dane:fail            `& failure reason
41121 &`msg:defer            `& error string
41122 &`msg:delivery         `& smtp confirmation message
41123 &`msg:fail:internal    `& failure reason
41124 &`msg:fail:delivery    `& smtp error message
41125 &`msg:host:defer       `& error string
41126 &`msg:rcpt:host:defer  `& error string
41127 &`msg:rcpt:defer       `& error string
41128 &`tls:cert             `& verification chain depth
41129 &`smtp:connect         `& smtp banner
41130 &`smtp:ehlo            `& smtp ehlo response
41131 .endd
41132
41133 The :defer events populate one extra variable: &$event_defer_errno$&.
41134
41135 For complex operations an ACL expansion can be used in &%event_action%&
41136 however due to the multiple contexts that Exim operates in during
41137 the course of its processing:
41138 .ilist
41139 variables set in transport events will not be visible outside that
41140 transport call
41141 .next
41142 acl_m variables in a server context are lost on a new connection,
41143 and after smtp helo/ehlo/mail/starttls/rset commands
41144 .endlist
41145 Using an ACL expansion with the logwrite modifier can be
41146 a useful way of writing to the main log.
41147
41148 The expansion of the event_action option should normally
41149 return an empty string.  Should it return anything else the
41150 following will be forced:
41151 .display
41152 &`tcp:connect      `&  do not connect
41153 &`tls:cert         `&  refuse verification
41154 &`smtp:connect     `&  close connection
41155 .endd
41156 All other message types ignore the result string, and
41157 no other use is made of it.
41158
41159 For a tcp:connect event, if the connection is being made to a proxy
41160 then the address and port variables will be that of the proxy and not
41161 the target system.
41162
41163 For tls:cert events, if GnuTLS is in use this will trigger only per
41164 chain element received on the connection.
41165 For OpenSSL it will trigger for every chain element including those
41166 loaded locally.
41167
41168 . ////////////////////////////////////////////////////////////////////////////
41169 . ////////////////////////////////////////////////////////////////////////////
41170
41171 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41172          "Adding drivers or lookups"
41173 .cindex "adding drivers"
41174 .cindex "new drivers, adding"
41175 .cindex "drivers" "adding new"
41176 The following actions have to be taken in order to add a new router, transport,
41177 authenticator, or lookup type to Exim:
41178
41179 .olist
41180 Choose a name for the driver or lookup type that does not conflict with any
41181 existing name; I will use &"newdriver"& in what follows.
41182 .next
41183 Add to &_src/EDITME_& the line:
41184 .display
41185 <&'type'&>&`_NEWDRIVER=yes`&
41186 .endd
41187 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41188 code is not to be included in the binary by default, comment this line out. You
41189 should also add any relevant comments about the driver or lookup type.
41190 .next
41191 Add to &_src/config.h.defaults_& the line:
41192 .code
41193 #define <type>_NEWDRIVER
41194 .endd
41195 .next
41196 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41197 and create a table entry as is done for all the other drivers and lookup types.
41198 .next
41199 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41200 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41201 Add your &`NEWDRIVER`& to that list.
41202 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41203 simple form that most lookups have.
41204 .next
41205 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41206 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41207 driver or lookup type and add it to the definition of OBJ.
41208 .next
41209 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41210 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41211 .next
41212 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41213 &_src_&.
41214 .next
41215 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41216 as for other drivers and lookups.
41217 .endlist
41218
41219 Then all you need to do is write the code! A good way to start is to make a
41220 proforma by copying an existing module of the same type, globally changing all
41221 occurrences of the name, and cutting out most of the code. Note that any
41222 options you create must be listed in alphabetical order, because the tables are
41223 searched using a binary chop procedure.
41224
41225 There is a &_README_& file in each of the sub-directories of &_src_& describing
41226 the interface that is expected.
41227
41228
41229
41230
41231 . ////////////////////////////////////////////////////////////////////////////
41232 . ////////////////////////////////////////////////////////////////////////////
41233
41234 . /////////////////////////////////////////////////////////////////////////////
41235 . These lines are processing instructions for the Simple DocBook Processor that
41236 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41237 . PDFs than using xmlto and fop. They will be ignored by all other XML
41238 . processors.
41239 . /////////////////////////////////////////////////////////////////////////////
41240
41241 .literal xml
41242 <?sdop
41243   format="newpage"
41244   foot_right_recto="&chaptertitle;"
41245   foot_right_verso="&chaptertitle;"
41246 ?>
41247 .literal off
41248
41249 .makeindex "Options index"   "option"
41250 .makeindex "Variables index" "variable"
41251 .makeindex "Concept index"   "concept"
41252
41253
41254 . /////////////////////////////////////////////////////////////////////////////
41255 . /////////////////////////////////////////////////////////////////////////////