Docs: list further ways $domain_data &c may be filled in
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.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 2020
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part_prefix_v$&"
1403 .vindex "&$local_part$&"
1404 .vindex "&$local_part_suffix$&"
1405 .vindex "&$local_part_suffix_v$&"
1406 .cindex affix "router precondition"
1407 If the &%local_parts%& option is set, the local part of the address must be in
1408 the set of local parts that it defines. If &%local_part_prefix%& or
1409 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1410 part before this check. If you want to do precondition tests on local parts
1411 that include affixes, you can do so by using a &%condition%& option (see below)
1412 .new
1413 that uses the variables &$local_part$&, &$local_part_prefix$&,
1414 &$local_part_prefix_v$&, &$local_part_suffix$&
1415 and &$local_part_suffix_v$& as necessary.
1416 .wen
1417 .next
1418 .vindex "&$local_user_uid$&"
1419 .vindex "&$local_user_gid$&"
1420 .vindex "&$home$&"
1421 If the &%check_local_user%& option is set, the local part must be the name of
1422 an account on the local host. If this check succeeds, the uid and gid of the
1423 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1424 user's home directory is placed in &$home$&; these values can be used in the
1425 remaining preconditions.
1426 .next
1427 If the &%router_home_directory%& option is set, it is expanded at this point,
1428 because it overrides the value of &$home$&. If this expansion were left till
1429 later, the value of &$home$& as set by &%check_local_user%& would be used in
1430 subsequent tests. Having two different values of &$home$& in the same router
1431 could lead to confusion.
1432 .next
1433 If the &%senders%& option is set, the envelope sender address must be in the
1434 set of addresses that it defines.
1435 .next
1436 If the &%require_files%& option is set, the existence or non-existence of
1437 specified files is tested.
1438 .next
1439 .cindex "customizing" "precondition"
1440 If the &%condition%& option is set, it is evaluated and tested. This option
1441 uses an expanded string to allow you to set up your own custom preconditions.
1442 Expanded strings are described in chapter &<<CHAPexpand>>&.
1443 .endlist
1444
1445
1446 Note that &%require_files%& comes near the end of the list, so you cannot use
1447 it to check for the existence of a file in which to lookup up a domain, local
1448 part, or sender. However, as these options are all expanded, you can use the
1449 &%exists%& expansion condition to make such tests within each condition. The
1450 &%require_files%& option is intended for checking files that the router may be
1451 going to use internally, or which are needed by a specific transport (for
1452 example, &_.procmailrc_&).
1453
1454
1455
1456 .section "Delivery in detail" "SECID18"
1457 .cindex "delivery" "in detail"
1458 When a message is to be delivered, the sequence of events is as follows:
1459
1460 .ilist
1461 If a system-wide filter file is specified, the message is passed to it. The
1462 filter may add recipients to the message, replace the recipients, discard the
1463 message, cause a new message to be generated, or cause the message delivery to
1464 fail. The format of the system filter file is the same as for Exim user filter
1465 files, described in the separate document entitled &'Exim's interfaces to mail
1466 filtering'&.
1467 .cindex "Sieve filter" "not available for system filter"
1468 (&*Note*&: Sieve cannot be used for system filter files.)
1469
1470 Some additional features are available in system filters &-- see chapter
1471 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1472 filter only once per delivery attempt, however many recipients it has. However,
1473 if there are several delivery attempts because one or more addresses could not
1474 be immediately delivered, the system filter is run each time. The filter
1475 condition &%first_delivery%& can be used to detect the first run of the system
1476 filter.
1477 .next
1478 Each recipient address is offered to each configured router, in turn, subject to
1479 its preconditions, until one is able to handle it. If no router can handle the
1480 address, that is, if they all decline, the address is failed. Because routers
1481 can be targeted at particular domains, several locally handled domains can be
1482 processed entirely independently of each other.
1483 .next
1484 .cindex "routing" "loops in"
1485 .cindex "loop" "while routing"
1486 A router that accepts an address may assign it to a local or a remote
1487 transport. However, the transport is not run at this time. Instead, the address
1488 is placed on a list for the particular transport, which will be run later.
1489 Alternatively, the router may generate one or more new addresses (typically
1490 from alias, forward, or filter files). New addresses are fed back into this
1491 process from the top, but in order to avoid loops, a router ignores any address
1492 which has an identically-named ancestor that was processed by itself.
1493 .next
1494 When all the routing has been done, addresses that have been successfully
1495 handled are passed to their assigned transports. When local transports are
1496 doing real local deliveries, they handle only one address at a time, but if a
1497 local transport is being used as a pseudo-remote transport (for example, to
1498 collect batched SMTP messages for transmission by some other means) multiple
1499 addresses can be handled. Remote transports can always handle more than one
1500 address at a time, but can be configured not to do so, or to restrict multiple
1501 addresses to the same domain.
1502 .next
1503 Each local delivery to a file or a pipe runs in a separate process under a
1504 non-privileged uid, and these deliveries are run one at a time. Remote
1505 deliveries also run in separate processes, normally under a uid that is private
1506 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1507 run in parallel. The maximum number of simultaneous remote deliveries for any
1508 one message is set by the &%remote_max_parallel%& option.
1509 The order in which deliveries are done is not defined, except that all local
1510 deliveries happen before any remote deliveries.
1511 .next
1512 .cindex "queue runner"
1513 When it encounters a local delivery during a queue run, Exim checks its retry
1514 database to see if there has been a previous temporary delivery failure for the
1515 address before running the local transport. If there was a previous failure,
1516 Exim does not attempt a new delivery until the retry time for the address is
1517 reached. However, this happens only for delivery attempts that are part of a
1518 queue run. Local deliveries are always attempted when delivery immediately
1519 follows message reception, even if retry times are set for them. This makes for
1520 better behaviour if one particular message is causing problems (for example,
1521 causing quota overflow, or provoking an error in a filter file).
1522 .next
1523 .cindex "delivery" "retry in remote transports"
1524 Remote transports do their own retry handling, since an address may be
1525 deliverable to one of a number of hosts, each of which may have a different
1526 retry time. If there have been previous temporary failures and no host has
1527 reached its retry time, no delivery is attempted, whether in a queue run or
1528 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1529 .next
1530 If there were any permanent errors, a bounce message is returned to an
1531 appropriate address (the sender in the common case), with details of the error
1532 for each failing address. Exim can be configured to send copies of bounce
1533 messages to other addresses.
1534 .next
1535 .cindex "delivery" "deferral"
1536 If one or more addresses suffered a temporary failure, the message is left on
1537 the queue, to be tried again later. Delivery of these addresses is said to be
1538 &'deferred'&.
1539 .next
1540 When all the recipient addresses have either been delivered or bounced,
1541 handling of the message is complete. The spool files and message log are
1542 deleted, though the message log can optionally be preserved if required.
1543 .endlist
1544
1545
1546
1547
1548 .section "Retry mechanism" "SECID19"
1549 .cindex "delivery" "retry mechanism"
1550 .cindex "retry" "description of mechanism"
1551 .cindex "queue runner"
1552 Exim's mechanism for retrying messages that fail to get delivered at the first
1553 attempt is the queue runner process. You must either run an Exim daemon that
1554 uses the &%-q%& option with a time interval to start queue runners at regular
1555 intervals or use some other means (such as &'cron'&) to start them. If you do
1556 not arrange for queue runners to be run, messages that fail temporarily at the
1557 first attempt will remain in your queue forever. A queue runner process works
1558 its way through the queue, one message at a time, trying each delivery that has
1559 passed its retry time.
1560 You can run several queue runners at once.
1561
1562 Exim uses a set of configured rules to determine when next to retry the failing
1563 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1564 should give up trying to deliver to the address, at which point it generates a
1565 bounce message. If no retry rules are set for a particular host, address, and
1566 error combination, no retries are attempted, and temporary errors are treated
1567 as permanent.
1568
1569
1570
1571 .section "Temporary delivery failure" "SECID20"
1572 .cindex "delivery" "temporary failure"
1573 There are many reasons why a message may not be immediately deliverable to a
1574 particular address. Failure to connect to a remote machine (because it, or the
1575 connection to it, is down) is one of the most common. Temporary failures may be
1576 detected during routing as well as during the transport stage of delivery.
1577 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1578 is on a file system where the user is over quota. Exim can be configured to
1579 impose its own quotas on local mailboxes; where system quotas are set they will
1580 also apply.
1581
1582 If a host is unreachable for a period of time, a number of messages may be
1583 waiting for it by the time it recovers, and sending them in a single SMTP
1584 connection is clearly beneficial. Whenever a delivery to a remote host is
1585 deferred,
1586 .cindex "hints database" "deferred deliveries"
1587 Exim makes a note in its hints database, and whenever a successful
1588 SMTP delivery has happened, it looks to see if any other messages are waiting
1589 for the same host. If any are found, they are sent over the same SMTP
1590 connection, subject to a configuration limit as to the maximum number in any
1591 one connection.
1592
1593
1594
1595 .section "Permanent delivery failure" "SECID21"
1596 .cindex "delivery" "permanent failure"
1597 .cindex "bounce message" "when generated"
1598 When a message cannot be delivered to some or all of its intended recipients, a
1599 bounce message is generated. Temporary delivery failures turn into permanent
1600 errors when their timeout expires. All the addresses that fail in a given
1601 delivery attempt are listed in a single message. If the original message has
1602 many recipients, it is possible for some addresses to fail in one delivery
1603 attempt and others to fail subsequently, giving rise to more than one bounce
1604 message. The wording of bounce messages can be customized by the administrator.
1605 See chapter &<<CHAPemsgcust>>& for details.
1606
1607 .cindex "&'X-Failed-Recipients:'& header line"
1608 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1609 failed addresses, for the benefit of programs that try to analyse such messages
1610 automatically.
1611
1612 .cindex "bounce message" "recipient of"
1613 A bounce message is normally sent to the sender of the original message, as
1614 obtained from the message's envelope. For incoming SMTP messages, this is the
1615 address given in the MAIL command. However, when an address is expanded via a
1616 forward or alias file, an alternative address can be specified for delivery
1617 failures of the generated addresses. For a mailing list expansion (see section
1618 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1619 of the list.
1620
1621
1622
1623 .section "Failures to deliver bounce messages" "SECID22"
1624 .cindex "bounce message" "failure to deliver"
1625 If a bounce message (either locally generated or received from a remote host)
1626 itself suffers a permanent delivery failure, the message is left in the queue,
1627 but it is frozen, awaiting the attention of an administrator. There are options
1628 that can be used to make Exim discard such failed messages, or to keep them
1629 for only a short time (see &%timeout_frozen_after%& and
1630 &%ignore_bounce_errors_after%&).
1631
1632
1633
1634
1635
1636 . ////////////////////////////////////////////////////////////////////////////
1637 . ////////////////////////////////////////////////////////////////////////////
1638
1639 .chapter "Building and installing Exim" "CHID3"
1640 .scindex IIDbuex "building Exim"
1641
1642 .section "Unpacking" "SECID23"
1643 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1644 creates a directory with the name of the current release (for example,
1645 &_exim-&version()_&) into which the following files are placed:
1646
1647 .table2 140pt
1648 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1649 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1650   documented"
1651 .irow &_LICENCE_&         "the GNU General Public Licence"
1652 .irow &_Makefile_&        "top-level make file"
1653 .irow &_NOTICE_&          "conditions for the use of Exim"
1654 .irow &_README_&          "list of files, directories and simple build &&&
1655   instructions"
1656 .endtable
1657
1658 Other files whose names begin with &_README_& may also be present. The
1659 following subdirectories are created:
1660
1661 .table2 140pt
1662 .irow &_Local_&           "an empty directory for local configuration files"
1663 .irow &_OS_&              "OS-specific files"
1664 .irow &_doc_&             "documentation files"
1665 .irow &_exim_monitor_&    "source files for the Exim monitor"
1666 .irow &_scripts_&         "scripts used in the build process"
1667 .irow &_src_&             "remaining source files"
1668 .irow &_util_&            "independent utilities"
1669 .endtable
1670
1671 The main utility programs are contained in the &_src_& directory and are built
1672 with the Exim binary. The &_util_& directory contains a few optional scripts
1673 that may be useful to some sites.
1674
1675
1676 .section "Multiple machine architectures and operating systems" "SECID24"
1677 .cindex "building Exim" "multiple OS/architectures"
1678 The building process for Exim is arranged to make it easy to build binaries for
1679 a number of different architectures and operating systems from the same set of
1680 source files. Compilation does not take place in the &_src_& directory.
1681 Instead, a &'build directory'& is created for each architecture and operating
1682 system.
1683 .cindex "symbolic link" "to build directory"
1684 Symbolic links to the sources are installed in this directory, which is where
1685 the actual building takes place. In most cases, Exim can discover the machine
1686 architecture and operating system for itself, but the defaults can be
1687 overridden if necessary.
1688 .cindex compiler requirements
1689 .cindex compiler version
1690 A C99-capable compiler will be required for the build.
1691
1692
1693 .section "PCRE library" "SECTpcre"
1694 .cindex "PCRE library"
1695 Exim no longer has an embedded PCRE library as the vast majority of
1696 modern systems include PCRE as a system library, although you may need to
1697 install the PCRE package or the PCRE development package for your operating
1698 system. If your system has a normal PCRE installation the Exim build
1699 process will need no further configuration. If the library or the
1700 headers are in an unusual location you will need to either set the PCRE_LIBS
1701 and INCLUDE directives appropriately,
1702 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1703 If your operating system has no
1704 PCRE support then you will need to obtain and build the current PCRE
1705 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1706 More information on PCRE is available at &url(https://www.pcre.org/).
1707
1708 .section "DBM libraries" "SECTdb"
1709 .cindex "DBM libraries" "discussion of"
1710 .cindex "hints database" "DBM files used for"
1711 Even if you do not use any DBM files in your configuration, Exim still needs a
1712 DBM library in order to operate, because it uses indexed files for its hints
1713 databases. Unfortunately, there are a number of DBM libraries in existence, and
1714 different operating systems often have different ones installed.
1715
1716 .cindex "Solaris" "DBM library for"
1717 .cindex "IRIX, DBM library for"
1718 .cindex "BSD, DBM library for"
1719 .cindex "Linux, DBM library for"
1720 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1721 Linux distribution, the DBM configuration should happen automatically, and you
1722 may be able to ignore this section. Otherwise, you may have to learn more than
1723 you would like about DBM libraries from what follows.
1724
1725 .cindex "&'ndbm'& DBM library"
1726 Licensed versions of Unix normally contain a library of DBM functions operating
1727 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1728 versions of Unix seem to vary in what they contain as standard. In particular,
1729 some early versions of Linux have no default DBM library, and different
1730 distributors have chosen to bundle different libraries with their packaged
1731 versions. However, the more recent releases seem to have standardized on the
1732 Berkeley DB library.
1733
1734 Different DBM libraries have different conventions for naming the files they
1735 use. When a program opens a file called &_dbmfile_&, there are several
1736 possibilities:
1737
1738 .olist
1739 A traditional &'ndbm'& implementation, such as that supplied as part of
1740 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1741 .next
1742 .cindex "&'gdbm'& DBM library"
1743 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1744 compatibility interface it makes two different hard links to it with names
1745 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1746 filename is used unmodified.
1747 .next
1748 .cindex "Berkeley DB library"
1749 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1750 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1751 programmer exactly the same as the traditional &'ndbm'& implementation.
1752 .next
1753 If the Berkeley package is used in its native mode, it operates on a single
1754 file called &_dbmfile_&; the programmer's interface is somewhat different to
1755 the traditional &'ndbm'& interface.
1756 .next
1757 To complicate things further, there are several very different versions of the
1758 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1759 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1760 Maintenance of some of the earlier releases has ceased. All versions of
1761 Berkeley DB could be obtained from
1762 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1763 page with far newer versions listed.
1764 It is probably wise to plan to move your storage configurations away from
1765 Berkeley DB format, as today there are smaller and simpler alternatives more
1766 suited to Exim's usage model.
1767 .next
1768 .cindex "&'tdb'& DBM library"
1769 Yet another DBM library, called &'tdb'&, is available from
1770 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1771 operates on a single file.
1772 .endlist
1773
1774 .cindex "USE_DB"
1775 .cindex "DBM libraries" "configuration for building"
1776 Exim and its utilities can be compiled to use any of these interfaces. In order
1777 to use any version of the Berkeley DB package in native mode, you must set
1778 USE_DB in an appropriate configuration file (typically
1779 &_Local/Makefile_&). For example:
1780 .code
1781 USE_DB=yes
1782 .endd
1783 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1784 error is diagnosed if you set more than one of these.
1785
1786 At the lowest level, the build-time configuration sets none of these options,
1787 thereby assuming an interface of type (1). However, some operating system
1788 configuration files (for example, those for the BSD operating systems and
1789 Linux) assume type (4) by setting USE_DB as their default, and the
1790 configuration files for Cygwin set USE_GDBM. Anything you set in
1791 &_Local/Makefile_&, however, overrides these system defaults.
1792
1793 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1794 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1795 in one of these lines:
1796 .code
1797 DBMLIB = -ldb
1798 DBMLIB = -ltdb
1799 .endd
1800 Settings like that will work if the DBM library is installed in the standard
1801 place. Sometimes it is not, and the library's header file may also not be in
1802 the default path. You may need to set INCLUDE to specify where the header
1803 file is, and to specify the path to the library more fully in DBMLIB, as in
1804 this example:
1805 .code
1806 INCLUDE=-I/usr/local/include/db-4.1
1807 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1808 .endd
1809 There is further detailed discussion about the various DBM libraries in the
1810 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1811
1812
1813
1814 .section "Pre-building configuration" "SECID25"
1815 .cindex "building Exim" "pre-building configuration"
1816 .cindex "configuration for building Exim"
1817 .cindex "&_Local/Makefile_&"
1818 .cindex "&_src/EDITME_&"
1819 Before building Exim, a local configuration file that specifies options
1820 independent of any operating system has to be created with the name
1821 &_Local/Makefile_&. A template for this file is supplied as the file
1822 &_src/EDITME_&, and it contains full descriptions of all the option settings
1823 therein. These descriptions are therefore not repeated here. If you are
1824 building Exim for the first time, the simplest thing to do is to copy
1825 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1826
1827 There are three settings that you must supply, because Exim will not build
1828 without them. They are the location of the runtime configuration file
1829 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1830 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1831 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1832 a colon-separated list of filenames; Exim uses the first of them that exists.
1833
1834 There are a few other parameters that can be specified either at build time or
1835 at runtime, to enable the same binary to be used on a number of different
1836 machines. However, if the locations of Exim's spool directory and log file
1837 directory (if not within the spool directory) are fixed, it is recommended that
1838 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1839 detected early in Exim's execution (such as a malformed configuration file) can
1840 be logged.
1841
1842 .cindex "content scanning" "specifying at build time"
1843 Exim's interfaces for calling virus and spam scanning software directly from
1844 access control lists are not compiled by default. If you want to include these
1845 facilities, you need to set
1846 .code
1847 WITH_CONTENT_SCAN=yes
1848 .endd
1849 in your &_Local/Makefile_&. For details of the facilities themselves, see
1850 chapter &<<CHAPexiscan>>&.
1851
1852
1853 .cindex "&_Local/eximon.conf_&"
1854 .cindex "&_exim_monitor/EDITME_&"
1855 If you are going to build the Exim monitor, a similar configuration process is
1856 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1857 your installation and saved under the name &_Local/eximon.conf_&. If you are
1858 happy with the default settings described in &_exim_monitor/EDITME_&,
1859 &_Local/eximon.conf_& can be empty, but it must exist.
1860
1861 This is all the configuration that is needed in straightforward cases for known
1862 operating systems. However, the building process is set up so that it is easy
1863 to override options that are set by default or by operating-system-specific
1864 configuration files, for example, to change the C compiler, which
1865 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1866 do this.
1867
1868
1869
1870 .section "Support for iconv()" "SECID26"
1871 .cindex "&[iconv()]& support"
1872 .cindex "RFC 2047"
1873 The contents of header lines in messages may be encoded according to the rules
1874 described RFC 2047. This makes it possible to transmit characters that are not
1875 in the ASCII character set, and to label them as being in a particular
1876 character set. When Exim is inspecting header lines by means of the &%$h_%&
1877 mechanism, it decodes them, and translates them into a specified character set
1878 (default is set at build time). The translation is possible only if the operating system
1879 supports the &[iconv()]& function.
1880
1881 However, some of the operating systems that supply &[iconv()]& do not support
1882 very many conversions. The GNU &%libiconv%& library (available from
1883 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1884 systems to remedy this deficiency, as well as on systems that do not supply
1885 &[iconv()]& at all. After installing &%libiconv%&, you should add
1886 .code
1887 HAVE_ICONV=yes
1888 .endd
1889 to your &_Local/Makefile_& and rebuild Exim.
1890
1891
1892
1893 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1894 .cindex "TLS" "including support for TLS"
1895 .cindex "encryption" "including support for"
1896 .cindex "OpenSSL" "building Exim with"
1897 .cindex "GnuTLS" "building Exim with"
1898 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1899 command as per RFC 2487. It can also support clients that expect to
1900 start a TLS session immediately on connection to a non-standard port (see the
1901 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1902 line option).
1903
1904 If you want to build Exim with TLS support, you must first install either the
1905 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1906 implementing SSL.
1907
1908 If you do not want TLS support you should set
1909 .code
1910 DISABLE_TLS=yes
1911 .endd
1912 in &_Local/Makefile_&.
1913
1914 If OpenSSL is installed, you should set
1915 .code
1916 USE_OPENSL=yes
1917 TLS_LIBS=-lssl -lcrypto
1918 .endd
1919 in &_Local/Makefile_&. You may also need to specify the locations of the
1920 OpenSSL library and include files. For example:
1921 .code
1922 USE_OPENSSL=yes
1923 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1924 TLS_INCLUDE=-I/usr/local/openssl/include/
1925 .endd
1926 .cindex "pkg-config" "OpenSSL"
1927 If you have &'pkg-config'& available, then instead you can just use:
1928 .code
1929 USE_OPENSSL=yes
1930 USE_OPENSSL_PC=openssl
1931 .endd
1932 .cindex "USE_GNUTLS"
1933 If GnuTLS is installed, you should set
1934 .code
1935 USE_GNUTLS=yes
1936 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1937 .endd
1938 in &_Local/Makefile_&, and again you may need to specify the locations of the
1939 library and include files. For example:
1940 .code
1941 USE_GNUTLS=yes
1942 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1943 TLS_INCLUDE=-I/usr/gnu/include
1944 .endd
1945 .cindex "pkg-config" "GnuTLS"
1946 If you have &'pkg-config'& available, then instead you can just use:
1947 .code
1948 USE_GNUTLS=yes
1949 USE_GNUTLS_PC=gnutls
1950 .endd
1951
1952 You do not need to set TLS_INCLUDE if the relevant directory is already
1953 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1954 given in chapter &<<CHAPTLS>>&.
1955
1956
1957
1958
1959 .section "Use of tcpwrappers" "SECID27"
1960
1961 .cindex "tcpwrappers, building Exim to support"
1962 .cindex "USE_TCP_WRAPPERS"
1963 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1964 .cindex "tcp_wrappers_daemon_name"
1965 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1966 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1967 alternative to Exim's own checking facilities for installations that are
1968 already making use of &'tcpwrappers'& for other purposes. To do this, you
1969 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1970 &_tcpd.h_& to be available at compile time, and also ensure that the library
1971 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1972 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1973 you might have
1974 .code
1975 USE_TCP_WRAPPERS=yes
1976 CFLAGS=-O -I/usr/local/include
1977 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1978 .endd
1979 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1980 files is &"exim"&. For example, the line
1981 .code
1982 exim : LOCAL  192.168.1.  .friendly.domain.example
1983 .endd
1984 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1985 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1986 All other connections are denied. The daemon name used by &'tcpwrappers'&
1987 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1988 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1989 configure file. Consult the &'tcpwrappers'& documentation for
1990 further details.
1991
1992
1993 .section "Including support for IPv6" "SECID28"
1994 .cindex "IPv6" "including support for"
1995 Exim contains code for use on systems that have IPv6 support. Setting
1996 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1997 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1998 where the IPv6 support is not fully integrated into the normal include and
1999 library files.
2000
2001 Two different types of DNS record for handling IPv6 addresses have been
2002 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2003 currently seen as the mainstream. Another record type called A6 was proposed
2004 as better than AAAA because it had more flexibility. However, it was felt to be
2005 over-complex, and its status was reduced to &"experimental"&.
2006 Exim used to
2007 have a compile option for including A6 record support but this has now been
2008 withdrawn.
2009
2010
2011
2012 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2013 .cindex "lookup modules"
2014 .cindex "dynamic modules"
2015 .cindex ".so building"
2016 On some platforms, Exim supports not compiling all lookup types directly into
2017 the main binary, instead putting some into external modules which can be loaded
2018 on demand.
2019 This permits packagers to build Exim with support for lookups with extensive
2020 library dependencies without requiring all users to install all of those
2021 dependencies.
2022 Most, but not all, lookup types can be built this way.
2023
2024 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2025 installed; Exim will only load modules from that directory, as a security
2026 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2027 for your OS; see &_OS/Makefile-Linux_& for an example.
2028 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2029 see &_src/EDITME_& for details.
2030
2031 Then, for each module to be loaded dynamically, define the relevant
2032 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2033 For example, this will build in lsearch but load sqlite and mysql support
2034 on demand:
2035 .code
2036 LOOKUP_LSEARCH=yes
2037 LOOKUP_SQLITE=2
2038 LOOKUP_MYSQL=2
2039 .endd
2040
2041
2042 .section "The building process" "SECID29"
2043 .cindex "build directory"
2044 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2045 created, run &'make'& at the top level. It determines the architecture and
2046 operating system types, and creates a build directory if one does not exist.
2047 For example, on a Sun system running Solaris 8, the directory
2048 &_build-SunOS5-5.8-sparc_& is created.
2049 .cindex "symbolic link" "to source files"
2050 Symbolic links to relevant source files are installed in the build directory.
2051
2052 If this is the first time &'make'& has been run, it calls a script that builds
2053 a make file inside the build directory, using the configuration files from the
2054 &_Local_& directory. The new make file is then passed to another instance of
2055 &'make'&. This does the real work, building a number of utility scripts, and
2056 then compiling and linking the binaries for the Exim monitor (if configured), a
2057 number of utility programs, and finally Exim itself. The command &`make
2058 makefile`& can be used to force a rebuild of the make file in the build
2059 directory, should this ever be necessary.
2060
2061 If you have problems building Exim, check for any comments there may be in the
2062 &_README_& file concerning your operating system, and also take a look at the
2063 FAQ, where some common problems are covered.
2064
2065
2066
2067 .section 'Output from &"make"&' "SECID283"
2068 The output produced by the &'make'& process for compile lines is often very
2069 unreadable, because these lines can be very long. For this reason, the normal
2070 output is suppressed by default, and instead output similar to that which
2071 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2072 each module that is being compiled or linked. However, it is still possible to
2073 get the full output, by calling &'make'& like this:
2074 .code
2075 FULLECHO='' make -e
2076 .endd
2077 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2078 command reflection in &'make'&. When you ask for the full output, it is
2079 given in addition to the short output.
2080
2081
2082
2083 .section "Overriding build-time options for Exim" "SECToverride"
2084 .cindex "build-time options, overriding"
2085 The main make file that is created at the beginning of the building process
2086 consists of the concatenation of a number of files which set configuration
2087 values, followed by a fixed set of &'make'& instructions. If a value is set
2088 more than once, the last setting overrides any previous ones. This provides a
2089 convenient way of overriding defaults. The files that are concatenated are, in
2090 order:
2091 .display
2092 &_OS/Makefile-Default_&
2093 &_OS/Makefile-_&<&'ostype'&>
2094 &_Local/Makefile_&
2095 &_Local/Makefile-_&<&'ostype'&>
2096 &_Local/Makefile-_&<&'archtype'&>
2097 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2098 &_OS/Makefile-Base_&
2099 .endd
2100 .cindex "&_Local/Makefile_&"
2101 .cindex "building Exim" "operating system type"
2102 .cindex "building Exim" "architecture type"
2103 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2104 architecture type. &_Local/Makefile_& is required to exist, and the building
2105 process fails if it is absent. The other three &_Local_& files are optional,
2106 and are often not needed.
2107
2108 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2109 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2110 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2111 values are used, thereby providing a means of forcing particular settings.
2112 Otherwise, the scripts try to get values from the &%uname%& command. If this
2113 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2114 of &'ad hoc'& transformations are then applied, to produce the standard names
2115 that Exim expects. You can run these scripts directly from the shell in order
2116 to find out what values are being used on your system.
2117
2118
2119 &_OS/Makefile-Default_& contains comments about the variables that are set
2120 therein. Some (but not all) are mentioned below. If there is something that
2121 needs changing, review the contents of this file and the contents of the make
2122 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2123 default values are.
2124
2125
2126 .cindex "building Exim" "overriding default settings"
2127 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2128 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2129 need to change the original files. Instead, you should make the changes by
2130 putting the new values in an appropriate &_Local_& file. For example,
2131 .cindex "Tru64-Unix build-time settings"
2132 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2133 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2134 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2135 called with the option &%-std1%&, to make it recognize some of the features of
2136 Standard C that Exim uses. (Most other compilers recognize Standard C by
2137 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2138 containing the lines
2139 .code
2140 CC=cc
2141 CFLAGS=-std1
2142 .endd
2143 If you are compiling for just one operating system, it may be easier to put
2144 these lines directly into &_Local/Makefile_&.
2145
2146 Keeping all your local configuration settings separate from the distributed
2147 files makes it easy to transfer them to new versions of Exim simply by copying
2148 the contents of the &_Local_& directory.
2149
2150
2151 .cindex "NIS lookup type" "including support for"
2152 .cindex "NIS+ lookup type" "including support for"
2153 .cindex "LDAP" "including support for"
2154 .cindex "lookup" "inclusion in binary"
2155 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2156 lookup, but not all systems have these components installed, so the default is
2157 not to include the relevant code in the binary. All the different kinds of file
2158 and database lookup that Exim supports are implemented as separate code modules
2159 which are included only if the relevant compile-time options are set. In the
2160 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2161 .code
2162 LOOKUP_LDAP=yes
2163 LOOKUP_NIS=yes
2164 LOOKUP_NISPLUS=yes
2165 .endd
2166 and similar settings apply to the other lookup types. They are all listed in
2167 &_src/EDITME_&. In many cases the relevant include files and interface
2168 libraries need to be installed before compiling Exim.
2169 .cindex "cdb" "including support for"
2170 However, there are some optional lookup types (such as cdb) for which
2171 the code is entirely contained within Exim, and no external include
2172 files or libraries are required. When a lookup type is not included in the
2173 binary, attempts to configure Exim to use it cause runtime configuration
2174 errors.
2175
2176 .cindex "pkg-config" "lookups"
2177 .cindex "pkg-config" "authenticators"
2178 Many systems now use a tool called &'pkg-config'& to encapsulate information
2179 about how to compile against a library; Exim has some initial support for
2180 being able to use pkg-config for lookups and authenticators.  For any given
2181 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2182 variable with the &`_PC`& suffix in the name and assign as the value the
2183 name of the package to be queried.  The results of querying via the
2184 &'pkg-config'& command will be added to the appropriate Makefile variables
2185 with &`+=`& directives, so your version of &'make'& will need to support that
2186 syntax.  For instance:
2187 .code
2188 LOOKUP_SQLITE=yes
2189 LOOKUP_SQLITE_PC=sqlite3
2190 AUTH_GSASL=yes
2191 AUTH_GSASL_PC=libgsasl
2192 AUTH_HEIMDAL_GSSAPI=yes
2193 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2194 .endd
2195
2196 .cindex "Perl" "including support for"
2197 Exim can be linked with an embedded Perl interpreter, allowing Perl
2198 subroutines to be called during string expansion. To enable this facility,
2199 .code
2200 EXIM_PERL=perl.o
2201 .endd
2202 must be defined in &_Local/Makefile_&. Details of this facility are given in
2203 chapter &<<CHAPperl>>&.
2204
2205 .cindex "X11 libraries, location of"
2206 The location of the X11 libraries is something that varies a lot between
2207 operating systems, and there may be different versions of X11 to cope
2208 with. Exim itself makes no use of X11, but if you are compiling the Exim
2209 monitor, the X11 libraries must be available.
2210 The following three variables are set in &_OS/Makefile-Default_&:
2211 .code
2212 X11=/usr/X11R6
2213 XINCLUDE=-I$(X11)/include
2214 XLFLAGS=-L$(X11)/lib
2215 .endd
2216 These are overridden in some of the operating-system configuration files. For
2217 example, in &_OS/Makefile-SunOS5_& there is
2218 .code
2219 X11=/usr/openwin
2220 XINCLUDE=-I$(X11)/include
2221 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2222 .endd
2223 If you need to override the default setting for your operating system, place a
2224 definition of all three of these variables into your
2225 &_Local/Makefile-<ostype>_& file.
2226
2227 .cindex "EXTRALIBS"
2228 If you need to add any extra libraries to the link steps, these can be put in a
2229 variable called EXTRALIBS, which appears in all the link commands, but by
2230 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2231 command for linking the main Exim binary, and not for any associated utilities.
2232
2233 .cindex "DBM libraries" "configuration for building"
2234 There is also DBMLIB, which appears in the link commands for binaries that
2235 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2236 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2237 binary, and which can be used, for example, to include additional X11
2238 libraries.
2239
2240 .cindex "configuration file" "editing"
2241 The make file copes with rebuilding Exim correctly if any of the configuration
2242 files are edited. However, if an optional configuration file is deleted, it is
2243 necessary to touch the associated non-optional file (that is,
2244 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2245
2246
2247 .section "OS-specific header files" "SECID30"
2248 .cindex "&_os.h_&"
2249 .cindex "building Exim" "OS-specific C header files"
2250 The &_OS_& directory contains a number of files with names of the form
2251 &_os.h-<ostype>_&. These are system-specific C header files that should not
2252 normally need to be changed. There is a list of macro settings that are
2253 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2254 are porting Exim to a new operating system.
2255
2256
2257
2258 .section "Overriding build-time options for the monitor" "SECID31"
2259 .cindex "building Eximon"
2260 A similar process is used for overriding things when building the Exim monitor,
2261 where the files that are involved are
2262 .display
2263 &_OS/eximon.conf-Default_&
2264 &_OS/eximon.conf-_&<&'ostype'&>
2265 &_Local/eximon.conf_&
2266 &_Local/eximon.conf-_&<&'ostype'&>
2267 &_Local/eximon.conf-_&<&'archtype'&>
2268 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2269 .endd
2270 .cindex "&_Local/eximon.conf_&"
2271 As with Exim itself, the final three files need not exist, and in this case the
2272 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2273 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2274 variables of the same name, preceded by EXIMON_. For example, setting
2275 EXIMON_LOG_DEPTH in the environment overrides the value of
2276 LOG_DEPTH at runtime.
2277 .ecindex IIDbuex
2278
2279
2280 .section "Installing Exim binaries and scripts" "SECID32"
2281 .cindex "installing Exim"
2282 .cindex "BIN_DIRECTORY"
2283 The command &`make install`& runs the &(exim_install)& script with no
2284 arguments. The script copies binaries and utility scripts into the directory
2285 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2286 .cindex "setuid" "installing Exim with"
2287 The install script copies files only if they are newer than the files they are
2288 going to replace. The Exim binary is required to be owned by root and have the
2289 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2290 install`& as root so that it can set up the Exim binary in this way. However, in
2291 some special situations (for example, if a host is doing no local deliveries)
2292 it may be possible to run Exim without making the binary setuid root (see
2293 chapter &<<CHAPsecurity>>& for details).
2294
2295 .cindex "CONFIGURE_FILE"
2296 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2297 in &_Local/Makefile_&. If this names a single file, and the file does not
2298 exist, the default configuration file &_src/configure.default_& is copied there
2299 by the installation script. If a runtime configuration file already exists, it
2300 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2301 alternative files, no default is installed.
2302
2303 .cindex "system aliases file"
2304 .cindex "&_/etc/aliases_&"
2305 One change is made to the default configuration file when it is installed: the
2306 default configuration contains a router that references a system aliases file.
2307 The path to this file is set to the value specified by
2308 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2309 If the system aliases file does not exist, the installation script creates it,
2310 and outputs a comment to the user.
2311
2312 The created file contains no aliases, but it does contain comments about the
2313 aliases a site should normally have. Mail aliases have traditionally been
2314 kept in &_/etc/aliases_&. However, some operating systems are now using
2315 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2316 Exim's configuration if necessary.
2317
2318 The default configuration uses the local host's name as the only local domain,
2319 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2320 running as the local user. System aliases and &_.forward_& files in users' home
2321 directories are supported, but no NIS or NIS+ support is configured. Domains
2322 other than the name of the local host are routed using the DNS, with delivery
2323 over SMTP.
2324
2325 It is possible to install Exim for special purposes (such as building a binary
2326 distribution) in a private part of the file system. You can do this by a
2327 command such as
2328 .code
2329 make DESTDIR=/some/directory/ install
2330 .endd
2331 This has the effect of pre-pending the specified directory to all the file
2332 paths, except the name of the system aliases file that appears in the default
2333 configuration. (If a default alias file is created, its name &'is'& modified.)
2334 For backwards compatibility, ROOT is used if DESTDIR is not set,
2335 but this usage is deprecated.
2336
2337 .cindex "installing Exim" "what is not installed"
2338 Running &'make install'& does not copy the Exim 4 conversion script
2339 &'convert4r4'&. You will probably run this only once if you are
2340 upgrading from Exim 3. None of the documentation files in the &_doc_&
2341 directory are copied, except for the info files when you have set
2342 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2343
2344 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2345 to their names. The Exim binary itself, however, is handled differently. It is
2346 installed under a name that includes the version number and the compile number,
2347 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2348 called &_exim_& to point to the binary. If you are updating a previous version
2349 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2350 from the directory (as seen by other processes).
2351
2352 .cindex "installing Exim" "testing the script"
2353 If you want to see what the &'make install'& will do before running it for
2354 real, you can pass the &%-n%& option to the installation script by this
2355 command:
2356 .code
2357 make INSTALL_ARG=-n install
2358 .endd
2359 The contents of the variable INSTALL_ARG are passed to the installation
2360 script. You do not need to be root to run this test. Alternatively, you can run
2361 the installation script directly, but this must be from within the build
2362 directory. For example, from the top-level Exim directory you could use this
2363 command:
2364 .code
2365 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2366 .endd
2367 .cindex "installing Exim" "install script options"
2368 There are two other options that can be supplied to the installation script.
2369
2370 .ilist
2371 &%-no_chown%& bypasses the call to change the owner of the installed binary
2372 to root, and the call to make it a setuid binary.
2373 .next
2374 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2375 installed binary.
2376 .endlist
2377
2378 INSTALL_ARG can be used to pass these options to the script. For example:
2379 .code
2380 make INSTALL_ARG=-no_symlink install
2381 .endd
2382 The installation script can also be given arguments specifying which files are
2383 to be copied. For example, to install just the Exim binary, and nothing else,
2384 without creating the symbolic link, you could use:
2385 .code
2386 make INSTALL_ARG='-no_symlink exim' install
2387 .endd
2388
2389
2390
2391 .section "Installing info documentation" "SECTinsinfdoc"
2392 .cindex "installing Exim" "&'info'& documentation"
2393 Not all systems use the GNU &'info'& system for documentation, and for this
2394 reason, the Texinfo source of Exim's documentation is not included in the main
2395 distribution. Instead it is available separately from the FTP site (see section
2396 &<<SECTavail>>&).
2397
2398 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2399 source of the documentation is found in the source tree, running &`make
2400 install`& automatically builds the info files and installs them.
2401
2402
2403
2404 .section "Setting up the spool directory" "SECID33"
2405 .cindex "spool directory" "creating"
2406 When it starts up, Exim tries to create its spool directory if it does not
2407 exist. The Exim uid and gid are used for the owner and group of the spool
2408 directory. Sub-directories are automatically created in the spool directory as
2409 necessary.
2410
2411
2412
2413
2414 .section "Testing" "SECID34"
2415 .cindex "testing" "installation"
2416 Having installed Exim, you can check that the runtime configuration file is
2417 syntactically valid by running the following command, which assumes that the
2418 Exim binary directory is within your PATH environment variable:
2419 .code
2420 exim -bV
2421 .endd
2422 If there are any errors in the configuration file, Exim outputs error messages.
2423 Otherwise it outputs the version number and build date,
2424 the DBM library that is being used, and information about which drivers and
2425 other optional code modules are included in the binary.
2426 Some simple routing tests can be done by using the address testing option. For
2427 example,
2428 .display
2429 &`exim -bt`& <&'local username'&>
2430 .endd
2431 should verify that it recognizes a local mailbox, and
2432 .display
2433 &`exim -bt`& <&'remote address'&>
2434 .endd
2435 a remote one. Then try getting it to deliver mail, both locally and remotely.
2436 This can be done by passing messages directly to Exim, without going through a
2437 user agent. For example:
2438 .code
2439 exim -v postmaster@your.domain.example
2440 From: user@your.domain.example
2441 To: postmaster@your.domain.example
2442 Subject: Testing Exim
2443
2444 This is a test message.
2445 ^D
2446 .endd
2447 The &%-v%& option causes Exim to output some verification of what it is doing.
2448 In this case you should see copies of three log lines, one for the message's
2449 arrival, one for its delivery, and one containing &"Completed"&.
2450
2451 .cindex "delivery" "problems with"
2452 If you encounter problems, look at Exim's log files (&'mainlog'& and
2453 &'paniclog'&) to see if there is any relevant information there. Another source
2454 of information is running Exim with debugging turned on, by specifying the
2455 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2456 with debugging turned on by a command of the form
2457 .display
2458 &`exim -d -M`& <&'exim-message-id'&>
2459 .endd
2460 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2461 produces rather a lot of output, but you can cut this down to specific areas.
2462 For example, if you use &%-d-all+route%& only the debugging information
2463 relevant to routing is included. (See the &%-d%& option in chapter
2464 &<<CHAPcommandline>>& for more details.)
2465
2466 .cindex '&"sticky"& bit'
2467 .cindex "lock files"
2468 One specific problem that has shown up on some sites is the inability to do
2469 local deliveries into a shared mailbox directory, because it does not have the
2470 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2471 writing to a mailbox file, and if it cannot create the lock file, the delivery
2472 is deferred. You can get round this either by setting the &"sticky bit"& on the
2473 directory, or by setting a specific group for local deliveries and allowing
2474 that group to create files in the directory (see the comments above the
2475 &(local_delivery)& transport in the default configuration file). Another
2476 approach is to configure Exim not to use lock files, but just to rely on
2477 &[fcntl()]& locking instead. However, you should do this only if all user
2478 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2479 see chapter &<<CHAPappendfile>>&.
2480
2481 One thing that cannot be tested on a system that is already running an MTA is
2482 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2483 &%-oX%& option can be used to run an Exim daemon that listens on some other
2484 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2485 &'exim_checkaccess'& utility can be used to check out policy controls on
2486 incoming SMTP mail.
2487
2488 Testing a new version on a system that is already running Exim can most easily
2489 be done by building a binary with a different CONFIGURE_FILE setting. From
2490 within the runtime configuration, all other file and directory names
2491 that Exim uses can be altered, in order to keep it entirely clear of the
2492 production version.
2493
2494
2495 .section "Replacing another MTA with Exim" "SECID35"
2496 .cindex "replacing another MTA"
2497 Building and installing Exim for the first time does not of itself put it in
2498 general use. The name by which the system's MTA is called by mail user agents
2499 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2500 operating system), and it is necessary to make this name point to the &'exim'&
2501 binary in order to get the user agents to pass messages to Exim. This is
2502 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2503 or &_/usr/lib/sendmail_&
2504 .cindex "symbolic link" "to &'exim'& binary"
2505 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2506 privilege and executable status from the old MTA. It is then necessary to stop
2507 and restart the mailer daemon, if one is running.
2508
2509 .cindex "FreeBSD, MTA indirection"
2510 .cindex "&_/etc/mail/mailer.conf_&"
2511 Some operating systems have introduced alternative ways of switching MTAs. For
2512 example, if you are running FreeBSD, you need to edit the file
2513 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2514 described. A typical example of the contents of this file for running Exim is
2515 as follows:
2516 .code
2517 sendmail            /usr/exim/bin/exim
2518 send-mail           /usr/exim/bin/exim
2519 mailq               /usr/exim/bin/exim -bp
2520 newaliases          /usr/bin/true
2521 .endd
2522 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2523 your Exim installation is &"live"&. Check it by sending a message from your
2524 favourite user agent.
2525
2526 You should consider what to tell your users about the change of MTA. Exim may
2527 have different capabilities to what was previously running, and there are
2528 various operational differences such as the text of messages produced by
2529 command line options and in bounce messages. If you allow your users to make
2530 use of Exim's filtering capabilities, you should make the document entitled
2531 &'Exim's interface to mail filtering'& available to them.
2532
2533
2534
2535 .section "Upgrading Exim" "SECID36"
2536 .cindex "upgrading Exim"
2537 If you are already running Exim on your host, building and installing a new
2538 version automatically makes it available to MUAs, or any other programs that
2539 call the MTA directly. However, if you are running an Exim daemon, you do need
2540 .cindex restart "on HUP signal"
2541 .cindex signal "HUP, to restart"
2542 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2543 new binary. You do not need to stop processing mail in order to install a new
2544 version of Exim. The install script does not modify an existing runtime
2545 configuration file.
2546
2547
2548
2549
2550 .section "Stopping the Exim daemon on Solaris" "SECID37"
2551 .cindex "Solaris" "stopping Exim on"
2552 The standard command for stopping the mailer daemon on Solaris is
2553 .code
2554 /etc/init.d/sendmail stop
2555 .endd
2556 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2557 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2558 for the text &"sendmail"&; this is not present because the actual program name
2559 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2560 solution is to replace the line that finds the process id with something like
2561 .code
2562 pid=`cat /var/spool/exim/exim-daemon.pid`
2563 .endd
2564 to obtain the daemon's pid directly from the file that Exim saves it in.
2565
2566 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2567 still be received from local processes, and if automatic delivery is configured
2568 (the normal case), deliveries will still occur.
2569
2570
2571
2572
2573 . ////////////////////////////////////////////////////////////////////////////
2574 . ////////////////////////////////////////////////////////////////////////////
2575
2576 .chapter "The Exim command line" "CHAPcommandline"
2577 .scindex IIDclo1 "command line" "options"
2578 .scindex IIDclo2 "options" "command line"
2579 Exim's command line takes the standard Unix form of a sequence of options,
2580 each starting with a hyphen character, followed by a number of arguments. The
2581 options are compatible with the main options of Sendmail, and there are also
2582 some additional options, some of which are compatible with Smail 3. Certain
2583 combinations of options do not make sense, and provoke an error if used.
2584 The form of the arguments depends on which options are set.
2585
2586
2587 .section "Setting options by program name" "SECID38"
2588 .cindex "&'mailq'&"
2589 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2590 were present before any other options.
2591 The &%-bp%& option requests a listing of the contents of the mail queue on the
2592 standard output.
2593 This feature is for compatibility with some systems that contain a command of
2594 that name in one of the standard libraries, symbolically linked to
2595 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2596
2597 .cindex "&'rsmtp'&"
2598 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2599 were present before any other options, for compatibility with Smail. The
2600 &%-bS%& option is used for reading in a number of messages in batched SMTP
2601 format.
2602
2603 .cindex "&'rmail'&"
2604 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2605 &%-oee%& options were present before any other options, for compatibility with
2606 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2607
2608 .cindex "&'runq'&"
2609 .cindex "queue runner"
2610 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2611 were present before any other options, for compatibility with Smail. The &%-q%&
2612 option causes a single queue runner process to be started.
2613
2614 .cindex "&'newaliases'&"
2615 .cindex "alias file" "building"
2616 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2617 If Exim is called under the name &'newaliases'& it behaves as if the option
2618 &%-bi%& were present before any other options, for compatibility with Sendmail.
2619 This option is used for rebuilding Sendmail's alias file. Exim does not have
2620 the concept of a single alias file, but can be configured to run a given
2621 command if called with the &%-bi%& option.
2622
2623
2624 .section "Trusted and admin users" "SECTtrustedadmin"
2625 Some Exim options are available only to &'trusted users'& and others are
2626 available only to &'admin users'&. In the description below, the phrases &"Exim
2627 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2628 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2629 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2630
2631 .ilist
2632 .cindex "trusted users" "definition of"
2633 .cindex "user" "trusted definition of"
2634 The trusted users are root, the Exim user, any user listed in the
2635 &%trusted_users%& configuration option, and any user whose current group or any
2636 supplementary group is one of those listed in the &%trusted_groups%&
2637 configuration option. Note that the Exim group is not automatically trusted.
2638
2639 .cindex '&"From"& line'
2640 .cindex "envelope from"
2641 .cindex "envelope sender"
2642 Trusted users are always permitted to use the &%-f%& option or a leading
2643 &"From&~"& line to specify the envelope sender of a message that is passed to
2644 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2645 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2646 users to set envelope senders.
2647
2648 .cindex "&'From:'& header line"
2649 .cindex "&'Sender:'& header line"
2650 .cindex "header lines" "From:"
2651 .cindex "header lines" "Sender:"
2652 For a trusted user, there is never any check on the contents of the &'From:'&
2653 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2654 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2655
2656 Trusted users may also specify a host name, host address, interface address,
2657 protocol name, ident value, and authentication data when submitting a message
2658 locally. Thus, they are able to insert messages into Exim's queue locally that
2659 have the characteristics of messages received from a remote host. Untrusted
2660 users may in some circumstances use &%-f%&, but can never set the other values
2661 that are available to trusted users.
2662 .next
2663 .cindex "user" "admin definition of"
2664 .cindex "admin user" "definition of"
2665 The admin users are root, the Exim user, and any user that is a member of the
2666 Exim group or of any group listed in the &%admin_groups%& configuration option.
2667 The current group does not have to be one of these groups.
2668
2669 Admin users are permitted to list the queue, and to carry out certain
2670 operations on messages, for example, to force delivery failures. It is also
2671 necessary to be an admin user in order to see the full information provided by
2672 the Exim monitor, and full debugging output.
2673
2674 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2675 Exim to attempt delivery of messages on its queue is restricted to admin users.
2676 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2677 option false (that is, specifying &%no_prod_requires_admin%&).
2678
2679 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2680 is restricted to admin users unless &%queue_list_requires_admin%& is set
2681 false.
2682 .endlist
2683
2684
2685 &*Warning*&: If you configure your system so that admin users are able to
2686 edit Exim's configuration file, you are giving those users an easy way of
2687 getting root. There is further discussion of this issue at the start of chapter
2688 &<<CHAPconf>>&.
2689
2690
2691
2692
2693 .section "Command line options" "SECID39"
2694 Exim's command line options are described in alphabetical order below. If none
2695 of the options that specifies a specific action (such as starting the daemon or
2696 a queue runner, or testing an address, or receiving a message in a specific
2697 format, or listing the queue) are present, and there is at least one argument
2698 on the command line, &%-bm%& (accept a local message on the standard input,
2699 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2700 outputs a brief message about itself and exits.
2701
2702 . ////////////////////////////////////////////////////////////////////////////
2703 . Insert a stylized XML comment here, to identify the start of the command line
2704 . options. This is for the benefit of the Perl script that automatically
2705 . creates a man page for the options.
2706 . ////////////////////////////////////////////////////////////////////////////
2707
2708 .literal xml
2709 <!-- === Start of command line options === -->
2710 .literal off
2711
2712
2713 .vlist
2714 .vitem &%--%&
2715 .oindex "--"
2716 .cindex "options" "command line; terminating"
2717 This is a pseudo-option whose only purpose is to terminate the options and
2718 therefore to cause subsequent command line items to be treated as arguments
2719 rather than options, even if they begin with hyphens.
2720
2721 .vitem &%--help%&
2722 .oindex "&%--help%&"
2723 This option causes Exim to output a few sentences stating what it is.
2724 The same output is generated if the Exim binary is called with no options and
2725 no arguments.
2726
2727 .vitem &%--version%&
2728 .oindex "&%--version%&"
2729 This option is an alias for &%-bV%& and causes version information to be
2730 displayed.
2731
2732 .vitem &%-Ac%& &&&
2733        &%-Am%&
2734 .oindex "&%-Ac%&"
2735 .oindex "&%-Am%&"
2736 These options are used by Sendmail for selecting configuration files and are
2737 ignored by Exim.
2738
2739 .vitem &%-B%&<&'type'&>
2740 .oindex "&%-B%&"
2741 .cindex "8-bit characters"
2742 .cindex "Sendmail compatibility" "8-bit characters"
2743 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2744 clean; it ignores this option.
2745
2746 .vitem &%-bd%&
2747 .oindex "&%-bd%&"
2748 .cindex "daemon"
2749 .cindex "SMTP" "listener"
2750 .cindex "queue runner"
2751 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2752 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2753 that the daemon should also initiate periodic queue runs.
2754
2755 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2756 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2757 disconnect from the controlling terminal. When running this way, it can be
2758 stopped by pressing ctrl-C.
2759
2760 By default, Exim listens for incoming connections to the standard SMTP port on
2761 all the host's running interfaces. However, it is possible to listen on other
2762 ports, on multiple ports, and only on specific interfaces. Chapter
2763 &<<CHAPinterfaces>>& contains a description of the options that control this.
2764
2765 When a listening daemon
2766 .cindex "daemon" "process id (pid)"
2767 .cindex "pid (process id)" "of daemon"
2768 is started without the use of &%-oX%& (that is, without overriding the normal
2769 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2770 in Exim's spool directory. This location can be overridden by setting
2771 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2772 running as root.
2773
2774 When &%-oX%& is used on the command line to start a listening daemon, the
2775 process id is not written to the normal pid file path. However, &%-oP%& can be
2776 used to specify a path on the command line if a pid file is required.
2777
2778 The SIGHUP signal
2779 .cindex "SIGHUP"
2780 .cindex restart "on HUP signal"
2781 .cindex signal "HUP, to restart"
2782 .cindex "daemon" "restarting"
2783 .cindex signal "to reload configuration"
2784 .cindex daemon "reload configuration"
2785 .cindex reload configuration
2786 can be used to cause the daemon to re-execute itself. This should be done
2787 whenever Exim's configuration file, or any file that is incorporated into it by
2788 means of the &%.include%& facility, is changed, and also whenever a new version
2789 of Exim is installed. It is not necessary to do this when other files that are
2790 referenced from the configuration (for example, alias files) are changed,
2791 because these are reread each time they are used.
2792
2793 .vitem &%-bdf%&
2794 .oindex "&%-bdf%&"
2795 This option has the same effect as &%-bd%& except that it never disconnects
2796 from the controlling terminal, even when no debugging is specified.
2797
2798 .vitem &%-be%&
2799 .oindex "&%-be%&"
2800 .cindex "testing" "string expansion"
2801 .cindex "expansion" "testing"
2802 Run Exim in expansion testing mode. Exim discards its root privilege, to
2803 prevent ordinary users from using this mode to read otherwise inaccessible
2804 files. If no arguments are given, Exim runs interactively, prompting for lines
2805 of data. Otherwise, it processes each argument in turn.
2806
2807 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2808 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2809 used without command line arguments. If successful, it uses the &[readline()]&
2810 function, which provides extensive line-editing facilities, for reading the
2811 test data. A line history is supported.
2812
2813 Long expansion expressions can be split over several lines by using backslash
2814 continuations. As in Exim's runtime configuration, white space at the start of
2815 continuation lines is ignored. Each argument or data line is passed through the
2816 string expansion mechanism, and the result is output. Variable values from the
2817 configuration file (for example, &$qualify_domain$&) are available, but no
2818 message-specific values (such as &$message_exim_id$&) are set, because no message
2819 is being processed (but see &%-bem%& and &%-Mset%&).
2820
2821 &*Note*&: If you use this mechanism to test lookups, and you change the data
2822 files or databases you are using, you must exit and restart Exim before trying
2823 the same lookup again. Otherwise, because each Exim process caches the results
2824 of lookups, you will just get the same result as before.
2825
2826 Macro processing is done on lines before string-expansion: new macros can be
2827 defined and macros will be expanded.
2828 Because macros in the config file are often used for secrets, those are only
2829 available to admin users.
2830
2831 .vitem &%-bem%&&~<&'filename'&>
2832 .oindex "&%-bem%&"
2833 .cindex "testing" "string expansion"
2834 .cindex "expansion" "testing"
2835 This option operates like &%-be%& except that it must be followed by the name
2836 of a file. For example:
2837 .code
2838 exim -bem /tmp/testmessage
2839 .endd
2840 The file is read as a message (as if receiving a locally-submitted non-SMTP
2841 message) before any of the test expansions are done. Thus, message-specific
2842 variables such as &$message_size$& and &$header_from:$& are available. However,
2843 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2844 recipients are read from the headers in the normal way, and are shown in the
2845 &$recipients$& variable. Note that recipients cannot be given on the command
2846 line, because further arguments are taken as strings to expand (just like
2847 &%-be%&).
2848
2849 .vitem &%-bF%&&~<&'filename'&>
2850 .oindex "&%-bF%&"
2851 .cindex "system filter" "testing"
2852 .cindex "testing" "system filter"
2853 This option is the same as &%-bf%& except that it assumes that the filter being
2854 tested is a system filter. The additional commands that are available only in
2855 system filters are recognized.
2856
2857 .vitem &%-bf%&&~<&'filename'&>
2858 .oindex "&%-bf%&"
2859 .cindex "filter" "testing"
2860 .cindex "testing" "filter file"
2861 .cindex "forward file" "testing"
2862 .cindex "testing" "forward file"
2863 .cindex "Sieve filter" "testing"
2864 This option runs Exim in user filter testing mode; the file is the filter file
2865 to be tested, and a test message must be supplied on the standard input. If
2866 there are no message-dependent tests in the filter, an empty file can be
2867 supplied.
2868
2869 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2870 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2871 filter and a user filter in the same run. For example:
2872 .code
2873 exim -bF /system/filter -bf /user/filter </test/message
2874 .endd
2875 This is helpful when the system filter adds header lines or sets filter
2876 variables that are used by the user filter.
2877
2878 If the test filter file does not begin with one of the special lines
2879 .code
2880 # Exim filter
2881 # Sieve filter
2882 .endd
2883 it is taken to be a normal &_.forward_& file, and is tested for validity under
2884 that interpretation. See sections &<<SECTitenonfilred>>& to
2885 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2886 redirection lists.
2887
2888 The result of an Exim command that uses &%-bf%&, provided no errors are
2889 detected, is a list of the actions that Exim would try to take if presented
2890 with the message for real. More details of filter testing are given in the
2891 separate document entitled &'Exim's interfaces to mail filtering'&.
2892
2893 When testing a filter file,
2894 .cindex "&""From""& line"
2895 .cindex "envelope from"
2896 .cindex "envelope sender"
2897 .oindex "&%-f%&" "for filter testing"
2898 the envelope sender can be set by the &%-f%& option,
2899 or by a &"From&~"& line at the start of the test message. Various parameters
2900 that would normally be taken from the envelope recipient address of the message
2901 can be set by means of additional command line options (see the next four
2902 options).
2903
2904 .vitem &%-bfd%&&~<&'domain'&>
2905 .oindex "&%-bfd%&"
2906 .vindex "&$qualify_domain$&"
2907 This sets the domain of the recipient address when a filter file is being
2908 tested by means of the &%-bf%& option. The default is the value of
2909 &$qualify_domain$&.
2910
2911 .vitem &%-bfl%&&~<&'local&~part'&>
2912 .oindex "&%-bfl%&"
2913 This sets the local part of the recipient address when a filter file is being
2914 tested by means of the &%-bf%& option. The default is the username of the
2915 process that calls Exim. A local part should be specified with any prefix or
2916 suffix stripped, because that is how it appears to the filter when a message is
2917 actually being delivered.
2918
2919 .vitem &%-bfp%&&~<&'prefix'&>
2920 .oindex "&%-bfp%&"
2921 .cindex affix "filter testing"
2922 This sets the prefix of the local part of the recipient address when a filter
2923 file is being tested by means of the &%-bf%& option. The default is an empty
2924 prefix.
2925
2926 .vitem &%-bfs%&&~<&'suffix'&>
2927 .oindex "&%-bfs%&"
2928 .cindex affix "filter testing"
2929 This sets the suffix of the local part of the recipient address when a filter
2930 file is being tested by means of the &%-bf%& option. The default is an empty
2931 suffix.
2932
2933 .vitem &%-bh%&&~<&'IP&~address'&>
2934 .oindex "&%-bh%&"
2935 .cindex "testing" "incoming SMTP"
2936 .cindex "SMTP" "testing incoming"
2937 .cindex "testing" "relay control"
2938 .cindex "relaying" "testing configuration"
2939 .cindex "policy control" "testing"
2940 .cindex "debugging" "&%-bh%& option"
2941 This option runs a fake SMTP session as if from the given IP address, using the
2942 standard input and output. The IP address may include a port number at the end,
2943 after a full stop. For example:
2944 .code
2945 exim -bh 10.9.8.7.1234
2946 exim -bh fe80::a00:20ff:fe86:a061.5678
2947 .endd
2948 When an IPv6 address is given, it is converted into canonical form. In the case
2949 of the second example above, the value of &$sender_host_address$& after
2950 conversion to the canonical form is
2951 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2952
2953 Comments as to what is going on are written to the standard error file. These
2954 include lines beginning with &"LOG"& for anything that would have been logged.
2955 This facility is provided for testing configuration options for incoming
2956 messages, to make sure they implement the required policy. For example, you can
2957 test your relay controls using &%-bh%&.
2958
2959 &*Warning 1*&:
2960 .cindex "RFC 1413"
2961 You can test features of the configuration that rely on ident (RFC 1413)
2962 information by using the &%-oMt%& option. However, Exim cannot actually perform
2963 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2964 connection.
2965
2966 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2967 are also skipped when testing using &%-bh%&. If you want these callouts to
2968 occur, use &%-bhc%& instead.
2969
2970 Messages supplied during the testing session are discarded, and nothing is
2971 written to any of the real log files. There may be pauses when DNS (and other)
2972 lookups are taking place, and of course these may time out. The &%-oMi%& option
2973 can be used to specify a specific IP interface and port if this is important,
2974 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2975 session were authenticated.
2976
2977 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2978 output just states whether a given recipient address from a given host is
2979 acceptable or not. See section &<<SECTcheckaccess>>&.
2980
2981 Features such as authentication and encryption, where the client input is not
2982 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2983 specialized SMTP test program such as
2984 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2985
2986 .vitem &%-bhc%&&~<&'IP&~address'&>
2987 .oindex "&%-bhc%&"
2988 This option operates in the same way as &%-bh%&, except that address
2989 verification callouts are performed if required. This includes consulting and
2990 updating the callout cache database.
2991
2992 .vitem &%-bi%&
2993 .oindex "&%-bi%&"
2994 .cindex "alias file" "building"
2995 .cindex "building alias file"
2996 .cindex "Sendmail compatibility" "&%-bi%& option"
2997 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2998 Exim does not have the concept of a single alias file, and so it cannot mimic
2999 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3000 tend to appear in various scripts such as NIS make files, so the option must be
3001 recognized.
3002
3003 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3004 configuration option is run, under the uid and gid of the caller of Exim. If
3005 the &%-oA%& option is used, its value is passed to the command as an argument.
3006 The command set by &%bi_command%& may not contain arguments. The command can
3007 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3008 if this is required. If the &%bi_command%& option is not set, calling Exim with
3009 &%-bi%& is a no-op.
3010
3011 . // Keep :help first, then the rest in alphabetical order
3012 .vitem &%-bI:help%&
3013 .oindex "&%-bI:help%&"
3014 .cindex "querying exim information"
3015 We shall provide various options starting &`-bI:`& for querying Exim for
3016 information.  The output of many of these will be intended for machine
3017 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3018 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3019 options shall cause Exim to exit after producing the requested output.
3020
3021 .vitem &%-bI:dscp%&
3022 .oindex "&%-bI:dscp%&"
3023 .cindex "DSCP" "values"
3024 This option causes Exim to emit an alphabetically sorted list of all
3025 recognised DSCP names.
3026
3027 .vitem &%-bI:sieve%&
3028 .oindex "&%-bI:sieve%&"
3029 .cindex "Sieve filter" "capabilities"
3030 This option causes Exim to emit an alphabetically sorted list of all supported
3031 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3032 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3033 &`SIEVE`& capability response line.  As the precise list may depend upon
3034 compile-time build options, which this option will adapt to, this is the only
3035 way to guarantee a correct response.
3036
3037 .vitem &%-bm%&
3038 .oindex "&%-bm%&"
3039 .cindex "local message reception"
3040 This option runs an Exim receiving process that accepts an incoming,
3041 locally-generated message on the standard input. The recipients are given as the
3042 command arguments (except when &%-t%& is also present &-- see below). Each
3043 argument can be a comma-separated list of RFC 2822 addresses. This is the
3044 default option for selecting the overall action of an Exim call; it is assumed
3045 if no other conflicting option is present.
3046
3047 If any addresses in the message are unqualified (have no domain), they are
3048 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3049 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3050 suppressing this for special cases.
3051
3052 Policy checks on the contents of local messages can be enforced by means of
3053 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3054
3055 .cindex "return code" "for &%-bm%&"
3056 The return code is zero if the message is successfully accepted. Otherwise, the
3057 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3058
3059 The format
3060 .cindex "message" "format"
3061 .cindex "format" "message"
3062 .cindex "&""From""& line"
3063 .cindex "UUCP" "&""From""& line"
3064 .cindex "Sendmail compatibility" "&""From""& line"
3065 of the message must be as defined in RFC 2822, except that, for
3066 compatibility with Sendmail and Smail, a line in one of the forms
3067 .code
3068 From sender Fri Jan  5 12:55 GMT 1997
3069 From sender Fri, 5 Jan 97 12:55:01
3070 .endd
3071 (with the weekday optional, and possibly with additional text after the date)
3072 is permitted to appear at the start of the message. There appears to be no
3073 authoritative specification of the format of this line. Exim recognizes it by
3074 matching against the regular expression defined by the &%uucp_from_pattern%&
3075 option, which can be changed if necessary.
3076
3077 .oindex "&%-f%&" "overriding &""From""& line"
3078 The specified sender is treated as if it were given as the argument to the
3079 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3080 preference to the address taken from the message. The caller of Exim must be a
3081 trusted user for the sender of a message to be set in this way.
3082
3083 .vitem &%-bmalware%&&~<&'filename'&>
3084 .oindex "&%-bmalware%&"
3085 .cindex "testing", "malware"
3086 .cindex "malware scan test"
3087 This debugging option causes Exim to scan the given file or directory
3088 (depending on the used scanner interface),
3089 using the malware scanning framework.  The option of &%av_scanner%& influences
3090 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3091 the expansion should have defaults which apply to this invocation.  ACLs are
3092 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3093 will never be populated and &%-bmalware%& will fail.
3094
3095 Exim will have changed working directory before resolving the filename, so
3096 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3097 user when it tries to open the file, rather than as the invoking user.
3098 This option requires admin privileges.
3099
3100 The &%-bmalware%& option will not be extended to be more generally useful,
3101 there are better tools for file-scanning.  This option exists to help
3102 administrators verify their Exim and AV scanner configuration.
3103
3104 .vitem &%-bnq%&
3105 .oindex "&%-bnq%&"
3106 .cindex "address qualification, suppressing"
3107 By default, Exim automatically qualifies unqualified addresses (those
3108 without domains) that appear in messages that are submitted locally (that
3109 is, not over TCP/IP). This qualification applies both to addresses in
3110 envelopes, and addresses in header lines. Sender addresses are qualified using
3111 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3112 defaults to the value of &%qualify_domain%&).
3113
3114 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3115 being used to re-submit messages that originally came from remote hosts after
3116 content scanning, you probably do not want to qualify unqualified addresses in
3117 header lines. (Such lines will be present only if you have not enabled a header
3118 syntax check in the appropriate ACL.)
3119
3120 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3121 messages that originate on the local host. When this is used, unqualified
3122 addresses in the envelope provoke errors (causing message rejection) and
3123 unqualified addresses in header lines are left alone.
3124
3125
3126 .vitem &%-bP%&
3127 .oindex "&%-bP%&"
3128 .cindex "configuration options" "extracting"
3129 .cindex "options" "configuration &-- extracting"
3130 If this option is given with no arguments, it causes the values of all Exim's
3131 main configuration options to be written to the standard output. The values
3132 of one or more specific options can be requested by giving their names as
3133 arguments, for example:
3134 .code
3135 exim -bP qualify_domain hold_domains
3136 .endd
3137 .cindex "hiding configuration option values"
3138 .cindex "configuration options" "hiding value of"
3139 .cindex "options" "hiding value of"
3140 However, any option setting that is preceded by the word &"hide"& in the
3141 configuration file is not shown in full, except to an admin user. For other
3142 users, the output is as in this example:
3143 .code
3144 mysql_servers = <value not displayable>
3145 .endd
3146 If &%config%& is given as an argument, the config is
3147 output, as it was parsed, any include file resolved, any comment removed.
3148
3149 If &%config_file%& is given as an argument, the name of the runtime
3150 configuration file is output. (&%configure_file%& works too, for
3151 backward compatibility.)
3152 If a list of configuration files was supplied, the value that is output here
3153 is the name of the file that was actually used.
3154
3155 .cindex "options" "hiding name of"
3156 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3157 name will not be output.
3158
3159 .cindex "daemon" "process id (pid)"
3160 .cindex "pid (process id)" "of daemon"
3161 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3162 directories where log files and daemon pid files are written are output,
3163 respectively. If these values are unset, log files are written in a
3164 sub-directory of the spool directory called &%log%&, and the pid file is
3165 written directly into the spool directory.
3166
3167 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3168 .code
3169 exim -bP +local_domains
3170 .endd
3171 it searches for a matching named list of any type (domain, host, address, or
3172 local part) and outputs what it finds.
3173
3174 .cindex "options" "router &-- extracting"
3175 .cindex "options" "transport &-- extracting"
3176 .cindex "options" "authenticator &-- extracting"
3177 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3178 followed by the name of an appropriate driver instance, the option settings for
3179 that driver are output. For example:
3180 .code
3181 exim -bP transport local_delivery
3182 .endd
3183 The generic driver options are output first, followed by the driver's private
3184 options. A list of the names of drivers of a particular type can be obtained by
3185 using one of the words &%router_list%&, &%transport_list%&, or
3186 &%authenticator_list%&, and a complete list of all drivers with their option
3187 settings can be obtained by using &%routers%&, &%transports%&, or
3188 &%authenticators%&.
3189
3190 .cindex "environment"
3191 If &%environment%& is given as an argument, the set of environment
3192 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3193 variables.
3194
3195 .cindex "options" "macro &-- extracting"
3196 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3197 are available, similarly to the drivers.  Because macros are sometimes used
3198 for storing passwords, this option is restricted.
3199 The output format is one item per line.
3200 For the "-bP macro <name>" form, if no such macro is found
3201 the exit status will be nonzero.
3202
3203 .vitem &%-bp%&
3204 .oindex "&%-bp%&"
3205 .cindex "queue" "listing messages in"
3206 .cindex "listing" "messages in the queue"
3207 This option requests a listing of the contents of the mail queue on the
3208 standard output. If the &%-bp%& option is followed by a list of message ids,
3209 just those messages are listed. By default, this option can be used only by an
3210 admin user. However, the &%queue_list_requires_admin%& option can be set false
3211 to allow any user to see the queue.
3212
3213 Each message in the queue is displayed as in the following example:
3214 .code
3215 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3216           red.king@looking-glass.fict.example
3217           <other addresses>
3218 .endd
3219 .cindex "message" "size in queue listing"
3220 .cindex "size" "of message"
3221 The first line contains the length of time the message has been in the queue
3222 (in this case 25 minutes), the size of the message (2.9K), the unique local
3223 identifier for the message, and the message sender, as contained in the
3224 envelope. For bounce messages, the sender address is empty, and appears as
3225 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3226 the default sender address, the user's login name is shown in parentheses
3227 before the sender address.
3228
3229 .cindex "frozen messages" "in queue listing"
3230 If the message is frozen (attempts to deliver it are suspended) then the text
3231 &"*** frozen ***"& is displayed at the end of this line.
3232
3233 The recipients of the message (taken from the envelope, not the headers) are
3234 displayed on subsequent lines. Those addresses to which the message has already
3235 been delivered are marked with the letter D. If an original address gets
3236 expanded into several addresses via an alias or forward file, the original is
3237 displayed with a D only when deliveries for all of its child addresses are
3238 complete.
3239
3240
3241 .vitem &%-bpa%&
3242 .oindex "&%-bpa%&"
3243 This option operates like &%-bp%&, but in addition it shows delivered addresses
3244 that were generated from the original top level address(es) in each message by
3245 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3246 of just &"D"&.
3247
3248
3249 .vitem &%-bpc%&
3250 .oindex "&%-bpc%&"
3251 .cindex "queue" "count of messages on"
3252 This option counts the number of messages in the queue, and writes the total
3253 to the standard output. It is restricted to admin users, unless
3254 &%queue_list_requires_admin%& is set false.
3255
3256
3257 .vitem &%-bpr%&
3258 .oindex "&%-bpr%&"
3259 This option operates like &%-bp%&, but the output is not sorted into
3260 chronological order of message arrival. This can speed it up when there are
3261 lots of messages in the queue, and is particularly useful if the output is
3262 going to be post-processed in a way that doesn't need the sorting.
3263
3264 .vitem &%-bpra%&
3265 .oindex "&%-bpra%&"
3266 This option is a combination of &%-bpr%& and &%-bpa%&.
3267
3268 .vitem &%-bpru%&
3269 .oindex "&%-bpru%&"
3270 This option is a combination of &%-bpr%& and &%-bpu%&.
3271
3272
3273 .vitem &%-bpu%&
3274 .oindex "&%-bpu%&"
3275 This option operates like &%-bp%& but shows only undelivered top-level
3276 addresses for each message displayed. Addresses generated by aliasing or
3277 forwarding are not shown, unless the message was deferred after processing by a
3278 router with the &%one_time%& option set.
3279
3280
3281 .vitem &%-brt%&
3282 .oindex "&%-brt%&"
3283 .cindex "testing" "retry configuration"
3284 .cindex "retry" "configuration testing"
3285 This option is for testing retry rules, and it must be followed by up to three
3286 arguments. It causes Exim to look for a retry rule that matches the values
3287 and to write it to the standard output. For example:
3288 .code
3289 exim -brt bach.comp.mus.example
3290 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3291 .endd
3292 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3293 argument, which is required, can be a complete address in the form
3294 &'local_part@domain'&, or it can be just a domain name. If the second argument
3295 contains a dot, it is interpreted as an optional second domain name; if no
3296 retry rule is found for the first argument, the second is tried. This ties in
3297 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3298 rule is found that matches the host, one that matches the mail domain is
3299 sought. Finally, an argument that is the name of a specific delivery error, as
3300 used in setting up retry rules, can be given. For example:
3301 .code
3302 exim -brt haydn.comp.mus.example quota_3d
3303 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3304 .endd
3305
3306 .vitem &%-brw%&
3307 .oindex "&%-brw%&"
3308 .cindex "testing" "rewriting"
3309 .cindex "rewriting" "testing"
3310 This option is for testing address rewriting rules, and it must be followed by
3311 a single argument, consisting of either a local part without a domain, or a
3312 complete address with a fully qualified domain. Exim outputs how this address
3313 would be rewritten for each possible place it might appear. See chapter
3314 &<<CHAPrewrite>>& for further details.
3315
3316 .vitem &%-bS%&
3317 .oindex "&%-bS%&"
3318 .cindex "SMTP" "batched incoming"
3319 .cindex "batched SMTP input"
3320 This option is used for batched SMTP input, which is an alternative interface
3321 for non-interactive local message submission. A number of messages can be
3322 submitted in a single run. However, despite its name, this is not really SMTP
3323 input. Exim reads each message's envelope from SMTP commands on the standard
3324 input, but generates no responses. If the caller is trusted, or
3325 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3326 believed; otherwise the sender is always the caller of Exim.
3327
3328 The message itself is read from the standard input, in SMTP format (leading
3329 dots doubled), terminated by a line containing just a single dot. An error is
3330 provoked if the terminating dot is missing. A further message may then follow.
3331
3332 As for other local message submissions, the contents of incoming batch SMTP
3333 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3334 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3335 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3336
3337 Some other SMTP commands are recognized in the input. HELO and EHLO act
3338 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3339 QUIT quits, ignoring the rest of the standard input.
3340
3341 .cindex "return code" "for &%-bS%&"
3342 If any error is encountered, reports are written to the standard output and
3343 error streams, and Exim gives up immediately. The return code is 0 if no error
3344 was detected; it is 1 if one or more messages were accepted before the error
3345 was detected; otherwise it is 2.
3346
3347 More details of input using batched SMTP are given in section
3348 &<<SECTincomingbatchedSMTP>>&.
3349
3350 .vitem &%-bs%&
3351 .oindex "&%-bs%&"
3352 .cindex "SMTP" "local input"
3353 .cindex "local SMTP input"
3354 This option causes Exim to accept one or more messages by reading SMTP commands
3355 on the standard input, and producing SMTP replies on the standard output. SMTP
3356 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3357 Some user agents use this interface as a way of passing locally-generated
3358 messages to the MTA.
3359
3360 In
3361 .cindex "sender" "source of"
3362 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3363 set, the senders of messages are taken from the SMTP MAIL commands.
3364 Otherwise the content of these commands is ignored and the sender is set up as
3365 the calling user. Unqualified addresses are automatically qualified using
3366 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3367 &%-bnq%& option is used.
3368
3369 .cindex "inetd"
3370 The
3371 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3372 using a listening daemon. Exim can distinguish the two cases by checking
3373 whether the standard input is a TCP/IP socket. When Exim is called from
3374 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3375 above concerning senders and qualification do not apply. In this situation,
3376 Exim behaves in exactly the same way as it does when receiving a message via
3377 the listening daemon.
3378
3379 .vitem &%-bt%&
3380 .oindex "&%-bt%&"
3381 .cindex "testing" "addresses"
3382 .cindex "address" "testing"
3383 This option runs Exim in address testing mode, in which each argument is taken
3384 as a recipient address to be tested for deliverability. The results are
3385 written to the standard output. If a test fails, and the caller is not an admin
3386 user, no details of the failure are output, because these might contain
3387 sensitive information such as usernames and passwords for database lookups.
3388
3389 If no arguments are given, Exim runs in an interactive manner, prompting with a
3390 right angle bracket for addresses to be tested.
3391
3392 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3393 &[readline()]& function, because it is running as &'root'& and there are
3394 security issues.
3395
3396 Each address is handled as if it were the recipient address of a message
3397 (compare the &%-bv%& option). It is passed to the routers and the result is
3398 written to the standard output. However, any router that has
3399 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3400 genuine routing tests if your first router passes everything to a scanner
3401 program.
3402
3403 .cindex "return code" "for &%-bt%&"
3404 The return code is 2 if any address failed outright; it is 1 if no address
3405 failed outright but at least one could not be resolved for some reason. Return
3406 code 0 is given only when all addresses succeed.
3407
3408 .cindex "duplicate addresses"
3409 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3410 addresses after routing is complete, so that only one delivery takes place.
3411 This does not happen when testing with &%-bt%&; the full results of routing are
3412 always shown.
3413
3414 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3415 routers in the configuration makes any tests on the sender address of a
3416 message,
3417 .oindex "&%-f%&" "for address testing"
3418 you can use the &%-f%& option to set an appropriate sender when running
3419 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3420 default qualifying domain. However, if you have set up (for example) routers
3421 whose behaviour depends on the contents of an incoming message, you cannot test
3422 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3423 doing such tests.
3424
3425 .vitem &%-bV%&
3426 .oindex "&%-bV%&"
3427 .cindex "version number of Exim"
3428 This option causes Exim to write the current version number, compilation
3429 number, and compilation date of the &'exim'& binary to the standard output.
3430 It also lists the DBM library that is being used, the optional modules (such as
3431 specific lookup types), the drivers that are included in the binary, and the
3432 name of the runtime configuration file that is in use.
3433
3434 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3435 configuration file. However, this is a static check only. It cannot check
3436 values that are to be expanded. For example, although a misspelt ACL verb is
3437 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3438 alone to discover (for example) all the typos in the configuration; some
3439 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3440 dynamic testing facilities.
3441
3442 .vitem &%-bv%&
3443 .oindex "&%-bv%&"
3444 .cindex "verifying address" "using &%-bv%&"
3445 .cindex "address" "verification"
3446 This option runs Exim in address verification mode, in which each argument is
3447 taken as a recipient address to be verified by the routers. (This does
3448 not involve any verification callouts). During normal operation, verification
3449 happens mostly as a consequence processing a &%verify%& condition in an ACL
3450 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3451 including callouts, see the &%-bh%& and &%-bhc%& options.
3452
3453 If verification fails, and the caller is not an admin user, no details of the
3454 failure are output, because these might contain sensitive information such as
3455 usernames and passwords for database lookups.
3456
3457 If no arguments are given, Exim runs in an interactive manner, prompting with a
3458 right angle bracket for addresses to be verified.
3459
3460 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3461 &[readline()]& function, because it is running as &'exim'& and there are
3462 security issues.
3463
3464 Verification differs from address testing (the &%-bt%& option) in that routers
3465 that have &%no_verify%& set are skipped, and if the address is accepted by a
3466 router that has &%fail_verify%& set, verification fails. The address is
3467 verified as a recipient if &%-bv%& is used; to test verification for a sender
3468 address, &%-bvs%& should be used.
3469
3470 If the &%-v%& option is not set, the output consists of a single line for each
3471 address, stating whether it was verified or not, and giving a reason in the
3472 latter case. Without &%-v%&, generating more than one address by redirection
3473 causes verification to end successfully, without considering the generated
3474 addresses. However, if just one address is generated, processing continues,
3475 and the generated address must verify successfully for the overall verification
3476 to succeed.
3477
3478 When &%-v%& is set, more details are given of how the address has been handled,
3479 and in the case of address redirection, all the generated addresses are also
3480 considered. Verification may succeed for some and fail for others.
3481
3482 The
3483 .cindex "return code" "for &%-bv%&"
3484 return code is 2 if any address failed outright; it is 1 if no address
3485 failed outright but at least one could not be resolved for some reason. Return
3486 code 0 is given only when all addresses succeed.
3487
3488 If any of the routers in the configuration makes any tests on the sender
3489 address of a message, you should use the &%-f%& option to set an appropriate
3490 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3491 calling user at the default qualifying domain.
3492
3493 .vitem &%-bvs%&
3494 .oindex "&%-bvs%&"
3495 This option acts like &%-bv%&, but verifies the address as a sender rather
3496 than a recipient address. This affects any rewriting and qualification that
3497 might happen.
3498
3499 .vitem &%-bw%&
3500 .oindex "&%-bw%&"
3501 .cindex "daemon"
3502 .cindex "inetd"
3503 .cindex "inetd" "wait mode"
3504 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3505 similarly to the &%-bd%& option.  All port specifications on the command-line
3506 and in the configuration file are ignored.  Queue-running may not be specified.
3507
3508 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3509 listening for connections.  This permits the system to start up and have
3510 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3511 each port only when the first connection is received.
3512
3513 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3514 which the daemon will exit, which should cause inetd to listen once more.
3515
3516 .vitem &%-C%&&~<&'filelist'&>
3517 .oindex "&%-C%&"
3518 .cindex "configuration file" "alternate"
3519 .cindex "CONFIGURE_FILE"
3520 .cindex "alternate configuration file"
3521 This option causes Exim to find the runtime configuration file from the given
3522 list instead of from the list specified by the CONFIGURE_FILE
3523 compile-time setting. Usually, the list will consist of just a single filename,
3524 but it can be a colon-separated list of names. In this case, the first
3525 file that exists is used. Failure to open an existing file stops Exim from
3526 proceeding any further along the list, and an error is generated.
3527
3528 When this option is used by a caller other than root, and the list is different
3529 from the compiled-in list, Exim gives up its root privilege immediately, and
3530 runs with the real and effective uid and gid set to those of the caller.
3531 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3532 file contains a list of full pathnames, one per line, for configuration files
3533 which are trusted. Root privilege is retained for any configuration file so
3534 listed, as long as the caller is the Exim user (or the user specified in the
3535 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3536 not writeable by inappropriate users or groups.
3537
3538 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3539 configuration using &%-C%& right through message reception and delivery,
3540 even if the caller is root. The reception works, but by that time, Exim is
3541 running as the Exim user, so when it re-executes to regain privilege for the
3542 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3543 test reception and delivery using two separate commands (one to put a message
3544 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3545
3546 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3547 prefix string with which any file named in a &%-C%& command line option
3548 must start. In addition, the filename must not contain the sequence &`/../`&.
3549 However, if the value of the &%-C%& option is identical to the value of
3550 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3551 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3552 unset, any filename can be used with &%-C%&.
3553
3554 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3555 to a directory to which only root has access. This prevents someone who has
3556 broken into the Exim account from running a privileged Exim with an arbitrary
3557 configuration file.
3558
3559 The &%-C%& facility is useful for ensuring that configuration files are
3560 syntactically correct, but cannot be used for test deliveries, unless the
3561 caller is privileged, or unless it is an exotic configuration that does not
3562 require privilege. No check is made on the owner or group of the files
3563 specified by this option.
3564
3565
3566 .vitem &%-D%&<&'macro'&>=<&'value'&>
3567 .oindex "&%-D%&"
3568 .cindex "macro" "setting on command line"
3569 This option can be used to override macro definitions in the configuration file
3570 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3571 unprivileged caller, it causes Exim to give up its root privilege.
3572 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3573 completely disabled, and its use causes an immediate error exit.
3574
3575 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3576 colon-separated list of macros which are considered safe and, if &%-D%& only
3577 supplies macros from this list, and the values are acceptable, then Exim will
3578 not give up root privilege if the caller is root, the Exim run-time user, or
3579 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3580 to be removed in the future.  Acceptable values for the macros satisfy the
3581 regexp: &`^[A-Za-z0-9_/.-]*$`&
3582
3583 The entire option (including equals sign if present) must all be within one
3584 command line item. &%-D%& can be used to set the value of a macro to the empty
3585 string, in which case the equals sign is optional. These two commands are
3586 synonymous:
3587 .code
3588 exim -DABC  ...
3589 exim -DABC= ...
3590 .endd
3591 To include spaces in a macro definition item, quotes must be used. If you use
3592 quotes, spaces are permitted around the macro name and the equals sign. For
3593 example:
3594 .code
3595 exim '-D ABC = something' ...
3596 .endd
3597 &%-D%& may be repeated up to 10 times on a command line.
3598 Only macro names up to 22 letters long can be set.
3599
3600
3601 .vitem &%-d%&<&'debug&~options'&>
3602 .oindex "&%-d%&"
3603 .cindex "debugging" "list of selectors"
3604 .cindex "debugging" "&%-d%& option"
3605 This option causes debugging information to be written to the standard
3606 error stream. It is restricted to admin users because debugging output may show
3607 database queries that contain password information. Also, the details of users'
3608 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3609 writes an error message to the standard error stream and exits with a non-zero
3610 return code.
3611
3612 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3613 standard debugging data is output. This can be reduced, or increased to include
3614 some more rarely needed information, by directly following &%-d%& with a string
3615 made up of names preceded by plus or minus characters. These add or remove sets
3616 of debugging data, respectively. For example, &%-d+filter%& adds filter
3617 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3618 no spaces are allowed in the debug setting. The available debugging categories
3619 are:
3620 .display
3621 &`acl            `& ACL interpretation
3622 &`auth           `& authenticators
3623 &`deliver        `& general delivery logic
3624 &`dns            `& DNS lookups (see also resolver)
3625 &`dnsbl          `& DNS black list (aka RBL) code
3626 &`exec           `& arguments for &[execv()]& calls
3627 &`expand         `& detailed debugging for string expansions
3628 &`filter         `& filter handling
3629 &`hints_lookup   `& hints data lookups
3630 &`host_lookup    `& all types of name-to-IP address handling
3631 &`ident          `& ident lookup
3632 &`interface      `& lists of local interfaces
3633 &`lists          `& matching things in lists
3634 &`load           `& system load checks
3635 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3636                     &<<CHAPlocalscan>>&)
3637 &`lookup         `& general lookup code and all lookups
3638 &`memory         `& memory handling
3639 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3640 &`pid            `& modifier: add pid to debug output lines
3641 &`process_info   `& setting info for the process log
3642 &`queue_run      `& queue runs
3643 &`receive        `& general message reception logic
3644 &`resolver       `& turn on the DNS resolver's debugging output
3645 &`retry          `& retry handling
3646 &`rewrite        `& address rewriting
3647 &`route          `& address routing
3648 &`timestamp      `& modifier: add timestamp to debug output lines
3649 &`tls            `& TLS logic
3650 &`transport      `& transports
3651 &`uid            `& changes of uid/gid and looking up uid/gid
3652 &`verify         `& address verification logic
3653 &`all            `& almost all of the above (see below), and also &%-v%&
3654 .endd
3655 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3656 for &`-all`&. The reason for this is that &`+all`& is something that people
3657 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3658 is included, an awful lot of output that is very rarely of interest is
3659 generated, so it now has to be explicitly requested. However, &`-all`& does
3660 turn everything off.
3661
3662 .cindex "resolver, debugging output"
3663 .cindex "DNS resolver, debugging output"
3664 The &`resolver`& option produces output only if the DNS resolver was compiled
3665 with DEBUG enabled. This is not the case in some operating systems. Also,
3666 unfortunately, debugging output from the DNS resolver is written to stdout
3667 rather than stderr.
3668
3669 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3670 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3671 However, the &`pid`& selector is forced when debugging is turned on for a
3672 daemon, which then passes it on to any re-executed Exims. Exim also
3673 automatically adds the pid to debug lines when several remote deliveries are
3674 run in parallel.
3675
3676 The &`timestamp`& selector causes the current time to be inserted at the start
3677 of all debug output lines. This can be useful when trying to track down delays
3678 in processing.
3679
3680 .cindex debugging "UTF-8 in"
3681 .cindex UTF-8 "in debug output"
3682 The &`noutf8`& selector disables the use of
3683 UTF-8 line-drawing characters to group related information.
3684 When disabled. ascii-art is used instead.
3685 Using the &`+all`& option does not set this modifier,
3686
3687 If the &%debug_print%& option is set in any driver, it produces output whenever
3688 any debugging is selected, or if &%-v%& is used.
3689
3690 .vitem &%-dd%&<&'debug&~options'&>
3691 .oindex "&%-dd%&"
3692 This option behaves exactly like &%-d%& except when used on a command that
3693 starts a daemon process. In that case, debugging is turned off for the
3694 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3695 behaviour of the daemon without creating as much output as full debugging does.
3696
3697 .vitem &%-dropcr%&
3698 .oindex "&%-dropcr%&"
3699 This is an obsolete option that is now a no-op. It used to affect the way Exim
3700 handled CR and LF characters in incoming messages. What happens now is
3701 described in section &<<SECTlineendings>>&.
3702
3703 .vitem &%-E%&
3704 .oindex "&%-E%&"
3705 .cindex "bounce message" "generating"
3706 This option specifies that an incoming message is a locally-generated delivery
3707 failure report. It is used internally by Exim when handling delivery failures
3708 and is not intended for external use. Its only effect is to stop Exim
3709 generating certain messages to the postmaster, as otherwise message cascades
3710 could occur in some situations. As part of the same option, a message id may
3711 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3712 new message contains the id, following &"R="&, as a cross-reference.
3713
3714 .vitem &%-e%&&'x'&
3715 .oindex "&%-e%&&'x'&"
3716 There are a number of Sendmail options starting with &%-oe%& which seem to be
3717 called by various programs without the leading &%o%& in the option. For
3718 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3719 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3720
3721 .vitem &%-F%&&~<&'string'&>
3722 .oindex "&%-F%&"
3723 .cindex "sender" "name"
3724 .cindex "name" "of sender"
3725 This option sets the sender's full name for use when a locally-generated
3726 message is being accepted. In the absence of this option, the user's &'gecos'&
3727 entry from the password data is used. As users are generally permitted to alter
3728 their &'gecos'& entries, no security considerations are involved. White space
3729 between &%-F%& and the <&'string'&> is optional.
3730
3731 .vitem &%-f%&&~<&'address'&>
3732 .oindex "&%-f%&"
3733 .cindex "sender" "address"
3734 .cindex "address" "sender"
3735 .cindex "trusted users"
3736 .cindex "envelope from"
3737 .cindex "envelope sender"
3738 .cindex "user" "trusted"
3739 This option sets the address of the envelope sender of a locally-generated
3740 message (also known as the return path). The option can normally be used only
3741 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3742 users to use it.
3743
3744 Processes running as root or the Exim user are always trusted. Other
3745 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3746 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3747 of a local message is set to the caller's login name at the default qualify
3748 domain.
3749
3750 There is one exception to the restriction on the use of &%-f%&: an empty sender
3751 can be specified by any user, trusted or not, to create a message that can
3752 never provoke a bounce. An empty sender can be specified either as an empty
3753 string, or as a pair of angle brackets with nothing between them, as in these
3754 examples of shell commands:
3755 .code
3756 exim -f '<>' user@domain
3757 exim -f "" user@domain
3758 .endd
3759 In addition, the use of &%-f%& is not restricted when testing a filter file
3760 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3761 &%-bv%& options.
3762
3763 Allowing untrusted users to change the sender address does not of itself make
3764 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3765 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3766 though this can be overridden by setting &%no_local_from_check%&.
3767
3768 White
3769 .cindex "&""From""& line"
3770 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3771 given as two arguments or one combined argument). The sender of a
3772 locally-generated message can also be set (when permitted) by an initial
3773 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3774 if &%-f%& is also present, it overrides &"From&~"&.
3775
3776 .vitem &%-G%&
3777 .oindex "&%-G%&"
3778 .cindex "submission fixups, suppressing (command-line)"
3779 This option is equivalent to an ACL applying:
3780 .code
3781 control = suppress_local_fixups
3782 .endd
3783 for every message received.  Note that Sendmail will complain about such
3784 bad formatting, where Exim silently just does not fix it up.  This may change
3785 in future.
3786
3787 As this affects audit information, the caller must be a trusted user to use
3788 this option.
3789
3790 .vitem &%-h%&&~<&'number'&>
3791 .oindex "&%-h%&"
3792 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3793 This option is accepted for compatibility with Sendmail, but has no effect. (In
3794 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3795 headers.)
3796
3797 .vitem &%-i%&
3798 .oindex "&%-i%&"
3799 .cindex "Solaris" "&'mail'& command"
3800 .cindex "dot" "in incoming non-SMTP message"
3801 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3802 line by itself should not terminate an incoming, non-SMTP message. I can find
3803 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3804 command in Solaris 2.4 uses it. See also &%-ti%&.
3805
3806 .vitem &%-L%&&~<&'tag'&>
3807 .oindex "&%-L%&"
3808 .cindex "syslog" "process name; set with flag"
3809 This option is equivalent to setting &%syslog_processname%& in the config
3810 file and setting &%log_file_path%& to &`syslog`&.
3811 Its use is restricted to administrators.  The configuration file has to be
3812 read and parsed, to determine access rights, before this is set and takes
3813 effect, so early configuration file errors will not honour this flag.
3814
3815 The tag should not be longer than 32 characters.
3816
3817 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3818 .oindex "&%-M%&"
3819 .cindex "forcing delivery"
3820 .cindex "delivery" "forcing attempt"
3821 .cindex "frozen messages" "forcing delivery"
3822 This option requests Exim to run a delivery attempt on each message in turn. If
3823 any of the messages are frozen, they are automatically thawed before the
3824 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3825 and &%hold_domains%& are ignored.
3826
3827 Retry
3828 .cindex "hints database" "overriding retry hints"
3829 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3830 the normal retry time has not yet been reached. This option requires the caller
3831 to be an admin user. However, there is an option called &%prod_requires_admin%&
3832 which can be set false to relax this restriction (and also the same requirement
3833 for the &%-q%&, &%-R%&, and &%-S%& options).
3834
3835 The deliveries happen synchronously, that is, the original Exim process does
3836 not terminate until all the delivery attempts have finished. No output is
3837 produced unless there is a serious error. If you want to see what is happening,
3838 use the &%-v%& option as well, or inspect Exim's main log.
3839
3840 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3841 .oindex "&%-Mar%&"
3842 .cindex "message" "adding recipients"
3843 .cindex "recipient" "adding"
3844 This option requests Exim to add the addresses to the list of recipients of the
3845 message (&"ar"& for &"add recipients"&). The first argument must be a message
3846 id, and the remaining ones must be email addresses. However, if the message is
3847 active (in the middle of a delivery attempt), it is not altered. This option
3848 can be used only by an admin user.
3849
3850 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3851         &~<&'message&~id'&>"
3852 .oindex "&%-MC%&"
3853 .cindex "SMTP" "passed connection"
3854 .cindex "SMTP" "multiple deliveries"
3855 .cindex "multiple SMTP deliveries"
3856 This option is not intended for use by external callers. It is used internally
3857 by Exim to invoke another instance of itself to deliver a waiting message using
3858 an existing SMTP connection, which is passed as the standard input. Details are
3859 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3860 must be root or the Exim user in order to use it.
3861
3862 .vitem &%-MCA%&
3863 .oindex "&%-MCA%&"
3864 This option is not intended for use by external callers. It is used internally
3865 by Exim in conjunction with the &%-MC%& option. It signifies that the
3866 connection to the remote host has been authenticated.
3867
3868 .vitem &%-MCD%&
3869 .oindex "&%-MCD%&"
3870 This option is not intended for use by external callers. It is used internally
3871 by Exim in conjunction with the &%-MC%& option. It signifies that the
3872 remote host supports the ESMTP &_DSN_& extension.
3873
3874 .new
3875 .vitem &%-MCd%&
3876 .oindex "&%-MCd%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-d%& option
3879 to pass on an information string on the purpose of the process.
3880 .wen
3881
3882 .vitem &%-MCG%&&~<&'queue&~name'&>
3883 .oindex "&%-MCG%&"
3884 This option is not intended for use by external callers. It is used internally
3885 by Exim in conjunction with the &%-MC%& option. It signifies that an
3886 alternate queue is used, named by the following argument.
3887
3888 .vitem &%-MCK%&
3889 .oindex "&%-MCK%&"
3890 This option is not intended for use by external callers. It is used internally
3891 by Exim in conjunction with the &%-MC%& option. It signifies that a
3892 remote host supports the ESMTP &_CHUNKING_& extension.
3893
3894 .vitem &%-MCP%&
3895 .oindex "&%-MCP%&"
3896 This option is not intended for use by external callers. It is used internally
3897 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3898 which Exim is connected supports pipelining.
3899
3900 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3901 .oindex "&%-MCQ%&"
3902 This option is not intended for use by external callers. It is used internally
3903 by Exim in conjunction with the &%-MC%& option when the original delivery was
3904 started by a queue runner. It passes on the process id of the queue runner,
3905 together with the file descriptor number of an open pipe. Closure of the pipe
3906 signals the final completion of the sequence of processes that are passing
3907 messages through the same SMTP connection.
3908
3909 .vitem &%-MCS%&
3910 .oindex "&%-MCS%&"
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 ESMTP SIZE option should be used on messages delivered down the existing
3914 connection.
3915
3916 .vitem &%-MCT%&
3917 .oindex "&%-MCT%&"
3918 This option is not intended for use by external callers. It is used internally
3919 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3920 host to which Exim is connected supports TLS encryption.
3921
3922 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3923 .oindex "&%-MCt%&"
3924 This option is not intended for use by external callers. It is used internally
3925 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3926 connection is being proxied by a parent process for handling TLS encryption.
3927 The arguments give the local address and port being proxied, and the TLS cipher.
3928
3929 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3930 .oindex "&%-Mc%&"
3931 .cindex "hints database" "not overridden by &%-Mc%&"
3932 .cindex "delivery" "manually started &-- not forced"
3933 This option requests Exim to run a delivery attempt on each message, in turn,
3934 but unlike the &%-M%& option, it does check for retry hints, and respects any
3935 that are found. This option is not very useful to external callers. It is
3936 provided mainly for internal use by Exim when it needs to re-invoke itself in
3937 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3938 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3939 respects retry times and other options such as &%hold_domains%& that are
3940 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3941 If you want to run a specific delivery as if in a queue run, you should use
3942 &%-q%& with a message id argument. A distinction between queue run deliveries
3943 and other deliveries is made in one or two places.
3944
3945 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3946 .oindex "&%-Mes%&"
3947 .cindex "message" "changing sender"
3948 .cindex "sender" "changing"
3949 This option requests Exim to change the sender address in the message to the
3950 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3951 &"edit sender"&). There must be exactly two arguments. The first argument must
3952 be a message id, and the second one an email address. However, if the message
3953 is active (in the middle of a delivery attempt), its status is not altered.
3954 This option can be used only by an admin user.
3955
3956 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3957 .oindex "&%-Mf%&"
3958 .cindex "freezing messages"
3959 .cindex "message" "manually freezing"
3960 This option requests Exim to mark each listed message as &"frozen"&. This
3961 prevents any delivery attempts taking place until the message is &"thawed"&,
3962 either manually or as a result of the &%auto_thaw%& configuration option.
3963 However, if any of the messages are active (in the middle of a delivery
3964 attempt), their status is not altered. This option can be used only by an admin
3965 user.
3966
3967 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3968 .oindex "&%-Mg%&"
3969 .cindex "giving up on messages"
3970 .cindex "message" "abandoning delivery attempts"
3971 .cindex "delivery" "abandoning further attempts"
3972 This option requests Exim to give up trying to deliver the listed messages,
3973 including any that are frozen. However, if any of the messages are active,
3974 their status is not altered. For non-bounce messages, a delivery error message
3975 is sent to the sender, containing the text &"cancelled by administrator"&.
3976 Bounce messages are just discarded. This option can be used only by an admin
3977 user.
3978
3979 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3980 .oindex "&%-MG%&"
3981 .cindex queue named
3982 .cindex "named queues" "moving messages"
3983 .cindex "queue" "moving messages"
3984 This option requests that each listed message be moved from its current
3985 queue to the given named queue.
3986 The destination queue name argument is required, but can be an empty
3987 string to define the default queue.
3988 If the messages are not currently located in the default queue,
3989 a &%-qG<name>%& option will be required to define the source queue.
3990
3991 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3992 .oindex "&%-Mmad%&"
3993 .cindex "delivery" "cancelling all"
3994 This option requests Exim to mark all the recipient addresses in the messages
3995 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3996 message is active (in the middle of a delivery attempt), its status is not
3997 altered. This option can be used only by an admin user.
3998
3999 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4000 .oindex "&%-Mmd%&"
4001 .cindex "delivery" "cancelling by address"
4002 .cindex "recipient" "removing"
4003 .cindex "removing recipients"
4004 This option requests Exim to mark the given addresses as already delivered
4005 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4006 the remaining ones must be email addresses. These are matched to recipient
4007 addresses in the message in a case-sensitive manner. If the message is active
4008 (in the middle of a delivery attempt), its status is not altered. This option
4009 can be used only by an admin user.
4010
4011 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4012 .oindex "&%-Mrm%&"
4013 .cindex "removing messages"
4014 .cindex "abandoning mail"
4015 .cindex "message" "manually discarding"
4016 This option requests Exim to remove the given messages from the queue. No
4017 bounce messages are sent; each message is simply forgotten. However, if any of
4018 the messages are active, their status is not altered. This option can be used
4019 only by an admin user or by the user who originally caused the message to be
4020 placed in the queue.
4021
4022 . .new
4023 . .vitem &%-MS%&
4024 . .oindex "&%-MS%&"
4025 . .cindex REQUIRETLS
4026 . This option is used to request REQUIRETLS processing on the message.
4027 . It is used internally by Exim in conjunction with -E when generating
4028 . a bounce message.
4029 . .wen
4030
4031 .vitem &%-Mset%&&~<&'message&~id'&>
4032 .oindex "&%-Mset%&"
4033 .cindex "testing" "string expansion"
4034 .cindex "expansion" "testing"
4035 This option is useful only in conjunction with &%-be%& (that is, when testing
4036 string expansions). Exim loads the given message from its spool before doing
4037 the test expansions, thus setting message-specific variables such as
4038 &$message_size$& and the header variables. The &$recipients$& variable is made
4039 available. This feature is provided to make it easier to test expansions that
4040 make use of these variables. However, this option can be used only by an admin
4041 user. See also &%-bem%&.
4042
4043 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4044 .oindex "&%-Mt%&"
4045 .cindex "thawing messages"
4046 .cindex "unfreezing messages"
4047 .cindex "frozen messages" "thawing"
4048 .cindex "message" "thawing frozen"
4049 This option requests Exim to &"thaw"& any of the listed messages that are
4050 &"frozen"&, so that delivery attempts can resume. However, if any of the
4051 messages are active, their status is not altered. This option can be used only
4052 by an admin user.
4053
4054 .vitem &%-Mvb%&&~<&'message&~id'&>
4055 .oindex "&%-Mvb%&"
4056 .cindex "listing" "message body"
4057 .cindex "message" "listing body of"
4058 This option causes the contents of the message body (-D) spool file to be
4059 written to the standard output. This option can be used only by an admin user.
4060
4061 .vitem &%-Mvc%&&~<&'message&~id'&>
4062 .oindex "&%-Mvc%&"
4063 .cindex "message" "listing in RFC 2822 format"
4064 .cindex "listing" "message in RFC 2822 format"
4065 This option causes a copy of the complete message (header lines plus body) to
4066 be written to the standard output in RFC 2822 format. This option can be used
4067 only by an admin user.
4068
4069 .vitem &%-Mvh%&&~<&'message&~id'&>
4070 .oindex "&%-Mvh%&"
4071 .cindex "listing" "message headers"
4072 .cindex "header lines" "listing"
4073 .cindex "message" "listing header lines"
4074 This option causes the contents of the message headers (-H) spool file to be
4075 written to the standard output. This option can be used only by an admin user.
4076
4077 .vitem &%-Mvl%&&~<&'message&~id'&>
4078 .oindex "&%-Mvl%&"
4079 .cindex "listing" "message log"
4080 .cindex "message" "listing message log"
4081 This option causes the contents of the message log spool file to be written to
4082 the standard output. This option can be used only by an admin user.
4083
4084 .vitem &%-m%&
4085 .oindex "&%-m%&"
4086 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4087 treats it that way too.
4088
4089 .vitem &%-N%&
4090 .oindex "&%-N%&"
4091 .cindex "debugging" "&%-N%& option"
4092 .cindex "debugging" "suppressing delivery"
4093 This is a debugging option that inhibits delivery of a message at the transport
4094 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4095 it just doesn't actually transport the message, but instead behaves as if it
4096 had successfully done so. However, it does not make any updates to the retry
4097 database, and the log entries for deliveries are flagged with &"*>"& rather
4098 than &"=>"&.
4099
4100 Because &%-N%& discards any message to which it applies, only root or the Exim
4101 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4102 words, an ordinary user can use it only when supplying an incoming message to
4103 which it will apply. Although transportation never fails when &%-N%& is set, an
4104 address may be deferred because of a configuration problem on a transport, or a
4105 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4106 the message, and applies to any subsequent delivery attempts that may happen
4107 for that message.
4108
4109 .vitem &%-n%&
4110 .oindex "&%-n%&"
4111 This option is interpreted by Sendmail to mean &"no aliasing"&.
4112 For normal modes of operation, it is ignored by Exim.
4113 When combined with &%-bP%& it makes the output more terse (suppresses
4114 option names, environment values and config pretty printing).
4115
4116 .vitem &%-O%&&~<&'data'&>
4117 .oindex "&%-O%&"
4118 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4119 Exim.
4120
4121 .vitem &%-oA%&&~<&'file&~name'&>
4122 .oindex "&%-oA%&"
4123 .cindex "Sendmail compatibility" "&%-oA%& option"
4124 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4125 alternative alias filename. Exim handles &%-bi%& differently; see the
4126 description above.
4127
4128 .vitem &%-oB%&&~<&'n'&>
4129 .oindex "&%-oB%&"
4130 .cindex "SMTP" "passed connection"
4131 .cindex "SMTP" "multiple deliveries"
4132 .cindex "multiple SMTP deliveries"
4133 This is a debugging option which limits the maximum number of messages that can
4134 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4135 transport. If <&'n'&> is omitted, the limit is set to 1.
4136
4137 .vitem &%-odb%&
4138 .oindex "&%-odb%&"
4139 .cindex "background delivery"
4140 .cindex "delivery" "in the background"
4141 This option applies to all modes in which Exim accepts incoming messages,
4142 including the listening daemon. It requests &"background"& delivery of such
4143 messages, which means that the accepting process automatically starts a
4144 delivery process for each message received, but does not wait for the delivery
4145 processes to finish.
4146
4147 When all the messages have been received, the reception process exits,
4148 leaving the delivery processes to finish in their own time. The standard output
4149 and error streams are closed at the start of each delivery process.
4150 This is the default action if none of the &%-od%& options are present.
4151
4152 If one of the queueing options in the configuration file
4153 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4154 overrides it if &%queue_only_override%& is set true, which is the default
4155 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4156
4157 .vitem &%-odf%&
4158 .oindex "&%-odf%&"
4159 .cindex "foreground delivery"
4160 .cindex "delivery" "in the foreground"
4161 This option requests &"foreground"& (synchronous) delivery when Exim has
4162 accepted a locally-generated message. (For the daemon it is exactly the same as
4163 &%-odb%&.) A delivery process is automatically started to deliver the message,
4164 and Exim waits for it to complete before proceeding.
4165
4166 The original Exim reception process does not finish until the delivery
4167 process for the final message has ended. The standard error stream is left open
4168 during deliveries.
4169
4170 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4171 false and one of the queueing options in the configuration file is in effect.
4172
4173 If there is a temporary delivery error during foreground delivery, the
4174 message is left in the queue for later delivery, and the original reception
4175 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4176 restricted configuration that never queues messages.
4177
4178
4179 .vitem &%-odi%&
4180 .oindex "&%-odi%&"
4181 This option is synonymous with &%-odf%&. It is provided for compatibility with
4182 Sendmail.
4183
4184 .vitem &%-odq%&
4185 .oindex "&%-odq%&"
4186 .cindex "non-immediate delivery"
4187 .cindex "delivery" "suppressing immediate"
4188 .cindex "queueing incoming messages"
4189 This option applies to all modes in which Exim accepts incoming messages,
4190 including the listening daemon. It specifies that the accepting process should
4191 not automatically start a delivery process for each message received. Messages
4192 are placed in the queue, and remain there until a subsequent queue runner
4193 process encounters them. There are several configuration options (such as
4194 &%queue_only%&) that can be used to queue incoming messages under certain
4195 conditions. This option overrides all of them and also &%-odqs%&. It always
4196 forces queueing.
4197
4198 .vitem &%-odqs%&
4199 .oindex "&%-odqs%&"
4200 .cindex "SMTP" "delaying delivery"
4201 .cindex "first pass routing"
4202 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4203 However, like &%-odb%& and &%-odi%&, this option has no effect if
4204 &%queue_only_override%& is false and one of the queueing options in the
4205 configuration file is in effect.
4206
4207 When &%-odqs%& does operate, a delivery process is started for each incoming
4208 message, in the background by default, but in the foreground if &%-odi%& is
4209 also present. The recipient addresses are routed, and local deliveries are done
4210 in the normal way. However, if any SMTP deliveries are required, they are not
4211 done at this time, so the message remains in the queue until a subsequent queue
4212 runner process encounters it. Because routing was done, Exim knows which
4213 messages are waiting for which hosts, and so a number of messages for the same
4214 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4215 configuration option has the same effect for specific domains. See also the
4216 &%-qq%& option.
4217
4218 .vitem &%-oee%&
4219 .oindex "&%-oee%&"
4220 .cindex "error" "reporting"
4221 If an error is detected while a non-SMTP message is being received (for
4222 example, a malformed address), the error is reported to the sender in a mail
4223 message.
4224
4225 .cindex "return code" "for &%-oee%&"
4226 Provided
4227 this error message is successfully sent, the Exim receiving process
4228 exits with a return code of zero. If not, the return code is 2 if the problem
4229 is that the original message has no recipients, or 1 for any other error.
4230 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4231
4232 .vitem &%-oem%&
4233 .oindex "&%-oem%&"
4234 .cindex "error" "reporting"
4235 .cindex "return code" "for &%-oem%&"
4236 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4237 return code, whether or not the error message was successfully sent.
4238 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4239
4240 .vitem &%-oep%&
4241 .oindex "&%-oep%&"
4242 .cindex "error" "reporting"
4243 If an error is detected while a non-SMTP message is being received, the
4244 error is reported by writing a message to the standard error file (stderr).
4245 .cindex "return code" "for &%-oep%&"
4246 The return code is 1 for all errors.
4247
4248 .vitem &%-oeq%&
4249 .oindex "&%-oeq%&"
4250 .cindex "error" "reporting"
4251 This option is supported for compatibility with Sendmail, but has the same
4252 effect as &%-oep%&.
4253
4254 .vitem &%-oew%&
4255 .oindex "&%-oew%&"
4256 .cindex "error" "reporting"
4257 This option is supported for compatibility with Sendmail, but has the same
4258 effect as &%-oem%&.
4259
4260 .vitem &%-oi%&
4261 .oindex "&%-oi%&"
4262 .cindex "dot" "in incoming non-SMTP message"
4263 This option, which has the same effect as &%-i%&, specifies that a dot on a
4264 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4265 single dot does terminate, though Exim does no special processing for other
4266 lines that start with a dot. This option is set by default if Exim is called as
4267 &'rmail'&. See also &%-ti%&.
4268
4269 .vitem &%-oitrue%&
4270 .oindex "&%-oitrue%&"
4271 This option is treated as synonymous with &%-oi%&.
4272
4273 .vitem &%-oMa%&&~<&'host&~address'&>
4274 .oindex "&%-oMa%&"
4275 .cindex "sender" "host address, specifying for local message"
4276 A number of options starting with &%-oM%& can be used to set values associated
4277 with remote hosts on locally-submitted messages (that is, messages not received
4278 over TCP/IP). These options can be used by any caller in conjunction with the
4279 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4280 other circumstances, they are ignored unless the caller is trusted.
4281
4282 The &%-oMa%& option sets the sender host address. This may include a port
4283 number at the end, after a full stop (period). For example:
4284 .code
4285 exim -bs -oMa 10.9.8.7.1234
4286 .endd
4287 An alternative syntax is to enclose the IP address in square brackets,
4288 followed by a colon and the port number:
4289 .code
4290 exim -bs -oMa [10.9.8.7]:1234
4291 .endd
4292 The IP address is placed in the &$sender_host_address$& variable, and the
4293 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4294 are present on the command line, the sender host IP address is taken from
4295 whichever one is last.
4296
4297 .vitem &%-oMaa%&&~<&'name'&>
4298 .oindex "&%-oMaa%&"
4299 .cindex "authentication" "name, specifying for local message"
4300 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4301 option sets the value of &$sender_host_authenticated$& (the authenticator
4302 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4303 This option can be used with &%-bh%& and &%-bs%& to set up an
4304 authenticated SMTP session without actually using the SMTP AUTH command.
4305
4306 .vitem &%-oMai%&&~<&'string'&>
4307 .oindex "&%-oMai%&"
4308 .cindex "authentication" "id, specifying for local message"
4309 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4310 option sets the value of &$authenticated_id$& (the id that was authenticated).
4311 This overrides the default value (the caller's login id, except with &%-bh%&,
4312 where there is no default) for messages from local sources. See chapter
4313 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4314
4315 .vitem &%-oMas%&&~<&'address'&>
4316 .oindex "&%-oMas%&"
4317 .cindex "authentication" "sender, specifying for local message"
4318 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4319 option sets the authenticated sender value in &$authenticated_sender$&. It
4320 overrides the sender address that is created from the caller's login id for
4321 messages from local sources, except when &%-bh%& is used, when there is no
4322 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4323 specified on a MAIL command overrides this value. See chapter
4324 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4325
4326 .vitem &%-oMi%&&~<&'interface&~address'&>
4327 .oindex "&%-oMi%&"
4328 .cindex "interface" "address, specifying for local message"
4329 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4330 option sets the IP interface address value. A port number may be included,
4331 using the same syntax as for &%-oMa%&. The interface address is placed in
4332 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4333
4334 .vitem &%-oMm%&&~<&'message&~reference'&>
4335 .oindex "&%-oMm%&"
4336 .cindex "message reference" "message reference, specifying for local message"
4337 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4338 option sets the message reference, e.g. message-id, and is logged during
4339 delivery. This is useful when some kind of audit trail is required to tie
4340 messages together. The format of the message reference is checked and will
4341 abort if the format is invalid. The option will only be accepted if exim is
4342 running in trusted mode, not as any regular user.
4343
4344 The best example of a message reference is when Exim sends a bounce message.
4345 The message reference is the message-id of the original message for which Exim
4346 is sending the bounce.
4347
4348 .vitem &%-oMr%&&~<&'protocol&~name'&>
4349 .oindex "&%-oMr%&"
4350 .cindex "protocol, specifying for local message"
4351 .vindex "&$received_protocol$&"
4352 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4353 option sets the received protocol value that is stored in
4354 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4355 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4356 SMTP protocol names (see the description of &$received_protocol$& in section
4357 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4358 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4359 be set by &%-oMr%&. Repeated use of this option is not supported.
4360
4361 .vitem &%-oMs%&&~<&'host&~name'&>
4362 .oindex "&%-oMs%&"
4363 .cindex "sender" "host name, specifying for local message"
4364 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4365 option sets the sender host name in &$sender_host_name$&. When this option is
4366 present, Exim does not attempt to look up a host name from an IP address; it
4367 uses the name it is given.
4368
4369 .vitem &%-oMt%&&~<&'ident&~string'&>
4370 .oindex "&%-oMt%&"
4371 .cindex "sender" "ident string, specifying for local message"
4372 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4373 option sets the sender ident value in &$sender_ident$&. The default setting for
4374 local callers is the login id of the calling process, except when &%-bh%& is
4375 used, when there is no default.
4376
4377 .vitem &%-om%&
4378 .oindex "&%-om%&"
4379 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4380 In Sendmail, this option means &"me too"&, indicating that the sender of a
4381 message should receive a copy of the message if the sender appears in an alias
4382 expansion. Exim always does this, so the option does nothing.
4383
4384 .vitem &%-oo%&
4385 .oindex "&%-oo%&"
4386 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4387 This option is ignored. In Sendmail it specifies &"old style headers"&,
4388 whatever that means.
4389
4390 .vitem &%-oP%&&~<&'path'&>
4391 .oindex "&%-oP%&"
4392 .cindex "pid (process id)" "of daemon"
4393 .cindex "daemon" "process id (pid)"
4394 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4395 value. The option specifies the file to which the process id of the daemon is
4396 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4397 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4398 because in those cases, the normal pid file is not used.
4399
4400 .new
4401 .vitem &%-oPX%&
4402 .oindex "&%-oPX%&"
4403 .cindex "pid (process id)" "of daemon"
4404 .cindex "daemon" "process id (pid)"
4405 This option is not intended for general use.
4406 The daemon uses it when terminating due to a SIGTEM, possibly in
4407 combination with &%-oP%&&~<&'path'&>.
4408 It causes the pid file to be removed.
4409 .wen
4410
4411 .vitem &%-or%&&~<&'time'&>
4412 .oindex "&%-or%&"
4413 .cindex "timeout" "for non-SMTP input"
4414 This option sets a timeout value for incoming non-SMTP messages. If it is not
4415 set, Exim will wait forever for the standard input. The value can also be set
4416 by the &%receive_timeout%& option. The format used for specifying times is
4417 described in section &<<SECTtimeformat>>&.
4418
4419 .vitem &%-os%&&~<&'time'&>
4420 .oindex "&%-os%&"
4421 .cindex "timeout" "for SMTP input"
4422 .cindex "SMTP" "input timeout"
4423 This option sets a timeout value for incoming SMTP messages. The timeout
4424 applies to each SMTP command and block of data. The value can also be set by
4425 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4426 for specifying times is described in section &<<SECTtimeformat>>&.
4427
4428 .vitem &%-ov%&
4429 .oindex "&%-ov%&"
4430 This option has exactly the same effect as &%-v%&.
4431
4432 .vitem &%-oX%&&~<&'number&~or&~string'&>
4433 .oindex "&%-oX%&"
4434 .cindex "TCP/IP" "setting listening ports"
4435 .cindex "TCP/IP" "setting listening interfaces"
4436 .cindex "port" "receiving TCP/IP"
4437 This option is relevant only when the &%-bd%& (start listening daemon) option
4438 is also given. It controls which ports and interfaces the daemon uses. Details
4439 of the syntax, and how it interacts with configuration file options, are given
4440 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4441 file is written unless &%-oP%& is also present to specify a pid filename.
4442
4443 .vitem &%-pd%&
4444 .oindex "&%-pd%&"
4445 .cindex "Perl" "starting the interpreter"
4446 This option applies when an embedded Perl interpreter is linked with Exim (see
4447 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4448 option, forcing the starting of the interpreter to be delayed until it is
4449 needed.
4450
4451 .vitem &%-ps%&
4452 .oindex "&%-ps%&"
4453 .cindex "Perl" "starting the interpreter"
4454 This option applies when an embedded Perl interpreter is linked with Exim (see
4455 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4456 option, forcing the starting of the interpreter to occur as soon as Exim is
4457 started.
4458
4459 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4460 .oindex "&%-p%&"
4461 For compatibility with Sendmail, this option is equivalent to
4462 .display
4463 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4464 .endd
4465 It sets the incoming protocol and host name (for trusted callers). The
4466 host name and its colon can be omitted when only the protocol is to be set.
4467 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4468 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4469 or &`s`& using this option (but that does not seem a real limitation).
4470 Repeated use of this option is not supported.
4471
4472 .vitem &%-q%&
4473 .oindex "&%-q%&"
4474 .cindex "queue runner" "starting manually"
4475 This option is normally restricted to admin users. However, there is a
4476 configuration option called &%prod_requires_admin%& which can be set false to
4477 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4478 and &%-S%& options).
4479
4480 .cindex "queue runner" "description of operation"
4481 If other commandline options do not specify an action,
4482 the &%-q%& option starts one queue runner process. This scans the queue of
4483 waiting messages, and runs a delivery process for each one in turn. It waits
4484 for each delivery process to finish before starting the next one. A delivery
4485 process may not actually do any deliveries if the retry times for the addresses
4486 have not been reached. Use &%-qf%& (see below) if you want to override this.
4487
4488 If
4489 .cindex "SMTP" "passed connection"
4490 .cindex "SMTP" "multiple deliveries"
4491 .cindex "multiple SMTP deliveries"
4492 the delivery process spawns other processes to deliver other messages down
4493 passed SMTP connections, the queue runner waits for these to finish before
4494 proceeding.
4495
4496 When all the queued messages have been considered, the original queue runner
4497 process terminates. In other words, a single pass is made over the waiting
4498 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4499 this to be repeated periodically.
4500
4501 Exim processes the waiting messages in an unpredictable order. It isn't very
4502 random, but it is likely to be different each time, which is all that matters.
4503 If one particular message screws up a remote MTA, other messages to the same
4504 MTA have a chance of getting through if they get tried first.
4505
4506 It is possible to cause the messages to be processed in lexical message id
4507 order, which is essentially the order in which they arrived, by setting the
4508 &%queue_run_in_order%& option, but this is not recommended for normal use.
4509
4510 .vitem &%-q%&<&'qflags'&>
4511 The &%-q%& option may be followed by one or more flag letters that change its
4512 behaviour. They are all optional, but if more than one is present, they must
4513 appear in the correct order. Each flag is described in a separate item below.
4514
4515 .vitem &%-qq...%&
4516 .oindex "&%-qq%&"
4517 .cindex "queue" "double scanning"
4518 .cindex "queue" "routing"
4519 .cindex "routing" "whole queue before delivery"
4520 .cindex "first pass routing"
4521 An option starting with &%-qq%& requests a two-stage queue run. In the first
4522 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4523 every domain. Addresses are routed, local deliveries happen, but no remote
4524 transports are run.
4525
4526 .new
4527 Performance will be best if the &%queue_run_in_order%& option is false.
4528 .wen
4529
4530 .cindex "hints database" "remembering routing"
4531 The hints database that remembers which messages are waiting for specific hosts
4532 is updated, as if delivery to those hosts had been deferred. After this is
4533 complete, a second, normal queue scan happens, with routing and delivery taking
4534 place as normal. Messages that are routed to the same host should mostly be
4535 delivered down a single SMTP
4536 .cindex "SMTP" "passed connection"
4537 .cindex "SMTP" "multiple deliveries"
4538 .cindex "multiple SMTP deliveries"
4539 connection because of the hints that were set up during the first queue scan.
4540 This option may be useful for hosts that are connected to the Internet
4541 intermittently.
4542
4543 .vitem &%-q[q]i...%&
4544 .oindex "&%-qi%&"
4545 .cindex "queue" "initial delivery"
4546 If the &'i'& flag is present, the queue runner runs delivery processes only for
4547 those messages that haven't previously been tried. (&'i'& stands for &"initial
4548 delivery"&.) This can be helpful if you are putting messages in the queue using
4549 &%-odq%& and want a queue runner just to process the new messages.
4550
4551 .vitem &%-q[q][i]f...%&
4552 .oindex "&%-qf%&"
4553 .cindex "queue" "forcing delivery"
4554 .cindex "delivery" "forcing in queue run"
4555 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4556 message, whereas without &'f'& only those non-frozen addresses that have passed
4557 their retry times are tried.
4558
4559 .vitem &%-q[q][i]ff...%&
4560 .oindex "&%-qff%&"
4561 .cindex "frozen messages" "forcing delivery"
4562 If &'ff'& is present, a delivery attempt is forced for every message, whether
4563 frozen or not.
4564
4565 .vitem &%-q[q][i][f[f]]l%&
4566 .oindex "&%-ql%&"
4567 .cindex "queue" "local deliveries only"
4568 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4569 be done. If a message requires any remote deliveries, it remains in the queue
4570 for later delivery.
4571
4572 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4573 .oindex "&%-qG%&"
4574 .cindex queue named
4575 .cindex "named queues"  "deliver from"
4576 .cindex "queue" "delivering specific messages"
4577 If the &'G'& flag and a name is present, the queue runner operates on the
4578 queue with the given name rather than the default queue.
4579 The name should not contain a &'/'& character.
4580 For a periodic queue run (see below)
4581 append to the name a slash and a time value.
4582
4583 If other commandline options specify an action, a &'-qG<name>'& option
4584 will specify a queue to operate on.
4585 For example:
4586 .code
4587 exim -bp -qGquarantine
4588 mailq -qGquarantine
4589 exim -qGoffpeak -Rf @special.domain.example
4590 .endd
4591
4592 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4593 When scanning the queue, Exim can be made to skip over messages whose ids are
4594 lexically less than a given value by following the &%-q%& option with a
4595 starting message id. For example:
4596 .code
4597 exim -q 0t5C6f-0000c8-00
4598 .endd
4599 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4600 second message id is given, messages whose ids are lexically greater than it
4601 are also skipped. If the same id is given twice, for example,
4602 .code
4603 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4604 .endd
4605 just one delivery process is started, for that message. This differs from
4606 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4607 that it counts as a delivery from a queue run. Note that the selection
4608 mechanism does not affect the order in which the messages are scanned. There
4609 are also other ways of selecting specific sets of messages for delivery in a
4610 queue run &-- see &%-R%& and &%-S%&.
4611
4612 .vitem &%-q%&<&'qflags'&><&'time'&>
4613 .cindex "queue runner" "starting periodically"
4614 .cindex "periodic queue running"
4615 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4616 starting a queue runner process at intervals specified by the given time value
4617 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4618 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4619 single daemon process handles both functions. A common way of starting up a
4620 combined daemon at system boot time is to use a command such as
4621 .code
4622 /usr/exim/bin/exim -bd -q30m
4623 .endd
4624 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4625 process every 30 minutes.
4626
4627 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4628 pid file is written unless one is explicitly requested by the &%-oP%& option.
4629
4630 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4631 .oindex "&%-qR%&"
4632 This option is synonymous with &%-R%&. It is provided for Sendmail
4633 compatibility.
4634
4635 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4636 .oindex "&%-qS%&"
4637 This option is synonymous with &%-S%&.
4638
4639 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4640 .oindex "&%-R%&"
4641 .cindex "queue runner" "for specific recipients"
4642 .cindex "delivery" "to given domain"
4643 .cindex "domain" "delivery to"
4644 The <&'rsflags'&> may be empty, in which case the white space before the string
4645 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4646 which are the possible values for <&'rsflags'&>. White space is required if
4647 <&'rsflags'&> is not empty.
4648
4649 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4650 perform a single queue run, except that, when scanning the messages on the
4651 queue, Exim processes only those that have at least one undelivered recipient
4652 address containing the given string, which is checked in a case-independent
4653 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4654 regular expression; otherwise it is a literal string.
4655
4656 If you want to do periodic queue runs for messages with specific recipients,
4657 you can combine &%-R%& with &%-q%& and a time value. For example:
4658 .code
4659 exim -q25m -R @special.domain.example
4660 .endd
4661 This example does a queue run for messages with recipients in the given domain
4662 every 25 minutes. Any additional flags that are specified with &%-q%& are
4663 applied to each queue run.
4664
4665 Once a message is selected for delivery by this mechanism, all its addresses
4666 are processed. For the first selected message, Exim overrides any retry
4667 information and forces a delivery attempt for each undelivered address. This
4668 means that if delivery of any address in the first message is successful, any
4669 existing retry information is deleted, and so delivery attempts for that
4670 address in subsequently selected messages (which are processed without forcing)
4671 will run. However, if delivery of any address does not succeed, the retry
4672 information is updated, and in subsequently selected messages, the failing
4673 address will be skipped.
4674
4675 .cindex "frozen messages" "forcing delivery"
4676 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4677 all selected messages, not just the first; frozen messages are included when
4678 &'ff'& is present.
4679
4680 The &%-R%& option makes it straightforward to initiate delivery of all messages
4681 to a given domain after a host has been down for some time. When the SMTP
4682 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4683 effect is to run Exim with the &%-R%& option, but it can be configured to run
4684 an arbitrary command instead.
4685
4686 .vitem &%-r%&
4687 .oindex "&%-r%&"
4688 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4689
4690 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4691 .oindex "&%-S%&"
4692 .cindex "delivery" "from given sender"
4693 .cindex "queue runner" "for specific senders"
4694 This option acts like &%-R%& except that it checks the string against each
4695 message's sender instead of against the recipients. If &%-R%& is also set, both
4696 conditions must be met for a message to be selected. If either of the options
4697 has &'f'& or &'ff'& in its flags, the associated action is taken.
4698
4699 .vitem &%-Tqt%&&~<&'times'&>
4700 .oindex "&%-Tqt%&"
4701 This is an option that is exclusively for use by the Exim testing suite. It is not
4702 recognized when Exim is run normally. It allows for the setting up of explicit
4703 &"queue times"& so that various warning/retry features can be tested.
4704
4705 .vitem &%-t%&
4706 .oindex "&%-t%&"
4707 .cindex "recipient" "extracting from header lines"
4708 .cindex "&'Bcc:'& header line"
4709 .cindex "&'Cc:'& header line"
4710 .cindex "&'To:'& header line"
4711 When Exim is receiving a locally-generated, non-SMTP message on its standard
4712 input, the &%-t%& option causes the recipients of the message to be obtained
4713 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4714 from the command arguments. The addresses are extracted before any rewriting
4715 takes place and the &'Bcc:'& header line, if present, is then removed.
4716
4717 .cindex "Sendmail compatibility" "&%-t%& option"
4718 If the command has any arguments, they specify addresses to which the message
4719 is &'not'& to be delivered. That is, the argument addresses are removed from
4720 the recipients list obtained from the headers. This is compatible with Smail 3
4721 and in accordance with the documented behaviour of several versions of
4722 Sendmail, as described in man pages on a number of operating systems (e.g.
4723 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4724 argument addresses to those obtained from the headers, and the O'Reilly
4725 Sendmail book documents it that way. Exim can be made to add argument addresses
4726 instead of subtracting them by setting the option
4727 &%extract_addresses_remove_arguments%& false.
4728
4729 .cindex "&%Resent-%& header lines" "with &%-t%&"
4730 If there are any &%Resent-%& header lines in the message, Exim extracts
4731 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4732 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4733 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4734 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4735
4736 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4737 message is resent several times). The RFC also specifies that they should be
4738 added at the front of the message, and separated by &'Received:'& lines. It is
4739 not at all clear how &%-t%& should operate in the present of multiple sets,
4740 nor indeed exactly what constitutes a &"set"&.
4741 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4742 are often added at the end of the header, and if a message is resent more than
4743 once, it is common for the original set of &%Resent-%& headers to be renamed as
4744 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4745
4746 .vitem &%-ti%&
4747 .oindex "&%-ti%&"
4748 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4749 compatibility with Sendmail.
4750
4751 .vitem &%-tls-on-connect%&
4752 .oindex "&%-tls-on-connect%&"
4753 .cindex "TLS" "use without STARTTLS"
4754 .cindex "TLS" "automatic start"
4755 This option is available when Exim is compiled with TLS support. It forces all
4756 incoming SMTP connections to behave as if the incoming port is listed in the
4757 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4758 &<<CHAPTLS>>& for further details.
4759
4760
4761 .vitem &%-U%&
4762 .oindex "&%-U%&"
4763 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4764 Sendmail uses this option for &"initial message submission"&, and its
4765 documentation states that in future releases, it may complain about
4766 syntactically invalid messages rather than fixing them when this flag is not
4767 set. Exim ignores this option.
4768
4769 .vitem &%-v%&
4770 .oindex "&%-v%&"
4771 This option causes Exim to write information to the standard error stream,
4772 describing what it is doing. In particular, it shows the log lines for
4773 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4774 dialogue is shown. Some of the log lines shown may not actually be written to
4775 the log if the setting of &%log_selector%& discards them. Any relevant
4776 selectors are shown with each log line. If none are shown, the logging is
4777 unconditional.
4778
4779 .vitem &%-x%&
4780 .oindex "&%-x%&"
4781 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4782 National Language Support extended characters in the body of the mail item"&).
4783 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4784 this option.
4785
4786 .vitem &%-X%&&~<&'logfile'&>
4787 .oindex "&%-X%&"
4788 This option is interpreted by Sendmail to cause debug information to be sent
4789 to the named file.  It is ignored by Exim.
4790
4791 .vitem &%-z%&&~<&'log-line'&>
4792 .oindex "&%-z%&"
4793 This option writes its argument to Exim's logfile.
4794 Use is restricted to administrators; the intent is for operational notes.
4795 Quotes should be used to maintain a multi-word item as a single argument,
4796 under most shells.
4797 .endlist
4798
4799 .ecindex IIDclo1
4800 .ecindex IIDclo2
4801
4802
4803 . ////////////////////////////////////////////////////////////////////////////
4804 . Insert a stylized DocBook comment here, to identify the end of the command
4805 . line options. This is for the benefit of the Perl script that automatically
4806 . creates a man page for the options.
4807 . ////////////////////////////////////////////////////////////////////////////
4808
4809 .literal xml
4810 <!-- === End of command line options === -->
4811 .literal off
4812
4813
4814
4815
4816
4817 . ////////////////////////////////////////////////////////////////////////////
4818 . ////////////////////////////////////////////////////////////////////////////
4819
4820
4821 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4822          "The runtime configuration file"
4823
4824 .cindex "runtime configuration"
4825 .cindex "configuration file" "general description"
4826 .cindex "CONFIGURE_FILE"
4827 .cindex "configuration file" "errors in"
4828 .cindex "error" "in configuration file"
4829 .cindex "return code" "for bad configuration"
4830 Exim uses a single runtime configuration file that is read whenever an Exim
4831 binary is executed. Note that in normal operation, this happens frequently,
4832 because Exim is designed to operate in a distributed manner, without central
4833 control.
4834
4835 If a syntax error is detected while reading the configuration file, Exim
4836 writes a message on the standard error, and exits with a non-zero return code.
4837 The message is also written to the panic log. &*Note*&: Only simple syntax
4838 errors can be detected at this time. The values of any expanded options are
4839 not checked until the expansion happens, even when the expansion does not
4840 actually alter the string.
4841
4842 The name of the configuration file is compiled into the binary for security
4843 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4844 most configurations, this specifies a single file. However, it is permitted to
4845 give a colon-separated list of filenames, in which case Exim uses the first
4846 existing file in the list.
4847
4848 .cindex "EXIM_USER"
4849 .cindex "EXIM_GROUP"
4850 .cindex "CONFIGURE_OWNER"
4851 .cindex "CONFIGURE_GROUP"
4852 .cindex "configuration file" "ownership"
4853 .cindex "ownership" "configuration file"
4854 The runtime configuration file must be owned by root or by the user that is
4855 specified at compile time by the CONFIGURE_OWNER option (if set). The
4856 configuration file must not be world-writeable, or group-writeable unless its
4857 group is the root group or the one specified at compile time by the
4858 CONFIGURE_GROUP option.
4859
4860 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4861 to root, anybody who is able to edit the runtime configuration file has an
4862 easy way to run commands as root. If you specify a user or group in the
4863 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4864 who are members of that group will trivially be able to obtain root privileges.
4865
4866 Up to Exim version 4.72, the runtime configuration file was also permitted to
4867 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4868 since it offered a simple privilege escalation for any attacker who managed to
4869 compromise the Exim user account.
4870
4871 A default configuration file, which will work correctly in simple situations,
4872 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4873 defines just one filename, the installation process copies the default
4874 configuration to a new file of that name if it did not previously exist. If
4875 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4876 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4877 configuration.
4878
4879
4880
4881 .section "Using a different configuration file" "SECID40"
4882 .cindex "configuration file" "alternate"
4883 A one-off alternate configuration can be specified by the &%-C%& command line
4884 option, which may specify a single file or a list of files. However, when
4885 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4886 unless the argument for &%-C%& is identical to the built-in value from
4887 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4888 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4889 is useful mainly for checking the syntax of configuration files before
4890 installing them. No owner or group checks are done on a configuration file
4891 specified by &%-C%&, if root privilege has been dropped.
4892
4893 Even the Exim user is not trusted to specify an arbitrary configuration file
4894 with the &%-C%& option to be used with root privileges, unless that file is
4895 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4896 testing a configuration using &%-C%& right through message reception and
4897 delivery, even if the caller is root. The reception works, but by that time,
4898 Exim is running as the Exim user, so when it re-execs to regain privilege for
4899 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4900 can test reception and delivery using two separate commands (one to put a
4901 message in the queue, using &%-odq%&, and another to do the delivery, using
4902 &%-M%&).
4903
4904 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4905 prefix string with which any file named in a &%-C%& command line option must
4906 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4907 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4908 filename can be used with &%-C%&.
4909
4910 One-off changes to a configuration can be specified by the &%-D%& command line
4911 option, which defines and overrides values for macros used inside the
4912 configuration file. However, like &%-C%&, the use of this option by a
4913 non-privileged user causes Exim to discard its root privilege.
4914 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4915 completely disabled, and its use causes an immediate error exit.
4916
4917 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4918 to declare certain macro names trusted, such that root privilege will not
4919 necessarily be discarded.
4920 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4921 considered safe and, if &%-D%& only supplies macros from this list, and the
4922 values are acceptable, then Exim will not give up root privilege if the caller
4923 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4924 transition mechanism and is expected to be removed in the future.  Acceptable
4925 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4926
4927 Some sites may wish to use the same Exim binary on different machines that
4928 share a file system, but to use different configuration files on each machine.
4929 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4930 looks for a file whose name is the configuration filename followed by a dot
4931 and the machine's node name, as obtained from the &[uname()]& function. If this
4932 file does not exist, the standard name is tried. This processing occurs for
4933 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4934
4935 In some esoteric situations different versions of Exim may be run under
4936 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4937 help with this. See the comments in &_src/EDITME_& for details.
4938
4939
4940
4941 .section "Configuration file format" "SECTconffilfor"
4942 .cindex "configuration file" "format of"
4943 .cindex "format" "configuration file"
4944 Exim's configuration file is divided into a number of different parts. General
4945 option settings must always appear at the start of the file. The other parts
4946 are all optional, and may appear in any order. Each part other than the first
4947 is introduced by the word &"begin"& followed by at least one literal
4948 space, and the name of the part. The optional parts are:
4949
4950 .ilist
4951 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4952 &<<CHAPACL>>&).
4953 .next
4954 .cindex "AUTH" "configuration"
4955 &'authenticators'&: Configuration settings for the authenticator drivers. These
4956 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4957 .next
4958 &'routers'&: Configuration settings for the router drivers. Routers process
4959 addresses and determine how the message is to be delivered (see chapters
4960 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4961 .next
4962 &'transports'&: Configuration settings for the transport drivers. Transports
4963 define mechanisms for copying messages to destinations (see chapters
4964 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4965 .next
4966 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4967 If there is no retry section, or if it is empty (that is, no retry rules are
4968 defined), Exim will not retry deliveries. In this situation, temporary errors
4969 are treated the same as permanent errors. Retry rules are discussed in chapter
4970 &<<CHAPretry>>&.
4971 .next
4972 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4973 when new addresses are generated during delivery. Rewriting is discussed in
4974 chapter &<<CHAPrewrite>>&.
4975 .next
4976 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4977 want to use this feature, you must set
4978 .code
4979 LOCAL_SCAN_HAS_OPTIONS=yes
4980 .endd
4981 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4982 facility are given in chapter &<<CHAPlocalscan>>&.
4983 .endlist
4984
4985 .cindex "configuration file" "leading white space in"
4986 .cindex "configuration file" "trailing white space in"
4987 .cindex "white space" "in configuration file"
4988 Leading and trailing white space in configuration lines is always ignored.
4989
4990 Blank lines in the file, and lines starting with a # character (ignoring
4991 leading white space) are treated as comments and are ignored. &*Note*&: A
4992 # character other than at the beginning of a line is not treated specially,
4993 and does not introduce a comment.
4994
4995 Any non-comment line can be continued by ending it with a backslash. Note that
4996 the general rule for white space means that trailing white space after the
4997 backslash and leading white space at the start of continuation
4998 lines is ignored. Comment lines beginning with # (but not empty lines) may
4999 appear in the middle of a sequence of continuation lines.
5000
5001 A convenient way to create a configuration file is to start from the
5002 default, which is supplied in &_src/configure.default_&, and add, delete, or
5003 change settings as required.
5004
5005 The ACLs, retry rules, and rewriting rules have their own syntax which is
5006 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5007 respectively. The other parts of the configuration file have some syntactic
5008 items in common, and these are described below, from section &<<SECTcos>>&
5009 onwards. Before that, the inclusion, macro, and conditional facilities are
5010 described.
5011
5012
5013
5014 .section "File inclusions in the configuration file" "SECID41"
5015 .cindex "inclusions in configuration file"
5016 .cindex "configuration file" "including other files"
5017 .cindex "&`.include`& in configuration file"
5018 .cindex "&`.include_if_exists`& in configuration file"
5019 You can include other files inside Exim's runtime configuration file by
5020 using this syntax:
5021 .display
5022 &`.include`& <&'filename'&>
5023 &`.include_if_exists`& <&'filename'&>
5024 .endd
5025 on a line by itself. Double quotes round the filename are optional. If you use
5026 the first form, a configuration error occurs if the file does not exist; the
5027 second form does nothing for non-existent files.
5028 The first form allows a relative name. It is resolved relative to
5029 the directory of the including file. For the second form an absolute filename
5030 is required.
5031
5032 Includes may be nested to any depth, but remember that Exim reads its
5033 configuration file often, so it is a good idea to keep them to a minimum.
5034 If you change the contents of an included file, you must HUP the daemon,
5035 because an included file is read only when the configuration itself is read.
5036
5037 The processing of inclusions happens early, at a physical line level, so, like
5038 comment lines, an inclusion can be used in the middle of an option setting,
5039 for example:
5040 .code
5041 hosts_lookup = a.b.c \
5042                .include /some/file
5043 .endd
5044 Include processing happens after macro processing (see below). Its effect is to
5045 process the lines of the included file as if they occurred inline where the
5046 inclusion appears.
5047
5048
5049
5050 .section "Macros in the configuration file" "SECTmacrodefs"
5051 .cindex "macro" "description of"
5052 .cindex "configuration file" "macros"
5053 If a line in the main part of the configuration (that is, before the first
5054 &"begin"& line) begins with an upper case letter, it is taken as a macro
5055 definition, and must be of the form
5056 .display
5057 <&'name'&> = <&'rest of line'&>
5058 .endd
5059 The name must consist of letters, digits, and underscores, and need not all be
5060 in upper case, though that is recommended. The rest of the line, including any
5061 continuations, is the replacement text, and has leading and trailing white
5062 space removed. Quotes are not removed. The replacement text can never end with
5063 a backslash character, but this doesn't seem to be a serious limitation.
5064
5065 Macros may also be defined between router, transport, authenticator, or ACL
5066 definitions. They may not, however, be defined within an individual driver or
5067 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5068
5069 .section "Macro substitution" "SECID42"
5070 Once a macro is defined, all subsequent lines in the file (and any included
5071 files) are scanned for the macro name; if there are several macros, the line is
5072 scanned for each, in turn, in the order in which the macros are defined. The
5073 replacement text is not re-scanned for the current macro, though it is scanned
5074 for subsequently defined macros. For this reason, a macro name may not contain
5075 the name of a previously defined macro as a substring. You could, for example,
5076 define
5077 .display
5078 &`ABCD_XYZ = `&<&'something'&>
5079 &`ABCD = `&<&'something else'&>
5080 .endd
5081 but putting the definitions in the opposite order would provoke a configuration
5082 error. Macro expansion is applied to individual physical lines from the file,
5083 before checking for line continuation or file inclusion (see above). If a line
5084 consists solely of a macro name, and the expansion of the macro is empty, the
5085 line is ignored. A macro at the start of a line may turn the line into a
5086 comment line or a &`.include`& line.
5087
5088
5089 .section "Redefining macros" "SECID43"
5090 Once defined, the value of a macro can be redefined later in the configuration
5091 (or in an included file). Redefinition is specified by using &'=='& instead of
5092 &'='&. For example:
5093 .code
5094 MAC =  initial value
5095 ...
5096 MAC == updated value
5097 .endd
5098 Redefinition does not alter the order in which the macros are applied to the
5099 subsequent lines of the configuration file. It is still the same order in which
5100 the macros were originally defined. All that changes is the macro's value.
5101 Redefinition makes it possible to accumulate values. For example:
5102 .code
5103 MAC =  initial value
5104 ...
5105 MAC == MAC and something added
5106 .endd
5107 This can be helpful in situations where the configuration file is built
5108 from a number of other files.
5109
5110 .section "Overriding macro values" "SECID44"
5111 The values set for macros in the configuration file can be overridden by the
5112 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5113 used, unless called by root or the Exim user. A definition on the command line
5114 using the &%-D%& option causes all definitions and redefinitions within the
5115 file to be ignored.
5116
5117
5118
5119 .section "Example of macro usage" "SECID45"
5120 As an example of macro usage, consider a configuration where aliases are looked
5121 up in a MySQL database. It helps to keep the file less cluttered if long
5122 strings such as SQL statements are defined separately as macros, for example:
5123 .code
5124 ALIAS_QUERY = select mailbox from user where \
5125               login='${quote_mysql:$local_part}';
5126 .endd
5127 This can then be used in a &(redirect)& router setting like this:
5128 .code
5129 data = ${lookup mysql{ALIAS_QUERY}}
5130 .endd
5131 In earlier versions of Exim macros were sometimes used for domain, host, or
5132 address lists. In Exim 4 these are handled better by named lists &-- see
5133 section &<<SECTnamedlists>>&.
5134
5135
5136 .section "Builtin macros" "SECTbuiltinmacros"
5137 Exim defines some macros depending on facilities available, which may
5138 differ due to build-time definitions and from one release to another.
5139 All of these macros start with an underscore.
5140 They can be used to conditionally include parts of a configuration
5141 (see below).
5142
5143 The following classes of macros are defined:
5144 .display
5145 &` _HAVE_*                    `&  build-time defines
5146 &` _DRIVER_ROUTER_*           `&  router drivers
5147 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5148 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5149 &` _LOG_*                     `&  log_selector values
5150 &` _OPT_MAIN_*                `&  main config options
5151 &` _OPT_ROUTERS_*             `&  generic router options
5152 &` _OPT_TRANSPORTS_*          `&  generic transport options
5153 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5154 &` _OPT_ROUTER_*_*            `&  private router options
5155 &` _OPT_TRANSPORT_*_*         `&  private transport options
5156 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5157 .endd
5158
5159 Use an &"exim -bP macros"& command to get the list of macros.
5160
5161
5162 .section "Conditional skips in the configuration file" "SECID46"
5163 .cindex "configuration file" "conditional skips"
5164 .cindex "&`.ifdef`&"
5165 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5166 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5167 portions of the configuration file. The processing happens whenever the file is
5168 read (that is, when an Exim binary starts to run).
5169
5170 The implementation is very simple. Instances of the first four directives must
5171 be followed by text that includes the names of one or macros. The condition
5172 that is tested is whether or not any macro substitution has taken place in the
5173 line. Thus:
5174 .code
5175 .ifdef AAA
5176 message_size_limit = 50M
5177 .else
5178 message_size_limit = 100M
5179 .endif
5180 .endd
5181 sets a message size limit of 50M if the macro &`AAA`& is defined
5182 (or &`A`& or &`AA`&), and 100M
5183 otherwise. If there is more than one macro named on the line, the condition
5184 is true if any of them are defined. That is, it is an &"or"& condition. To
5185 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5186
5187 Although you can use a macro expansion to generate one of these directives,
5188 it is not very useful, because the condition &"there was a macro substitution
5189 in this line"& will always be true.
5190
5191 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5192 to clarify complicated nestings.
5193
5194
5195
5196 .section "Common option syntax" "SECTcos"
5197 .cindex "common option syntax"
5198 .cindex "syntax of common options"
5199 .cindex "configuration file" "common option syntax"
5200 For the main set of options, driver options, and &[local_scan()]& options,
5201 each setting is on a line by itself, and starts with a name consisting of
5202 lower-case letters and underscores. Many options require a data value, and in
5203 these cases the name must be followed by an equals sign (with optional white
5204 space) and then the value. For example:
5205 .code
5206 qualify_domain = mydomain.example.com
5207 .endd
5208 .cindex "hiding configuration option values"
5209 .cindex "configuration options" "hiding value of"
5210 .cindex "options" "hiding value of"
5211 Some option settings may contain sensitive data, for example, passwords for
5212 accessing databases. To stop non-admin users from using the &%-bP%& command
5213 line option to read these values, you can precede the option settings with the
5214 word &"hide"&. For example:
5215 .code
5216 hide mysql_servers = localhost/users/admin/secret-password
5217 .endd
5218 For non-admin users, such options are displayed like this:
5219 .code
5220 mysql_servers = <value not displayable>
5221 .endd
5222 If &"hide"& is used on a driver option, it hides the value of that option on
5223 all instances of the same driver.
5224
5225 The following sections describe the syntax used for the different data types
5226 that are found in option settings.
5227
5228
5229 .section "Boolean options" "SECID47"
5230 .cindex "format" "boolean"
5231 .cindex "boolean configuration values"
5232 .oindex "&%no_%&&'xxx'&"
5233 .oindex "&%not_%&&'xxx'&"
5234 Options whose type is given as boolean are on/off switches. There are two
5235 different ways of specifying such options: with and without a data value. If
5236 the option name is specified on its own without data, the switch is turned on;
5237 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5238 boolean options may be followed by an equals sign and one of the words
5239 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5240 the following two settings have exactly the same effect:
5241 .code
5242 queue_only
5243 queue_only = true
5244 .endd
5245 The following two lines also have the same (opposite) effect:
5246 .code
5247 no_queue_only
5248 queue_only = false
5249 .endd
5250 You can use whichever syntax you prefer.
5251
5252
5253
5254
5255 .section "Integer values" "SECID48"
5256 .cindex "integer configuration values"
5257 .cindex "format" "integer"
5258 If an option's type is given as &"integer"&, the value can be given in decimal,
5259 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5260 number is assumed. Otherwise, it is treated as an octal number unless it starts
5261 with the characters &"0x"&, in which case the remainder is interpreted as a
5262 hexadecimal number.
5263
5264 If an integer value is followed by the letter K, it is multiplied by 1024; if
5265 it is followed by the letter M, it is multiplied by 1024x1024;
5266 if by the letter G, 1024x1024x1024.
5267 When the values
5268 of integer option settings are output, values which are an exact multiple of
5269 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5270 and M. The printing style is independent of the actual input format that was
5271 used.
5272
5273
5274 .section "Octal integer values" "SECID49"
5275 .cindex "integer format"
5276 .cindex "format" "octal integer"
5277 If an option's type is given as &"octal integer"&, its value is always
5278 interpreted as an octal number, whether or not it starts with the digit zero.
5279 Such options are always output in octal.
5280
5281
5282 .section "Fixed point numbers" "SECID50"
5283 .cindex "fixed point configuration values"
5284 .cindex "format" "fixed point"
5285 If an option's type is given as &"fixed-point"&, its value must be a decimal
5286 integer, optionally followed by a decimal point and up to three further digits.
5287
5288
5289
5290 .section "Time intervals" "SECTtimeformat"
5291 .cindex "time interval" "specifying in configuration"
5292 .cindex "format" "time interval"
5293 A time interval is specified as a sequence of numbers, each followed by one of
5294 the following letters, with no intervening white space:
5295
5296 .table2 30pt
5297 .irow &%s%& seconds
5298 .irow &%m%& minutes
5299 .irow &%h%& hours
5300 .irow &%d%& days
5301 .irow &%w%& weeks
5302 .endtable
5303
5304 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5305 intervals are output in the same format. Exim does not restrict the values; it
5306 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5307
5308
5309
5310 .section "String values" "SECTstrings"
5311 .cindex "string" "format of configuration values"
5312 .cindex "format" "string"
5313 If an option's type is specified as &"string"&, the value can be specified with
5314 or without double-quotes. If it does not start with a double-quote, the value
5315 consists of the remainder of the line plus any continuation lines, starting at
5316 the first character after any leading white space, with trailing white space
5317 removed, and with no interpretation of the characters in the string. Because
5318 Exim removes comment lines (those beginning with #) at an early stage, they can
5319 appear in the middle of a multi-line string. The following two settings are
5320 therefore equivalent:
5321 .code
5322 trusted_users = uucp:mail
5323 trusted_users = uucp:\
5324                 # This comment line is ignored
5325                 mail
5326 .endd
5327 .cindex "string" "quoted"
5328 .cindex "escape characters in quoted strings"
5329 If a string does start with a double-quote, it must end with a closing
5330 double-quote, and any backslash characters other than those used for line
5331 continuation are interpreted as escape characters, as follows:
5332
5333 .table2 100pt
5334 .irow &`\\`&                     "single backslash"
5335 .irow &`\n`&                     "newline"
5336 .irow &`\r`&                     "carriage return"
5337 .irow &`\t`&                     "tab"
5338 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5339 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5340                                    character"
5341 .endtable
5342
5343 If a backslash is followed by some other character, including a double-quote
5344 character, that character replaces the pair.
5345
5346 Quoting is necessary only if you want to make use of the backslash escapes to
5347 insert special characters, or if you need to specify a value with leading or
5348 trailing spaces. These cases are rare, so quoting is almost never needed in
5349 current versions of Exim. In versions of Exim before 3.14, quoting was required
5350 in order to continue lines, so you may come across older configuration files
5351 and examples that apparently quote unnecessarily.
5352
5353
5354 .section "Expanded strings" "SECID51"
5355 .cindex "expansion" "definition of"
5356 Some strings in the configuration file are subjected to &'string expansion'&,
5357 by which means various parts of the string may be changed according to the
5358 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5359 is as just described; in particular, the handling of backslashes in quoted
5360 strings is done as part of the input process, before expansion takes place.
5361 However, backslash is also an escape character for the expander, so any
5362 backslashes that are required for that reason must be doubled if they are
5363 within a quoted configuration string.
5364
5365
5366 .section "User and group names" "SECID52"
5367 .cindex "user name" "format of"
5368 .cindex "format" "user name"
5369 .cindex "groups" "name format"
5370 .cindex "format" "group name"
5371 User and group names are specified as strings, using the syntax described
5372 above, but the strings are interpreted specially. A user or group name must
5373 either consist entirely of digits, or be a name that can be looked up using the
5374 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5375
5376
5377 .section "List construction" "SECTlistconstruct"
5378 .cindex "list" "syntax of in configuration"
5379 .cindex "format" "list item in configuration"
5380 .cindex "string" "list, definition of"
5381 The data for some configuration options is a list of items, with colon as the
5382 default separator. Many of these options are shown with type &"string list"& in
5383 the descriptions later in this document. Others are listed as &"domain list"&,
5384 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5385 are all the same; however, those other than &"string list"& are subject to
5386 particular kinds of interpretation, as described in chapter
5387 &<<CHAPdomhosaddlists>>&.
5388
5389 In all these cases, the entire list is treated as a single string as far as the
5390 input syntax is concerned. The &%trusted_users%& setting in section
5391 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5392 in a list, it must be entered as two colons. Leading and trailing white space
5393 on each item in a list is ignored. This makes it possible to include items that
5394 start with a colon, and in particular, certain forms of IPv6 address. For
5395 example, the list
5396 .code
5397 local_interfaces = 127.0.0.1 : ::::1
5398 .endd
5399 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5400
5401 &*Note*&: Although leading and trailing white space is ignored in individual
5402 list items, it is not ignored when parsing the list. The space after the first
5403 colon in the example above is necessary. If it were not there, the list would
5404 be interpreted as the two items 127.0.0.1:: and 1.
5405
5406 .section "Changing list separators" "SECTlistsepchange"
5407 .cindex "list separator" "changing"
5408 .cindex "IPv6" "addresses in lists"
5409 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5410 introduced to allow the separator character to be changed. If a list begins
5411 with a left angle bracket, followed by any punctuation character, that
5412 character is used instead of colon as the list separator. For example, the list
5413 above can be rewritten to use a semicolon separator like this:
5414 .code
5415 local_interfaces = <; 127.0.0.1 ; ::1
5416 .endd
5417 This facility applies to all lists, with the exception of the list in
5418 &%log_file_path%&. It is recommended that the use of non-colon separators be
5419 confined to circumstances where they really are needed.
5420
5421 .cindex "list separator" "newline as"
5422 .cindex "newline" "as list separator"
5423 It is also possible to use newline and other control characters (those with
5424 code values less than 32, plus DEL) as separators in lists. Such separators
5425 must be provided literally at the time the list is processed. For options that
5426 are string-expanded, you can write the separator using a normal escape
5427 sequence. This will be processed by the expander before the string is
5428 interpreted as a list. For example, if a newline-separated list of domains is
5429 generated by a lookup, you can process it directly by a line such as this:
5430 .code
5431 domains = <\n ${lookup mysql{.....}}
5432 .endd
5433 This avoids having to change the list separator in such data. You are unlikely
5434 to want to use a control character as a separator in an option that is not
5435 expanded, because the value is literal text. However, it can be done by giving
5436 the value in quotes. For example:
5437 .code
5438 local_interfaces = "<\n 127.0.0.1 \n ::1"
5439 .endd
5440 Unlike printing character separators, which can be included in list items by
5441 doubling, it is not possible to include a control character as data when it is
5442 set as the separator. Two such characters in succession are interpreted as
5443 enclosing an empty list item.
5444
5445
5446
5447 .section "Empty items in lists" "SECTempitelis"
5448 .cindex "list" "empty item in"
5449 An empty item at the end of a list is always ignored. In other words, trailing
5450 separator characters are ignored. Thus, the list in
5451 .code
5452 senders = user@domain :
5453 .endd
5454 contains only a single item. If you want to include an empty string as one item
5455 in a list, it must not be the last item. For example, this list contains three
5456 items, the second of which is empty:
5457 .code
5458 senders = user1@domain : : user2@domain
5459 .endd
5460 &*Note*&: There must be white space between the two colons, as otherwise they
5461 are interpreted as representing a single colon data character (and the list
5462 would then contain just one item). If you want to specify a list that contains
5463 just one, empty item, you can do it as in this example:
5464 .code
5465 senders = :
5466 .endd
5467 In this case, the first item is empty, and the second is discarded because it
5468 is at the end of the list.
5469
5470
5471
5472
5473 .section "Format of driver configurations" "SECTfordricon"
5474 .cindex "drivers" "configuration format"
5475 There are separate parts in the configuration for defining routers, transports,
5476 and authenticators. In each part, you are defining a number of driver
5477 instances, each with its own set of options. Each driver instance is defined by
5478 a sequence of lines like this:
5479 .display
5480 <&'instance name'&>:
5481   <&'option'&>
5482   ...
5483   <&'option'&>
5484 .endd
5485 In the following example, the instance name is &(localuser)&, and it is
5486 followed by three options settings:
5487 .code
5488 localuser:
5489   driver = accept
5490   check_local_user
5491   transport = local_delivery
5492 .endd
5493 For each driver instance, you specify which Exim code module it uses &-- by the
5494 setting of the &%driver%& option &-- and (optionally) some configuration
5495 settings. For example, in the case of transports, if you want a transport to
5496 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5497 a local file you would use the &(appendfile)& driver. Each of the drivers is
5498 described in detail in its own separate chapter later in this manual.
5499
5500 You can have several routers, transports, or authenticators that are based on
5501 the same underlying driver (each must have a different instance name).
5502
5503 The order in which routers are defined is important, because addresses are
5504 passed to individual routers one by one, in order. The order in which
5505 transports are defined does not matter at all. The order in which
5506 authenticators are defined is used only when Exim, as a client, is searching
5507 them to find one that matches an authentication mechanism offered by the
5508 server.
5509
5510 .cindex "generic options"
5511 .cindex "options" "generic &-- definition of"
5512 Within a driver instance definition, there are two kinds of option: &'generic'&
5513 and &'private'&. The generic options are those that apply to all drivers of the
5514 same type (that is, all routers, all transports or all authenticators). The
5515 &%driver%& option is a generic option that must appear in every definition.
5516 .cindex "private options"
5517 The private options are special for each driver, and none need appear, because
5518 they all have default values.
5519
5520 The options may appear in any order, except that the &%driver%& option must
5521 precede any private options, since these depend on the particular driver. For
5522 this reason, it is recommended that &%driver%& always be the first option.
5523
5524 Driver instance names, which are used for reference in log entries and
5525 elsewhere, can be any sequence of letters, digits, and underscores (starting
5526 with a letter) and must be unique among drivers of the same type. A router and
5527 a transport (for example) can each have the same name, but no two router
5528 instances can have the same name. The name of a driver instance should not be
5529 confused with the name of the underlying driver module. For example, the
5530 configuration lines:
5531 .code
5532 remote_smtp:
5533   driver = smtp
5534 .endd
5535 create an instance of the &(smtp)& transport driver whose name is
5536 &(remote_smtp)&. The same driver code can be used more than once, with
5537 different instance names and different option settings each time. A second
5538 instance of the &(smtp)& transport, with different options, might be defined
5539 thus:
5540 .code
5541 special_smtp:
5542   driver = smtp
5543   port = 1234
5544   command_timeout = 10s
5545 .endd
5546 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5547 these transport instances from routers, and these names would appear in log
5548 lines.
5549
5550 Comment lines may be present in the middle of driver specifications. The full
5551 list of option settings for any particular driver instance, including all the
5552 defaulted values, can be extracted by making use of the &%-bP%& command line
5553 option.
5554
5555
5556
5557
5558
5559
5560 . ////////////////////////////////////////////////////////////////////////////
5561 . ////////////////////////////////////////////////////////////////////////////
5562
5563 .chapter "The default configuration file" "CHAPdefconfil"
5564 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5565 .cindex "default" "configuration file &""walk through""&"
5566 The default configuration file supplied with Exim as &_src/configure.default_&
5567 is sufficient for a host with simple mail requirements. As an introduction to
5568 the way Exim is configured, this chapter &"walks through"& the default
5569 configuration, giving brief explanations of the settings. Detailed descriptions
5570 of the options are given in subsequent chapters. The default configuration file
5571 itself contains extensive comments about ways you might want to modify the
5572 initial settings. However, note that there are many options that are not
5573 mentioned at all in the default configuration.
5574
5575
5576
5577 .section "Macros" "SECTdefconfmacros"
5578 All macros should be defined before any options.
5579
5580 One macro is specified, but commented out, in the default configuration:
5581 .code
5582 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5583 .endd
5584 If all off-site mail is expected to be delivered to a "smarthost", then set the
5585 hostname here and uncomment the macro.  This will affect which router is used
5586 later on.  If this is left commented out, then Exim will perform direct-to-MX
5587 deliveries using a &(dnslookup)& router.
5588
5589 In addition to macros defined here, Exim includes a number of built-in macros
5590 to enable configuration to be guarded by a binary built with support for a
5591 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5592
5593
5594 .section "Main configuration settings" "SECTdefconfmain"
5595 The main (global) configuration option settings section must always come first
5596 in the file, after the macros.
5597 The first thing you'll see in the file, after some initial comments, is the line
5598 .code
5599 # primary_hostname =
5600 .endd
5601 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5602 to know the official, fully qualified name of your host, and this is where you
5603 can specify it. However, in most cases you do not need to set this option. When
5604 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5605
5606 The first three non-comment configuration lines are as follows:
5607 .code
5608 domainlist local_domains    = @
5609 domainlist relay_to_domains =
5610 hostlist   relay_from_hosts = 127.0.0.1
5611 .endd
5612 These are not, in fact, option settings. They are definitions of two named
5613 domain lists and one named host list. Exim allows you to give names to lists of
5614 domains, hosts, and email addresses, in order to make it easier to manage the
5615 configuration file (see section &<<SECTnamedlists>>&).
5616
5617 The first line defines a domain list called &'local_domains'&; this is used
5618 later in the configuration to identify domains that are to be delivered
5619 on the local host.
5620
5621 .cindex "@ in a domain list"
5622 There is just one item in this list, the string &"@"&. This is a special form
5623 of entry which means &"the name of the local host"&. Thus, if the local host is
5624 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5625 be delivered locally. Because the local host's name is referenced indirectly,
5626 the same configuration file can be used on different hosts.
5627
5628 The second line defines a domain list called &'relay_to_domains'&, but the
5629 list itself is empty. Later in the configuration we will come to the part that
5630 controls mail relaying through the local host; it allows relaying to any
5631 domains in this list. By default, therefore, no relaying on the basis of a mail
5632 domain is permitted.
5633
5634 The third line defines a host list called &'relay_from_hosts'&. This list is
5635 used later in the configuration to permit relaying from any host or IP address
5636 that matches the list. The default contains just the IP address of the IPv4
5637 loopback interface, which means that processes on the local host are able to
5638 submit mail for relaying by sending it over TCP/IP to that interface. No other
5639 hosts are permitted to submit messages for relaying.
5640
5641 Just to be sure there's no misunderstanding: at this point in the configuration
5642 we aren't actually setting up any controls. We are just defining some domains
5643 and hosts that will be used in the controls that are specified later.
5644
5645 The next two configuration lines are genuine option settings:
5646 .code
5647 acl_smtp_rcpt = acl_check_rcpt
5648 acl_smtp_data = acl_check_data
5649 .endd
5650 These options specify &'Access Control Lists'& (ACLs) that are to be used
5651 during an incoming SMTP session for every recipient of a message (every RCPT
5652 command), and after the contents of the message have been received,
5653 respectively. The names of the lists are &'acl_check_rcpt'& and
5654 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5655 section of the configuration. The RCPT ACL controls which recipients are
5656 accepted for an incoming message &-- if a configuration does not provide an ACL
5657 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5658 contents of a message to be checked.
5659
5660 Two commented-out option settings are next:
5661 .code
5662 # av_scanner = clamd:/tmp/clamd
5663 # spamd_address = 127.0.0.1 783
5664 .endd
5665 These are example settings that can be used when Exim is compiled with the
5666 content-scanning extension. The first specifies the interface to the virus
5667 scanner, and the second specifies the interface to SpamAssassin. Further
5668 details are given in chapter &<<CHAPexiscan>>&.
5669
5670 Three more commented-out option settings follow:
5671 .code
5672 # tls_advertise_hosts = *
5673 # tls_certificate = /etc/ssl/exim.crt
5674 # tls_privatekey = /etc/ssl/exim.pem
5675 .endd
5676 These are example settings that can be used when Exim is compiled with
5677 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5678 first one specifies the list of clients that are allowed to use TLS when
5679 connecting to this server; in this case, the wildcard means all clients. The
5680 other options specify where Exim should find its TLS certificate and private
5681 key, which together prove the server's identity to any clients that connect.
5682 More details are given in chapter &<<CHAPTLS>>&.
5683
5684 Another two commented-out option settings follow:
5685 .code
5686 # daemon_smtp_ports = 25 : 465 : 587
5687 # tls_on_connect_ports = 465
5688 .endd
5689 .cindex "port" "465 and 587"
5690 .cindex "port" "for message submission"
5691 .cindex "message" "submission, ports for"
5692 .cindex "submissions protocol"
5693 .cindex "smtps protocol"
5694 .cindex "ssmtp protocol"
5695 .cindex "SMTP" "submissions protocol"
5696 .cindex "SMTP" "ssmtp protocol"
5697 .cindex "SMTP" "smtps protocol"
5698 These options provide better support for roaming users who wish to use this
5699 server for message submission. They are not much use unless you have turned on
5700 TLS (as described in the previous paragraph) and authentication (about which
5701 more in section &<<SECTdefconfauth>>&).
5702 Mail submission from mail clients (MUAs) should be separate from inbound mail
5703 to your domain (MX delivery) for various good reasons (eg, ability to impose
5704 much saner TLS protocol and ciphersuite requirements without unintended
5705 consequences).
5706 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5707 which uses STARTTLS, so this is the &"submission"& port.
5708 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5709 which should be used in preference to 587.
5710 You should also consider deploying SRV records to help clients find
5711 these ports.
5712 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5713
5714 Two more commented-out options settings follow:
5715 .code
5716 # qualify_domain =
5717 # qualify_recipient =
5718 .endd
5719 The first of these specifies a domain that Exim uses when it constructs a
5720 complete email address from a local login name. This is often needed when Exim
5721 receives a message from a local process. If you do not set &%qualify_domain%&,
5722 the value of &%primary_hostname%& is used. If you set both of these options,
5723 you can have different qualification domains for sender and recipient
5724 addresses. If you set only the first one, its value is used in both cases.
5725
5726 .cindex "domain literal" "recognizing format"
5727 The following line must be uncommented if you want Exim to recognize
5728 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5729 (an IP address within square brackets) instead of a named domain.
5730 .code
5731 # allow_domain_literals
5732 .endd
5733 The RFCs still require this form, but many people think that in the modern
5734 Internet it makes little sense to permit mail to be sent to specific hosts by
5735 quoting their IP addresses. This ancient format has been used by people who
5736 try to abuse hosts by using them for unwanted relaying. However, some
5737 people believe there are circumstances (for example, messages addressed to
5738 &'postmaster'&) where domain literals are still useful.
5739
5740 The next configuration line is a kind of trigger guard:
5741 .code
5742 never_users = root
5743 .endd
5744 It specifies that no delivery must ever be run as the root user. The normal
5745 convention is to set up &'root'& as an alias for the system administrator. This
5746 setting is a guard against slips in the configuration.
5747 The list of users specified by &%never_users%& is not, however, the complete
5748 list; the build-time configuration in &_Local/Makefile_& has an option called
5749 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5750 contents of &%never_users%& are added to this list. By default
5751 FIXED_NEVER_USERS also specifies root.
5752
5753 When a remote host connects to Exim in order to send mail, the only information
5754 Exim has about the host's identity is its IP address. The next configuration
5755 line,
5756 .code
5757 host_lookup = *
5758 .endd
5759 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5760 in order to get a host name. This improves the quality of the logging
5761 information, but if you feel it is too expensive, you can remove it entirely,
5762 or restrict the lookup to hosts on &"nearby"& networks.
5763 Note that it is not always possible to find a host name from an IP address,
5764 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5765 unreachable.
5766
5767 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5768 1413 (hence their names):
5769 .code
5770 rfc1413_hosts = *
5771 rfc1413_query_timeout = 0s
5772 .endd
5773 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5774 Few hosts offer RFC1413 service these days; calls have to be
5775 terminated by a timeout and this needlessly delays the startup
5776 of an incoming SMTP connection.
5777 If you have hosts for which you trust RFC1413 and need this
5778 information, you can change this.
5779
5780 This line enables an efficiency SMTP option.  It is negotiated by clients
5781 and not expected to cause problems but can be disabled if needed.
5782 .code
5783 prdr_enable = true
5784 .endd
5785
5786 When Exim receives messages over SMTP connections, it expects all addresses to
5787 be fully qualified with a domain, as required by the SMTP definition. However,
5788 if you are running a server to which simple clients submit messages, you may
5789 find that they send unqualified addresses. The two commented-out options:
5790 .code
5791 # sender_unqualified_hosts =
5792 # recipient_unqualified_hosts =
5793 .endd
5794 show how you can specify hosts that are permitted to send unqualified sender
5795 and recipient addresses, respectively.
5796
5797 The &%log_selector%& option is used to increase the detail of logging
5798 over the default:
5799 .code
5800 log_selector = +smtp_protocol_error +smtp_syntax_error \
5801                +tls_certificate_verified
5802 .endd
5803
5804 The &%percent_hack_domains%& option is also commented out:
5805 .code
5806 # percent_hack_domains =
5807 .endd
5808 It provides a list of domains for which the &"percent hack"& is to operate.
5809 This is an almost obsolete form of explicit email routing. If you do not know
5810 anything about it, you can safely ignore this topic.
5811
5812 The next two settings in the main part of the default configuration are
5813 concerned with messages that have been &"frozen"& on Exim's queue. When a
5814 message is frozen, Exim no longer continues to try to deliver it. Freezing
5815 occurs when a bounce message encounters a permanent failure because the sender
5816 address of the original message that caused the bounce is invalid, so the
5817 bounce cannot be delivered. This is probably the most common case, but there
5818 are also other conditions that cause freezing, and frozen messages are not
5819 always bounce messages.
5820 .code
5821 ignore_bounce_errors_after = 2d
5822 timeout_frozen_after = 7d
5823 .endd
5824 The first of these options specifies that failing bounce messages are to be
5825 discarded after 2 days in the queue. The second specifies that any frozen
5826 message (whether a bounce message or not) is to be timed out (and discarded)
5827 after a week. In this configuration, the first setting ensures that no failing
5828 bounce message ever lasts a week.
5829
5830 Exim queues it's messages in a spool directory. If you expect to have
5831 large queues, you may consider using this option. It splits the spool
5832 directory into subdirectories to avoid file system degradation from
5833 many files in a single directory, resulting in better performance.
5834 Manual manipulation of queued messages becomes more complex (though fortunately
5835 not often needed).
5836 .code
5837 # split_spool_directory = true
5838 .endd
5839
5840 In an ideal world everybody follows the standards. For non-ASCII
5841 messages RFC 2047 is a standard, allowing a maximum line length of 76
5842 characters. Exim adheres that standard and won't process messages which
5843 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5844 In particular, the Exim maintainers have had multiple reports of
5845 problems from Russian administrators of issues until they disable this
5846 check, because of some popular, yet buggy, mail composition software.
5847 .code
5848 # check_rfc2047_length = false
5849 .endd
5850
5851 If you need to be strictly RFC compliant you may wish to disable the
5852 8BITMIME advertisement. Use this, if you exchange mails with systems
5853 that are not 8-bit clean.
5854 .code
5855 # accept_8bitmime = false
5856 .endd
5857
5858 Libraries you use may depend on specific environment settings.  This
5859 imposes a security risk (e.g. PATH). There are two lists:
5860 &%keep_environment%& for the variables to import as they are, and
5861 &%add_environment%& for variables we want to set to a fixed value.
5862 Note that TZ is handled separately, by the $%timezone%$ runtime
5863 option and by the TIMEZONE_DEFAULT buildtime option.
5864 .code
5865 # keep_environment = ^LDAP
5866 # add_environment = PATH=/usr/bin::/bin
5867 .endd
5868
5869
5870 .section "ACL configuration" "SECID54"
5871 .cindex "default" "ACLs"
5872 .cindex "&ACL;" "default configuration"
5873 In the default configuration, the ACL section follows the main configuration.
5874 It starts with the line
5875 .code
5876 begin acl
5877 .endd
5878 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5879 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5880 and &%acl_smtp_data%& above.
5881
5882 .cindex "RCPT" "ACL for"
5883 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5884 RCPT command specifies one of the message's recipients. The ACL statements
5885 are considered in order, until the recipient address is either accepted or
5886 rejected. The RCPT command is then accepted or rejected, according to the
5887 result of the ACL processing.
5888 .code
5889 acl_check_rcpt:
5890 .endd
5891 This line, consisting of a name terminated by a colon, marks the start of the
5892 ACL, and names it.
5893 .code
5894 accept  hosts = :
5895 .endd
5896 This ACL statement accepts the recipient if the sending host matches the list.
5897 But what does that strange list mean? It doesn't actually contain any host
5898 names or IP addresses. The presence of the colon puts an empty item in the
5899 list; Exim matches this only if the incoming message did not come from a remote
5900 host, because in that case, the remote hostname is empty. The colon is
5901 important. Without it, the list itself is empty, and can never match anything.
5902
5903 What this statement is doing is to accept unconditionally all recipients in
5904 messages that are submitted by SMTP from local processes using the standard
5905 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5906 manner.
5907 .code
5908 deny    domains       = +local_domains
5909         local_parts   = ^[.] : ^.*[@%!/|]
5910         message       = Restricted characters in address
5911
5912 deny    domains       = !+local_domains
5913         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5914         message       = Restricted characters in address
5915 .endd
5916 These statements are concerned with local parts that contain any of the
5917 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5918 Although these characters are entirely legal in local parts (in the case of
5919 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5920 in Internet mail addresses.
5921
5922 The first three have in the past been associated with explicitly routed
5923 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5924 option). Addresses containing these characters are regularly tried by spammers
5925 in an attempt to bypass relaying restrictions, and also by open relay testing
5926 programs. Unless you really need them it is safest to reject these characters
5927 at this early stage. This configuration is heavy-handed in rejecting these
5928 characters for all messages it accepts from remote hosts. This is a deliberate
5929 policy of being as safe as possible.
5930
5931 The first rule above is stricter, and is applied to messages that are addressed
5932 to one of the local domains handled by this host. This is implemented by the
5933 first condition, which restricts it to domains that are listed in the
5934 &'local_domains'& domain list. The &"+"& character is used to indicate a
5935 reference to a named list. In this configuration, there is just one domain in
5936 &'local_domains'&, but in general there may be many.
5937
5938 The second condition on the first statement uses two regular expressions to
5939 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5940 or &"|"&. If you have local accounts that include these characters, you will
5941 have to modify this rule.
5942
5943 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5944 allows them because they have been encountered in practice. (Consider the
5945 common convention of local parts constructed as
5946 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5947 the author of Exim, who has no second initial.) However, a local part starting
5948 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5949 filename (for example, for a mailing list). This is also true for local parts
5950 that contain slashes. A pipe symbol can also be troublesome if the local part
5951 is incorporated unthinkingly into a shell command line.
5952
5953 The second rule above applies to all other domains, and is less strict. This
5954 allows your own users to send outgoing messages to sites that use slashes
5955 and vertical bars in their local parts. It blocks local parts that begin
5956 with a dot, slash, or vertical bar, but allows these characters within the
5957 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5958 and &"!"& is blocked, as before. The motivation here is to prevent your users
5959 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5960 .code
5961 accept  local_parts   = postmaster
5962         domains       = +local_domains
5963 .endd
5964 This statement, which has two conditions, accepts an incoming address if the
5965 local part is &'postmaster'& and the domain is one of those listed in the
5966 &'local_domains'& domain list. The &"+"& character is used to indicate a
5967 reference to a named list. In this configuration, there is just one domain in
5968 &'local_domains'&, but in general there may be many.
5969
5970 The presence of this statement means that mail to postmaster is never blocked
5971 by any of the subsequent tests. This can be helpful while sorting out problems
5972 in cases where the subsequent tests are incorrectly denying access.
5973 .code
5974 require verify        = sender
5975 .endd
5976 This statement requires the sender address to be verified before any subsequent
5977 ACL statement can be used. If verification fails, the incoming recipient
5978 address is refused. Verification consists of trying to route the address, to
5979 see if a bounce message could be delivered to it. In the case of remote
5980 addresses, basic verification checks only the domain, but &'callouts'& can be
5981 used for more verification if required. Section &<<SECTaddressverification>>&
5982 discusses the details of address verification.
5983 .code
5984 accept  hosts         = +relay_from_hosts
5985         control       = submission
5986 .endd
5987 This statement accepts the address if the message is coming from one of the
5988 hosts that are defined as being allowed to relay through this host. Recipient
5989 verification is omitted here, because in many cases the clients are dumb MUAs
5990 that do not cope well with SMTP error responses. For the same reason, the
5991 second line specifies &"submission mode"& for messages that are accepted. This
5992 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5993 messages that are deficient in some way, for example, because they lack a
5994 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5995 probably add recipient verification here, and disable submission mode.
5996 .code
5997 accept  authenticated = *
5998         control       = submission
5999 .endd
6000 This statement accepts the address if the client host has authenticated itself.
6001 Submission mode is again specified, on the grounds that such messages are most
6002 likely to come from MUAs. The default configuration does not define any
6003 authenticators, though it does include some nearly complete commented-out
6004 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6005 fact authenticate until you complete the authenticator definitions.
6006 .code
6007 require message = relay not permitted
6008         domains = +local_domains : +relay_to_domains
6009 .endd
6010 This statement rejects the address if its domain is neither a local domain nor
6011 one of the domains for which this host is a relay.
6012 .code
6013 require verify = recipient
6014 .endd
6015 This statement requires the recipient address to be verified; if verification
6016 fails, the address is rejected.
6017 .code
6018 # deny    dnslists    = black.list.example
6019 #         message     = rejected because $sender_host_address \
6020 #                       is in a black list at $dnslist_domain\n\
6021 #                       $dnslist_text
6022 #
6023 # warn    dnslists    = black.list.example
6024 #         add_header  = X-Warning: $sender_host_address is in \
6025 #                       a black list at $dnslist_domain
6026 #         log_message = found in $dnslist_domain
6027 .endd
6028 These commented-out lines are examples of how you could configure Exim to check
6029 sending hosts against a DNS black list. The first statement rejects messages
6030 from blacklisted hosts, whereas the second just inserts a warning header
6031 line.
6032 .code
6033 # require verify = csa
6034 .endd
6035 This commented-out line is an example of how you could turn on client SMTP
6036 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6037 records.
6038 .code
6039 accept
6040 .endd
6041 The final statement in the first ACL unconditionally accepts any recipient
6042 address that has successfully passed all the previous tests.
6043 .code
6044 acl_check_data:
6045 .endd
6046 This line marks the start of the second ACL, and names it. Most of the contents
6047 of this ACL are commented out:
6048 .code
6049 # deny    malware   = *
6050 #         message   = This message contains a virus \
6051 #                     ($malware_name).
6052 .endd
6053 These lines are examples of how to arrange for messages to be scanned for
6054 viruses when Exim has been compiled with the content-scanning extension, and a
6055 suitable virus scanner is installed. If the message is found to contain a
6056 virus, it is rejected with the given custom error message.
6057 .code
6058 # warn    spam      = nobody
6059 #         message   = X-Spam_score: $spam_score\n\
6060 #                     X-Spam_score_int: $spam_score_int\n\
6061 #                     X-Spam_bar: $spam_bar\n\
6062 #                     X-Spam_report: $spam_report
6063 .endd
6064 These lines are an example of how to arrange for messages to be scanned by
6065 SpamAssassin when Exim has been compiled with the content-scanning extension,
6066 and SpamAssassin has been installed. The SpamAssassin check is run with
6067 &`nobody`& as its user parameter, and the results are added to the message as a
6068 series of extra header line. In this case, the message is not rejected,
6069 whatever the spam score.
6070 .code
6071 accept
6072 .endd
6073 This final line in the DATA ACL accepts the message unconditionally.
6074
6075
6076 .section "Router configuration" "SECID55"
6077 .cindex "default" "routers"
6078 .cindex "routers" "default"
6079 The router configuration comes next in the default configuration, introduced
6080 by the line
6081 .code
6082 begin routers
6083 .endd
6084 Routers are the modules in Exim that make decisions about where to send
6085 messages. An address is passed to each router, in turn, until it is either
6086 accepted, or failed. This means that the order in which you define the routers
6087 matters. Each router is fully described in its own chapter later in this
6088 manual. Here we give only brief overviews.
6089 .code
6090 # domain_literal:
6091 #   driver = ipliteral
6092 #   domains = !+local_domains
6093 #   transport = remote_smtp
6094 .endd
6095 .cindex "domain literal" "default router"
6096 This router is commented out because the majority of sites do not want to
6097 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6098 you uncomment this router, you also need to uncomment the setting of
6099 &%allow_domain_literals%& in the main part of the configuration.
6100
6101 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6102 macro has been defined, per
6103 .code
6104 .ifdef ROUTER_SMARTHOST
6105 smarthost:
6106 #...
6107 .else
6108 dnslookup:
6109 #...
6110 .endif
6111 .endd
6112
6113 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6114 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6115 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6116 skip these routers because of the &%domains%& option.
6117
6118 .code
6119 smarthost:
6120   driver = manualroute
6121   domains = ! +local_domains
6122   transport = smarthost_smtp
6123   route_data = ROUTER_SMARTHOST
6124   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6125   no_more
6126 .endd
6127 This router only handles mail which is not to any local domains; this is
6128 specified by the line
6129 .code
6130 domains = ! +local_domains
6131 .endd
6132 The &%domains%& option lists the domains to which this router applies, but the
6133 exclamation mark is a negation sign, so the router is used only for domains
6134 that are not in the domain list called &'local_domains'& (which was defined at
6135 the start of the configuration). The plus sign before &'local_domains'&
6136 indicates that it is referring to a named list. Addresses in other domains are
6137 passed on to the following routers.
6138
6139 The name of the router driver is &(manualroute)& because we are manually
6140 specifying how mail should be routed onwards, instead of using DNS MX.
6141 While the name of this router instance is arbitrary, the &%driver%& option must
6142 be one of the driver modules that is in the Exim binary.
6143
6144 With no pre-conditions other than &%domains%&, all mail for non-local domains
6145 will be handled by this router, and the &%no_more%& setting will ensure that no
6146 other routers will be used for messages matching the pre-conditions.  See
6147 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6148 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6149 and the macro supplies the value; the address is then queued for the
6150 &(smarthost_smtp)& transport.
6151
6152 .code
6153 dnslookup:
6154   driver = dnslookup
6155   domains = ! +local_domains
6156   transport = remote_smtp
6157   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6158   no_more
6159 .endd
6160 The &%domains%& option behaves as per smarthost, above.
6161
6162 The name of the router driver is &(dnslookup)&,
6163 and is specified by the &%driver%& option. Do not be confused by the fact that
6164 the name of this router instance is the same as the name of the driver. The
6165 instance name is arbitrary, but the name set in the &%driver%& option must be
6166 one of the driver modules that is in the Exim binary.
6167
6168 The &(dnslookup)& router routes addresses by looking up their domains in the
6169 DNS in order to obtain a list of hosts to which the address is routed. If the
6170 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6171 specified by the &%transport%& option. If the router does not find the domain
6172 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6173 the address fails and is bounced.
6174
6175 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6176 be entirely ignored. This option is present because a number of cases have been
6177 encountered where MX records in the DNS point to host names
6178 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6179 Completely ignoring these IP addresses causes Exim to fail to route the
6180 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6181 continue to try to deliver the message periodically until the address timed
6182 out.
6183 .code
6184 system_aliases:
6185   driver = redirect
6186   allow_fail
6187   allow_defer
6188   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6189 # user = exim
6190   file_transport = address_file
6191   pipe_transport = address_pipe
6192 .endd
6193 Control reaches this and subsequent routers only for addresses in the local
6194 domains. This router checks to see whether the local part is defined as an
6195 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6196 data that it looks up from that file. If no data is found for the local part,
6197 the value of the &%data%& option is empty, causing the address to be passed to
6198 the next router.
6199
6200 &_/etc/aliases_& is a conventional name for the system aliases file that is
6201 often used. That is why it is referenced by from the default configuration
6202 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6203 &_Local/Makefile_& before building Exim.
6204 .code
6205 userforward:
6206   driver = redirect
6207   check_local_user
6208 # local_part_suffix = +* : -*
6209 # local_part_suffix_optional
6210   file = $home/.forward
6211 # allow_filter
6212   no_verify
6213   no_expn
6214   check_ancestor
6215   file_transport = address_file
6216   pipe_transport = address_pipe
6217   reply_transport = address_reply
6218 .endd
6219 This is the most complicated router in the default configuration. It is another
6220 redirection router, but this time it is looking for forwarding data set up by
6221 individual users. The &%check_local_user%& setting specifies a check that the
6222 local part of the address is the login name of a local user. If it is not, the
6223 router is skipped. The two commented options that follow &%check_local_user%&,
6224 namely:
6225 .code
6226 # local_part_suffix = +* : -*
6227 # local_part_suffix_optional
6228 .endd
6229 .vindex "&$local_part_suffix$&"
6230 show how you can specify the recognition of local part suffixes. If the first
6231 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6232 by any sequence of characters, is removed from the local part and placed in the
6233 variable &$local_part_suffix$&. The second suffix option specifies that the
6234 presence of a suffix in the local part is optional. When a suffix is present,
6235 the check for a local login uses the local part with the suffix removed.
6236
6237 When a local user account is found, the file called &_.forward_& in the user's
6238 home directory is consulted. If it does not exist, or is empty, the router
6239 declines. Otherwise, the contents of &_.forward_& are interpreted as
6240 redirection data (see chapter &<<CHAPredirect>>& for more details).
6241
6242 .cindex "Sieve filter" "enabling in default router"
6243 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6244 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6245 is commented out by default), the contents of the file are interpreted as a set
6246 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6247 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6248 separate document entitled &'Exim's interfaces to mail filtering'&.
6249
6250 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6251 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6252 There are two reasons for doing this:
6253
6254 .olist
6255 Whether or not a local user has a &_.forward_& file is not really relevant when
6256 checking an address for validity; it makes sense not to waste resources doing
6257 unnecessary work.
6258 .next
6259 More importantly, when Exim is verifying addresses or handling an EXPN
6260 command during an SMTP session, it is running as the Exim user, not as root.
6261 The group is the Exim group, and no additional groups are set up.
6262 It may therefore not be possible for Exim to read users' &_.forward_& files at
6263 this time.
6264 .endlist
6265
6266 The setting of &%check_ancestor%& prevents the router from generating a new
6267 address that is the same as any previous address that was redirected. (This
6268 works round a problem concerning a bad interaction between aliasing and
6269 forwarding &-- see section &<<SECTredlocmai>>&).
6270
6271 The final three option settings specify the transports that are to be used when
6272 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6273 auto-reply, respectively. For example, if a &_.forward_& file contains
6274 .code
6275 a.nother@elsewhere.example, /home/spqr/archive
6276 .endd
6277 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6278 transport.
6279 .code
6280 localuser:
6281   driver = accept
6282   check_local_user
6283 # local_part_suffix = +* : -*
6284 # local_part_suffix_optional
6285   transport = local_delivery
6286 .endd
6287 The final router sets up delivery into local mailboxes, provided that the local
6288 part is the name of a local login, by accepting the address and assigning it to
6289 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6290 routers, so the address is bounced. The commented suffix settings fulfil the
6291 same purpose as they do for the &(userforward)& router.
6292
6293
6294 .section "Transport configuration" "SECID56"
6295 .cindex "default" "transports"
6296 .cindex "transports" "default"
6297 Transports define mechanisms for actually delivering messages. They operate
6298 only when referenced from routers, so the order in which they are defined does
6299 not matter. The transports section of the configuration starts with
6300 .code
6301 begin transports
6302 .endd
6303 Two remote transports and four local transports are defined.
6304 .code
6305 remote_smtp:
6306   driver = smtp
6307   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6308 .ifdef _HAVE_PRDR
6309   hosts_try_prdr = *
6310 .endif
6311 .endd
6312 This transport is used for delivering messages over SMTP connections.
6313 The list of remote hosts comes from the router.
6314 The &%message_size_limit%& usage is a hack to avoid sending on messages
6315 with over-long lines.
6316
6317 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6318 negotiated between client and server and not expected to cause problems
6319 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6320 use of the &%hosts_try_prdr%& configuration option.
6321
6322 The other remote transport is used when delivering to a specific smarthost
6323 with whom there must be some kind of existing relationship, instead of the
6324 usual federated system.
6325
6326 .code
6327 smarthost_smtp:
6328   driver = smtp
6329   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6330   multi_domain
6331   #
6332 .ifdef _HAVE_TLS
6333   # Comment out any of these which you have to, then file a Support
6334   # request with your smarthost provider to get things fixed:
6335   hosts_require_tls = *
6336   tls_verify_hosts = *
6337   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6338   # have to comment it out then this will at least log whether you succeed
6339   # or not:
6340   tls_try_verify_hosts = *
6341   #
6342   # The SNI name should match the name which we'll expect to verify;
6343   # many mail systems don't use SNI and this doesn't matter, but if it does,
6344   # we need to send a name which the remote site will recognize.
6345   # This _should_ be the name which the smarthost operators specified as
6346   # the hostname for sending your mail to.
6347   tls_sni = ROUTER_SMARTHOST
6348   #
6349 .ifdef _HAVE_OPENSSL
6350   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6351 .endif
6352 .ifdef _HAVE_GNUTLS
6353   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6354 .endif
6355 .endif
6356 .ifdef _HAVE_PRDR
6357   hosts_try_prdr = *
6358 .endif
6359 .endd
6360 After the same &%message_size_limit%& hack, we then specify that this Transport
6361 can handle messages to multiple domains in one run.  The assumption here is
6362 that you're routing all non-local mail to the same place and that place is
6363 happy to take all messages from you as quickly as possible.
6364 All other options depend upon built-in macros; if Exim was built without TLS support
6365 then no other options are defined.
6366 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6367 and versions using the &%tls_require_ciphers%& option, where the value to be
6368 used depends upon the library providing TLS.
6369 Beyond that, the options adopt the stance that you should have TLS support available
6370 from your smarthost on today's Internet, so we turn on requiring TLS for the
6371 mail to be delivered, and requiring that the certificate be valid, and match
6372 the expected hostname.  The &%tls_sni%& option can be used by service providers
6373 to select an appropriate certificate to present to you and here we re-use the
6374 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6375 You want to specify the hostname which you'll expect to validate for, and that
6376 should not be subject to insecure tampering via DNS results.
6377
6378 For the &%hosts_try_prdr%& option see the previous transport.
6379
6380 All other options are defaulted.
6381 .code
6382 local_delivery:
6383   driver = appendfile
6384   file = /var/mail/$local_part_data
6385   delivery_date_add
6386   envelope_to_add
6387   return_path_add
6388 # group = mail
6389 # mode = 0660
6390 .endd
6391 This &(appendfile)& transport is used for local delivery to user mailboxes in
6392 traditional BSD mailbox format.
6393
6394 .new
6395 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6396 as it is provided by a potential bad actor.
6397 Instead we use &$local_part_data$&,
6398 the result of looking up &$local_part$& in the user database
6399 (done by using &%check_local_user%& in the the router).
6400 .wen
6401
6402 By default &(appendfile)& runs under the uid and gid of the
6403 local user, which requires the sticky bit to be set on the &_/var/mail_&
6404 directory. Some systems use the alternative approach of running mail deliveries
6405 under a particular group instead of using the sticky bit. The commented options
6406 show how this can be done.
6407
6408 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6409 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6410 similarly-named options above.
6411 .code
6412 address_pipe:
6413   driver = pipe
6414   return_output
6415 .endd
6416 This transport is used for handling deliveries to pipes that are generated by
6417 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6418 option specifies that any output on stdout or stderr generated by the pipe is to
6419 be returned to the sender.
6420 .code
6421 address_file:
6422   driver = appendfile
6423   delivery_date_add
6424   envelope_to_add
6425   return_path_add
6426 .endd
6427 This transport is used for handling deliveries to files that are generated by
6428 redirection. The name of the file is not specified in this instance of
6429 &(appendfile)&, because it comes from the &(redirect)& router.
6430 .code
6431 address_reply:
6432   driver = autoreply
6433 .endd
6434 This transport is used for handling automatic replies generated by users'
6435 filter files.
6436
6437
6438
6439 .section "Default retry rule" "SECID57"
6440 .cindex "retry" "default rule"
6441 .cindex "default" "retry rule"
6442 The retry section of the configuration file contains rules which affect the way
6443 Exim retries deliveries that cannot be completed at the first attempt. It is
6444 introduced by the line
6445 .code
6446 begin retry
6447 .endd
6448 In the default configuration, there is just one rule, which applies to all
6449 errors:
6450 .code
6451 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6452 .endd
6453 This causes any temporarily failing address to be retried every 15 minutes for
6454 2 hours, then at intervals starting at one hour and increasing by a factor of
6455 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6456 is not delivered after 4 days of temporary failure, it is bounced. The time is
6457 measured from first failure, not from the time the message was received.
6458
6459 If the retry section is removed from the configuration, or is empty (that is,
6460 if no retry rules are defined), Exim will not retry deliveries. This turns
6461 temporary errors into permanent errors.
6462
6463
6464 .section "Rewriting configuration" "SECID58"
6465 The rewriting section of the configuration, introduced by
6466 .code
6467 begin rewrite
6468 .endd
6469 contains rules for rewriting addresses in messages as they arrive. There are no
6470 rewriting rules in the default configuration file.
6471
6472
6473
6474 .section "Authenticators configuration" "SECTdefconfauth"
6475 .cindex "AUTH" "configuration"
6476 The authenticators section of the configuration, introduced by
6477 .code
6478 begin authenticators
6479 .endd
6480 defines mechanisms for the use of the SMTP AUTH command. The default
6481 configuration file contains two commented-out example authenticators
6482 which support plaintext username/password authentication using the
6483 standard PLAIN mechanism and the traditional but non-standard LOGIN
6484 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6485 to support most MUA software.
6486
6487 The example PLAIN authenticator looks like this:
6488 .code
6489 #PLAIN:
6490 #  driver                  = plaintext
6491 #  server_set_id           = $auth2
6492 #  server_prompts          = :
6493 #  server_condition        = Authentication is not yet configured
6494 #  server_advertise_condition = ${if def:tls_in_cipher }
6495 .endd
6496 And the example LOGIN authenticator looks like this:
6497 .code
6498 #LOGIN:
6499 #  driver                  = plaintext
6500 #  server_set_id           = $auth1
6501 #  server_prompts          = <| Username: | Password:
6502 #  server_condition        = Authentication is not yet configured
6503 #  server_advertise_condition = ${if def:tls_in_cipher }
6504 .endd
6505
6506 The &%server_set_id%& option makes Exim remember the authenticated username
6507 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6508 &%server_prompts%& option configures the &(plaintext)& authenticator so
6509 that it implements the details of the specific authentication mechanism,
6510 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6511 when Exim offers authentication to clients; in the examples, this is only
6512 when TLS or SSL has been started, so to enable the authenticators you also
6513 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6514
6515 The &%server_condition%& setting defines how to verify that the username and
6516 password are correct. In the examples it just produces an error message.
6517 To make the authenticators work, you can use a string expansion
6518 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6519
6520 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6521 usercode and password are in different positions.
6522 Chapter &<<CHAPplaintext>>& covers both.
6523
6524 .ecindex IIDconfiwal
6525
6526
6527
6528 . ////////////////////////////////////////////////////////////////////////////
6529 . ////////////////////////////////////////////////////////////////////////////
6530
6531 .chapter "Regular expressions" "CHAPregexp"
6532
6533 .cindex "regular expressions" "library"
6534 .cindex "PCRE"
6535 Exim supports the use of regular expressions in many of its options. It
6536 uses the PCRE regular expression library; this provides regular expression
6537 matching that is compatible with Perl 5. The syntax and semantics of
6538 regular expressions is discussed in
6539 online Perl manpages, in
6540 many Perl reference books, and also in
6541 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6542 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6543 . --- the http: URL here redirects to another page with the ISBN in the URL
6544 . --- where trying to use https: just redirects back to http:, so sticking
6545 . --- to the old URL for now.  2018-09-07.
6546
6547 The documentation for the syntax and semantics of the regular expressions that
6548 are supported by PCRE is included in the PCRE distribution, and no further
6549 description is included here. The PCRE functions are called from Exim using
6550 the default option settings (that is, with no PCRE options set), except that
6551 the PCRE_CASELESS option is set when the matching is required to be
6552 case-insensitive.
6553
6554 In most cases, when a regular expression is required in an Exim configuration,
6555 it has to start with a circumflex, in order to distinguish it from plain text
6556 or an &"ends with"& wildcard. In this example of a configuration setting, the
6557 second item in the colon-separated list is a regular expression.
6558 .code
6559 domains = a.b.c : ^\\d{3} : *.y.z : ...
6560 .endd
6561 The doubling of the backslash is required because of string expansion that
6562 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6563 of this issue, and a way of avoiding the need for doubling backslashes. The
6564 regular expression that is eventually used in this example contains just one
6565 backslash. The circumflex is included in the regular expression, and has the
6566 normal effect of &"anchoring"& it to the start of the string that is being
6567 matched.
6568
6569 There are, however, two cases where a circumflex is not required for the
6570 recognition of a regular expression: these are the &%match%& condition in a
6571 string expansion, and the &%matches%& condition in an Exim filter file. In
6572 these cases, the relevant string is always treated as a regular expression; if
6573 it does not start with a circumflex, the expression is not anchored, and can
6574 match anywhere in the subject string.
6575
6576 In all cases, if you want a regular expression to match at the end of a string,
6577 you must code the $ metacharacter to indicate this. For example:
6578 .code
6579 domains = ^\\d{3}\\.example
6580 .endd
6581 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6582 You need to use:
6583 .code
6584 domains = ^\\d{3}\\.example\$
6585 .endd
6586 if you want &'example'& to be the top-level domain. The backslash before the
6587 $ is needed because string expansion also interprets dollar characters.
6588
6589
6590
6591 . ////////////////////////////////////////////////////////////////////////////
6592 . ////////////////////////////////////////////////////////////////////////////
6593
6594 .chapter "File and database lookups" "CHAPfdlookup"
6595 .scindex IIDfidalo1 "file" "lookups"
6596 .scindex IIDfidalo2 "database" "lookups"
6597 .cindex "lookup" "description of"
6598 Exim can be configured to look up data in files or databases as it processes
6599 messages. Two different kinds of syntax are used:
6600
6601 .olist
6602 A string that is to be expanded may contain explicit lookup requests. These
6603 cause parts of the string to be replaced by data that is obtained from the
6604 lookup. Lookups of this type are conditional expansion items. Different results
6605 can be defined for the cases of lookup success and failure. See chapter
6606 &<<CHAPexpand>>&, where string expansions are described in detail.
6607 The key for the lookup is specified as part of the string expansion.
6608 .next
6609 Lists of domains, hosts, and email addresses can contain lookup requests as a
6610 way of avoiding excessively long linear lists. In this case, the data that is
6611 returned by the lookup is often (but not always) discarded; whether the lookup
6612 succeeds or fails is what really counts. These kinds of list are described in
6613 chapter &<<CHAPdomhosaddlists>>&.
6614 The key for the lookup is given by the context in which the list is expanded.
6615 .endlist
6616
6617 String expansions, lists, and lookups interact with each other in such a way
6618 that there is no order in which to describe any one of them that does not
6619 involve references to the others. Each of these three chapters makes more sense
6620 if you have read the other two first. If you are reading this for the first
6621 time, be aware that some of it will make a lot more sense after you have read
6622 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6623
6624 .section "Examples of different lookup syntax" "SECID60"
6625 It is easy to confuse the two different kinds of lookup, especially as the
6626 lists that may contain the second kind are always expanded before being
6627 processed as lists. Therefore, they may also contain lookups of the first kind.
6628 Be careful to distinguish between the following two examples:
6629 .code
6630 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6631 domains = lsearch;/some/file
6632 .endd
6633 The first uses a string expansion, the result of which must be a domain list.
6634 No strings have been specified for a successful or a failing lookup; the
6635 defaults in this case are the looked-up data and an empty string, respectively.
6636 The expansion takes place before the string is processed as a list, and the
6637 file that is searched could contain lines like this:
6638 .code
6639 192.168.3.4: domain1:domain2:...
6640 192.168.1.9: domain3:domain4:...
6641 .endd
6642 When the lookup succeeds, the result of the expansion is a list of domains (and
6643 possibly other types of item that are allowed in domain lists).
6644 .cindex "tainted data" "de-tainting"
6645 The result of the expansion is not tainted.
6646
6647 In the second example, the lookup is a single item in a domain list. It causes
6648 Exim to use a lookup to see if the domain that is being processed can be found
6649 in the file. The file could contains lines like this:
6650 .code
6651 domain1:
6652 domain2:
6653 .endd
6654 Any data that follows the keys is not relevant when checking that the domain
6655 matches the list item.
6656
6657 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6658 Consider a file containing lines like this:
6659 .code
6660 192.168.5.6: lsearch;/another/file
6661 .endd
6662 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6663 first &%domains%& setting above generates the second setting, which therefore
6664 causes a second lookup to occur.
6665
6666 .new
6667 The lookup type may optionally be followed by a comma
6668 and a comma-separated list of options.
6669 Each option is a &"name=value"& pair.
6670 Whether an option is meaningful depands on the lookup type.
6671 .wen
6672
6673 The rest of this chapter describes the different lookup types that are
6674 available. Any of them can be used in any part of the configuration where a
6675 lookup is permitted.
6676
6677
6678 .section "Lookup types" "SECID61"
6679 .cindex "lookup" "types of"
6680 .cindex "single-key lookup" "definition of"
6681 Two different types of data lookup are implemented:
6682
6683 .ilist
6684 The &'single-key'& type requires the specification of a file in which to look,
6685 and a single key to search for. The key must be a non-empty string for the
6686 lookup to succeed. The lookup type determines how the file is searched.
6687 .new
6688 .cindex "tainted data" "single-key lookups"
6689 The file string may not be tainted
6690
6691 .cindex "tainted data" "de-tainting"
6692 All single-key lookups support the option &"ret=key"&.
6693 If this is given and the lookup
6694 (either underlying implementation or cached value)
6695 returns data, the result is replaced with a non-tainted
6696 version of the lookup key.
6697 .wen
6698 .next
6699 .cindex "query-style lookup" "definition of"
6700 The &'query-style'& type accepts a generalized database query. No particular
6701 key value is assumed by Exim for query-style lookups. You can use whichever
6702 Exim variables you need to construct the database query.
6703 .endlist
6704
6705 The code for each lookup type is in a separate source file that is included in
6706 the binary of Exim only if the corresponding compile-time option is set. The
6707 default settings in &_src/EDITME_& are:
6708 .code
6709 LOOKUP_DBM=yes
6710 LOOKUP_LSEARCH=yes
6711 .endd
6712 which means that only linear searching and DBM lookups are included by default.
6713 For some types of lookup (e.g. SQL databases), you need to install appropriate
6714 libraries and header files before building Exim.
6715
6716
6717
6718
6719 .section "Single-key lookup types" "SECTsinglekeylookups"
6720 .cindex "lookup" "single-key types"
6721 .cindex "single-key lookup" "list of types"
6722 The following single-key lookup types are implemented:
6723
6724 .ilist
6725 .cindex "cdb" "description of"
6726 .cindex "lookup" "cdb"
6727 .cindex "binary zero" "in lookup key"
6728 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6729 string without a terminating binary zero. The cdb format is designed for
6730 indexed files that are read frequently and never updated, except by total
6731 re-creation. As such, it is particularly suitable for large files containing
6732 aliases or other indexed data referenced by an MTA. Information about cdb and
6733 tools for building the files can be found in several places:
6734 .display
6735 &url(https://cr.yp.to/cdb.html)
6736 &url(https://www.corpit.ru/mjt/tinycdb.html)
6737 &url(https://packages.debian.org/stable/utils/freecdb)
6738 &url(https://github.com/philpennock/cdbtools) (in Go)
6739 .endd
6740 A cdb distribution is not needed in order to build Exim with cdb support,
6741 because the code for reading cdb files is included directly in Exim itself.
6742 However, no means of building or testing cdb files is provided with Exim, so
6743 you need to obtain a cdb distribution in order to do this.
6744 .next
6745 .cindex "DBM" "lookup type"
6746 .cindex "lookup" "dbm"
6747 .cindex "binary zero" "in lookup key"
6748 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6749 DBM file by looking up the record with the given key. A terminating binary
6750 zero is included in the key that is passed to the DBM library. See section
6751 &<<SECTdb>>& for a discussion of DBM libraries.
6752
6753 .cindex "Berkeley DB library" "file format"
6754 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6755 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6756 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6757 the DB_UNKNOWN option. This enables it to handle any of the types of database
6758 that the library supports, and can be useful for accessing DBM files created by
6759 other applications. (For earlier DB versions, DB_HASH is always used.)
6760 .next
6761 .cindex "lookup" "dbmjz"
6762 .cindex "lookup" "dbm &-- embedded NULs"
6763 .cindex "sasldb2"
6764 .cindex "dbmjz lookup type"
6765 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6766 interpreted as an Exim list; the elements of the list are joined together with
6767 ASCII NUL characters to form the lookup key.  An example usage would be to
6768 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6769 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6770 &(cram_md5)& authenticator.
6771 .next
6772 .cindex "lookup" "dbmnz"
6773 .cindex "lookup" "dbm &-- terminating zero"
6774 .cindex "binary zero" "in lookup key"
6775 .cindex "Courier"
6776 .cindex "&_/etc/userdbshadow.dat_&"
6777 .cindex "dbmnz lookup type"
6778 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6779 is not included in the key that is passed to the DBM library. You may need this
6780 if you want to look up data in files that are created by or shared with some
6781 other application that does not use terminating zeros. For example, you need to
6782 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6783 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6784 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6785 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6786 .next
6787 .cindex "lookup" "dsearch"
6788 .cindex "dsearch lookup type"
6789 &(dsearch)&: The given file must be an
6790 .new
6791 absolute
6792 .wen
6793 directory path; this is searched for an entry
6794 whose name is the key by calling the &[lstat()]& function.
6795 The key may not
6796 contain any forward slash characters.
6797 If &[lstat()]& succeeds then so does the lookup.
6798 .new
6799 .cindex "tainted data" "dsearch result"
6800 The result is regarded as untainted.
6801
6802 Options for the lookup can be given by appending them after the word "dsearch",
6803 separated by a comma.  Options, if present, are a comma-separated list having
6804 each element starting with a tag name and an equals.
6805
6806 Two options are supported, for the return value and for filtering match
6807 candidates.
6808 The "ret" option requests an alternate result value of
6809 the entire path for the entry. Example:
6810 .code
6811 ${lookup {passwd} dsearch,ret=full {/etc}}
6812 .endd
6813 The default result is just the requested entry.
6814 The "filter" option requests that only directory entries of a given type
6815 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6816 not matching "." or ".."). Example:
6817 .code
6818 ${lookup {passwd} dsearch,filter=file {/etc}}
6819 .endd
6820 The default matching is for any entry type, including directories
6821 and symlinks.
6822 .wen
6823
6824 An example of how this
6825 lookup can be used to support virtual domains is given in section
6826 &<<SECTvirtualdomains>>&.
6827 .next
6828 .cindex "lookup" "iplsearch"
6829 .cindex "iplsearch lookup type"
6830 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6831 terminated by a colon or white space or the end of the line. The keys in the
6832 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6833 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6834 being interpreted as a key terminator. For example:
6835 .code
6836 1.2.3.4:           data for 1.2.3.4
6837 192.168.0.0/16:    data for 192.168.0.0/16
6838 "abcd::cdab":      data for abcd::cdab
6839 "abcd:abcd::/32"   data for abcd:abcd::/32
6840 .endd
6841 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6842 file is searched linearly, using the CIDR masks where present, until a matching
6843 key is found. The first key that matches is used; there is no attempt to find a
6844 &"best"& match. Apart from the way the keys are matched, the processing for
6845 &(iplsearch)& is the same as for &(lsearch)&.
6846
6847 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6848 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6849 lookup types support only literal keys.
6850
6851 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6852 the implicit key is the host's IP address rather than its name (see section
6853 &<<SECThoslispatsikey>>&).
6854
6855 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6856 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6857 notation before executing the lookup.)
6858 .next
6859 .cindex lookup json
6860 .cindex json "lookup type"
6861 .cindex JSON expansions
6862 &(json)&: The given file is a text file with a JSON structure.
6863 An element of the structure is extracted, defined by the search key.
6864 The key is a list of subelement selectors
6865 (colon-separated by default but changeable in the usual way)
6866 which are applied in turn to select smaller and smaller portions
6867 of the JSON structure.
6868 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6869 nunbered array element is selected.
6870 Otherwise it must apply to a JSON object; the named element is selected.
6871 The final resulting element can be a simple JSON type or a JSON object
6872 or array; for the latter two a string-representation of the JSON
6873 is returned.
6874 For elements of type string, the returned value is de-quoted.
6875 .next
6876 .cindex "linear search"
6877 .cindex "lookup" "lsearch"
6878 .cindex "lsearch lookup type"
6879 .cindex "case sensitivity" "in lsearch lookup"
6880 &(lsearch)&: The given file is a text file that is searched linearly for a
6881 line beginning with the search key, terminated by a colon or white space or the
6882 end of the line. The search is case-insensitive; that is, upper and lower case
6883 letters are treated as the same. The first occurrence of the key that is found
6884 in the file is used.
6885
6886 White space between the key and the colon is permitted. The remainder of the
6887 line, with leading and trailing white space removed, is the data. This can be
6888 continued onto subsequent lines by starting them with any amount of white
6889 space, but only a single space character is included in the data at such a
6890 junction. If the data begins with a colon, the key must be terminated by a
6891 colon, for example:
6892 .code
6893 baduser:  :fail:
6894 .endd
6895 Empty lines and lines beginning with # are ignored, even if they occur in the
6896 middle of an item. This is the traditional textual format of alias files. Note
6897 that the keys in an &(lsearch)& file are literal strings. There is no
6898 wildcarding of any kind.
6899
6900 .cindex "lookup" "lsearch &-- colons in keys"
6901 .cindex "white space" "in lsearch key"
6902 In most &(lsearch)& files, keys are not required to contain colons or #
6903 characters, or white space. However, if you need this feature, it is available.
6904 If a key begins with a doublequote character, it is terminated only by a
6905 matching quote (or end of line), and the normal escaping rules apply to its
6906 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6907 quoted keys (exactly as for unquoted keys). There is no special handling of
6908 quotes for the data part of an &(lsearch)& line.
6909
6910 .next
6911 .cindex "NIS lookup type"
6912 .cindex "lookup" "NIS"
6913 .cindex "binary zero" "in lookup key"
6914 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6915 the given key, without a terminating binary zero. There is a variant called
6916 &(nis0)& which does include the terminating binary zero in the key. This is
6917 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6918 aliases; the full map names must be used.
6919
6920 .next
6921 .cindex "wildlsearch lookup type"
6922 .cindex "lookup" "wildlsearch"
6923 .cindex "nwildlsearch lookup type"
6924 .cindex "lookup" "nwildlsearch"
6925 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6926 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6927 the file may be wildcarded. The difference between these two lookup types is
6928 that for &(wildlsearch)&, each key in the file is string-expanded before being
6929 used, whereas for &(nwildlsearch)&, no expansion takes place.
6930
6931 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6932 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6933 file that are regular expressions can be made case-sensitive by the use of
6934 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6935
6936 . ==== As this is a nested list, any displays it contains must be indented
6937 . ==== as otherwise they are too far to the left.
6938
6939 .olist
6940 The string may begin with an asterisk to mean &"ends with"&. For example:
6941 .code
6942     *.a.b.c       data for anything.a.b.c
6943     *fish         data for anythingfish
6944 .endd
6945 .next
6946 The string may begin with a circumflex to indicate a regular expression. For
6947 example, for &(wildlsearch)&:
6948 .code
6949     ^\N\d+\.a\.b\N    data for <digits>.a.b
6950 .endd
6951 Note the use of &`\N`& to disable expansion of the contents of the regular
6952 expression. If you are using &(nwildlsearch)&, where the keys are not
6953 string-expanded, the equivalent entry is:
6954 .code
6955     ^\d+\.a\.b        data for <digits>.a.b
6956 .endd
6957 The case-insensitive flag is set at the start of compiling the regular
6958 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6959 For example, to make the entire pattern case-sensitive:
6960 .code
6961     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6962 .endd
6963
6964 If the regular expression contains white space or colon characters, you must
6965 either quote it (see &(lsearch)& above), or represent these characters in other
6966 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6967 colon. This may be easier than quoting, because if you quote, you have to
6968 escape all the backslashes inside the quotes.
6969
6970 &*Note*&: It is not possible to capture substrings in a regular expression
6971 match for later use, because the results of all lookups are cached. If a lookup
6972 is repeated, the result is taken from the cache, and no actual pattern matching
6973 takes place. The values of all the numeric variables are unset after a
6974 &((n)wildlsearch)& match.
6975
6976 .next
6977 Although I cannot see it being of much use, the general matching function that
6978 is used to implement &((n)wildlsearch)& means that the string may begin with a
6979 lookup name terminated by a semicolon, and followed by lookup data. For
6980 example:
6981 .code
6982     cdb;/some/file  data for keys that match the file
6983 .endd
6984 The data that is obtained from the nested lookup is discarded.
6985 .endlist olist
6986
6987 Keys that do not match any of these patterns are interpreted literally. The
6988 continuation rules for the data are the same as for &(lsearch)&, and keys may
6989 be followed by optional colons.
6990
6991 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6992 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6993 lookup types support only literal keys.
6994
6995 .next
6996 .cindex "spf lookup type"
6997 .cindex "lookup" "spf"
6998 &(spf)&: If Exim is built with SPF support, manual lookups can be done
6999 (as opposed to the standard ACL condition method).
7000 For details see section &<<SECSPF>>&.
7001 .endlist ilist
7002
7003
7004 .section "Query-style lookup types" "SECTquerystylelookups"
7005 .cindex "lookup" "query-style types"
7006 .cindex "query-style lookup" "list of types"
7007 The supported query-style lookup types are listed below. Further details about
7008 many of them are given in later sections.
7009
7010 .ilist
7011 .cindex "DNS" "as a lookup type"
7012 .cindex "lookup" "DNS"
7013 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7014 are given in the supplied query. The resulting data is the contents of the
7015 records. See section &<<SECTdnsdb>>&.
7016 .next
7017 .cindex "InterBase lookup type"
7018 .cindex "lookup" "InterBase"
7019 &(ibase)&: This does a lookup in an InterBase database.
7020 .next
7021 .cindex "LDAP" "lookup type"
7022 .cindex "lookup" "LDAP"
7023 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7024 returns attributes from a single entry. There is a variant called &(ldapm)&
7025 that permits values from multiple entries to be returned. A third variant
7026 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7027 any attribute values. See section &<<SECTldap>>&.
7028 .next
7029 .cindex "MySQL" "lookup type"
7030 .cindex "lookup" "MySQL"
7031 &(mysql)&: The format of the query is an SQL statement that is passed to a
7032 MySQL database. See section &<<SECTsql>>&.
7033 .next
7034 .cindex "NIS+ lookup type"
7035 .cindex "lookup" "NIS+"
7036 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7037 the field to be returned. See section &<<SECTnisplus>>&.
7038 .next
7039 .cindex "Oracle" "lookup type"
7040 .cindex "lookup" "Oracle"
7041 &(oracle)&: The format of the query is an SQL statement that is passed to an
7042 Oracle database. See section &<<SECTsql>>&.
7043 .next
7044 .cindex "lookup" "passwd"
7045 .cindex "passwd lookup type"
7046 .cindex "&_/etc/passwd_&"
7047 &(passwd)& is a query-style lookup with queries that are just user names. The
7048 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7049 success, the result string is the same as you would get from an &(lsearch)&
7050 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7051 password value. For example:
7052 .code
7053 *:42:42:King Rat:/home/kr:/bin/bash
7054 .endd
7055 .next
7056 .cindex "PostgreSQL lookup type"
7057 .cindex "lookup" "PostgreSQL"
7058 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7059 PostgreSQL database. See section &<<SECTsql>>&.
7060
7061 .next
7062 .cindex "Redis lookup type"
7063 .cindex lookup Redis
7064 &(redis)&: The format of the query is either a simple get or simple set,
7065 passed to a Redis database. See section &<<SECTsql>>&.
7066
7067 .next
7068 .cindex "sqlite lookup type"
7069 .cindex "lookup" "sqlite"
7070 &(sqlite)&: The format of the query is
7071 new
7072 an optional filename
7073 .wen
7074 followed by an SQL statement
7075 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7076
7077 .next
7078 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7079 not likely to be useful in normal operation.
7080 .next
7081 .cindex "whoson lookup type"
7082 .cindex "lookup" "whoson"
7083 . --- still http:-only, 2018-09-07
7084 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7085 allows a server to check whether a particular (dynamically allocated) IP
7086 address is currently allocated to a known (trusted) user and, optionally, to
7087 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7088 at one time for &"POP before SMTP"& authentication, but that approach has been
7089 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7090 &"POP before SMTP"& checking using ACL statements such as
7091 .code
7092 require condition = \
7093   ${lookup whoson {$sender_host_address}{yes}{no}}
7094 .endd
7095 The query consists of a single IP address. The value returned is the name of
7096 the authenticated user, which is stored in the variable &$value$&. However, in
7097 this example, the data in &$value$& is not used; the result of the lookup is
7098 one of the fixed strings &"yes"& or &"no"&.
7099 .endlist
7100
7101
7102
7103 .section "Temporary errors in lookups" "SECID63"
7104 .cindex "lookup" "temporary error in"
7105 Lookup functions can return temporary error codes if the lookup cannot be
7106 completed. For example, an SQL or LDAP database might be unavailable. For this
7107 reason, it is not advisable to use a lookup that might do this for critical
7108 options such as a list of local domains.
7109
7110 When a lookup cannot be completed in a router or transport, delivery
7111 of the message (to the relevant address) is deferred, as for any other
7112 temporary error. In other circumstances Exim may assume the lookup has failed,
7113 or may give up altogether.
7114
7115
7116
7117 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7118 .cindex "wildcard lookups"
7119 .cindex "lookup" "default values"
7120 .cindex "lookup" "wildcard"
7121 .cindex "lookup" "* added to type"
7122 .cindex "default" "in single-key lookups"
7123 In this context, a &"default value"& is a value specified by the administrator
7124 that is to be used if a lookup fails.
7125
7126 &*Note:*& This section applies only to single-key lookups. For query-style
7127 lookups, the facilities of the query language must be used. An attempt to
7128 specify a default for a query-style lookup provokes an error.
7129
7130 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7131 and the initial lookup fails, the key &"*"& is looked up in the file to
7132 provide a default value. See also the section on partial matching below.
7133
7134 .cindex "*@ with single-key lookup"
7135 .cindex "lookup" "*@ added to type"
7136 .cindex "alias file" "per-domain default"
7137 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7138 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7139 character, a second lookup is done with everything before the last @ replaced
7140 by *. This makes it possible to provide per-domain defaults in alias files
7141 that include the domains in the keys. If the second lookup fails (or doesn't
7142 take place because there is no @ in the key), &"*"& is looked up.
7143 For example, a &(redirect)& router might contain:
7144 .code
7145 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7146 .endd
7147 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7148 looks up these keys, in this order:
7149 .code
7150 jane@eyre.example
7151 *@eyre.example
7152 *
7153 .endd
7154 The data is taken from whichever key it finds first. &*Note*&: In an
7155 &(lsearch)& file, this does not mean the first of these keys in the file. A
7156 complete scan is done for each key, and only if it is not found at all does
7157 Exim move on to try the next key.
7158
7159
7160
7161 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7162 .cindex "partial matching"
7163 .cindex "wildcard lookups"
7164 .cindex "lookup" "partial matching"
7165 .cindex "lookup" "wildcard"
7166 .cindex "asterisk" "in search type"
7167 The normal operation of a single-key lookup is to search the file for an exact
7168 match with the given key. However, in a number of situations where domains are
7169 being looked up, it is useful to be able to do partial matching. In this case,
7170 information in the file that has a key starting with &"*."& is matched by any
7171 domain that ends with the components that follow the full stop. For example, if
7172 a key in a DBM file is
7173 .code
7174 *.dates.fict.example
7175 .endd
7176 then when partial matching is enabled this is matched by (amongst others)
7177 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7178 by &'dates.fict.example'&, if that does not appear as a separate key in the
7179 file.
7180
7181 &*Note*&: Partial matching is not available for query-style lookups. It is
7182 also not available for any lookup items in address lists (see section
7183 &<<SECTaddresslist>>&).
7184
7185 Partial matching is implemented by doing a series of separate lookups using
7186 keys constructed by modifying the original subject key. This means that it can
7187 be used with any of the single-key lookup types, provided that
7188 partial matching keys
7189 beginning with a special prefix (default &"*."&) are included in the data file.
7190 Keys in the file that do not begin with the prefix are matched only by
7191 unmodified subject keys when partial matching is in use.
7192
7193 Partial matching is requested by adding the string &"partial-"& to the front of
7194 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7195 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7196 is added at the start of the subject key, and it is looked up again. If that
7197 fails, further lookups are tried with dot-separated components removed from the
7198 start of the subject key, one-by-one, and &"*."& added on the front of what
7199 remains.
7200
7201 A minimum number of two non-* components are required. This can be adjusted
7202 by including a number before the hyphen in the search type. For example,
7203 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7204 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7205 subject key is &'2250.dates.fict.example'& then the following keys are looked
7206 up when the minimum number of non-* components is two:
7207 .code
7208 2250.dates.fict.example
7209 *.2250.dates.fict.example
7210 *.dates.fict.example
7211 *.fict.example
7212 .endd
7213 As soon as one key in the sequence is successfully looked up, the lookup
7214 finishes.
7215
7216 .cindex "lookup" "partial matching &-- changing prefix"
7217 .cindex "prefix" "for partial matching"
7218 The use of &"*."& as the partial matching prefix is a default that can be
7219 changed. The motivation for this feature is to allow Exim to operate with file
7220 formats that are used by other MTAs. A different prefix can be supplied in
7221 parentheses instead of the hyphen after &"partial"&. For example:
7222 .code
7223 domains = partial(.)lsearch;/some/file
7224 .endd
7225 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7226 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7227 components is unchanged). The prefix may consist of any punctuation characters
7228 other than a closing parenthesis. It may be empty, for example:
7229 .code
7230 domains = partial1()cdb;/some/file
7231 .endd
7232 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7233 &`a.b.c`&, &`b.c`&, and &`c`&.
7234
7235 If &"partial0"& is specified, what happens at the end (when the lookup with
7236 just one non-wild component has failed, and the original key is shortened right
7237 down to the null string) depends on the prefix:
7238
7239 .ilist
7240 If the prefix has zero length, the whole lookup fails.
7241 .next
7242 If the prefix has length 1, a lookup for just the prefix is done. For
7243 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7244 .next
7245 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7246 remainder is looked up. With the default prefix, therefore, the final lookup is
7247 for &"*"& on its own.
7248 .next
7249 Otherwise, the whole prefix is looked up.
7250 .endlist
7251
7252
7253 If the search type ends in &"*"& or &"*@"& (see section
7254 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7255 this implies happens after all partial lookups have failed. If &"partial0"& is
7256 specified, adding &"*"& to the search type has no effect with the default
7257 prefix, because the &"*"& key is already included in the sequence of partial
7258 lookups. However, there might be a use for lookup types such as
7259 &"partial0(.)lsearch*"&.
7260
7261 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7262 in domain lists and the like. Partial matching works only in terms of
7263 dot-separated components; a key such as &`*fict.example`&
7264 in a database file is useless, because the asterisk in a partial matching
7265 subject key is always followed by a dot.
7266
7267
7268
7269
7270 .section "Lookup caching" "SECID64"
7271 .cindex "lookup" "caching"
7272 .cindex "caching" "lookup data"
7273 Exim caches all lookup results in order to avoid needless repetition of
7274 lookups. However, because (apart from the daemon) Exim operates as a collection
7275 of independent, short-lived processes, this caching applies only within a
7276 single Exim process. There is no inter-process lookup caching facility.
7277
7278 For single-key lookups, Exim keeps the relevant files open in case there is
7279 another lookup that needs them. In some types of configuration this can lead to
7280 many files being kept open for messages with many recipients. To avoid hitting
7281 the operating system limit on the number of simultaneously open files, Exim
7282 closes the least recently used file when it needs to open more files than its
7283 own internal limit, which can be changed via the &%lookup_open_max%& option.
7284
7285 The single-key lookup files are closed and the lookup caches are flushed at
7286 strategic points during delivery &-- for example, after all routing is
7287 complete.
7288
7289
7290
7291
7292 .section "Quoting lookup data" "SECID65"
7293 .cindex "lookup" "quoting"
7294 .cindex "quoting" "in lookups"
7295 When data from an incoming message is included in a query-style lookup, there
7296 is the possibility of special characters in the data messing up the syntax of
7297 the query. For example, a NIS+ query that contains
7298 .code
7299 [name=$local_part]
7300 .endd
7301 will be broken if the local part happens to contain a closing square bracket.
7302 For NIS+, data can be enclosed in double quotes like this:
7303 .code
7304 [name="$local_part"]
7305 .endd
7306 but this still leaves the problem of a double quote in the data. The rule for
7307 NIS+ is that double quotes must be doubled. Other lookup types have different
7308 rules, and to cope with the differing requirements, an expansion operator
7309 of the following form is provided:
7310 .code
7311 ${quote_<lookup-type>:<string>}
7312 .endd
7313 For example, the safest way to write the NIS+ query is
7314 .code
7315 [name="${quote_nisplus:$local_part}"]
7316 .endd
7317 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7318 operator can be used for all lookup types, but has no effect for single-key
7319 lookups, since no quoting is ever needed in their key strings.
7320
7321
7322
7323
7324 .section "More about dnsdb" "SECTdnsdb"
7325 .cindex "dnsdb lookup"
7326 .cindex "lookup" "dnsdb"
7327 .cindex "DNS" "as a lookup type"
7328 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7329 of a record type and a domain name, separated by an equals sign. For example,
7330 an expansion string could contain:
7331 .code
7332 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7333 .endd
7334 If the lookup succeeds, the result is placed in &$value$&, which in this case
7335 is used on its own as the result. If the lookup does not succeed, the
7336 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7337 &<<SECTforexpfai>>& for an explanation of what this means.
7338
7339 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7340 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7341 If no type is given, TXT is assumed.
7342
7343 For any record type, if multiple records are found, the data is returned as a
7344 concatenation, with newline as the default separator. The order, of course,
7345 depends on the DNS resolver. You can specify a different separator character
7346 between multiple records by putting a right angle-bracket followed immediately
7347 by the new separator at the start of the query. For example:
7348 .code
7349 ${lookup dnsdb{>: a=host1.example}}
7350 .endd
7351 It is permitted to specify a space as the separator character. Further
7352 white space is ignored.
7353 For lookup types that return multiple fields per record,
7354 an alternate field separator can be specified using a comma after the main
7355 separator character, followed immediately by the field separator.
7356
7357 .cindex "PTR record" "in &(dnsdb)& lookup"
7358 When the type is PTR,
7359 the data can be an IP address, written as normal; inversion and the addition of
7360 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7361 .code
7362 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7363 .endd
7364 If the data for a PTR record is not a syntactically valid IP address, it is not
7365 altered and nothing is added.
7366
7367 .cindex "MX record" "in &(dnsdb)& lookup"
7368 .cindex "SRV record" "in &(dnsdb)& lookup"
7369 For an MX lookup, both the preference value and the host name are returned for
7370 each record, separated by a space. For an SRV lookup, the priority, weight,
7371 port, and host name are returned for each record, separated by spaces.
7372 The field separator can be modified as above.
7373
7374 .cindex "TXT record" "in &(dnsdb)& lookup"
7375 .cindex "SPF record" "in &(dnsdb)& lookup"
7376 For TXT records with multiple items of data, only the first item is returned,
7377 unless a field separator is specified.
7378 To concatenate items without a separator, use a semicolon instead.
7379 For SPF records the
7380 default behaviour is to concatenate multiple items without using a separator.
7381 .code
7382 ${lookup dnsdb{>\n,: txt=a.b.example}}
7383 ${lookup dnsdb{>\n; txt=a.b.example}}
7384 ${lookup dnsdb{spf=example.org}}
7385 .endd
7386 It is permitted to specify a space as the separator character. Further
7387 white space is ignored.
7388
7389 .cindex "SOA record" "in &(dnsdb)& lookup"
7390 For an SOA lookup, while no result is obtained the lookup is redone with
7391 successively more leading components dropped from the given domain.
7392 Only the primary-nameserver field is returned unless a field separator is
7393 specified.
7394 .code
7395 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7396 .endd
7397
7398 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7399 .cindex "dnsdb modifiers"
7400 .cindex "modifiers" "dnsdb"
7401 .cindex "options" "dnsdb"
7402 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7403 each followed by a comma,
7404 that may appear before the record type.
7405
7406 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7407 temporary DNS error for any of them, the behaviour is controlled by
7408 a defer-option modifier.
7409 The possible keywords are
7410 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7411 With &"strict"& behaviour, any temporary DNS error causes the
7412 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7413 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7414 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7415 error causes the whole lookup to defer only if none of the other lookups
7416 succeed. The default is &"lax"&, so the following lookups are equivalent:
7417 .code
7418 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7419 ${lookup dnsdb{a=one.host.com:two.host.com}}
7420 .endd
7421 Thus, in the default case, as long as at least one of the DNS lookups
7422 yields some data, the lookup succeeds.
7423
7424 .cindex "DNSSEC" "dns lookup"
7425 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7426 The possible keywords are
7427 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7428 With &"strict"& or &"lax"& DNSSEC information is requested
7429 with the lookup.
7430 With &"strict"& a response from the DNS resolver that
7431 is not labelled as authenticated data
7432 is treated as equivalent to a temporary DNS error.
7433 The default is &"lax"&.
7434
7435 See also the &$lookup_dnssec_authenticated$& variable.
7436
7437 .cindex timeout "dns lookup"
7438 .cindex "DNS" timeout
7439 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7440 The form is &"retrans_VAL"& where VAL is an Exim time specification
7441 (e.g. &"5s"&).
7442 The default value is set by the main configuration option &%dns_retrans%&.
7443
7444 Retries for the dnsdb lookup can be controlled by a retry modifier.
7445 The form if &"retry_VAL"& where VAL is an integer.
7446 The default count is set by the main configuration option &%dns_retry%&.
7447
7448 .cindex caching "of dns lookup"
7449 .cindex TTL "of dns lookup"
7450 .cindex DNS TTL
7451 Dnsdb lookup results are cached within a single process (and its children).
7452 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7453 value of the set of returned DNS records.
7454
7455
7456 .section "Pseudo dnsdb record types" "SECID66"
7457 .cindex "MX record" "in &(dnsdb)& lookup"
7458 By default, both the preference value and the host name are returned for
7459 each MX record, separated by a space. If you want only host names, you can use
7460 the pseudo-type MXH:
7461 .code
7462 ${lookup dnsdb{mxh=a.b.example}}
7463 .endd
7464 In this case, the preference values are omitted, and just the host names are
7465 returned.
7466
7467 .cindex "name server for enclosing domain"
7468 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7469 records on the given domain, but if none are found, it removes the first
7470 component of the domain name, and tries again. This process continues until NS
7471 records are found or there are no more components left (or there is a DNS
7472 error). In other words, it may return the name servers for a top-level domain,
7473 but it never returns the root name servers. If there are no NS records for the
7474 top-level domain, the lookup fails. Consider these examples:
7475 .code
7476 ${lookup dnsdb{zns=xxx.quercite.com}}
7477 ${lookup dnsdb{zns=xxx.edu}}
7478 .endd
7479 Assuming that in each case there are no NS records for the full domain name,
7480 the first returns the name servers for &%quercite.com%&, and the second returns
7481 the name servers for &%edu%&.
7482
7483 You should be careful about how you use this lookup because, unless the
7484 top-level domain does not exist, the lookup always returns some host names. The
7485 sort of use to which this might be put is for seeing if the name servers for a
7486 given domain are on a blacklist. You can probably assume that the name servers
7487 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7488 such a list.
7489
7490 .cindex "CSA" "in &(dnsdb)& lookup"
7491 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7492 records according to the CSA rules, which are described in section
7493 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7494 not sufficient because of the extra parent domain search behaviour of CSA. The
7495 result of a successful lookup such as:
7496 .code
7497 ${lookup dnsdb {csa=$sender_helo_name}}
7498 .endd
7499 has two space-separated fields: an authorization code and a target host name.
7500 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7501 authorization required but absent, or &"?"& for unknown.
7502
7503 .cindex "A+" "in &(dnsdb)& lookup"
7504 The pseudo-type A+ performs an AAAA
7505 and then an A lookup.  All results are returned; defer processing
7506 (see below) is handled separately for each lookup.  Example:
7507 .code
7508 ${lookup dnsdb {>; a+=$sender_helo_name}}
7509 .endd
7510
7511
7512 .section "Multiple dnsdb lookups" "SECID67"
7513 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7514 However, you can specify a list of domains or IP addresses in a single
7515 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7516 the default separator, but with the ability to change this. For example:
7517 .code
7518 ${lookup dnsdb{one.domain.com:two.domain.com}}
7519 ${lookup dnsdb{a=one.host.com:two.host.com}}
7520 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7521 .endd
7522 In order to retain backwards compatibility, there is one special case: if
7523 the lookup type is PTR and no change of separator is specified, Exim looks
7524 to see if the rest of the string is precisely one IPv6 address. In this
7525 case, it does not treat it as a list.
7526
7527 The data from each lookup is concatenated, with newline separators by default,
7528 in the same way that multiple DNS records for a single item are handled. A
7529 different separator can be specified, as described above.
7530
7531
7532
7533
7534 .section "More about LDAP" "SECTldap"
7535 .cindex "LDAP" "lookup, more about"
7536 .cindex "lookup" "LDAP"
7537 .cindex "Solaris" "LDAP"
7538 The original LDAP implementation came from the University of Michigan; this has
7539 become &"Open LDAP"&, and there are now two different releases. Another
7540 implementation comes from Netscape, and Solaris 7 and subsequent releases
7541 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7542 the lookup function level, their error handling is different. For this reason
7543 it is necessary to set a compile-time variable when building Exim with LDAP, to
7544 indicate which LDAP library is in use. One of the following should appear in
7545 your &_Local/Makefile_&:
7546 .code
7547 LDAP_LIB_TYPE=UMICHIGAN
7548 LDAP_LIB_TYPE=OPENLDAP1
7549 LDAP_LIB_TYPE=OPENLDAP2
7550 LDAP_LIB_TYPE=NETSCAPE
7551 LDAP_LIB_TYPE=SOLARIS
7552 .endd
7553 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7554 same interface as the University of Michigan version.
7555
7556 There are three LDAP lookup types in Exim. These behave slightly differently in
7557 the way they handle the results of a query:
7558
7559 .ilist
7560 &(ldap)& requires the result to contain just one entry; if there are more, it
7561 gives an error.
7562 .next
7563 &(ldapdn)& also requires the result to contain just one entry, but it is the
7564 Distinguished Name that is returned rather than any attribute values.
7565 .next
7566 &(ldapm)& permits the result to contain more than one entry; the attributes
7567 from all of them are returned.
7568 .endlist
7569
7570
7571 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7572 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7573 the data returned by a successful lookup is described in the next section.
7574 First we explain how LDAP queries are coded.
7575
7576
7577 .section "Format of LDAP queries" "SECTforldaque"
7578 .cindex "LDAP" "query format"
7579 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7580 the configuration of a &(redirect)& router one might have this setting:
7581 .code
7582 data = ${lookup ldap \
7583   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7584   c=UK?mailbox?base?}}
7585 .endd
7586 .cindex "LDAP" "with TLS"
7587 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7588 secure (encrypted) LDAP connections. The second of these ensures that an
7589 encrypted TLS connection is used.
7590
7591 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7592 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7593 See the &%ldap_start_tls%& option.
7594
7595 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7596 controlled. Every part of the TLS configuration can be configured by settings in
7597 &_exim.conf_&. Depending on the version of the client libraries installed on
7598 your system, some of the initialization may have required setting options in
7599 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7600 certificates. This revealed a nuance where the current UID that exim was
7601 running as could affect which config files it read. With Exim 4.83, these
7602 methods become optional, only taking effect if not specifically set in
7603 &_exim.conf_&.
7604
7605
7606 .section "LDAP quoting" "SECID68"
7607 .cindex "LDAP" "quoting"
7608 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7609 and the second because the LDAP query is represented as a URL. Furthermore,
7610 within an LDAP query, two different kinds of quoting are required. For this
7611 reason, there are two different LDAP-specific quoting operators.
7612
7613 The &%quote_ldap%& operator is designed for use on strings that are part of
7614 filter specifications. Conceptually, it first does the following conversions on
7615 the string:
7616 .code
7617 *   =>   \2A
7618 (   =>   \28
7619 )   =>   \29
7620 \   =>   \5C
7621 .endd
7622 in accordance with RFC 2254. The resulting string is then quoted according
7623 to the rules for URLs, that is, all non-alphanumeric characters except
7624 .code
7625 ! $ ' - . _ ( ) * +
7626 .endd
7627 are converted to their hex values, preceded by a percent sign. For example:
7628 .code
7629 ${quote_ldap: a(bc)*, a<yz>; }
7630 .endd
7631 yields
7632 .code
7633 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7634 .endd
7635 Removing the URL quoting, this is (with a leading and a trailing space):
7636 .code
7637 a\28bc\29\2A, a<yz>;
7638 .endd
7639 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7640 base DN specifications in queries. Conceptually, it first converts the string
7641 by inserting a backslash in front of any of the following characters:
7642 .code
7643 , + " \ < > ;
7644 .endd
7645 It also inserts a backslash before any leading spaces or # characters, and
7646 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7647 is then quoted according to the rules for URLs. For example:
7648 .code
7649 ${quote_ldap_dn: a(bc)*, a<yz>; }
7650 .endd
7651 yields
7652 .code
7653 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7654 .endd
7655 Removing the URL quoting, this is (with a trailing space):
7656 .code
7657 \ a(bc)*\, a\<yz\>\;\
7658 .endd
7659 There are some further comments about quoting in the section on LDAP
7660 authentication below.
7661
7662
7663 .section "LDAP connections" "SECID69"
7664 .cindex "LDAP" "connections"
7665 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7666 is in use, via a Unix domain socket. The example given above does not specify
7667 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7668 by starting it with
7669 .code
7670 ldap://<hostname>:<port>/...
7671 .endd
7672 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7673 used. When no server is specified in a query, a list of default servers is
7674 taken from the &%ldap_default_servers%& configuration option. This supplies a
7675 colon-separated list of servers which are tried in turn until one successfully
7676 handles a query, or there is a serious error. Successful handling either
7677 returns the requested data, or indicates that it does not exist. Serious errors
7678 are syntactical, or multiple values when only a single value is expected.
7679 Errors which cause the next server to be tried are connection failures, bind
7680 failures, and timeouts.
7681
7682 For each server name in the list, a port number can be given. The standard way
7683 of specifying a host and port is to use a colon separator (RFC 1738). Because
7684 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7685 doubled. For example
7686 .code
7687 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7688 .endd
7689 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7690 to the LDAP library with no server name, and the library's default (normally
7691 the local host) is used.
7692
7693 If you are using the OpenLDAP library, you can connect to an LDAP server using
7694 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7695 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7696 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7697 not available.
7698
7699 For this type of connection, instead of a host name for the server, a pathname
7700 for the socket is required, and the port number is not relevant. The pathname
7701 can be specified either as an item in &%ldap_default_servers%&, or inline in
7702 the query. In the former case, you can have settings such as
7703 .code
7704 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7705 .endd
7706 When the pathname is given in the query, you have to escape the slashes as
7707 &`%2F`& to fit in with the LDAP URL syntax. For example:
7708 .code
7709 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7710 .endd
7711 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7712 a pathname, it uses the Unix domain socket code, even if the query actually
7713 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7714 socket connection. This behaviour means that you can use a setting of
7715 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7716 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7717 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7718 backup host.
7719
7720 If an explicit &`ldapi`& type is given in a query when a host name is
7721 specified, an error is diagnosed. However, if there are more items in
7722 &%ldap_default_servers%&, they are tried. In other words:
7723
7724 .ilist
7725 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7726 interface.
7727 .next
7728 Using &`ldapi`& with a host name causes an error.
7729 .endlist
7730
7731
7732 Using &`ldapi`& with no host or path in the query, and no setting of
7733 &%ldap_default_servers%&, does whatever the library does by default.
7734
7735
7736
7737 .section "LDAP authentication and control information" "SECID70"
7738 .cindex "LDAP" "authentication"
7739 The LDAP URL syntax provides no way of passing authentication and other control
7740 information to the server. To make this possible, the URL in an LDAP query may
7741 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7742 spaces. If a value contains spaces it must be enclosed in double quotes, and
7743 when double quotes are used, backslash is interpreted in the usual way inside
7744 them. The following names are recognized:
7745 .display
7746 &`DEREFERENCE`&  set the dereferencing parameter
7747 &`NETTIME    `&  set a timeout for a network operation
7748 &`USER       `&  set the DN, for authenticating the LDAP bind
7749 &`PASS       `&  set the password, likewise
7750 &`REFERRALS  `&  set the referrals parameter
7751 &`SERVERS    `&  set alternate server list for this query only
7752 &`SIZE       `&  set the limit for the number of entries returned
7753 &`TIME       `&  set the maximum waiting time for a query
7754 .endd
7755 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7756 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7757 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7758 library from trying to follow referrals issued by the LDAP server.
7759
7760 .cindex LDAP timeout
7761 .cindex timeout "LDAP lookup"
7762 The name CONNECT is an obsolete name for NETTIME, retained for
7763 backwards compatibility. This timeout (specified as a number of seconds) is
7764 enforced from the client end for operations that can be carried out over a
7765 network. Specifically, it applies to network connections and calls to the
7766 &'ldap_result()'& function. If the value is greater than zero, it is used if
7767 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7768 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7769 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7770 Netscape SDK; for OpenLDAP no action is taken.
7771
7772 The TIME parameter (also a number of seconds) is passed to the server to
7773 set a server-side limit on the time taken to complete a search.
7774
7775 The SERVERS parameter allows you to specify an alternate list of ldap servers
7776 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7777 default list of ldap servers, and a single lookup can specify a single ldap
7778 server to use.  But when you need to do a lookup with a list of servers that is
7779 different than the default list (maybe different order, maybe a completely
7780 different set of servers), the SERVERS parameter allows you to specify this
7781 alternate list (colon-separated).
7782
7783 Here is an example of an LDAP query in an Exim lookup that uses some of these
7784 values. This is a single line, folded to fit on the page:
7785 .code
7786 ${lookup ldap
7787   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7788   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7789   {$value}fail}
7790 .endd
7791 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7792 any of the auxiliary data. Exim configuration settings that include lookups
7793 which contain password information should be preceded by &"hide"& to prevent
7794 non-admin users from using the &%-bP%& option to see their values.
7795
7796 The auxiliary data items may be given in any order. The default is no
7797 connection timeout (the system timeout is used), no user or password, no limit
7798 on the number of entries returned, and no time limit on queries.
7799
7800 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7801 removes any URL quoting that it may contain before passing it LDAP. Apparently
7802 some libraries do this for themselves, but some do not. Removing the URL
7803 quoting has two advantages:
7804
7805 .ilist
7806 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7807 DNs as with DNs inside actual queries.
7808 .next
7809 It permits spaces inside USER= DNs.
7810 .endlist
7811
7812 For example, a setting such as
7813 .code
7814 USER=cn=${quote_ldap_dn:$1}
7815 .endd
7816 should work even if &$1$& contains spaces.
7817
7818 Expanded data for the PASS= value should be quoted using the &%quote%&
7819 expansion operator, rather than the LDAP quote operators. The only reason this
7820 field needs quoting is to ensure that it conforms to the Exim syntax, which
7821 does not allow unquoted spaces. For example:
7822 .code
7823 PASS=${quote:$3}
7824 .endd
7825 The LDAP authentication mechanism can be used to check passwords as part of
7826 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7827 &<<CHAPexpand>>&.
7828
7829
7830
7831 .section "Format of data returned by LDAP" "SECID71"
7832 .cindex "LDAP" "returned data formats"
7833 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7834 as a sequence of values, for example
7835 .code
7836 cn=manager,o=University of Cambridge,c=UK
7837 .endd
7838 The &(ldap)& lookup type generates an error if more than one entry matches the
7839 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7840 the result between the data from different entries. It is possible for multiple
7841 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7842 you know that whatever values are returned all came from a single entry in the
7843 directory.
7844
7845 In the common case where you specify a single attribute in your LDAP query, the
7846 result is not quoted, and does not contain the attribute name. If the attribute
7847 has multiple values, they are separated by commas. Any comma that is
7848 part of an attribute's value is doubled.
7849
7850 If you specify multiple attributes, the result contains space-separated, quoted
7851 strings, each preceded by the attribute name and an equals sign. Within the
7852 quotes, the quote character, backslash, and newline are escaped with
7853 backslashes, and commas are used to separate multiple values for the attribute.
7854 Any commas in attribute values are doubled
7855 (permitting treatment of the values as a comma-separated list).
7856 Apart from the escaping, the string within quotes takes the same form as the
7857 output when a single attribute is requested. Specifying no attributes is the
7858 same as specifying all of an entry's attributes.
7859
7860 Here are some examples of the output format. The first line of each pair is an
7861 LDAP query, and the second is the data that is returned. The attribute called
7862 &%attr1%& has two values, one of them with an embedded comma, whereas
7863 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7864 (they have SUP &%attr%& in their schema definitions).
7865
7866 .code
7867 ldap:///o=base?attr1?sub?(uid=fred)
7868 value1.1,value1,,2
7869
7870 ldap:///o=base?attr2?sub?(uid=fred)
7871 value two
7872
7873 ldap:///o=base?attr?sub?(uid=fred)
7874 value1.1,value1,,2,value two
7875
7876 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7877 attr1="value1.1,value1,,2" attr2="value two"
7878
7879 ldap:///o=base??sub?(uid=fred)
7880 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7881 .endd
7882 You can
7883 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7884 results of LDAP lookups.
7885 The &%extract%& operator in string expansions can be used to pick out
7886 individual fields from data that consists of &'key'&=&'value'& pairs.
7887 The &%listextract%& operator should be used to pick out individual values
7888 of attributes, even when only a single value is expected.
7889 The doubling of embedded commas allows you to use the returned data as a
7890 comma separated list (using the "<," syntax for changing the input list separator).
7891
7892
7893
7894
7895 .section "More about NIS+" "SECTnisplus"
7896 .cindex "NIS+ lookup type"
7897 .cindex "lookup" "NIS+"
7898 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7899 and field name. If this is given, the result of a successful query is the
7900 contents of the named field; otherwise the result consists of a concatenation
7901 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7902 values containing spaces are quoted. For example, the query
7903 .code
7904 [name=mg1456],passwd.org_dir
7905 .endd
7906 might return the string
7907 .code
7908 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7909 home=/home/mg1456 shell=/bin/bash shadow=""
7910 .endd
7911 (split over two lines here to fit on the page), whereas
7912 .code
7913 [name=mg1456],passwd.org_dir:gcos
7914 .endd
7915 would just return
7916 .code
7917 Martin Guerre
7918 .endd
7919 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7920 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7921 operator is to double any quote characters within the text.
7922
7923
7924
7925 .section "SQL lookups" "SECTsql"
7926 .cindex "SQL lookup types"
7927 .cindex "MySQL" "lookup type"
7928 .cindex "PostgreSQL lookup type"
7929 .cindex "lookup" "MySQL"
7930 .cindex "lookup" "PostgreSQL"
7931 .cindex "Oracle" "lookup type"
7932 .cindex "lookup" "Oracle"
7933 .cindex "InterBase lookup type"
7934 .cindex "lookup" "InterBase"
7935 .cindex "Redis lookup type"
7936 .cindex lookup Redis
7937 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7938 and SQLite
7939 databases. Queries for these databases contain SQL statements, so an example
7940 might be
7941 .code
7942 ${lookup mysql{select mailbox from users where id='userx'}\
7943   {$value}fail}
7944 .endd
7945 If the result of the query contains more than one field, the data for each
7946 field in the row is returned, preceded by its name, so the result of
7947 .code
7948 ${lookup pgsql{select home,name from users where id='userx'}\
7949   {$value}}
7950 .endd
7951 might be
7952 .code
7953 home=/home/userx name="Mister X"
7954 .endd
7955 Empty values and values containing spaces are double quoted, with embedded
7956 quotes escaped by a backslash. If the result of the query contains just one
7957 field, the value is passed back verbatim, without a field name, for example:
7958 .code
7959 Mister X
7960 .endd
7961 If the result of the query yields more than one row, it is all concatenated,
7962 with a newline between the data for each row.
7963
7964
7965 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7966 .cindex "MySQL" "lookup type"
7967 .cindex "PostgreSQL lookup type"
7968 .cindex "lookup" "MySQL"
7969 .cindex "lookup" "PostgreSQL"
7970 .cindex "Oracle" "lookup type"
7971 .cindex "lookup" "Oracle"
7972 .cindex "InterBase lookup type"
7973 .cindex "lookup" "InterBase"
7974 .cindex "Redis lookup type"
7975 .cindex lookup Redis
7976 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7977 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7978 or &%redis_servers%&
7979 option (as appropriate) must be set to a colon-separated list of server
7980 information.
7981 .oindex &%mysql_servers%&
7982 .oindex &%pgsql_servers%&
7983 .oindex &%oracle_servers%&
7984 .oindex &%ibase_servers%&
7985 .oindex &%redis_servers%&
7986 (For MySQL and PostgreSQL, the global option need not be set if all
7987 queries contain their own server information &-- see section
7988 &<<SECTspeserque>>&.)
7989 For all but Redis
7990 each item in the list is a slash-separated list of four
7991 items: host name, database name, user name, and password. In the case of
7992 Oracle, the host name field is used for the &"service name"&, and the database
7993 name field is not used and should be empty. For example:
7994 .code
7995 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7996 .endd
7997 Because password data is sensitive, you should always precede the setting with
7998 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7999 option. Here is an example where two MySQL servers are listed:
8000 .code
8001 hide mysql_servers = localhost/users/root/secret:\
8002                      otherhost/users/root/othersecret
8003 .endd
8004 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8005 because this is a colon-separated list, the colon has to be doubled. For each
8006 query, these parameter groups are tried in order until a connection is made and
8007 a query is successfully processed. The result of a query may be that no data is
8008 found, but that is still a successful query. In other words, the list of
8009 servers provides a backup facility, not a list of different places to look.
8010
8011 For Redis the global option need not be specified if all queries contain their
8012 own server information &-- see section &<<SECTspeserque>>&.
8013 If specified, the option must be set to a colon-separated list of server
8014 information.
8015 Each item in the list is a slash-separated list of three items:
8016 host, database number, and password.
8017 .olist
8018 The host is required and may be either an IPv4 address and optional
8019 port number (separated by a colon, which needs doubling due to the
8020 higher-level list), or a Unix socket pathname enclosed in parentheses
8021 .next
8022 The database number is optional; if present that number is selected in the backend
8023 .next
8024 The password is optional; if present it is used to authenticate to the backend
8025 .endlist
8026
8027 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8028 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8029 respectively, and the characters single-quote, double-quote, and backslash
8030 itself are escaped with backslashes.
8031
8032 The &%quote_redis%& expansion operator
8033 escapes whitespace and backslash characters with a backslash.
8034
8035 .section "Specifying the server in the query" "SECTspeserque"
8036 .new
8037 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8038 it is possible to specify a list of servers with an individual query. This is
8039 done by appending a comma-separated option to the query type:
8040 .display
8041 &`,servers=`&&'server1:server2:server3:...'&
8042 .endd
8043 .wen
8044 Each item in the list may take one of two forms:
8045 .olist
8046 If it contains no slashes it is assumed to be just a host name. The appropriate
8047 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8048 of the same name, and the remaining parameters (database, user, password) are
8049 taken from there.
8050 .next
8051 If it contains any slashes, it is taken as a complete parameter set.
8052 .endlist
8053 The list of servers is used in exactly the same way as the global list.
8054 Once a connection to a server has happened and a query has been
8055 successfully executed, processing of the lookup ceases.
8056
8057 This feature is intended for use in master/slave situations where updates
8058 are occurring and you want to update the master rather than a slave. If the
8059 master is in the list as a backup for reading, you might have a global setting
8060 like this:
8061 .code
8062 mysql_servers = slave1/db/name/pw:\
8063                 slave2/db/name/pw:\
8064                 master/db/name/pw
8065 .endd
8066 In an updating lookup, you could then write:
8067 .code
8068 ${lookup mysql,servers=master {UPDATE ...} }
8069 .endd
8070 That query would then be sent only to the master server. If, on the other hand,
8071 the master is not to be used for reading, and so is not present in the global
8072 option, you can still update it by a query of this form:
8073 .code
8074 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8075 .endd
8076
8077 .new
8078 An older syntax places the servers speciification before the qury,
8079 semicolon separated:
8080 .code
8081 ${lookup mysql{servers=master; UPDATE ...} }
8082 .endd
8083 The new version avoids potential issues with tainted
8084 arguments in the query, for explicit expansion.
8085 &*Note*&: server specifications in list-style lookups are still problematic.
8086 .wen
8087
8088
8089 .section "Special MySQL features" "SECID73"
8090 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8091 causes a connection to the server on the local host by means of a Unix domain
8092 socket. An alternate socket can be specified in parentheses.
8093 An option group name for MySQL option files can be specified in square brackets;
8094 the default value is &"exim"&.
8095 The full syntax of each item in &%mysql_servers%& is:
8096 .display
8097 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8098   <&'database'&>/<&'user'&>/<&'password'&>
8099 .endd
8100 Any of the four sub-parts of the first field can be omitted. For normal use on
8101 the local host it can be left blank or set to just &"localhost"&.
8102
8103 No database need be supplied &-- but if it is absent here, it must be given in
8104 the queries.
8105
8106 If a MySQL query is issued that does not request any data (an insert, update,
8107 or delete command), the result of the lookup is the number of rows affected.
8108
8109 &*Warning*&: This can be misleading. If an update does not actually change
8110 anything (for example, setting a field to the value it already has), the result
8111 is zero because no rows are affected.
8112
8113
8114 .section "Special PostgreSQL features" "SECID74"
8115 PostgreSQL lookups can also use Unix domain socket connections to the database.
8116 This is usually faster and costs less CPU time than a TCP/IP connection.
8117 However it can be used only if the mail server runs on the same machine as the
8118 database server. A configuration line for PostgreSQL via Unix domain sockets
8119 looks like this:
8120 .code
8121 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8122 .endd
8123 In other words, instead of supplying a host name, a path to the socket is
8124 given. The path name is enclosed in parentheses so that its slashes aren't
8125 visually confused with the delimiters for the other server parameters.
8126
8127 If a PostgreSQL query is issued that does not request any data (an insert,
8128 update, or delete command), the result of the lookup is the number of rows
8129 affected.
8130
8131 .section "More about SQLite" "SECTsqlite"
8132 .cindex "lookup" "SQLite"
8133 .cindex "sqlite lookup type"
8134 SQLite is different to the other SQL lookups because a filename is required in
8135 addition to the SQL query. An SQLite database is a single file, and there is no
8136 daemon as in the other SQL databases.
8137
8138 .new
8139 .oindex &%sqlite_dbfile%&
8140 The preferred way of specifying the file is by using the
8141 &%sqlite_dbfile%& option, set to
8142 an absolute path.
8143 .wen
8144 A deprecated method is available, prefixing the query with the filename
8145 separated by white space.
8146 This means that the path name cannot contain white space.
8147 .cindex "tainted data" "sqlite file"
8148 It also means that the query cannot use any tainted values, as that taints
8149 the entire query including the filename - resulting in a refusal to open
8150 the file.
8151
8152 .new
8153 Here is a lookup expansion example:
8154 .code
8155 sqlite_dbfile = /some/thing/sqlitedb
8156 ...
8157 ${lookup sqlite {select name from aliases where id='userx';}}
8158 .endd
8159 In a list, the syntax is similar. For example:
8160 .code
8161 domainlist relay_to_domains = sqlite;\
8162    select * from relays where ip='$sender_host_address';
8163 .endd
8164 .wen
8165 The only character affected by the &%quote_sqlite%& operator is a single
8166 quote, which it doubles.
8167
8168 .cindex timeout SQLite
8169 .cindex sqlite "lookup timeout"
8170 The SQLite library handles multiple simultaneous accesses to the database
8171 internally. Multiple readers are permitted, but only one process can
8172 update at once. Attempts to access the database while it is being updated
8173 are rejected after a timeout period, during which the SQLite library
8174 waits for the lock to be released. In Exim, the default timeout is set
8175 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8176 option.
8177
8178 .section "More about Redis" "SECTredis"
8179 .cindex "lookup" "Redis"
8180 .cindex "redis lookup type"
8181 Redis is a non-SQL database. Commands are simple get and set.
8182 Examples:
8183 .code
8184 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8185 ${lookup redis{get keyname}}
8186 .endd
8187
8188 As of release 4.91, "lightweight" support for Redis Cluster is available.
8189 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8190 of which must be reachable from the running exim instance. If the cluster has
8191 master/slave replication, the list must contain all the master and slave
8192 servers.
8193
8194 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8195 immediately follow the redirection but treats the response as a DEFER, moving on
8196 to the next server in the &%redis_servers%& list until the correct server is
8197 reached.
8198
8199 .ecindex IIDfidalo1
8200 .ecindex IIDfidalo2
8201
8202
8203 . ////////////////////////////////////////////////////////////////////////////
8204 . ////////////////////////////////////////////////////////////////////////////
8205
8206 .chapter "Domain, host, address, and local part lists" &&&
8207          "CHAPdomhosaddlists" &&&
8208          "Domain, host, and address lists"
8209 .scindex IIDdohoadli "lists of domains; hosts; etc."
8210 A number of Exim configuration options contain lists of domains, hosts,
8211 email addresses, or local parts. For example, the &%hold_domains%& option
8212 contains a list of domains whose delivery is currently suspended. These lists
8213 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8214 arguments to expansion conditions such as &%match_domain%&.
8215
8216 Each item in one of these lists is a pattern to be matched against a domain,
8217 host, email address, or local part, respectively. In the sections below, the
8218 different types of pattern for each case are described, but first we cover some
8219 general facilities that apply to all four kinds of list.
8220
8221 Note that other parts of Exim use a &'string list'& which does not
8222 support all the complexity available in
8223 domain, host, address and local part lists.
8224
8225
8226
8227 .section "Expansion of lists" "SECTlistexpand"
8228 .cindex "expansion" "of lists"
8229 Each list is expanded as a single string before it is used.
8230
8231 &'Exception: the router headers_remove option, where list-item
8232 splitting is done before string-expansion.'&
8233
8234 The result of
8235 expansion must be a list, possibly containing empty items, which is split up
8236 into separate items for matching. By default, colon is the separator character,
8237 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8238 &<<SECTempitelis>>& for details of the list syntax; the second of these
8239 discusses the way to specify empty list items.
8240
8241
8242 If the string expansion is forced to fail, Exim behaves as if the item it is
8243 testing (domain, host, address, or local part) is not in the list. Other
8244 expansion failures cause temporary errors.
8245
8246 If an item in a list is a regular expression, backslashes, dollars and possibly
8247 other special characters in the expression must be protected against
8248 misinterpretation by the string expander. The easiest way to do this is to use
8249 the &`\N`& expansion feature to indicate that the contents of the regular
8250 expression should not be expanded. For example, in an ACL you might have:
8251 .code
8252 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8253                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8254 .endd
8255 The first item is a regular expression that is protected from expansion by
8256 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8257 senders based on the receiving domain.
8258
8259
8260
8261
8262 .section "Negated items in lists" "SECID76"
8263 .cindex "list" "negation"
8264 .cindex "negation" "in lists"
8265 Items in a list may be positive or negative. Negative items are indicated by a
8266 leading exclamation mark, which may be followed by optional white space. A list
8267 defines a set of items (domains, etc). When Exim processes one of these lists,
8268 it is trying to find out whether a domain, host, address, or local part
8269 (respectively) is in the set that is defined by the list. It works like this:
8270
8271 The list is scanned from left to right. If a positive item is matched, the
8272 subject that is being checked is in the set; if a negative item is matched, the
8273 subject is not in the set. If the end of the list is reached without the
8274 subject having matched any of the patterns, it is in the set if the last item
8275 was a negative one, but not if it was a positive one. For example, the list in
8276 .code
8277 domainlist relay_to_domains = !a.b.c : *.b.c
8278 .endd
8279 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8280 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8281 list is positive. However, if the setting were
8282 .code
8283 domainlist relay_to_domains = !a.b.c
8284 .endd
8285 then all domains other than &'a.b.c'& would match because the last item in the
8286 list is negative. In other words, a list that ends with a negative item behaves
8287 as if it had an extra item &`:*`& on the end.
8288
8289 Another way of thinking about positive and negative items in lists is to read
8290 the connector as &"or"& after a positive item and as &"and"& after a negative
8291 item.
8292
8293
8294
8295 .section "File names in lists" "SECTfilnamlis"
8296 .cindex "list" "filename in"
8297 If an item in a domain, host, address, or local part list is an absolute
8298 filename (beginning with a slash character), each line of the file is read and
8299 processed as if it were an independent item in the list, except that further
8300 filenames are not allowed,
8301 and no expansion of the data from the file takes place.
8302 Empty lines in the file are ignored, and the file may also contain comment
8303 lines:
8304
8305 .ilist
8306 For domain and host lists, if a # character appears anywhere in a line of the
8307 file, it and all following characters are ignored.
8308 .next
8309 Because local parts may legitimately contain # characters, a comment in an
8310 address list or local part list file is recognized only if # is preceded by
8311 white space or the start of the line. For example:
8312 .code
8313 not#comment@x.y.z   # but this is a comment
8314 .endd
8315 .endlist
8316
8317 Putting a filename in a list has the same effect as inserting each line of the
8318 file as an item in the list (blank lines and comments excepted). However, there
8319 is one important difference: the file is read each time the list is processed,
8320 so if its contents vary over time, Exim's behaviour changes.
8321
8322 If a filename is preceded by an exclamation mark, the sense of any match
8323 within the file is inverted. For example, if
8324 .code
8325 hold_domains = !/etc/nohold-domains
8326 .endd
8327 and the file contains the lines
8328 .code
8329 !a.b.c
8330 *.b.c
8331 .endd
8332 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8333 any domain matching &`*.b.c`& is not.
8334
8335
8336
8337 .section "An lsearch file is not an out-of-line list" "SECID77"
8338 As will be described in the sections that follow, lookups can be used in lists
8339 to provide indexed methods of checking list membership. There has been some
8340 confusion about the way &(lsearch)& lookups work in lists. Because
8341 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8342 sometimes thought that it is allowed to contain wild cards and other kinds of
8343 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8344 always fixed strings, just as for any other single-key lookup type.
8345
8346 If you want to use a file to contain wild-card patterns that form part of a
8347 list, just give the filename on its own, without a search type, as described
8348 in the previous section. You could also use the &(wildlsearch)& or
8349 &(nwildlsearch)&, but there is no advantage in doing this.
8350
8351
8352
8353
8354 .new
8355 .section "Results of list checking" SECTlistresults
8356 The primary result of doing a list check is a truth value.
8357 In some contexts additional information is stored
8358 about the list element that matched:
8359 .vlist
8360 .vitem hosts
8361 A &%hosts%& ACL condition
8362 will store a result in the &$host_data$& variable.
8363 .vitem local_parts
8364 A &%local_parts%& router option or &%local_parts%& ACL condition
8365 will store a result in the &$local_part_data$& variable.
8366 .vitem domains
8367 A &%domains%& router option or &%domains%& ACL condition
8368 .vitem senders
8369 A &%senders%& router option or &%senders%& ACL condition
8370 will store a result in the &$sender_data$& variable.
8371 .vitem recipients
8372 A &%recipients%& ACL condition
8373 will store a result in the &$recipient_data$& variable.
8374 .endlist
8375
8376 The detail of the additional information depends on the
8377 type of match and is given below as the &*value*& information.
8378 .wen
8379
8380
8381
8382
8383 .section "Named lists" "SECTnamedlists"
8384 .cindex "named lists"
8385 .cindex "list" "named"
8386 A list of domains, hosts, email addresses, or local parts can be given a name
8387 which is then used to refer to the list elsewhere in the configuration. This is
8388 particularly convenient if the same list is required in several different
8389 places. It also allows lists to be given meaningful names, which can improve
8390 the readability of the configuration. For example, it is conventional to define
8391 a domain list called &'local_domains'& for all the domains that are handled
8392 locally on a host, using a configuration line such as
8393 .code
8394 domainlist local_domains = localhost:my.dom.example
8395 .endd
8396 Named lists are referenced by giving their name preceded by a plus sign, so,
8397 for example, a router that is intended to handle local domains would be
8398 configured with the line
8399 .code
8400 domains = +local_domains
8401 .endd
8402 The first router in a configuration is often one that handles all domains
8403 except the local ones, using a configuration with a negated item like this:
8404 .code
8405 dnslookup:
8406   driver = dnslookup
8407   domains = ! +local_domains
8408   transport = remote_smtp
8409   no_more
8410 .endd
8411 The four kinds of named list are created by configuration lines starting with
8412 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8413 respectively. Then there follows the name that you are defining, followed by an
8414 equals sign and the list itself. For example:
8415 .code
8416 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8417 addresslist bad_senders = cdb;/etc/badsenders
8418 .endd
8419 A named list may refer to other named lists:
8420 .code
8421 domainlist  dom1 = first.example : second.example
8422 domainlist  dom2 = +dom1 : third.example
8423 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8424 .endd
8425 &*Warning*&: If the last item in a referenced list is a negative one, the
8426 effect may not be what you intended, because the negation does not propagate
8427 out to the higher level. For example, consider:
8428 .code
8429 domainlist  dom1 = !a.b
8430 domainlist  dom2 = +dom1 : *.b
8431 .endd
8432 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8433 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8434 means it matches the second list as well. The effect is not the same as
8435 .code
8436 domainlist  dom2 = !a.b : *.b
8437 .endd
8438 where &'x.y'& does not match. It's best to avoid negation altogether in
8439 referenced lists if you can.
8440
8441 .new
8442 .cindex "hiding named list values"
8443 .cindex "named lists" "hiding value of"
8444 Some named list definitions may contain sensitive data, for example, passwords for
8445 accessing databases. To stop non-admin users from using the &%-bP%& command
8446 line option to read these values, you can precede the definition with the
8447 word &"hide"&. For example:
8448 .code
8449 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8450 .endd
8451 .wen
8452
8453
8454 Named lists may have a performance advantage. When Exim is routing an
8455 address or checking an incoming message, it caches the result of tests on named
8456 lists. So, if you have a setting such as
8457 .code
8458 domains = +local_domains
8459 .endd
8460 on several of your routers
8461 or in several ACL statements,
8462 the actual test is done only for the first one. However, the caching works only
8463 if there are no expansions within the list itself or any sublists that it
8464 references. In other words, caching happens only for lists that are known to be
8465 the same each time they are referenced.
8466
8467 By default, there may be up to 16 named lists of each type. This limit can be
8468 extended by changing a compile-time variable. The use of domain and host lists
8469 is recommended for concepts such as local domains, relay domains, and relay
8470 hosts. The default configuration is set up like this.
8471
8472
8473
8474 .section "Named lists compared with macros" "SECID78"
8475 .cindex "list" "named compared with macro"
8476 .cindex "macro" "compared with named list"
8477 At first sight, named lists might seem to be no different from macros in the
8478 configuration file. However, macros are just textual substitutions. If you
8479 write
8480 .code
8481 ALIST = host1 : host2
8482 auth_advertise_hosts = !ALIST
8483 .endd
8484 it probably won't do what you want, because that is exactly the same as
8485 .code
8486 auth_advertise_hosts = !host1 : host2
8487 .endd
8488 Notice that the second host name is not negated. However, if you use a host
8489 list, and write
8490 .code
8491 hostlist alist = host1 : host2
8492 auth_advertise_hosts = ! +alist
8493 .endd
8494 the negation applies to the whole list, and so that is equivalent to
8495 .code
8496 auth_advertise_hosts = !host1 : !host2
8497 .endd
8498
8499
8500 .section "Named list caching" "SECID79"
8501 .cindex "list" "caching of named"
8502 .cindex "caching" "named lists"
8503 While processing a message, Exim caches the result of checking a named list if
8504 it is sure that the list is the same each time. In practice, this means that
8505 the cache operates only if the list contains no $ characters, which guarantees
8506 that it will not change when it is expanded. Sometimes, however, you may have
8507 an expanded list that you know will be the same each time within a given
8508 message. For example:
8509 .code
8510 domainlist special_domains = \
8511            ${lookup{$sender_host_address}cdb{/some/file}}
8512 .endd
8513 This provides a list of domains that depends only on the sending host's IP
8514 address. If this domain list is referenced a number of times (for example,
8515 in several ACL lines, or in several routers) the result of the check is not
8516 cached by default, because Exim does not know that it is going to be the
8517 same list each time.
8518
8519 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8520 cache the result anyway. For example:
8521 .code
8522 domainlist_cache special_domains = ${lookup{...
8523 .endd
8524 If you do this, you should be absolutely sure that caching is going to do
8525 the right thing in all cases. When in doubt, leave it out.
8526
8527
8528
8529 .section "Domain lists" "SECTdomainlist"
8530 .cindex "domain list" "patterns for"
8531 .cindex "list" "domain list"
8532 Domain lists contain patterns that are to be matched against a mail domain.
8533 The following types of item may appear in domain lists:
8534
8535 .ilist
8536 .cindex "primary host name"
8537 .cindex "host name" "matched in domain list"
8538 .oindex "&%primary_hostname%&"
8539 .cindex "domain list" "matching primary host name"
8540 .cindex "@ in a domain list"
8541 If a pattern consists of a single @ character, it matches the local host name,
8542 as set by the &%primary_hostname%& option (or defaulted). This makes it
8543 possible to use the same configuration file on several different hosts that
8544 differ only in their names.
8545
8546 .new
8547 The value for a match will be the primary host name.
8548 .wen
8549
8550
8551 .next
8552 .cindex "@[] in a domain list"
8553 .cindex "domain list" "matching local IP interfaces"
8554 .cindex "domain literal"
8555 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8556 in square brackets (as in an email address that contains a domain literal), but
8557 only if that IP address is recognized as local for email routing purposes. The
8558 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8559 control which of a host's several IP addresses are treated as local.
8560 In today's Internet, the use of domain literals is controversial;
8561 see the &%allow_domain_literals%& main option.
8562
8563 .new
8564 The value for a match will be the string &`@[]`&.
8565 .wen
8566
8567
8568 .next
8569 .cindex "@mx_any"
8570 .cindex "@mx_primary"
8571 .cindex "@mx_secondary"
8572 .cindex "domain list" "matching MX pointers to local host"
8573 If a pattern consists of the string &`@mx_any`& it matches any domain that
8574 has an MX record pointing to the local host or to any host that is listed in
8575 .oindex "&%hosts_treat_as_local%&"
8576 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8577 are similar, except that the first matches only when a primary MX target is the
8578 local host, and the second only when no primary MX target is the local host,
8579 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8580 preference value &-- there may of course be more than one of them.
8581
8582 The MX lookup that takes place when matching a pattern of this type is
8583 performed with the resolver options for widening names turned off. Thus, for
8584 example, a single-component domain will &'not'& be expanded by adding the
8585 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8586 options of the &(dnslookup)& router for a discussion of domain widening.
8587
8588 Sometimes you may want to ignore certain IP addresses when using one of these
8589 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8590 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8591 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8592 on a router). For example:
8593 .code
8594 domains = @mx_any/ignore=127.0.0.1
8595 .endd
8596 This example matches any domain that has an MX record pointing to one of
8597 the local host's IP addresses other than 127.0.0.1.
8598
8599 The list of IP addresses is in fact processed by the same code that processes
8600 host lists, so it may contain CIDR-coded network specifications and it may also
8601 contain negative items.
8602
8603 Because the list of IP addresses is a sublist within a domain list, you have to
8604 be careful about delimiters if there is more than one address. Like any other
8605 list, the default delimiter can be changed. Thus, you might have:
8606 .code
8607 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8608           an.other.domain : ...
8609 .endd
8610 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8611 involved, it is easiest to change the delimiter for the main list as well:
8612 .code
8613 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8614           an.other.domain ? ...
8615 .endd
8616 .new
8617 The value for a match will be the list element string (starting &`@mx_`&).
8618 .wen
8619
8620
8621 .next
8622 .cindex "asterisk" "in domain list"
8623 .cindex "domain list" "asterisk in"
8624 .cindex "domain list" "matching &""ends with""&"
8625 If a pattern starts with an asterisk, the remaining characters of the pattern
8626 are compared with the terminating characters of the domain. The use of &"*"& in
8627 domain lists differs from its use in partial matching lookups. In a domain
8628 list, the character following the asterisk need not be a dot, whereas partial
8629 matching works only in terms of dot-separated components. For example, a domain
8630 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8631 &'cipher.key.ex'&.
8632
8633 .new
8634 The value for a match will be the list element string (starting with the asterisk).
8635 Additionally, &$0$& will be set to the matched string
8636 and &$1$& to the variable portion which the asterisk matched.
8637 .wen
8638
8639 .next
8640 .cindex "regular expressions" "in domain list"
8641 .cindex "domain list" "matching regular expression"
8642 If a pattern starts with a circumflex character, it is treated as a regular
8643 expression, and matched against the domain using a regular expression matching
8644 function. The circumflex is treated as part of the regular expression.
8645 Email domains are case-independent, so this regular expression match is by
8646 default case-independent, but you can make it case-dependent by starting it
8647 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8648 are given in chapter &<<CHAPregexp>>&.
8649
8650 &*Warning*&: Because domain lists are expanded before being processed, you
8651 must escape any backslash and dollar characters in the regular expression, or
8652 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8653 it is not to be expanded (unless you really do want to build a regular
8654 expression by expansion, of course).
8655
8656 .new
8657 The value for a match will be the list element string (starting with the circumflex).
8658 Additionally, &$0$& will be set to the string matching the regular expression,
8659 and &$1$& (onwards) to any submatches identified by parentheses.
8660 .wen
8661
8662
8663
8664 .next
8665 .cindex "lookup" "in domain list"
8666 .cindex "domain list" "matching by lookup"
8667 If a pattern starts with the name of a single-key lookup type followed by a
8668 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8669 must be a filename in a suitable format for the lookup type. For example, for
8670 &"cdb;"& it must be an absolute path:
8671 .code
8672 domains = cdb;/etc/mail/local_domains.cdb
8673 .endd
8674 The appropriate type of lookup is done on the file using the domain name as the
8675 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8676 only in whether or not the key is present in the file. However, when a lookup
8677 is used for the &%domains%& option on a router
8678 or a &%domains%& condition in an ACL statement, the value is preserved in the
8679 &$domain_data$& variable and can be referred to in other router options or
8680 other statements in the same ACL.
8681 .cindex "tainted data" "de-tainting"
8682 The value will be untainted.
8683
8684
8685 .next
8686 Any of the single-key lookup type names may be preceded by
8687 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8688 .code
8689 domains = partial-dbm;/partial/domains
8690 .endd
8691 This causes partial matching logic to be invoked; a description of how this
8692 works is given in section &<<SECTpartiallookup>>&.
8693
8694 .next
8695 .cindex "asterisk" "in lookup type"
8696 Any of the single-key lookup types may be followed by an asterisk. This causes
8697 a default lookup for a key consisting of a single asterisk to be done if the
8698 original lookup fails. This is not a useful feature when using a domain list to
8699 select particular domains (because any domain would match), but it might have
8700 value if the result of the lookup is being used via the &$domain_data$&
8701 expansion variable.
8702
8703 .next
8704 If the pattern starts with the name of a query-style lookup type followed by a
8705 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8706 pattern must be an appropriate query for the lookup type, as described in
8707 chapter &<<CHAPfdlookup>>&. For example:
8708 .code
8709 hold_domains = mysql;select domain from holdlist \
8710   where domain = '${quote_mysql:$domain}';
8711 .endd
8712 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8713 example, it doesn't matter what field you select). Exim is interested only in
8714 whether or not the query succeeds. However, when a lookup is used for the
8715 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8716 variable and can be referred to in other options.
8717 .cindex "tainted data" "de-tainting"
8718 The value will be untainted.
8719
8720 .next
8721 .new
8722 If the pattern starts with the name of a lookup type
8723 of either kind (single-key or query-style) it may be
8724 followed by a comma and options,
8725 The options are lookup-type specific and consist of a comma-separated list.
8726 Each item starts with a tag and and equals "=".
8727 .wen
8728
8729 .next
8730 .cindex "domain list" "matching literal domain name"
8731 If none of the above cases apply, a caseless textual comparison is made
8732 between the pattern and the domain.
8733
8734 The value for a match will be the list element string.
8735 .cindex "tainted data" "de-tainting"
8736 Note that this is commonly untainted
8737 (depending on the way the list was created).
8738 Specifically, explicit text in the configuration file in not tainted.
8739 This is a useful way of obtaining an untainted equivalent to
8740 the domain, for later operations.
8741
8742 However if the list (including one-element lists)
8743 is created by expanding a variable containing tainted data,
8744 it is tainted and so will the match value be.
8745 .endlist
8746
8747
8748 Here is an example that uses several different kinds of pattern:
8749 .code
8750 domainlist funny_domains = \
8751   @ : \
8752   lib.unseen.edu : \
8753   *.foundation.fict.example : \
8754   \N^[1-2]\d{3}\.fict\.example$\N : \
8755   partial-dbm;/opt/data/penguin/book : \
8756   nis;domains.byname : \
8757   nisplus;[name=$domain,status=local],domains.org_dir
8758 .endd
8759 There are obvious processing trade-offs among the various matching modes. Using
8760 an asterisk is faster than a regular expression, and listing a few names
8761 explicitly probably is too. The use of a file or database lookup is expensive,
8762 but may be the only option if hundreds of names are required. Because the
8763 patterns are tested in order, it makes sense to put the most commonly matched
8764 patterns earlier.
8765
8766
8767
8768 .section "Host lists" "SECThostlist"
8769 .cindex "host list" "patterns in"
8770 .cindex "list" "host list"
8771 Host lists are used to control what remote hosts are allowed to do. For
8772 example, some hosts may be allowed to use the local host as a relay, and some
8773 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8774 two different ways, by name or by IP address. In a host list, some types of
8775 pattern are matched to a host name, and some are matched to an IP address.
8776 You need to be particularly careful with this when single-key lookups are
8777 involved, to ensure that the right value is being used as the key.
8778
8779
8780 .section "Special host list patterns" "SECID80"
8781 .cindex "empty item in hosts list"
8782 .cindex "host list" "empty string in"
8783 If a host list item is the empty string, it matches only when no remote host is
8784 involved. This is the case when a message is being received from a local
8785 process using SMTP on the standard input, that is, when a TCP/IP connection is
8786 not used.
8787
8788 .cindex "asterisk" "in host list"
8789 The special pattern &"*"& in a host list matches any host or no host. Neither
8790 the IP address nor the name is actually inspected.
8791
8792
8793
8794 .section "Host list patterns that match by IP address" "SECThoslispatip"
8795 .cindex "host list" "matching IP addresses"
8796 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8797 the incoming address actually appears in the IPv6 host as
8798 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8799 list, it is converted into a traditional IPv4 address first. (Not all operating
8800 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8801 concerns.)
8802
8803 The following types of pattern in a host list check the remote host by
8804 inspecting its IP address:
8805
8806 .ilist
8807 If the pattern is a plain domain name (not a regular expression, not starting
8808 with *, not a lookup of any kind), Exim calls the operating system function
8809 to find the associated IP address(es). Exim uses the newer
8810 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8811 This typically causes a forward DNS lookup of the name. The result is compared
8812 with the IP address of the subject host.
8813
8814 If there is a temporary problem (such as a DNS timeout) with the host name
8815 lookup, a temporary error occurs. For example, if the list is being used in an
8816 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8817 temporary SMTP error code. If no IP address can be found for the host name,
8818 what happens is described in section &<<SECTbehipnot>>& below.
8819
8820 .next
8821 .cindex "@ in a host list"
8822 If the pattern is &"@"&, the primary host name is substituted and used as a
8823 domain name, as just described.
8824
8825 .next
8826 If the pattern is an IP address, it is matched against the IP address of the
8827 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8828 IPv6 addresses can be given in colon-separated format, but the colons have to
8829 be doubled so as not to be taken as item separators when the default list
8830 separator is used. IPv6 addresses are recognized even when Exim is compiled
8831 without IPv6 support. This means that if they appear in a host list on an
8832 IPv4-only host, Exim will not treat them as host names. They are just addresses
8833 that can never match a client host.
8834
8835 .next
8836 .cindex "@[] in a host list"
8837 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8838 the local host. For example, if the local host is an IPv4 host with one
8839 interface address 10.45.23.56, these two ACL statements have the same effect:
8840 .code
8841 accept hosts = 127.0.0.1 : 10.45.23.56
8842 accept hosts = @[]
8843 .endd
8844 .next
8845 .cindex "CIDR notation"
8846 If the pattern is an IP address followed by a slash and a mask length (for
8847 example 10.11.42.0/24), it is matched against the IP address of the subject
8848 host under the given mask. This allows, an entire network of hosts to be
8849 included (or excluded) by a single item. The mask uses CIDR notation; it
8850 specifies the number of address bits that must match, starting from the most
8851 significant end of the address.
8852
8853 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8854 of a range of addresses. It is the number of bits in the network portion of the
8855 address. The above example specifies a 24-bit netmask, so it matches all 256
8856 addresses in the 10.11.42.0 network. An item such as
8857 .code
8858 192.168.23.236/31
8859 .endd
8860 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8861 32 for an IPv4 address is the same as no mask at all; just a single address
8862 matches.
8863
8864 Here is another example which shows an IPv4 and an IPv6 network:
8865 .code
8866 recipient_unqualified_hosts = 192.168.0.0/16: \
8867                               3ffe::ffff::836f::::/48
8868 .endd
8869 The doubling of list separator characters applies only when these items
8870 appear inline in a host list. It is not required when indirecting via a file.
8871 For example:
8872 .code
8873 recipient_unqualified_hosts = /opt/exim/unqualnets
8874 .endd
8875 could make use of a file containing
8876 .code
8877 172.16.0.0/12
8878 3ffe:ffff:836f::/48
8879 .endd
8880 to have exactly the same effect as the previous example. When listing IPv6
8881 addresses inline, it is usually more convenient to use the facility for
8882 changing separator characters. This list contains the same two networks:
8883 .code
8884 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8885                                  3ffe:ffff:836f::/48
8886 .endd
8887 The separator is changed to semicolon by the leading &"<;"& at the start of the
8888 list.
8889 .endlist
8890
8891
8892
8893 .section "Host list patterns for single-key lookups by host address" &&&
8894          "SECThoslispatsikey"
8895 .cindex "host list" "lookup of IP address"
8896 When a host is to be identified by a single-key lookup of its complete IP
8897 address, the pattern takes this form:
8898 .display
8899 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8900 .endd
8901 For example:
8902 .code
8903 hosts_lookup = net-cdb;/hosts-by-ip.db
8904 .endd
8905 The text form of the IP address of the subject host is used as the lookup key.
8906 IPv6 addresses are converted to an unabbreviated form, using lower case
8907 letters, with dots as separators because colon is the key terminator in
8908 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8909 quoting the keys, but this is a facility that was added later.] The data
8910 returned by the lookup is not used.
8911
8912 .cindex "IP address" "masking"
8913 .cindex "host list" "masked IP address"
8914 Single-key lookups can also be performed using masked IP addresses, using
8915 patterns of this form:
8916 .display
8917 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8918 .endd
8919 For example:
8920 .code
8921 net24-dbm;/networks.db
8922 .endd
8923 The IP address of the subject host is masked using <&'number'&> as the mask
8924 length. A textual string is constructed from the masked value, followed by the
8925 mask, and this is used as the lookup key. For example, if the host's IP address
8926 is 192.168.34.6, the key that is looked up for the above example is
8927 &"192.168.34.0/24"&.
8928
8929 When an IPv6 address is converted to a string, dots are normally used instead
8930 of colons, so that keys in &(lsearch)& files need not contain colons (which
8931 terminate &(lsearch)& keys). This was implemented some time before the ability
8932 to quote keys was made available in &(lsearch)& files. However, the more
8933 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8934 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8935 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8936 converted using colons and not dots.
8937 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8938 addresses are always used.
8939 The latter are converted to IPv4 addresses, in dotted-quad form.
8940
8941 Ideally, it would be nice to tidy up this anomalous situation by changing to
8942 colons in all cases, given that quoting is now available for &(lsearch)&.
8943 However, this would be an incompatible change that might break some existing
8944 configurations.
8945
8946 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8947 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8948 the former case the key strings include the mask value, whereas in the latter
8949 case the IP address is used on its own.
8950
8951
8952
8953 .section "Host list patterns that match by host name" "SECThoslispatnam"
8954 .cindex "host" "lookup failures"
8955 .cindex "unknown host name"
8956 .cindex "host list" "matching host name"
8957 There are several types of pattern that require Exim to know the name of the
8958 remote host. These are either wildcard patterns or lookups by name. (If a
8959 complete hostname is given without any wildcarding, it is used to find an IP
8960 address to match against, as described in section &<<SECThoslispatip>>&
8961 above.)
8962
8963 If the remote host name is not already known when Exim encounters one of these
8964 patterns, it has to be found from the IP address.
8965 Although many sites on the Internet are conscientious about maintaining reverse
8966 DNS data for their hosts, there are also many that do not do this.
8967 Consequently, a name cannot always be found, and this may lead to unwanted
8968 effects. Take care when configuring host lists with wildcarded name patterns.
8969 Consider what will happen if a name cannot be found.
8970
8971 Because of the problems of determining host names from IP addresses, matching
8972 against host names is not as common as matching against IP addresses.
8973
8974 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8975 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8976 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8977 are done can be changed by setting the &%host_lookup_order%& option. For
8978 security, once Exim has found one or more names, it looks up the IP addresses
8979 for these names and compares them with the IP address that it started with.
8980 Only those names whose IP addresses match are accepted. Any other names are
8981 discarded. If no names are left, Exim behaves as if the host name cannot be
8982 found. In the most common case there is only one name and one IP address.
8983
8984 There are some options that control what happens if a host name cannot be
8985 found. These are described in section &<<SECTbehipnot>>& below.
8986
8987 .cindex "host" "alias for"
8988 .cindex "alias for host"
8989 As a result of aliasing, hosts may have more than one name. When processing any
8990 of the following types of pattern, all the host's names are checked:
8991
8992 .ilist
8993 .cindex "asterisk" "in host list"
8994 If a pattern starts with &"*"& the remainder of the item must match the end of
8995 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8996 &'.b.c'&. This special simple form is provided because this is a very common
8997 requirement. Other kinds of wildcarding require the use of a regular
8998 expression.
8999 .next
9000 .cindex "regular expressions" "in host list"
9001 .cindex "host list" "regular expression in"
9002 If the item starts with &"^"& it is taken to be a regular expression which is
9003 matched against the host name. Host names are case-independent, so this regular
9004 expression match is by default case-independent, but you can make it
9005 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9006 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9007 example,
9008 .code
9009 ^(a|b)\.c\.d$
9010 .endd
9011 is a regular expression that matches either of the two hosts &'a.c.d'& or
9012 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9013 that backslash and dollar characters are not misinterpreted as part of the
9014 string expansion. The simplest way to do this is to use &`\N`& to mark that
9015 part of the string as non-expandable. For example:
9016 .code
9017 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9018 .endd
9019 &*Warning*&: If you want to match a complete host name, you must include the
9020 &`$`& terminating metacharacter in the regular expression, as in the above
9021 example. Without it, a match at the start of the host name is all that is
9022 required.
9023 .endlist
9024
9025
9026
9027
9028 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9029 .cindex "host" "lookup failures, permanent"
9030 While processing a host list, Exim may need to look up an IP address from a
9031 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9032 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9033 behaviour when it fails to find the information it is seeking is the same.
9034
9035 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9036 apply to temporary DNS errors, whose handling is described in the next section.
9037
9038 .cindex "&`+include_unknown`&"
9039 .cindex "&`+ignore_unknown`&"
9040 Exim parses a host list from left to right. If it encounters a permanent
9041 lookup failure in any item in the host list before it has found a match,
9042 Exim treats it as a failure and the default behavior is as if the host
9043 does not match the list. This may not always be what you want to happen.
9044 To change Exim's behaviour, the special items &`+include_unknown`& or
9045 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9046 not recognized in an indirected file).
9047
9048 .ilist
9049 If any item that follows &`+include_unknown`& requires information that
9050 cannot found, Exim behaves as if the host does match the list. For example,
9051 .code
9052 host_reject_connection = +include_unknown:*.enemy.ex
9053 .endd
9054 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9055 any hosts whose name it cannot find.
9056
9057 .next
9058 If any item that follows &`+ignore_unknown`& requires information that cannot
9059 be found, Exim ignores that item and proceeds to the rest of the list. For
9060 example:
9061 .code
9062 accept hosts = +ignore_unknown : friend.example : \
9063                192.168.4.5
9064 .endd
9065 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9066 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9067 name can be found for 192.168.4.5, it is rejected.
9068 .endlist
9069
9070 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9071 list. The effect of each one lasts until the next, or until the end of the
9072 list.
9073
9074 .section "Mixing wildcarded host names and addresses in host lists" &&&
9075          "SECTmixwilhos"
9076 .cindex "host list" "mixing names and addresses in"
9077
9078 This section explains the host/ip processing logic with the same concepts
9079 as the previous section, but specifically addresses what happens when a
9080 wildcarded hostname is one of the items in the hostlist.
9081
9082 .ilist
9083 If you have name lookups or wildcarded host names and
9084 IP addresses in the same host list, you should normally put the IP
9085 addresses first. For example, in an ACL you could have:
9086 .code
9087 accept hosts = 10.9.8.7 : *.friend.example
9088 .endd
9089 The reason you normally would order it this way lies in the
9090 left-to-right way that Exim processes lists.  It can test IP addresses
9091 without doing any DNS lookups, but when it reaches an item that requires
9092 a host name, it fails if it cannot find a host name to compare with the
9093 pattern. If the above list is given in the opposite order, the
9094 &%accept%& statement fails for a host whose name cannot be found, even
9095 if its IP address is 10.9.8.7.
9096
9097 .next
9098 If you really do want to do the name check first, and still recognize the IP
9099 address, you can rewrite the ACL like this:
9100 .code
9101 accept hosts = *.friend.example
9102 accept hosts = 10.9.8.7
9103 .endd
9104 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9105 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9106 &`+ignore_unknown`&, which was discussed in depth in the first example in
9107 this section.
9108 .endlist
9109
9110
9111 .section "Temporary DNS errors when looking up host information" &&&
9112          "SECTtemdnserr"
9113 .cindex "host" "lookup failures, temporary"
9114 .cindex "&`+include_defer`&"
9115 .cindex "&`+ignore_defer`&"
9116 A temporary DNS lookup failure normally causes a defer action (except when
9117 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9118 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9119 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9120 section. These options should be used with care, probably only in non-critical
9121 host lists such as whitelists.
9122
9123
9124
9125 .section "Host list patterns for single-key lookups by host name" &&&
9126          "SECThoslispatnamsk"
9127 .cindex "unknown host name"
9128 .cindex "host list" "matching host name"
9129 If a pattern is of the form
9130 .display
9131 <&'single-key-search-type'&>;<&'search-data'&>
9132 .endd
9133 for example
9134 .code
9135 dbm;/host/accept/list
9136 .endd
9137 a single-key lookup is performed, using the host name as its key. If the
9138 lookup succeeds, the host matches the item. The actual data that is looked up
9139 is not used.
9140
9141 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9142 keys in the file, not IP addresses. If you want to do lookups based on IP
9143 addresses, you must precede the search type with &"net-"& (see section
9144 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9145 two items in the same list, one doing an address lookup and one doing a name
9146 lookup, both using the same file.
9147
9148
9149
9150 .section "Host list patterns for query-style lookups" "SECID81"
9151 If a pattern is of the form
9152 .display
9153 <&'query-style-search-type'&>;<&'query'&>
9154 .endd
9155 the query is obeyed, and if it succeeds, the host matches the item. The actual
9156 data that is looked up is not used. The variables &$sender_host_address$& and
9157 &$sender_host_name$& can be used in the query. For example:
9158 .code
9159 hosts_lookup = pgsql;\
9160   select ip from hostlist where ip='$sender_host_address'
9161 .endd
9162 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9163 can use the &%sg%& expansion item to change this if you need to. If you want to
9164 use masked IP addresses in database queries, you can use the &%mask%& expansion
9165 operator.
9166
9167 If the query contains a reference to &$sender_host_name$&, Exim automatically
9168 looks up the host name if it has not already done so. (See section
9169 &<<SECThoslispatnam>>& for comments on finding host names.)
9170
9171 Historical note: prior to release 4.30, Exim would always attempt to find a
9172 host name before running the query, unless the search type was preceded by
9173 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9174 still recognized for query-style lookups, but its presence or absence has no
9175 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9176 See section &<<SECThoslispatsikey>>&.)
9177
9178
9179
9180
9181
9182 .section "Address lists" "SECTaddresslist"
9183 .cindex "list" "address list"
9184 .cindex "address list" "empty item"
9185 .cindex "address list" "patterns"
9186 Address lists contain patterns that are matched against mail addresses. There
9187 is one special case to be considered: the sender address of a bounce message is
9188 always empty. You can test for this by providing an empty item in an address
9189 list. For example, you can set up a router to process bounce messages by
9190 using this option setting:
9191 .code
9192 senders = :
9193 .endd
9194 The presence of the colon creates an empty item. If you do not provide any
9195 data, the list is empty and matches nothing. The empty sender can also be
9196 detected by a regular expression that matches an empty string,
9197 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9198
9199 Non-empty items in an address list can be straightforward email addresses. For
9200 example:
9201 .code
9202 senders = jbc@askone.example : hs@anacreon.example
9203 .endd
9204 A certain amount of wildcarding is permitted. If a pattern contains an @
9205 character, but is not a regular expression and does not begin with a
9206 semicolon-terminated lookup type (described below), the local part of the
9207 subject address is compared with the local part of the pattern, which may start
9208 with an asterisk. If the local parts match, the domain is checked in exactly
9209 the same way as for a pattern in a domain list. For example, the domain can be
9210 wildcarded, refer to a named list, or be a lookup:
9211 .code
9212 deny senders = *@*.spamming.site:\
9213                *@+hostile_domains:\
9214                bozo@partial-lsearch;/list/of/dodgy/sites:\
9215                *@dbm;/bad/domains.db
9216 .endd
9217 .cindex "local part" "starting with !"
9218 .cindex "address list" "local part starting with !"
9219 If a local part that begins with an exclamation mark is required, it has to be
9220 specified using a regular expression, because otherwise the exclamation mark is
9221 treated as a sign of negation, as is standard in lists.
9222
9223 If a non-empty pattern that is not a regular expression or a lookup does not
9224 contain an @ character, it is matched against the domain part of the subject
9225 address. The only two formats that are recognized this way are a literal
9226 domain, or a domain pattern that starts with *. In both these cases, the effect
9227 is the same as if &`*@`& preceded the pattern. For example:
9228 .code
9229 deny senders = enemy.domain : *.enemy.domain
9230 .endd
9231
9232 The following kinds of more complicated address list pattern can match any
9233 address, including the empty address that is characteristic of bounce message
9234 senders:
9235
9236 .ilist
9237 .cindex "regular expressions" "in address list"
9238 .cindex "address list" "regular expression in"
9239 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9240 done against the complete address, with the pattern as the regular expression.
9241 You must take care that backslash and dollar characters are not misinterpreted
9242 as part of the string expansion. The simplest way to do this is to use &`\N`&
9243 to mark that part of the string as non-expandable. For example:
9244 .code
9245 deny senders = \N^.*this.*@example\.com$\N : \
9246                \N^\d{8}.+@spamhaus.example$\N : ...
9247 .endd
9248 The &`\N`& sequences are removed by the expansion, so these items do indeed
9249 start with &"^"& by the time they are being interpreted as address patterns.
9250
9251 .next
9252 .cindex "address list" "lookup for complete address"
9253 Complete addresses can be looked up by using a pattern that starts with a
9254 lookup type terminated by a semicolon, followed by the data for the lookup. For
9255 example:
9256 .code
9257 deny senders = cdb;/etc/blocked.senders : \
9258   mysql;select address from blocked where \
9259   address='${quote_mysql:$sender_address}'
9260 .endd
9261 Both query-style and single-key lookup types can be used. For a single-key
9262 lookup type, Exim uses the complete address as the key. However, empty keys are
9263 not supported for single-key lookups, so a match against the empty address
9264 always fails. This restriction does not apply to query-style lookups.
9265
9266 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9267 cannot be used, and is ignored if specified, with an entry being written to the
9268 panic log.
9269 .cindex "*@ with single-key lookup"
9270 However, you can configure lookup defaults, as described in section
9271 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9272 default. For example, with this lookup:
9273 .code
9274 accept senders = lsearch*@;/some/file
9275 .endd
9276 the file could contains lines like this:
9277 .code
9278 user1@domain1.example
9279 *@domain2.example
9280 .endd
9281 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9282 that are tried is:
9283 .code
9284 nimrod@jaeger.example
9285 *@jaeger.example
9286 *
9287 .endd
9288 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9289 would mean that every address matches, thus rendering the test useless.
9290
9291 &*Warning 2*&: Do not confuse these two kinds of item:
9292 .code
9293 deny recipients = dbm*@;/some/file
9294 deny recipients = *@dbm;/some/file
9295 .endd
9296 The first does a whole address lookup, with defaulting, as just described,
9297 because it starts with a lookup type. The second matches the local part and
9298 domain independently, as described in a bullet point below.
9299 .endlist
9300
9301
9302 The following kinds of address list pattern can match only non-empty addresses.
9303 If the subject address is empty, a match against any of these pattern types
9304 always fails.
9305
9306
9307 .ilist
9308 .cindex "@@ with single-key lookup"
9309 .cindex "address list" "@@ lookup type"
9310 .cindex "address list" "split local part and domain"
9311 If a pattern starts with &"@@"& followed by a single-key lookup item
9312 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9313 split into a local part and a domain. The domain is looked up in the file. If
9314 it is not found, there is no match. If it is found, the data that is looked up
9315 from the file is treated as a colon-separated list of local part patterns, each
9316 of which is matched against the subject local part in turn.
9317
9318 .cindex "asterisk" "in address list"
9319 The lookup may be a partial one, and/or one involving a search for a default
9320 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9321 patterns that are looked up can be regular expressions or begin with &"*"&, or
9322 even be further lookups. They may also be independently negated. For example,
9323 with
9324 .code
9325 deny senders = @@dbm;/etc/reject-by-domain
9326 .endd
9327 the data from which the DBM file is built could contain lines like
9328 .code
9329 baddomain.com:  !postmaster : *
9330 .endd
9331 to reject all senders except &%postmaster%& from that domain.
9332
9333 .cindex "local part" "starting with !"
9334 If a local part that actually begins with an exclamation mark is required, it
9335 has to be specified using a regular expression. In &(lsearch)& files, an entry
9336 may be split over several lines by indenting the second and subsequent lines,
9337 but the separating colon must still be included at line breaks. White space
9338 surrounding the colons is ignored. For example:
9339 .code
9340 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9341   spammer3 : spammer4
9342 .endd
9343 As in all colon-separated lists in Exim, a colon can be included in an item by
9344 doubling.
9345
9346 If the last item in the list starts with a right angle-bracket, the remainder
9347 of the item is taken as a new key to look up in order to obtain a continuation
9348 list of local parts. The new key can be any sequence of characters. Thus one
9349 might have entries like
9350 .code
9351 aol.com: spammer1 : spammer 2 : >*
9352 xyz.com: spammer3 : >*
9353 *:       ^\d{8}$
9354 .endd
9355 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9356 local parts for all domains, in addition to the specific local parts listed for
9357 each domain. Of course, using this feature costs another lookup each time a
9358 chain is followed, but the effort needed to maintain the data is reduced.
9359
9360 .cindex "loop" "in lookups"
9361 It is possible to construct loops using this facility, and in order to catch
9362 them, the chains may be no more than fifty items long.
9363
9364 .next
9365 The @@<&'lookup'&> style of item can also be used with a query-style
9366 lookup, but in this case, the chaining facility is not available. The lookup
9367 can only return a single list of local parts.
9368 .endlist
9369
9370 &*Warning*&: There is an important difference between the address list items
9371 in these two examples:
9372 .code
9373 senders = +my_list
9374 senders = *@+my_list
9375 .endd
9376 In the first one, &`my_list`& is a named address list, whereas in the second
9377 example it is a named domain list.
9378
9379
9380
9381
9382 .section "Case of letters in address lists" "SECTcasletadd"
9383 .cindex "case of local parts"
9384 .cindex "address list" "case forcing"
9385 .cindex "case forcing in address lists"
9386 Domains in email addresses are always handled caselessly, but for local parts
9387 case may be significant on some systems (see &%caseful_local_part%& for how
9388 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9389 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9390 blocking lists should be done in a case-independent manner. Since most address
9391 lists in Exim are used for this kind of control, Exim attempts to do this by
9392 default.
9393
9394 The domain portion of an address is always lowercased before matching it to an
9395 address list. The local part is lowercased by default, and any string
9396 comparisons that take place are done caselessly. This means that the data in
9397 the address list itself, in files included as plain filenames, and in any file
9398 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9399 keys in files that are looked up by a search type other than &(lsearch)& (which
9400 works caselessly) must be in lower case, because these lookups are not
9401 case-independent.
9402
9403 .cindex "&`+caseful`&"
9404 To allow for the possibility of caseful address list matching, if an item in
9405 an address list is the string &"+caseful"&, the original case of the local
9406 part is restored for any comparisons that follow, and string comparisons are no
9407 longer case-independent. This does not affect the domain, which remains in
9408 lower case. However, although independent matches on the domain alone are still
9409 performed caselessly, regular expressions that match against an entire address
9410 become case-sensitive after &"+caseful"& has been seen.
9411
9412
9413
9414 .section "Local part lists" "SECTlocparlis"
9415 .cindex "list" "local part list"
9416 .cindex "local part" "list"
9417 Case-sensitivity in local part lists is handled in the same way as for address
9418 lists, as just described. The &"+caseful"& item can be used if required. In a
9419 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9420 set false, the subject is lowercased and the matching is initially
9421 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9422 matching in the local part list, but not elsewhere in the router. If
9423 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9424 option is case-sensitive from the start.
9425
9426 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9427 comments are handled in the same way as address lists &-- they are recognized
9428 only if the # is preceded by white space or the start of the line.
9429 Otherwise, local part lists are matched in the same way as domain lists, except
9430 that the special items that refer to the local host (&`@`&, &`@[]`&,
9431 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9432 Refer to section &<<SECTdomainlist>>& for details of the other available item
9433 types.
9434 .ecindex IIDdohoadli
9435
9436
9437
9438
9439 . ////////////////////////////////////////////////////////////////////////////
9440 . ////////////////////////////////////////////////////////////////////////////
9441
9442 .chapter "String expansions" "CHAPexpand"
9443 .scindex IIDstrexp "expansion" "of strings"
9444 Many strings in Exim's runtime configuration are expanded before use. Some of
9445 them are expanded every time they are used; others are expanded only once.
9446
9447 When a string is being expanded it is copied verbatim from left to right except
9448 .cindex expansion "string concatenation"
9449 when a dollar or backslash character is encountered. A dollar specifies the
9450 start of a portion of the string that is interpreted and replaced as described
9451 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9452 escape character, as described in the following section.
9453
9454 Whether a string is expanded depends upon the context.  Usually this is solely
9455 dependent upon the option for which a value is sought; in this documentation,
9456 options for which string expansion is performed are marked with &dagger; after
9457 the data type.  ACL rules always expand strings.  A couple of expansion
9458 conditions do not expand some of the brace-delimited branches, for security
9459 reasons,
9460 .cindex "tainted data" expansion
9461 .cindex expansion "tainted data"
9462 and expansion of data deriving from the sender (&"tainted data"&)
9463 is not permitted.
9464
9465
9466
9467 .section "Literal text in expanded strings" "SECTlittext"
9468 .cindex "expansion" "including literal text"
9469 An uninterpreted dollar can be included in an expanded string by putting a
9470 backslash in front of it. A backslash can be used to prevent any special
9471 character being treated specially in an expansion, including backslash itself.
9472 If the string appears in quotes in the configuration file, two backslashes are
9473 required because the quotes themselves cause interpretation of backslashes when
9474 the string is read in (see section &<<SECTstrings>>&).
9475
9476 .cindex "expansion" "non-expandable substrings"
9477 A portion of the string can specified as non-expandable by placing it between
9478 two occurrences of &`\N`&. This is particularly useful for protecting regular
9479 expressions, which often contain backslashes and dollar signs. For example:
9480 .code
9481 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9482 .endd
9483 On encountering the first &`\N`&, the expander copies subsequent characters
9484 without interpretation until it reaches the next &`\N`& or the end of the
9485 string.
9486
9487
9488
9489 .section "Character escape sequences in expanded strings" "SECID82"
9490 .cindex "expansion" "escape sequences"
9491 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9492 expanded string is recognized as an escape sequence for the character newline,
9493 carriage return, or tab, respectively. A backslash followed by up to three
9494 octal digits is recognized as an octal encoding for a single character, and a
9495 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9496 encoding.
9497
9498 These escape sequences are also recognized in quoted strings when they are read
9499 in. Their interpretation in expansions as well is useful for unquoted strings,
9500 and for other cases such as looked-up strings that are then expanded.
9501
9502
9503 .section "Testing string expansions" "SECID83"
9504 .cindex "expansion" "testing"
9505 .cindex "testing" "string expansion"
9506 .oindex "&%-be%&"
9507 Many expansions can be tested by calling Exim with the &%-be%& option. This
9508 takes the command arguments, or lines from the standard input if there are no
9509 arguments, runs them through the string expansion code, and writes the results
9510 to the standard output. Variables based on configuration values are set up, but
9511 since no message is being processed, variables such as &$local_part$& have no
9512 value. Nevertheless the &%-be%& option can be useful for checking out file and
9513 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9514 and &%nhash%&.
9515
9516 Exim gives up its root privilege when it is called with the &%-be%& option, and
9517 instead runs under the uid and gid it was called with, to prevent users from
9518 using &%-be%& for reading files to which they do not have access.
9519
9520 .oindex "&%-bem%&"
9521 If you want to test expansions that include variables whose values are taken
9522 from a message, there are two other options that can be used. The &%-bem%&
9523 option is like &%-be%& except that it is followed by a filename. The file is
9524 read as a message before doing the test expansions. For example:
9525 .code
9526 exim -bem /tmp/test.message '$h_subject:'
9527 .endd
9528 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9529 Exim message identifier. For example:
9530 .code
9531 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9532 .endd
9533 This loads the message from Exim's spool before doing the test expansions, and
9534 is therefore restricted to admin users.
9535
9536
9537 .section "Forced expansion failure" "SECTforexpfai"
9538 .cindex "expansion" "forced failure"
9539 A number of expansions that are described in the following section have
9540 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9541 (which are sometimes called &"curly brackets"&). Which of the two strings is
9542 used depends on some condition that is evaluated as part of the expansion. If,
9543 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9544 the entire string expansion fails in a way that can be detected by the code
9545 that requested the expansion. This is called &"forced expansion failure"&, and
9546 its consequences depend on the circumstances. In some cases it is no different
9547 from any other expansion failure, but in others a different action may be
9548 taken. Such variations are mentioned in the documentation of the option that is
9549 being expanded.
9550
9551
9552
9553
9554 .section "Expansion items" "SECTexpansionitems"
9555 The following items are recognized in expanded strings. White space may be used
9556 between sub-items that are keywords or substrings enclosed in braces inside an
9557 outer set of braces, to improve readability. &*Warning*&: Within braces,
9558 white space is significant.
9559
9560 .vlist
9561 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9562 .cindex "expansion" "variables"
9563 Substitute the contents of the named variable, for example:
9564 .code
9565 $local_part
9566 ${domain}
9567 .endd
9568 The second form can be used to separate the name from subsequent alphanumeric
9569 characters. This form (using braces) is available only for variables; it does
9570 &'not'& apply to message headers. The names of the variables are given in
9571 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9572 given, the expansion fails.
9573
9574 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9575 .cindex "expansion" "operators"
9576 The string is first itself expanded, and then the operation specified by
9577 <&'op'&> is applied to it. For example:
9578 .code
9579 ${lc:$local_part}
9580 .endd
9581 The string starts with the first character after the colon, which may be
9582 leading white space. A list of operators is given in section &<<SECTexpop>>&
9583 below. The operator notation is used for simple expansion items that have just
9584 one argument, because it reduces the number of braces and therefore makes the
9585 string easier to understand.
9586
9587 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9588 This item inserts &"basic"& header lines. It is described with the &%header%&
9589 expansion item below.
9590
9591
9592 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9593 .cindex "expansion" "calling an acl"
9594 .cindex "&%acl%&" "call from expansion"
9595 The name and zero to nine argument strings are first expanded separately.  The expanded
9596 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9597 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9598 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9599 and may use the variables; if another acl expansion is used the values
9600 are restored after it returns.  If the ACL sets
9601 a value using a "message =" modifier and returns accept or deny, the value becomes
9602 the result of the expansion.
9603 If no message is set and the ACL returns accept or deny
9604 the expansion result is an empty string.
9605 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9606
9607
9608 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9609 .cindex authentication "results header"
9610 .cindex headers "authentication-results:"
9611 .cindex authentication "expansion item"
9612 This item returns a string suitable for insertion as an
9613 &'Authentication-Results:'&
9614 header line.
9615 The given <&'authserv-id'&> is included in the result; typically this
9616 will be a domain name identifying the system performing the authentications.
9617 Methods that might be present in the result include:
9618 .code
9619 none
9620 iprev
9621 auth
9622 spf
9623 dkim
9624 .endd
9625
9626 Example use (as an ACL modifier):
9627 .code
9628       add_header = :at_start:${authresults {$primary_hostname}}
9629 .endd
9630 This is safe even if no authentication results are available.
9631
9632
9633 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9634        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9635 .cindex "expansion" "extracting certificate fields"
9636 .cindex "&%certextract%&" "certificate fields"
9637 .cindex "certificate" "extracting fields"
9638 The <&'certificate'&> must be a variable of type certificate.
9639 The field name is expanded and used to retrieve the relevant field from
9640 the certificate.  Supported fields are:
9641 .display
9642 &`version        `&
9643 &`serial_number  `&
9644 &`subject        `& RFC4514 DN
9645 &`issuer         `& RFC4514 DN
9646 &`notbefore      `& time
9647 &`notafter       `& time
9648 &`sig_algorithm  `&
9649 &`signature      `&
9650 &`subj_altname   `& tagged list
9651 &`ocsp_uri       `& list
9652 &`crl_uri        `& list
9653 .endd
9654 If the field is found,
9655 <&'string2'&> is expanded, and replaces the whole item;
9656 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9657 variable &$value$& contains the value that has been extracted. Afterwards, it
9658 is restored to any previous value it might have had.
9659
9660 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9661 key is not found. If {<&'string2'&>} is also omitted, the value that was
9662 extracted is used.
9663
9664 Some field names take optional modifiers, appended and separated by commas.
9665
9666 The field selectors marked as "RFC4514" above
9667 output a Distinguished Name string which is
9668 not quite
9669 parseable by Exim as a comma-separated tagged list
9670 (the exceptions being elements containing commas).
9671 RDN elements of a single type may be selected by
9672 a modifier of the type label; if so the expansion
9673 result is a list (newline-separated by default).
9674 The separator may be changed by another modifier of
9675 a right angle-bracket followed immediately by the new separator.
9676 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9677
9678 The field selectors marked as "time" above
9679 take an optional modifier of "int"
9680 for which the result is the number of seconds since epoch.
9681 Otherwise the result is a human-readable string
9682 in the timezone selected by the main "timezone" option.
9683
9684 The field selectors marked as "list" above return a list,
9685 newline-separated by default,
9686 (embedded separator characters in elements are doubled).
9687 The separator may be changed by a modifier of
9688 a right angle-bracket followed immediately by the new separator.
9689
9690 The field selectors marked as "tagged" above
9691 prefix each list element with a type string and an equals sign.
9692 Elements of only one type may be selected by a modifier
9693 which is one of "dns", "uri" or "mail";
9694 if so the element tags are omitted.
9695
9696 If not otherwise noted field values are presented in human-readable form.
9697
9698 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9699        {*&<&'arg'&>&*}...}*&"
9700 .cindex &%dlfunc%&
9701 This expansion dynamically loads and then calls a locally-written C function.
9702 This functionality is available only if Exim is compiled with
9703 .code
9704 EXPAND_DLFUNC=yes
9705 .endd
9706 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9707 object so that it doesn't reload the same object file in the same Exim process
9708 (but of course Exim does start new processes frequently).
9709
9710 There may be from zero to eight arguments to the function.
9711
9712 When compiling
9713 a local function that is to be called in this way,
9714 first &_DLFUNC_IMPL_& should be defined,
9715 and second &_local_scan.h_& should be included.
9716 The Exim variables and functions that are defined by that API
9717 are also available for dynamically loaded functions. The function itself
9718 must have the following type:
9719 .code
9720 int dlfunction(uschar **yield, int argc, uschar *argv[])
9721 .endd
9722 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9723 function should return one of the following values:
9724
9725 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9726 into the expanded string that is being built.
9727
9728 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9729 from &'yield'&, if it is set.
9730
9731 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9732 taken from &'yield'& if it is set.
9733
9734 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9735
9736 When compiling a function that is to be used in this way with gcc,
9737 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9738 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9739
9740
9741 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9742 .cindex "expansion" "extracting value from environment"
9743 .cindex "environment" "values from"
9744 The key is first expanded separately, and leading and trailing white space
9745 removed.
9746 This is then searched for as a name in the environment.
9747 If a variable is found then its value is placed in &$value$&
9748 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9749
9750 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9751 appear, for example:
9752 .code
9753 ${env{USER}{$value} fail }
9754 .endd
9755 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9756 {<&'string1'&>} must be present for &"fail"& to be recognized.
9757
9758 If {<&'string2'&>} is omitted an empty string is substituted on
9759 search failure.
9760 If {<&'string1'&>} is omitted the search result is substituted on
9761 search success.
9762
9763 The environment is adjusted by the &%keep_environment%& and
9764 &%add_environment%& main section options.
9765
9766
9767 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9768        {*&<&'string3'&>&*}}*&"
9769 .cindex "expansion" "extracting substrings by key"
9770 .cindex "&%extract%&" "substrings by key"
9771 The key and <&'string1'&> are first expanded separately. Leading and trailing
9772 white space is removed from the key (but not from any of the strings). The key
9773 must not be empty and must not consist entirely of digits.
9774 The expanded <&'string1'&> must be of the form:
9775 .display
9776 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9777 .endd
9778 .vindex "&$value$&"
9779 where the equals signs and spaces (but not both) are optional. If any of the
9780 values contain white space, they must be enclosed in double quotes, and any
9781 values that are enclosed in double quotes are subject to escape processing as
9782 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9783 for the value that corresponds to the key. The search is case-insensitive. If
9784 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9785 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9786 variable &$value$& contains the value that has been extracted. Afterwards, it
9787 is restored to any previous value it might have had.
9788
9789 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9790 key is not found. If {<&'string2'&>} is also omitted, the value that was
9791 extracted is used. Thus, for example, these two expansions are identical, and
9792 yield &"2001"&:
9793 .code
9794 ${extract{gid}{uid=1984 gid=2001}}
9795 ${extract{gid}{uid=1984 gid=2001}{$value}}
9796 .endd
9797 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9798 appear, for example:
9799 .code
9800 ${extract{Z}{A=... B=...}{$value} fail }
9801 .endd
9802 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9803 {<&'string2'&>} must be present for &"fail"& to be recognized.
9804
9805 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9806        {*&<&'string3'&>&*}}*&" &&&
9807        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9808        {*&<&'string3'&>&*}}*&"
9809 .cindex "expansion" "extracting from JSON object"
9810 .cindex JSON expansions
9811 The key and <&'string1'&> are first expanded separately. Leading and trailing
9812 white space is removed from the key (but not from any of the strings). The key
9813 must not be empty and must not consist entirely of digits.
9814 The expanded <&'string1'&> must be of the form:
9815 .display
9816 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9817 .endd
9818 .vindex "&$value$&"
9819 The braces, commas and colons, and the quoting of the member name are required;
9820 the spaces are optional.
9821 Matching of the key against the member names is done case-sensitively.
9822 For the &"json"& variant,
9823 if a returned value is a JSON string, it retains its leading and
9824 trailing quotes.
9825 For the &"jsons"& variant, which is intended for use with JSON strings, the
9826 leading and trailing quotes are removed from the returned value.
9827 . XXX should be a UTF-8 compare
9828
9829 The results of matching are handled as above.
9830
9831
9832 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9833         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9834 .cindex "expansion" "extracting substrings by number"
9835 .cindex "&%extract%&" "substrings by number"
9836 The <&'number'&> argument must consist entirely of decimal digits,
9837 apart from leading and trailing white space, which is ignored.
9838 This is what distinguishes this form of &%extract%& from the previous kind. It
9839 behaves in the same way, except that, instead of extracting a named field, it
9840 extracts from <&'string1'&> the field whose number is given as the first
9841 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9842 <&'string3'&> as before.
9843
9844 The fields in the string are separated by any one of the characters in the
9845 separator string. These may include space or tab characters.
9846 The first field is numbered one. If the number is negative, the fields are
9847 counted from the end of the string, with the rightmost one numbered -1. If the
9848 number given is zero, the entire string is returned. If the modulus of the
9849 number is greater than the number of fields in the string, the result is the
9850 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9851 provided. For example:
9852 .code
9853 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9854 .endd
9855 yields &"42"&, and
9856 .code
9857 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9858 .endd
9859 yields &"99"&. Two successive separators mean that the field between them is
9860 empty (for example, the fifth field above).
9861
9862
9863 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9864         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9865        "&*${extract jsons{*&<&'number'&>&*}}&&&
9866         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9867 .cindex "expansion" "extracting from JSON array"
9868 .cindex JSON expansions
9869 The <&'number'&> argument must consist entirely of decimal digits,
9870 apart from leading and trailing white space, which is ignored.
9871
9872 Field selection and result handling is as above;
9873 there is no choice of field separator.
9874 For the &"json"& variant,
9875 if a returned value is a JSON string, it retains its leading and
9876 trailing quotes.
9877 For the &"jsons"& variant, which is intended for use with JSON strings, the
9878 leading and trailing quotes are removed from the returned value.
9879
9880
9881 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9882 .cindex "list" "selecting by condition"
9883 .cindex "expansion" "selecting from list by condition"
9884 .vindex "&$item$&"
9885 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9886 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9887 For each item
9888 in this list, its value is place in &$item$&, and then the condition is
9889 evaluated. If the condition is true, &$item$& is added to the output as an
9890 item in a new list; if the condition is false, the item is discarded. The
9891 separator used for the output list is the same as the one used for the
9892 input, but a separator setting is not included in the output. For example:
9893 .code
9894 ${filter{a:b:c}{!eq{$item}{b}}}
9895 .endd
9896 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9897 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9898
9899
9900 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9901 .cindex "hash function" "textual"
9902 .cindex "expansion" "textual hash"
9903 This is a textual hashing function, and was the first to be implemented in
9904 early versions of Exim. In current releases, there are other hashing functions
9905 (numeric, MD5, and SHA-1), which are described below.
9906
9907 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9908 <&'n'&>. If you are using fixed values for these numbers, that is, if
9909 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9910 use the simpler operator notation that avoids some of the braces:
9911 .code
9912 ${hash_<n>_<m>:<string>}
9913 .endd
9914 The second number is optional (in both notations). If <&'n'&> is greater than
9915 or equal to the length of the string, the expansion item returns the string.
9916 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9917 function to the string. The new string consists of characters taken from the
9918 first <&'m'&> characters of the string
9919 .code
9920 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9921 .endd
9922 If <&'m'&> is not present the value 26 is used, so that only lower case
9923 letters appear. For example:
9924 .display
9925 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9926 &`$hash{5}{monty}}           `&   yields  &`monty`&
9927 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9928 .endd
9929
9930 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9931         &*$h_*&<&'header&~name'&>&*:*&" &&&
9932        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9933         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9934        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9935         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9936        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9937         &*$rh_*&<&'header&~name'&>&*:*&"
9938 .cindex "expansion" "header insertion"
9939 .vindex "&$header_$&"
9940 .vindex "&$bheader_$&"
9941 .vindex "&$lheader_$&"
9942 .vindex "&$rheader_$&"
9943 .cindex "header lines" "in expansion strings"
9944 .cindex "header lines" "character sets"
9945 .cindex "header lines" "decoding"
9946 Substitute the contents of the named message header line, for example
9947 .code
9948 $header_reply-to:
9949 .endd
9950 The newline that terminates a header line is not included in the expansion, but
9951 internal newlines (caused by splitting the header line over several physical
9952 lines) may be present.
9953
9954 The difference between the four pairs of expansions is in the way
9955 the data in the header line is interpreted.
9956
9957 .ilist
9958 .cindex "white space" "in header lines"
9959 &%rheader%& gives the original &"raw"& content of the header line, with no
9960 processing at all, and without the removal of leading and trailing white space.
9961
9962 .next
9963 .cindex "list" "of header lines"
9964 &%lheader%& gives a colon-separated list, one element per header when there
9965 are multiple headers with a given name.
9966 Any embedded colon characters within an element are doubled, so normal Exim
9967 list-processing facilities can be used.
9968 The terminating newline of each element is removed; in other respects
9969 the content is &"raw"&.
9970
9971 .next
9972 .cindex "base64 encoding" "in header lines"
9973 &%bheader%& removes leading and trailing white space, and then decodes base64
9974 or quoted-printable MIME &"words"& within the header text, but does no
9975 character set translation. If decoding of what looks superficially like a MIME
9976 &"word"& fails, the raw string is returned. If decoding
9977 .cindex "binary zero" "in header line"
9978 produces a binary zero character, it is replaced by a question mark &-- this is
9979 what Exim does for binary zeros that are actually received in header lines.
9980
9981 .next
9982 &%header%& tries to translate the string as decoded by &%bheader%& to a
9983 standard character set. This is an attempt to produce the same string as would
9984 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9985 returned. Translation is attempted only on operating systems that support the
9986 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9987 a system Makefile or in &_Local/Makefile_&.
9988 .endlist ilist
9989
9990 In a filter file, the target character set for &%header%& can be specified by a
9991 command of the following form:
9992 .code
9993 headers charset "UTF-8"
9994 .endd
9995 This command affects all references to &$h_$& (or &$header_$&) expansions in
9996 subsequently obeyed filter commands. In the absence of this command, the target
9997 character set in a filter is taken from the setting of the &%headers_charset%&
9998 option in the runtime configuration. The value of this option defaults to the
9999 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10000 ISO-8859-1.
10001
10002 Header names follow the syntax of RFC 2822, which states that they may contain
10003 any printing characters except space and colon. Consequently, curly brackets
10004 &'do not'& terminate header names, and should not be used to enclose them as
10005 if they were variables. Attempting to do so causes a syntax error.
10006
10007 Only header lines that are common to all copies of a message are visible to
10008 this mechanism. These are the original header lines that are received with the
10009 message, and any that are added by an ACL statement or by a system
10010 filter. Header lines that are added to a particular copy of a message by a
10011 router or transport are not accessible.
10012
10013 For incoming SMTP messages, no header lines are visible in
10014 ACLs that are obeyed before the data phase completes,
10015 because the header structure is not set up until the message is received.
10016 They are visible in DKIM, PRDR and DATA ACLs.
10017 Header lines that are added in a RCPT ACL (for example)
10018 are saved until the message's incoming header lines are available, at which
10019 point they are added.
10020 When any of the above ACLs ar
10021 running, however, header lines added by earlier ACLs are visible.
10022
10023 Upper case and lower case letters are synonymous in header names. If the
10024 following character is white space, the terminating colon may be omitted, but
10025 this is not recommended, because you may then forget it when it is needed. When
10026 white space terminates the header name, this white space is included in the
10027 expanded string.  If the message does not contain the given header, the
10028 expansion item is replaced by an empty string. (See the &%def%& condition in
10029 section &<<SECTexpcond>>& for a means of testing for the existence of a
10030 header.)
10031
10032 If there is more than one header with the same name, they are all concatenated
10033 to form the substitution string, up to a maximum length of 64K. Unless
10034 &%rheader%& is being used, leading and trailing white space is removed from
10035 each header before concatenation, and a completely empty header is ignored. A
10036 newline character is then inserted between non-empty headers, but there is no
10037 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10038 those headers that contain lists of addresses, a comma is also inserted at the
10039 junctions between headers. This does not happen for the &%rheader%& expansion.
10040
10041 .new
10042 .cindex "tainted data"
10043 When the headers are from an incoming message,
10044 the result of expanding any of these variables is tainted.
10045 .wen
10046
10047
10048 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10049 .cindex "expansion" "hmac hashing"
10050 .cindex &%hmac%&
10051 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10052 shared secret and some text into a message authentication code, as specified in
10053 RFC 2104. This differs from &`${md5:secret_text...}`& or
10054 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10055 cryptographic hash, allowing for authentication that is not possible with MD5
10056 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10057 present. For example:
10058 .code
10059 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10060 .endd
10061 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10062 produces:
10063 .code
10064 dd97e3ba5d1a61b5006108f8c8252953
10065 .endd
10066 As an example of how this might be used, you might put in the main part of
10067 an Exim configuration:
10068 .code
10069 SPAMSCAN_SECRET=cohgheeLei2thahw
10070 .endd
10071 In a router or a transport you could then have:
10072 .code
10073 headers_add = \
10074   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10075   ${hmac{md5}{SPAMSCAN_SECRET}\
10076   {${primary_hostname},${message_exim_id},$h_message-id:}}
10077 .endd
10078 Then given a message, you can check where it was scanned by looking at the
10079 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10080 this header line is authentic by recomputing the authentication code from the
10081 host name, message ID and the &'Message-id:'& header line. This can be done
10082 using Exim's &%-be%& option, or by other means, for example, by using the
10083 &'hmac_md5_hex()'& function in Perl.
10084
10085
10086 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10087 .cindex "expansion" "conditional"
10088 .cindex "&%if%&, expansion item"
10089 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10090 item; otherwise <&'string2'&> is used. The available conditions are described
10091 in section &<<SECTexpcond>>& below. For example:
10092 .code
10093 ${if eq {$local_part}{postmaster} {yes}{no} }
10094 .endd
10095 The second string need not be present; if it is not and the condition is not
10096 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10097 be present instead of the second string (without any curly brackets). In this
10098 case, the expansion is forced to fail if the condition is not true (see section
10099 &<<SECTforexpfai>>&).
10100
10101 If both strings are omitted, the result is the string &`true`& if the condition
10102 is true, and the empty string if the condition is false. This makes it less
10103 cumbersome to write custom ACL and router conditions. For example, instead of
10104 .code
10105 condition = ${if >{$acl_m4}{3}{true}{false}}
10106 .endd
10107 you can use
10108 .code
10109 condition = ${if >{$acl_m4}{3}}
10110 .endd
10111
10112
10113
10114 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10115 .cindex expansion "imap folder"
10116 .cindex "&%imapfolder%& expansion item"
10117 This item converts a (possibly multilevel, or with non-ASCII characters)
10118 folder specification to a Maildir name for filesystem use.
10119 For information on internationalisation support see &<<SECTi18nMDA>>&.
10120
10121
10122
10123 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10124 .cindex "expansion" "string truncation"
10125 .cindex "&%length%& expansion item"
10126 The &%length%& item is used to extract the initial portion of a string. Both
10127 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10128 you are using a fixed value for the number, that is, if <&'string1'&> does not
10129 change when expanded, you can use the simpler operator notation that avoids
10130 some of the braces:
10131 .code
10132 ${length_<n>:<string>}
10133 .endd
10134 The result of this item is either the first <&'n'&> bytes or the whole
10135 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10136 &%strlen%&, which gives the length of a string.
10137 All measurement is done in bytes and is not UTF-8 aware.
10138
10139
10140 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10141         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10142 .cindex "expansion" "extracting list elements by number"
10143 .cindex "&%listextract%&" "extract list elements by number"
10144 .cindex "list" "extracting elements by number"
10145 The <&'number'&> argument must consist entirely of decimal digits,
10146 apart from an optional leading minus,
10147 and leading and trailing white space (which is ignored).
10148
10149 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10150 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10151
10152 The first field of the list is numbered one.
10153 If the number is negative, the fields are
10154 counted from the end of the list, with the rightmost one numbered -1.
10155 The numbered element of the list is extracted and placed in &$value$&,
10156 then <&'string2'&> is expanded as the result.
10157
10158 If the modulus of the
10159 number is zero or greater than the number of fields in the string,
10160 the result is the expansion of <&'string3'&>.
10161
10162 For example:
10163 .code
10164 ${listextract{2}{x:42:99}}
10165 .endd
10166 yields &"42"&, and
10167 .code
10168 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10169 .endd
10170 yields &"result: 42"&.
10171
10172 If {<&'string3'&>} is omitted, an empty string is used for string3.
10173 If {<&'string2'&>} is also omitted, the value that was
10174 extracted is used.
10175 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10176
10177
10178 .new
10179 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10180 .cindex quoting "for list"
10181 .cindex list quoting
10182 This item doubles any occurrence of the separator character
10183 in the given string.
10184 An empty string is replaced with a single space.
10185 This converts the string into a safe form for use as a list element,
10186 in a list using the given separator.
10187 .wen
10188
10189
10190 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10191         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10192 This is the first of one of two different types of lookup item, which are both
10193 described in the next item.
10194
10195 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10196         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10197 .cindex "expansion" "lookup in"
10198 .cindex "file" "lookups"
10199 .cindex "lookup" "in expanded string"
10200 The two forms of lookup item specify data lookups in files and databases, as
10201 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10202 lookups, and the second is used for query-style lookups. The <&'key'&>,
10203 <&'file'&>, and <&'query'&> strings are expanded before use.
10204
10205 If there is any white space in a lookup item which is part of a filter command,
10206 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10207 other place where white space is significant, the lookup item must be enclosed
10208 in double quotes. The use of data lookups in users' filter files may be locked
10209 out by the system administrator.
10210
10211 .vindex "&$value$&"
10212 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10213 During its expansion, the variable &$value$& contains the data returned by the
10214 lookup. Afterwards it reverts to the value it had previously (at the outer
10215 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10216 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10217 string on failure. If <&'string2'&> is provided, it can itself be a nested
10218 lookup, thus providing a mechanism for looking up a default value when the
10219 original lookup fails.
10220
10221 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10222 data for the outer lookup while the parameters of the second lookup are
10223 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10224 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10225 appear, and in this case, if the lookup fails, the entire expansion is forced
10226 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10227 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10228 successful lookup, and nothing in the case of failure.
10229
10230 For single-key lookups, the string &"partial"& is permitted to precede the
10231 search type in order to do partial matching, and * or *@ may follow a search
10232 type to request default lookups if the key does not match (see sections
10233 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10234
10235 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10236 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10237 and non-wild parts of the key during the expansion of the replacement text.
10238 They return to their previous values at the end of the lookup item.
10239
10240 This example looks up the postmaster alias in the conventional alias file:
10241 .code
10242 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10243 .endd
10244 This example uses NIS+ to look up the full name of the user corresponding to
10245 the local part of an address, forcing the expansion to fail if it is not found:
10246 .code
10247 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10248   {$value}fail}
10249 .endd
10250
10251
10252 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10253 .cindex "expansion" "list creation"
10254 .vindex "&$item$&"
10255 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10256 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10257 For each item
10258 in this list, its value is place in &$item$&, and then <&'string2'&> is
10259 expanded and added to the output as an item in a new list. The separator used
10260 for the output list is the same as the one used for the input, but a separator
10261 setting is not included in the output. For example:
10262 .code
10263 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10264 .endd
10265 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10266 value of &$item$& is restored to what it was before. See also the &%filter%&
10267 and &%reduce%& expansion items.
10268
10269 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10270 .cindex "expansion" "numeric hash"
10271 .cindex "hash function" "numeric"
10272 The three strings are expanded; the first two must yield numbers. Call them
10273 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10274 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10275 can use the simpler operator notation that avoids some of the braces:
10276 .code
10277 ${nhash_<n>_<m>:<string>}
10278 .endd
10279 The second number is optional (in both notations). If there is only one number,
10280 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10281 processed by a div/mod hash function that returns two numbers, separated by a
10282 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10283 example,
10284 .code
10285 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10286 .endd
10287 returns the string &"6/33"&.
10288
10289
10290
10291 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10292 .cindex "Perl" "use in expanded string"
10293 .cindex "expansion" "calling Perl from"
10294 This item is available only if Exim has been built to include an embedded Perl
10295 interpreter. The subroutine name and the arguments are first separately
10296 expanded, and then the Perl subroutine is called with those arguments. No
10297 additional arguments need be given; the maximum number permitted, including the
10298 name of the subroutine, is nine.
10299
10300 The return value of the subroutine is inserted into the expanded string, unless
10301 the return value is &%undef%&. In that case, the expansion fails in the same
10302 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10303 Whatever you return is evaluated in a scalar context. For example, if you
10304 return the name of a Perl vector, the return value is the size of the vector,
10305 not its contents.
10306
10307 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10308 with the error message that was passed to &%die%&. More details of the embedded
10309 Perl facility are given in chapter &<<CHAPperl>>&.
10310
10311 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10312 out the use of this expansion item in filter files.
10313
10314
10315 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10316 .cindex "&%prvs%& expansion item"
10317 The first argument is a complete email address and the second is secret
10318 keystring. The third argument, specifying a key number, is optional. If absent,
10319 it defaults to 0. The result of the expansion is a prvs-signed email address,
10320 to be typically used with the &%return_path%& option on an &(smtp)& transport
10321 as part of a bounce address tag validation (BATV) scheme. For more discussion
10322 and an example, see section &<<SECTverifyPRVS>>&.
10323
10324 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10325         {*&<&'string'&>&*}}*&"
10326 .cindex "&%prvscheck%& expansion item"
10327 This expansion item is the complement of the &%prvs%& item. It is used for
10328 checking prvs-signed addresses. If the expansion of the first argument does not
10329 yield a syntactically valid prvs-signed address, the whole item expands to the
10330 empty string. When the first argument does expand to a syntactically valid
10331 prvs-signed address, the second argument is expanded, with the prvs-decoded
10332 version of the address and the key number extracted from the address in the
10333 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10334
10335 These two variables can be used in the expansion of the second argument to
10336 retrieve the secret. The validity of the prvs-signed address is then checked
10337 against the secret. The result is stored in the variable &$prvscheck_result$&,
10338 which is empty for failure or &"1"& for success.
10339
10340 The third argument is optional; if it is missing, it defaults to an empty
10341 string. This argument is now expanded. If the result is an empty string, the
10342 result of the expansion is the decoded version of the address. This is the case
10343 whether or not the signature was valid. Otherwise, the result of the expansion
10344 is the expansion of the third argument.
10345
10346 All three variables can be used in the expansion of the third argument.
10347 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10348 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10349
10350 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10351 .cindex "expansion" "inserting an entire file"
10352 .cindex "file" "inserting into expansion"
10353 .cindex "&%readfile%& expansion item"
10354 The filename and end-of-line string are first expanded separately. The file is
10355 then read, and its contents replace the entire item. All newline characters in
10356 the file are replaced by the end-of-line string if it is present. Otherwise,
10357 newlines are left in the string.
10358 String expansion is not applied to the contents of the file. If you want this,
10359 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10360 the string expansion fails.
10361
10362 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10363 locks out the use of this expansion item in filter files.
10364
10365
10366
10367 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10368         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10369 .cindex "expansion" "inserting from a socket"
10370 .cindex "socket, use of in expansion"
10371 .cindex "&%readsocket%& expansion item"
10372 This item inserts data from a Unix domain or TCP socket into the expanded
10373 string. The minimal way of using it uses just two arguments, as in these
10374 examples:
10375 .code
10376 ${readsocket{/socket/name}{request string}}
10377 ${readsocket{inet:some.host:1234}{request string}}
10378 .endd
10379 For a Unix domain socket, the first substring must be the path to the socket.
10380 For an Internet socket, the first substring must contain &`inet:`& followed by
10381 a host name or IP address, followed by a colon and a port, which can be a
10382 number or the name of a TCP port in &_/etc/services_&. An IP address may
10383 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10384 example:
10385 .code
10386 ${readsocket{inet:[::1]:1234}{request string}}
10387 .endd
10388 Only a single host name may be given, but if looking it up yields more than
10389 one IP address, they are each tried in turn until a connection is made. For
10390 both kinds of socket, Exim makes a connection, writes the request string
10391 unless it is an empty string; and no terminating NUL is ever sent)
10392 and reads from the socket until an end-of-file
10393 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10394 extend what can be done. Firstly, you can vary the timeout. For example:
10395 .code
10396 ${readsocket{/socket/name}{request string}{3s}}
10397 .endd
10398
10399 The third argument is a list of options, of which the first element is the timeout
10400 and must be present if any options are given.
10401 Further elements are options of form &'name=value'&.
10402 Example:
10403 .code
10404 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10405 .endd
10406
10407 .new
10408 The following option names are recognised:
10409 .ilist
10410 &*cache*&
10411 Defines if the result data can be cached for use by a later identical
10412 request in the same process.
10413 Values are &"yes"& or &"no"& (the default).
10414 If not, all cached results for this connection specification
10415 will be invalidated.
10416
10417 .next
10418 &*shutdown*&
10419 Defines whether or not a write-shutdown is done on the connection after
10420 sending the request. Values are &"yes"& (the default) or &"no"&
10421 (preferred, eg. by some webservers).
10422
10423 .next
10424 &*tls*&
10425 Controls the use of TLS on the connection.
10426 Values are &"yes"& or &"no"& (the default).
10427 If it is enabled, a shutdown as descripbed above is never done.
10428 .endlist
10429 .wen
10430
10431
10432 A fourth argument allows you to change any newlines that are in the data
10433 that is read, in the same way as for &%readfile%& (see above). This example
10434 turns them into spaces:
10435 .code
10436 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10437 .endd
10438 As with all expansions, the substrings are expanded before the processing
10439 happens. Errors in these sub-expansions cause the expansion to fail. In
10440 addition, the following errors can occur:
10441
10442 .ilist
10443 Failure to create a socket file descriptor;
10444 .next
10445 Failure to connect the socket;
10446 .next
10447 Failure to write the request string;
10448 .next
10449 Timeout on reading from the socket.
10450 .endlist
10451
10452 By default, any of these errors causes the expansion to fail. However, if
10453 you supply a fifth substring, it is expanded and used when any of the above
10454 errors occurs. For example:
10455 .code
10456 ${readsocket{/socket/name}{request string}{3s}{\n}\
10457   {socket failure}}
10458 .endd
10459 You can test for the existence of a Unix domain socket by wrapping this
10460 expansion in &`${if exists`&, but there is a race condition between that test
10461 and the actual opening of the socket, so it is safer to use the fifth argument
10462 if you want to be absolutely sure of avoiding an expansion error for a
10463 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10464
10465 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10466 locks out the use of this expansion item in filter files.
10467
10468
10469 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10470 .cindex "expansion" "reducing a list to a scalar"
10471 .cindex "list" "reducing to a scalar"
10472 .vindex "&$value$&"
10473 .vindex "&$item$&"
10474 This operation reduces a list to a single, scalar string. After expansion,
10475 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10476 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10477 Then <&'string2'&> is expanded and
10478 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10479 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10480 them. The result of that expansion is assigned to &$value$& before the next
10481 iteration. When the end of the list is reached, the final value of &$value$& is
10482 added to the expansion output. The &%reduce%& expansion item can be used in a
10483 number of ways. For example, to add up a list of numbers:
10484 .code
10485 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10486 .endd
10487 The result of that expansion would be &`6`&. The maximum of a list of numbers
10488 can be found:
10489 .code
10490 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10491 .endd
10492 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10493 restored to what they were before. See also the &%filter%& and &%map%&
10494 expansion items.
10495
10496 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10497 This item inserts &"raw"& header lines. It is described with the &%header%&
10498 expansion item in section &<<SECTexpansionitems>>& above.
10499
10500 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10501         {*&<&'string2'&>&*}}*&"
10502 .cindex "expansion" "running a command"
10503 .cindex "&%run%& expansion item"
10504 The command and its arguments are first expanded as one string. The string is
10505 split apart into individual arguments by spaces, and then the command is run
10506 in a separate process, but under the same uid and gid.  As in other command
10507 executions from Exim, a shell is not used by default. If the command requires
10508 a shell, you must explicitly code it.
10509
10510 Since the arguments are split by spaces, when there is a variable expansion
10511 which has an empty result, it will cause the situation that the argument will
10512 simply be omitted when the program is actually executed by Exim. If the
10513 script/program requires a specific number of arguments and the expanded
10514 variable could possibly result in this empty expansion, the variable must be
10515 quoted. This is more difficult if the expanded variable itself could result
10516 in a string containing quotes, because it would interfere with the quotes
10517 around the command arguments. A possible guard against this is to wrap the
10518 variable in the &%sg%& operator to change any quote marks to some other
10519 character.
10520
10521 The standard input for the command exists, but is empty. The standard output
10522 and standard error are set to the same file descriptor.
10523 .cindex "return code" "from &%run%& expansion"
10524 .vindex "&$value$&"
10525 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10526 and replaces the entire item; during this expansion, the standard output/error
10527 from the command is in the variable &$value$&. If the command fails,
10528 <&'string2'&>, if present, is expanded and used. Once again, during the
10529 expansion, the standard output/error from the command is in the variable
10530 &$value$&.
10531
10532 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10533 can be the word &"fail"& (not in braces) to force expansion failure if the
10534 command does not succeed. If both strings are omitted, the result is contents
10535 of the standard output/error on success, and nothing on failure.
10536
10537 .vindex "&$run_in_acl$&"
10538 The standard output/error of the command is put in the variable &$value$&.
10539 In this ACL example, the output of a command is logged for the admin to
10540 troubleshoot:
10541 .code
10542 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10543       log_message  = Output of id: $value
10544 .endd
10545 If the command requires shell idioms, such as the > redirect operator, the
10546 shell must be invoked directly, such as with:
10547 .code
10548 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10549 .endd
10550
10551 .vindex "&$runrc$&"
10552 The return code from the command is put in the variable &$runrc$&, and this
10553 remains set afterwards, so in a filter file you can do things like this:
10554 .code
10555 if "${run{x y z}{}}$runrc" is 1 then ...
10556   elif $runrc is 2 then ...
10557   ...
10558 endif
10559 .endd
10560 If execution of the command fails (for example, the command does not exist),
10561 the return code is 127 &-- the same code that shells use for non-existent
10562 commands.
10563
10564 &*Warning*&: In a router or transport, you cannot assume the order in which
10565 option values are expanded, except for those preconditions whose order of
10566 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10567 by the expansion of one option, and use it in another.
10568
10569 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10570 out the use of this expansion item in filter files.
10571
10572
10573 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10574 .cindex "expansion" "string substitution"
10575 .cindex "&%sg%& expansion item"
10576 This item works like Perl's substitution operator (s) with the global (/g)
10577 option; hence its name. However, unlike the Perl equivalent, Exim does not
10578 modify the subject string; instead it returns the modified string for insertion
10579 into the overall expansion. The item takes three arguments: the subject string,
10580 a regular expression, and a substitution string. For example:
10581 .code
10582 ${sg{abcdefabcdef}{abc}{xyz}}
10583 .endd
10584 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10585 if any $, } or \ characters are required in the regular expression or in the
10586 substitution string, they have to be escaped. For example:
10587 .code
10588 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10589 .endd
10590 yields &"defabc"&, and
10591 .code
10592 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10593 .endd
10594 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10595 the regular expression from string expansion.
10596
10597 The regular expression is compiled in 8-bit mode, working against bytes
10598 rather than any Unicode-aware character handling.
10599
10600
10601 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10602 .cindex sorting "a list"
10603 .cindex list sorting
10604 .cindex expansion "list sorting"
10605 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10606 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10607 The <&'comparator'&> argument is interpreted as the operator
10608 of a two-argument expansion condition.
10609 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10610 The comparison should return true when applied to two values
10611 if the first value should sort before the second value.
10612 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10613 the element being placed in &$item$&,
10614 to give values for comparison.
10615
10616 The item result is a sorted list,
10617 with the original list separator,
10618 of the list elements (in full) of the original.
10619
10620 Examples:
10621 .code
10622 ${sort{3:2:1:4}{<}{$item}}
10623 .endd
10624 sorts a list of numbers, and
10625 .code
10626 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10627 .endd
10628 will sort an MX lookup into priority order.
10629
10630
10631 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10632 .cindex "&%substr%& expansion item"
10633 .cindex "substring extraction"
10634 .cindex "expansion" "substring extraction"
10635 The three strings are expanded; the first two must yield numbers. Call them
10636 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10637 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10638 can use the simpler operator notation that avoids some of the braces:
10639 .code
10640 ${substr_<n>_<m>:<string>}
10641 .endd
10642 The second number is optional (in both notations).
10643 If it is absent in the simpler format, the preceding underscore must also be
10644 omitted.
10645
10646 The &%substr%& item can be used to extract more general substrings than
10647 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10648 length required. For example
10649 .code
10650 ${substr{3}{2}{$local_part}}
10651 .endd
10652 If the starting offset is greater than the string length the result is the
10653 null string; if the length plus starting offset is greater than the string
10654 length, the result is the right-hand part of the string, starting from the
10655 given offset. The first byte (character) in the string has offset zero.
10656
10657 The &%substr%& expansion item can take negative offset values to count
10658 from the right-hand end of its operand. The last byte (character) is offset -1,
10659 the second-last is offset -2, and so on. Thus, for example,
10660 .code
10661 ${substr{-5}{2}{1234567}}
10662 .endd
10663 yields &"34"&. If the absolute value of a negative offset is greater than the
10664 length of the string, the substring starts at the beginning of the string, and
10665 the length is reduced by the amount of overshoot. Thus, for example,
10666 .code
10667 ${substr{-5}{2}{12}}
10668 .endd
10669 yields an empty string, but
10670 .code
10671 ${substr{-3}{2}{12}}
10672 .endd
10673 yields &"1"&.
10674
10675 When the second number is omitted from &%substr%&, the remainder of the string
10676 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10677 string preceding the offset point are taken. For example, an offset of -1 and
10678 no length, as in these semantically identical examples:
10679 .code
10680 ${substr_-1:abcde}
10681 ${substr{-1}{abcde}}
10682 .endd
10683 yields all but the last character of the string, that is, &"abcd"&.
10684
10685 All measurement is done in bytes and is not UTF-8 aware.
10686
10687
10688
10689 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10690         {*&<&'replacements'&>&*}}*&"
10691 .cindex "expansion" "character translation"
10692 .cindex "&%tr%& expansion item"
10693 This item does single-character (in bytes) translation on its subject string. The second
10694 argument is a list of characters to be translated in the subject string. Each
10695 matching character is replaced by the corresponding character from the
10696 replacement list. For example
10697 .code
10698 ${tr{abcdea}{ac}{13}}
10699 .endd
10700 yields &`1b3de1`&. If there are duplicates in the second character string, the
10701 last occurrence is used. If the third string is shorter than the second, its
10702 last character is replicated. However, if it is empty, no translation takes
10703 place.
10704
10705 All character handling is done in bytes and is not UTF-8 aware.
10706
10707 .endlist
10708
10709
10710
10711 .section "Expansion operators" "SECTexpop"
10712 .cindex "expansion" "operators"
10713 For expansion items that perform transformations on a single argument string,
10714 the &"operator"& notation is used because it is simpler and uses fewer braces.
10715 The substring is first expanded before the operation is applied to it. The
10716 following operations can be performed:
10717
10718 .vlist
10719 .vitem &*${address:*&<&'string'&>&*}*&
10720 .cindex "expansion" "RFC 2822 address handling"
10721 .cindex "&%address%& expansion item"
10722 The string is interpreted as an RFC 2822 address, as it might appear in a
10723 header line, and the effective address is extracted from it. If the string does
10724 not parse successfully, the result is empty.
10725
10726 The parsing correctly handles SMTPUTF8 Unicode in the string.
10727
10728
10729 .vitem &*${addresses:*&<&'string'&>&*}*&
10730 .cindex "expansion" "RFC 2822 address handling"
10731 .cindex "&%addresses%& expansion item"
10732 The string (after expansion) is interpreted as a list of addresses in RFC
10733 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10734 operative address (&'local-part@domain'&) is extracted from each item, and the
10735 result of the expansion is a colon-separated list, with appropriate
10736 doubling of colons should any happen to be present in the email addresses.
10737 Syntactically invalid RFC2822 address items are omitted from the output.
10738
10739 It is possible to specify a character other than colon for the output
10740 separator by starting the string with > followed by the new separator
10741 character. For example:
10742 .code
10743 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10744 .endd
10745 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10746 first, so if the expanded string starts with >, it may change the output
10747 separator unintentionally. This can be avoided by setting the output
10748 separator explicitly:
10749 .code
10750 ${addresses:>:$h_from:}
10751 .endd
10752
10753 Compare the &%address%& (singular)
10754 expansion item, which extracts the working address from a single RFC2822
10755 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10756 processing lists.
10757
10758 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10759 a strict interpretation of header line formatting.  Exim parses the bare,
10760 unquoted portion of an email address and if it finds a comma, treats it as an
10761 email address separator. For the example header line:
10762 .code
10763 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10764 .endd
10765 The first example below demonstrates that Q-encoded email addresses are parsed
10766 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10767 It does not see the comma because it's still encoded as "=2C".  The second
10768 example below is passed the contents of &`$header_from:`&, meaning it gets
10769 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10770 The third example shows that the presence of a comma is skipped when it is
10771 quoted.  The fourth example shows SMTPUTF8 handling.
10772 .code
10773 # exim -be '${addresses:From: \
10774 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10775 user@example.com
10776 # exim -be '${addresses:From: Last, First <user@example.com>}'
10777 Last:user@example.com
10778 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10779 user@example.com
10780 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10781 フィリップ@example.jp
10782 .endd
10783
10784 .vitem &*${base32:*&<&'digits'&>&*}*&
10785 .cindex "&%base32%& expansion item"
10786 .cindex "expansion" "conversion to base 32"
10787 The string must consist entirely of decimal digits. The number is converted to
10788 base 32 and output as a (empty, for zero) string of characters.
10789 Only lowercase letters are used.
10790
10791 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10792 .cindex "&%base32d%& expansion item"
10793 .cindex "expansion" "conversion to base 32"
10794 The string must consist entirely of base-32 digits.
10795 The number is converted to decimal and output as a string.
10796
10797 .vitem &*${base62:*&<&'digits'&>&*}*&
10798 .cindex "&%base62%& expansion item"
10799 .cindex "expansion" "conversion to base 62"
10800 The string must consist entirely of decimal digits. The number is converted to
10801 base 62 and output as a string of six characters, including leading zeros. In
10802 the few operating environments where Exim uses base 36 instead of base 62 for
10803 its message identifiers (because those systems do not have case-sensitive
10804 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10805 to be absolutely clear: this is &'not'& base64 encoding.
10806
10807 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10808 .cindex "&%base62d%& expansion item"
10809 .cindex "expansion" "conversion to base 62"
10810 The string must consist entirely of base-62 digits, or, in operating
10811 environments where Exim uses base 36 instead of base 62 for its message
10812 identifiers, base-36 digits. The number is converted to decimal and output as a
10813 string.
10814
10815 .vitem &*${base64:*&<&'string'&>&*}*&
10816 .cindex "expansion" "base64 encoding"
10817 .cindex "base64 encoding" "in string expansion"
10818 .cindex "&%base64%& expansion item"
10819 .cindex certificate "base64 of DER"
10820 This operator converts a string into one that is base64 encoded.
10821
10822 If the string is a single variable of type certificate,
10823 returns the base64 encoding of the DER form of the certificate.
10824
10825
10826 .vitem &*${base64d:*&<&'string'&>&*}*&
10827 .cindex "expansion" "base64 decoding"
10828 .cindex "base64 decoding" "in string expansion"
10829 .cindex "&%base64d%& expansion item"
10830 This operator converts a base64-encoded string into the un-coded form.
10831
10832
10833 .vitem &*${domain:*&<&'string'&>&*}*&
10834 .cindex "domain" "extraction"
10835 .cindex "expansion" "domain extraction"
10836 The string is interpreted as an RFC 2822 address and the domain is extracted
10837 from it. If the string does not parse successfully, the result is empty.
10838
10839
10840 .vitem &*${escape:*&<&'string'&>&*}*&
10841 .cindex "expansion" "escaping non-printing characters"
10842 .cindex "&%escape%& expansion item"
10843 If the string contains any non-printing characters, they are converted to
10844 escape sequences starting with a backslash. Whether characters with the most
10845 significant bit set (so-called &"8-bit characters"&) count as printing or not
10846 is controlled by the &%print_topbitchars%& option.
10847
10848 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10849 .cindex "expansion" "escaping 8-bit characters"
10850 .cindex "&%escape8bit%& expansion item"
10851 If the string contains and characters with the most significant bit set,
10852 they are converted to escape sequences starting with a backslash.
10853 Backslashes and DEL characters are also converted.
10854
10855
10856 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10857 .cindex "expansion" "expression evaluation"
10858 .cindex "expansion" "arithmetic expression"
10859 .cindex "&%eval%& expansion item"
10860 These items supports simple arithmetic and bitwise logical operations in
10861 expansion strings. The string (after expansion) must be a conventional
10862 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10863 logical operators, and parentheses. All operations are carried out using
10864 integer arithmetic. The operator priorities are as follows (the same as in the
10865 C programming language):
10866 .table2 70pt 300pt
10867 .irow &'highest:'& "not (~), negate (-)"
10868 .irow ""   "multiply (*), divide (/), remainder (%)"
10869 .irow ""   "plus (+), minus (-)"
10870 .irow ""   "shift-left (<<), shift-right (>>)"
10871 .irow ""   "and (&&)"
10872 .irow ""   "xor (^)"
10873 .irow &'lowest:'&  "or (|)"
10874 .endtable
10875 Binary operators with the same priority are evaluated from left to right. White
10876 space is permitted before or after operators.
10877
10878 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10879 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10880 decimal, even if they start with a leading zero; hexadecimal numbers are not
10881 permitted. This can be useful when processing numbers extracted from dates or
10882 times, which often do have leading zeros.
10883
10884 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10885 or 1024*1024*1024,
10886 respectively. Negative numbers are supported. The result of the computation is
10887 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10888
10889 .display
10890 &`${eval:1+1}            `&  yields 2
10891 &`${eval:1+2*3}          `&  yields 7
10892 &`${eval:(1+2)*3}        `&  yields 9
10893 &`${eval:2+42%5}         `&  yields 4
10894 &`${eval:0xc&amp;5}          `&  yields 4
10895 &`${eval:0xc|5}          `&  yields 13
10896 &`${eval:0xc^5}          `&  yields 9
10897 &`${eval:0xc>>1}         `&  yields 6
10898 &`${eval:0xc<<1}         `&  yields 24
10899 &`${eval:~255&amp;0x1234}    `&  yields 4608
10900 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10901 .endd
10902
10903 As a more realistic example, in an ACL you might have
10904 .code
10905 deny   condition =                    \
10906          ${if and {                   \
10907            {>{$rcpt_count}{10}}       \
10908            {                          \
10909            <                          \
10910              {$recipients_count}      \
10911              {${eval:$rcpt_count/2}}  \
10912            }                          \
10913          }{yes}{no}}
10914        message = Too many bad recipients
10915 .endd
10916 The condition is true if there have been more than 10 RCPT commands and
10917 fewer than half of them have resulted in a valid recipient.
10918
10919
10920 .vitem &*${expand:*&<&'string'&>&*}*&
10921 .cindex "expansion" "re-expansion of substring"
10922 The &%expand%& operator causes a string to be expanded for a second time. For
10923 example,
10924 .code
10925 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10926 .endd
10927 first looks up a string in a file while expanding the operand for &%expand%&,
10928 and then re-expands what it has found.
10929
10930
10931 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10932 .cindex "Unicode"
10933 .cindex "UTF-8" "conversion from"
10934 .cindex "expansion" "UTF-8 conversion"
10935 .cindex "&%from_utf8%& expansion item"
10936 The world is slowly moving towards Unicode, although there are no standards for
10937 email yet. However, other applications (including some databases) are starting
10938 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10939 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10940 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10941 the result is an undefined sequence of bytes.
10942
10943 Unicode code points with values less than 256 are compatible with ASCII and
10944 ISO-8859-1 (also known as Latin-1).
10945 For example, character 169 is the copyright symbol in both cases, though the
10946 way it is encoded is different. In UTF-8, more than one byte is needed for
10947 characters with code values greater than 127, whereas ISO-8859-1 is a
10948 single-byte encoding (but thereby limited to 256 characters). This makes
10949 translation from UTF-8 to ISO-8859-1 straightforward.
10950
10951
10952 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10953 .cindex "hash function" "textual"
10954 .cindex "expansion" "textual hash"
10955 The &%hash%& operator is a simpler interface to the hashing function that can
10956 be used when the two parameters are fixed numbers (as opposed to strings that
10957 change when expanded). The effect is the same as
10958 .code
10959 ${hash{<n>}{<m>}{<string>}}
10960 .endd
10961 See the description of the general &%hash%& item above for details. The
10962 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10963
10964
10965
10966 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10967 .cindex "base64 encoding" "conversion from hex"
10968 .cindex "expansion" "hex to base64"
10969 .cindex "&%hex2b64%& expansion item"
10970 This operator converts a hex string into one that is base64 encoded. This can
10971 be useful for processing the output of the various hashing functions.
10972
10973
10974
10975 .vitem &*${hexquote:*&<&'string'&>&*}*&
10976 .cindex "quoting" "hex-encoded unprintable characters"
10977 .cindex "&%hexquote%& expansion item"
10978 This operator converts non-printable characters in a string into a hex
10979 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10980 as is, and other byte values are converted to &`\xNN`&, for example, a
10981 byte value 127 is converted to &`\x7f`&.
10982
10983
10984 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10985 .cindex "&%ipv6denorm%& expansion item"
10986 .cindex "IP address" normalisation
10987 This expands an IPv6 address to a full eight-element colon-separated set
10988 of hex digits including leading zeroes.
10989 A trailing ipv4-style dotted-decimal set is converted to hex.
10990 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10991
10992 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10993 .cindex "&%ipv6norm%& expansion item"
10994 .cindex "IP address" normalisation
10995 .cindex "IP address" "canonical form"
10996 This converts an IPv6 address to canonical form.
10997 Leading zeroes of groups are omitted, and the longest
10998 set of zero-valued groups is replaced with a double colon.
10999 A trailing ipv4-style dotted-decimal set is converted to hex.
11000 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11001
11002
11003 .vitem &*${lc:*&<&'string'&>&*}*&
11004 .cindex "case forcing in strings"
11005 .cindex "string" "case forcing"
11006 .cindex "lower casing"
11007 .cindex "expansion" "case forcing"
11008 .cindex "&%lc%& expansion item"
11009 This forces the letters in the string into lower-case, for example:
11010 .code
11011 ${lc:$local_part}
11012 .endd
11013 Case is defined per the system C locale.
11014
11015 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11016 .cindex "expansion" "string truncation"
11017 .cindex "&%length%& expansion item"
11018 The &%length%& operator is a simpler interface to the &%length%& function that
11019 can be used when the parameter is a fixed number (as opposed to a string that
11020 changes when expanded). The effect is the same as
11021 .code
11022 ${length{<number>}{<string>}}
11023 .endd
11024 See the description of the general &%length%& item above for details. Note that
11025 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11026 when &%length%& is used as an operator.
11027 All measurement is done in bytes and is not UTF-8 aware.
11028
11029
11030 .vitem &*${listcount:*&<&'string'&>&*}*&
11031 .cindex "expansion" "list item count"
11032 .cindex "list" "item count"
11033 .cindex "list" "count of items"
11034 .cindex "&%listcount%& expansion item"
11035 The string is interpreted as a list and the number of items is returned.
11036
11037
11038 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11039 .cindex "expansion" "named list"
11040 .cindex "&%listnamed%& expansion item"
11041 The name is interpreted as a named list and the content of the list is returned,
11042 expanding any referenced lists, re-quoting as needed for colon-separation.
11043 If the optional type is given it must be one of "a", "d", "h" or "l"
11044 and selects address-, domain-, host- or localpart- lists to search among respectively.
11045 Otherwise all types are searched in an undefined order and the first
11046 matching list is returned.
11047
11048
11049 .vitem &*${local_part:*&<&'string'&>&*}*&
11050 .cindex "expansion" "local part extraction"
11051 .cindex "&%local_part%& expansion item"
11052 The string is interpreted as an RFC 2822 address and the local part is
11053 extracted from it. If the string does not parse successfully, the result is
11054 empty.
11055 The parsing correctly handles SMTPUTF8 Unicode in the string.
11056
11057
11058 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11059 .cindex "masked IP address"
11060 .cindex "IP address" "masking"
11061 .cindex "CIDR notation"
11062 .cindex "expansion" "IP address masking"
11063 .cindex "&%mask%& expansion item"
11064 If the form of the string to be operated on is not an IP address followed by a
11065 slash and an integer (that is, a network address in CIDR notation), the
11066 expansion fails. Otherwise, this operator converts the IP address to binary,
11067 masks off the least significant bits according to the bit count, and converts
11068 the result back to text, with mask appended. For example,
11069 .code
11070 ${mask:10.111.131.206/28}
11071 .endd
11072 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11073 be mostly used for looking up masked addresses in files, the result for an IPv6
11074 address uses dots to separate components instead of colons, because colon
11075 terminates a key string in lsearch files. So, for example,
11076 .code
11077 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11078 .endd
11079 returns the string
11080 .code
11081 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11082 .endd
11083 Letters in IPv6 addresses are always output in lower case.
11084
11085
11086 .vitem &*${md5:*&<&'string'&>&*}*&
11087 .cindex "MD5 hash"
11088 .cindex "expansion" "MD5 hash"
11089 .cindex certificate fingerprint
11090 .cindex "&%md5%& expansion item"
11091 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11092 as a 32-digit hexadecimal number, in which any letters are in lower case.
11093
11094 If the string is a single variable of type certificate,
11095 returns the MD5 hash fingerprint of the certificate.
11096
11097
11098 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11099 .cindex "expansion" "numeric hash"
11100 .cindex "hash function" "numeric"
11101 The &%nhash%& operator is a simpler interface to the numeric hashing function
11102 that can be used when the two parameters are fixed numbers (as opposed to
11103 strings that change when expanded). The effect is the same as
11104 .code
11105 ${nhash{<n>}{<m>}{<string>}}
11106 .endd
11107 See the description of the general &%nhash%& item above for details.
11108
11109
11110 .vitem &*${quote:*&<&'string'&>&*}*&
11111 .cindex "quoting" "in string expansions"
11112 .cindex "expansion" "quoting"
11113 .cindex "&%quote%& expansion item"
11114 The &%quote%& operator puts its argument into double quotes if it
11115 is an empty string or
11116 contains anything other than letters, digits, underscores, dots, and hyphens.
11117 Any occurrences of double quotes and backslashes are escaped with a backslash.
11118 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11119 respectively For example,
11120 .code
11121 ${quote:ab"*"cd}
11122 .endd
11123 becomes
11124 .code
11125 "ab\"*\"cd"
11126 .endd
11127 The place where this is useful is when the argument is a substitution from a
11128 variable or a message header.
11129
11130 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11131 .cindex "&%quote_local_part%& expansion item"
11132 This operator is like &%quote%&, except that it quotes the string only if
11133 required to do so by the rules of RFC 2822 for quoting local parts. For
11134 example, a plus sign would not cause quoting (but it would for &%quote%&).
11135 If you are creating a new email address from the contents of &$local_part$&
11136 (or any other unknown data), you should always use this operator.
11137
11138 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11139 will likely use the quoting form.
11140 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11141
11142
11143 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11144 .cindex "quoting" "lookup-specific"
11145 This operator applies lookup-specific quoting rules to the string. Each
11146 query-style lookup type has its own quoting rules which are described with
11147 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11148 .code
11149 ${quote_ldap:two * two}
11150 .endd
11151 returns
11152 .code
11153 two%20%5C2A%20two
11154 .endd
11155 For single-key lookup types, no quoting is ever necessary and this operator
11156 yields an unchanged string.
11157
11158
11159 .vitem &*${randint:*&<&'n'&>&*}*&
11160 .cindex "random number"
11161 This operator returns a somewhat random number which is less than the
11162 supplied number and is at least 0.  The quality of this randomness depends
11163 on how Exim was built; the values are not suitable for keying material.
11164 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11165 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11166 for versions of GnuTLS with that function.
11167 Otherwise, the implementation may be arc4random(), random() seeded by
11168 srandomdev() or srandom(), or a custom implementation even weaker than
11169 random().
11170
11171
11172 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11173 .cindex "expansion" "IP address"
11174 This operator reverses an IP address; for IPv4 addresses, the result is in
11175 dotted-quad decimal form, while for IPv6 addresses the result is in
11176 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11177 for DNS.  For example,
11178 .code
11179 ${reverse_ip:192.0.2.4}
11180 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11181 .endd
11182 returns
11183 .code
11184 4.2.0.192
11185 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
11186 .endd
11187
11188
11189 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11190 .cindex "expansion" "RFC 2047"
11191 .cindex "RFC 2047" "expansion operator"
11192 .cindex "&%rfc2047%& expansion item"
11193 This operator encodes text according to the rules of RFC 2047. This is an
11194 encoding that is used in header lines to encode non-ASCII characters. It is
11195 assumed that the input string is in the encoding specified by the
11196 &%headers_charset%& option, which gets its default at build time. If the string
11197 contains only characters in the range 33&--126, and no instances of the
11198 characters
11199 .code
11200 ? = ( ) < > @ , ; : \ " . [ ] _
11201 .endd
11202 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11203 string, using as many &"encoded words"& as necessary to encode all the
11204 characters.
11205
11206
11207 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11208 .cindex "expansion" "RFC 2047"
11209 .cindex "RFC 2047" "decoding"
11210 .cindex "&%rfc2047d%& expansion item"
11211 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11212 bytes are replaced by question marks. Characters are converted into the
11213 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11214 not recognized unless &%check_rfc2047_length%& is set false.
11215
11216 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11217 access a header line, RFC 2047 decoding is done automatically. You do not need
11218 to use this operator as well.
11219
11220
11221
11222 .vitem &*${rxquote:*&<&'string'&>&*}*&
11223 .cindex "quoting" "in regular expressions"
11224 .cindex "regular expressions" "quoting"
11225 .cindex "&%rxquote%& expansion item"
11226 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11227 characters in its argument. This is useful when substituting the values of
11228 variables or headers inside regular expressions.
11229
11230
11231 .vitem &*${sha1:*&<&'string'&>&*}*&
11232 .cindex "SHA-1 hash"
11233 .cindex "expansion" "SHA-1 hashing"
11234 .cindex certificate fingerprint
11235 .cindex "&%sha1%& expansion item"
11236 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11237 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11238
11239 If the string is a single variable of type certificate,
11240 returns the SHA-1 hash fingerprint of the certificate.
11241
11242
11243 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11244        &*${sha2:*&<&'string'&>&*}*& &&&
11245        &*${sha2_<n>:*&<&'string'&>&*}*&
11246 .cindex "SHA-256 hash"
11247 .cindex "SHA-2 hash"
11248 .cindex certificate fingerprint
11249 .cindex "expansion" "SHA-256 hashing"
11250 .cindex "&%sha256%& expansion item"
11251 .cindex "&%sha2%& expansion item"
11252 The &%sha256%& operator computes the SHA-256 hash value of the string
11253 and returns
11254 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11255
11256 If the string is a single variable of type certificate,
11257 returns the SHA-256 hash fingerprint of the certificate.
11258
11259 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11260 (except for certificates, which are not supported).
11261 Finally, if an underbar
11262 and a number is appended it specifies the output length, selecting a
11263 member of the SHA-2 family of hash functions.
11264 Values of 256, 384 and 512 are accepted, with 256 being the default.
11265
11266
11267 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11268        &*${sha3_<n>:*&<&'string'&>&*}*&
11269 .cindex "SHA3 hash"
11270 .cindex "expansion" "SHA3 hashing"
11271 .cindex "&%sha3%& expansion item"
11272 The &%sha3%& operator computes the SHA3-256 hash value of the string
11273 and returns
11274 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11275
11276 If a number is appended, separated by an underbar, it specifies
11277 the output length.  Values of 224, 256, 384 and 512 are accepted;
11278 with 256 being the default.
11279
11280 The &%sha3%& expansion item is only supported if Exim has been
11281 compiled with GnuTLS 3.5.0 or later,
11282 or OpenSSL 1.1.1 or later.
11283 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11284
11285
11286 .vitem &*${stat:*&<&'string'&>&*}*&
11287 .cindex "expansion" "statting a file"
11288 .cindex "file" "extracting characteristics"
11289 .cindex "&%stat%& expansion item"
11290 The string, after expansion, must be a file path. A call to the &[stat()]&
11291 function is made for this path. If &[stat()]& fails, an error occurs and the
11292 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11293 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11294 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11295 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11296 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11297 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11298 can extract individual fields using the &%extract%& expansion item.
11299
11300 The use of the &%stat%& expansion in users' filter files can be locked out by
11301 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11302 systems for files larger than 2GB.
11303
11304 .vitem &*${str2b64:*&<&'string'&>&*}*&
11305 .cindex "&%str2b64%& expansion item"
11306 Now deprecated, a synonym for the &%base64%& expansion operator.
11307
11308
11309
11310 .vitem &*${strlen:*&<&'string'&>&*}*&
11311 .cindex "expansion" "string length"
11312 .cindex "string" "length in expansion"
11313 .cindex "&%strlen%& expansion item"
11314 The item is replace by the length of the expanded string, expressed as a
11315 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11316 All measurement is done in bytes and is not UTF-8 aware.
11317
11318
11319 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11320 .cindex "&%substr%& expansion item"
11321 .cindex "substring extraction"
11322 .cindex "expansion" "substring expansion"
11323 The &%substr%& operator is a simpler interface to the &%substr%& function that
11324 can be used when the two parameters are fixed numbers (as opposed to strings
11325 that change when expanded). The effect is the same as
11326 .code
11327 ${substr{<start>}{<length>}{<string>}}
11328 .endd
11329 See the description of the general &%substr%& item above for details. The
11330 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11331 All measurement is done in bytes and is not UTF-8 aware.
11332
11333 .vitem &*${time_eval:*&<&'string'&>&*}*&
11334 .cindex "&%time_eval%& expansion item"
11335 .cindex "time interval" "decoding"
11336 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11337 seconds.
11338
11339 .vitem &*${time_interval:*&<&'string'&>&*}*&
11340 .cindex "&%time_interval%& expansion item"
11341 .cindex "time interval" "formatting"
11342 The argument (after sub-expansion) must be a sequence of decimal digits that
11343 represents an interval of time as a number of seconds. It is converted into a
11344 number of larger units and output in Exim's normal time format, for example,
11345 &`1w3d4h2m6s`&.
11346
11347 .vitem &*${uc:*&<&'string'&>&*}*&
11348 .cindex "case forcing in strings"
11349 .cindex "string" "case forcing"
11350 .cindex "upper casing"
11351 .cindex "expansion" "case forcing"
11352 .cindex "&%uc%& expansion item"
11353 This forces the letters in the string into upper-case.
11354 Case is defined per the system C locale.
11355
11356 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11357 .cindex "correction of invalid utf-8 sequences in strings"
11358 .cindex "utf-8" "utf-8 sequences"
11359 .cindex "incorrect utf-8"
11360 .cindex "expansion" "utf-8 forcing"
11361 .cindex "&%utf8clean%& expansion item"
11362 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11363 In versions of Exim before 4.92, this did not correctly do so for a truncated
11364 final codepoint's encoding, and the character would be silently dropped.
11365 If you must handle detection of this scenario across both sets of Exim behavior,
11366 the complexity will depend upon the task.
11367 For instance, to detect if the first character is multibyte and a 1-byte
11368 extraction can be successfully used as a path component (as is common for
11369 dividing up delivery folders), you might use:
11370 .code
11371 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11372 .endd
11373 (which will false-positive if the first character of the local part is a
11374 literal question mark).
11375
11376 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11377        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11378        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11379        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11380 .cindex expansion UTF-8
11381 .cindex UTF-8 expansion
11382 .cindex EAI
11383 .cindex internationalisation
11384 .cindex "&%utf8_domain_to_alabel%& expansion item"
11385 .cindex "&%utf8_domain_from_alabel%& expansion item"
11386 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11387 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11388 These convert EAI mail name components between UTF-8 and a-label forms.
11389 For information on internationalisation support see &<<SECTi18nMTA>>&.
11390 .endlist
11391
11392
11393
11394
11395
11396
11397 .section "Expansion conditions" "SECTexpcond"
11398 .scindex IIDexpcond "expansion" "conditions"
11399 The following conditions are available for testing by the &%${if%& construct
11400 while expanding strings:
11401
11402 .vlist
11403 .vitem &*!*&<&'condition'&>
11404 .cindex "expansion" "negating a condition"
11405 .cindex "negation" "in expansion condition"
11406 Preceding any condition with an exclamation mark negates the result of the
11407 condition.
11408
11409 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11410 .cindex "numeric comparison"
11411 .cindex "expansion" "numeric comparison"
11412 There are a number of symbolic operators for doing numeric comparisons. They
11413 are:
11414 .display
11415 &`=   `&   equal
11416 &`==  `&   equal
11417 &`>   `&   greater
11418 &`>=  `&   greater or equal
11419 &`<   `&   less
11420 &`<=  `&   less or equal
11421 .endd
11422 For example:
11423 .code
11424 ${if >{$message_size}{10M} ...
11425 .endd
11426 Note that the general negation operator provides for inequality testing. The
11427 two strings must take the form of optionally signed decimal integers,
11428 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11429 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11430 As a special case, the numerical value of an empty string is taken as
11431 zero.
11432
11433 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11434 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11435 10M, not if 10M is larger than &$message_size$&.
11436
11437
11438 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11439         {*&<&'arg2'&>&*}...}*&
11440 .cindex "expansion" "calling an acl"
11441 .cindex "&%acl%&" "expansion condition"
11442 The name and zero to nine argument strings are first expanded separately.  The expanded
11443 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11444 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11445 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11446 and may use the variables; if another acl expansion is used the values
11447 are restored after it returns.  If the ACL sets
11448 a value using a "message =" modifier the variable $value becomes
11449 the result of the expansion, otherwise it is empty.
11450 If the ACL returns accept the condition is true; if deny, false.
11451 If the ACL returns defer the result is a forced-fail.
11452
11453 .vitem &*bool&~{*&<&'string'&>&*}*&
11454 .cindex "expansion" "boolean parsing"
11455 .cindex "&%bool%& expansion condition"
11456 This condition turns a string holding a true or false representation into
11457 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11458 (case-insensitively); also integer numbers map to true if non-zero,
11459 false if zero.
11460 An empty string is treated as false.
11461 Leading and trailing whitespace is ignored;
11462 thus a string consisting only of whitespace is false.
11463 All other string values will result in expansion failure.
11464
11465 When combined with ACL variables, this expansion condition will let you
11466 make decisions in one place and act on those decisions in another place.
11467 For example:
11468 .code
11469 ${if bool{$acl_m_privileged_sender} ...
11470 .endd
11471
11472
11473 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11474 .cindex "expansion" "boolean parsing"
11475 .cindex "&%bool_lax%& expansion condition"
11476 Like &%bool%&, this condition turns a string into a boolean state.  But
11477 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11478 loose definition that the Router &%condition%& option uses.  The empty string
11479 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11480 true.  Leading and trailing whitespace is ignored.
11481
11482 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11483
11484 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11485 .cindex "expansion" "encrypted comparison"
11486 .cindex "encrypted strings, comparing"
11487 .cindex "&%crypteq%& expansion condition"
11488 This condition is included in the Exim binary if it is built to support any
11489 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11490 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11491 included in the binary.
11492
11493 The &%crypteq%& condition has two arguments. The first is encrypted and
11494 compared against the second, which is already encrypted. The second string may
11495 be in the LDAP form for storing encrypted strings, which starts with the
11496 encryption type in curly brackets, followed by the data. If the second string
11497 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11498 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11499 Typically this will be a field from a password file. An example of an encrypted
11500 string in LDAP form is:
11501 .code
11502 {md5}CY9rzUYh03PK3k6DJie09g==
11503 .endd
11504 If such a string appears directly in an expansion, the curly brackets have to
11505 be quoted, because they are part of the expansion syntax. For example:
11506 .code
11507 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11508 .endd
11509 The following encryption types (whose names are matched case-independently) are
11510 supported:
11511
11512 .ilist
11513 .cindex "MD5 hash"
11514 .cindex "base64 encoding" "in encrypted password"
11515 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11516 printable characters to compare with the remainder of the second string. If the
11517 length of the comparison string is 24, Exim assumes that it is base64 encoded
11518 (as in the above example). If the length is 32, Exim assumes that it is a
11519 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11520 comparison fails.
11521
11522 .next
11523 .cindex "SHA-1 hash"
11524 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11525 printable characters to compare with the remainder of the second string. If the
11526 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11527 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11528 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11529
11530 .next
11531 .cindex "&[crypt()]&"
11532 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11533 only the first eight characters of the password. However, in modern operating
11534 systems this is no longer true, and in many cases the entire password is used,
11535 whatever its length.
11536
11537 .next
11538 .cindex "&[crypt16()]&"
11539 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11540 use up to 16 characters of the password in some operating systems. Again, in
11541 modern operating systems, more characters may be used.
11542 .endlist
11543 Exim has its own version of &[crypt16()]&, which is just a double call to
11544 &[crypt()]&. For operating systems that have their own version, setting
11545 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11546 operating system version instead of its own. This option is set by default in
11547 the OS-dependent &_Makefile_& for those operating systems that are known to
11548 support &[crypt16()]&.
11549
11550 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11551 it was not using the same algorithm as some operating systems' versions. It
11552 turns out that as well as &[crypt16()]& there is a function called
11553 &[bigcrypt()]& in some operating systems. This may or may not use the same
11554 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11555
11556 However, since there is now a move away from the traditional &[crypt()]&
11557 functions towards using SHA1 and other algorithms, tidying up this area of
11558 Exim is seen as very low priority.
11559
11560 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11561 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11562 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11563 default is &`{crypt}`&. Whatever the default, you can always use either
11564 function by specifying it explicitly in curly brackets.
11565
11566 .vitem &*def:*&<&'variable&~name'&>
11567 .cindex "expansion" "checking for empty variable"
11568 .cindex "&%def%& expansion condition"
11569 The &%def%& condition must be followed by the name of one of the expansion
11570 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11571 variable does not contain the empty string. For example:
11572 .code
11573 ${if def:sender_ident {from $sender_ident}}
11574 .endd
11575 Note that the variable name is given without a leading &%$%& character. If the
11576 variable does not exist, the expansion fails.
11577
11578 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11579         &~&*def:h_*&<&'header&~name'&>&*:*&"
11580 .cindex "expansion" "checking header line existence"
11581 This condition is true if a message is being processed and the named header
11582 exists in the message. For example,
11583 .code
11584 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11585 .endd
11586 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11587 the header name must be terminated by a colon if white space does not follow.
11588
11589 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11590        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11591 .cindex "string" "comparison"
11592 .cindex "expansion" "string comparison"
11593 .cindex "&%eq%& expansion condition"
11594 .cindex "&%eqi%& expansion condition"
11595 The two substrings are first expanded. The condition is true if the two
11596 resulting strings are identical. For &%eq%& the comparison includes the case of
11597 letters, whereas for &%eqi%& the comparison is case-independent, where
11598 case is defined per the system C locale.
11599
11600 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11601 .cindex "expansion" "file existence test"
11602 .cindex "file" "existence test"
11603 .cindex "&%exists%&, expansion condition"
11604 The substring is first expanded and then interpreted as an absolute path. The
11605 condition is true if the named file (or directory) exists. The existence test
11606 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11607 users' filter files may be locked out by the system administrator.
11608
11609 .vitem &*first_delivery*&
11610 .cindex "delivery" "first"
11611 .cindex "first delivery"
11612 .cindex "expansion" "first delivery test"
11613 .cindex "&%first_delivery%& expansion condition"
11614 This condition, which has no data, is true during a message's first delivery
11615 attempt. It is false during any subsequent delivery attempts.
11616
11617
11618 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11619        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11620 .cindex "list" "iterative conditions"
11621 .cindex "expansion" "&*forall*& condition"
11622 .cindex "expansion" "&*forany*& condition"
11623 .vindex "&$item$&"
11624 These conditions iterate over a list. The first argument is expanded to form
11625 the list. By default, the list separator is a colon, but it can be changed by
11626 the normal method (&<<SECTlistsepchange>>&).
11627 The second argument is interpreted as a condition that is to
11628 be applied to each item in the list in turn. During the interpretation of the
11629 condition, the current list item is placed in a variable called &$item$&.
11630 .ilist
11631 For &*forany*&, interpretation stops if the condition is true for any item, and
11632 the result of the whole condition is true. If the condition is false for all
11633 items in the list, the overall condition is false.
11634 .next
11635 For &*forall*&, interpretation stops if the condition is false for any item,
11636 and the result of the whole condition is false. If the condition is true for
11637 all items in the list, the overall condition is true.
11638 .endlist
11639 Note that negation of &*forany*& means that the condition must be false for all
11640 items for the overall condition to succeed, and negation of &*forall*& means
11641 that the condition must be false for at least one item. In this example, the
11642 list separator is changed to a comma:
11643 .code
11644 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11645 .endd
11646 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11647 being processed, to enable these expansion items to be nested.
11648
11649 To scan a named list, expand it with the &*listnamed*& operator.
11650
11651 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11652        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11653        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11654        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11655 .cindex JSON "iterative conditions"
11656 .cindex JSON expansions
11657 .cindex expansion "&*forall_json*& condition"
11658 .cindex expansion "&*forany_json*& condition"
11659 .cindex expansion "&*forall_jsons*& condition"
11660 .cindex expansion "&*forany_jsons*& condition"
11661 As for the above, except that the first argument must, after expansion,
11662 be a JSON array.
11663 The array separator is not changeable.
11664 For the &"jsons"& variants the elements are expected to be JSON strings
11665 and have their quotes removed before the evaluation of the condition.
11666
11667
11668
11669 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11670        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11671 .cindex "string" "comparison"
11672 .cindex "expansion" "string comparison"
11673 .cindex "&%ge%& expansion condition"
11674 .cindex "&%gei%& expansion condition"
11675 The two substrings are first expanded. The condition is true if the first
11676 string is lexically greater than or equal to the second string. For &%ge%& the
11677 comparison includes the case of letters, whereas for &%gei%& the comparison is
11678 case-independent.
11679 Case and collation order are defined per the system C locale.
11680
11681 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11682        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11683 .cindex "string" "comparison"
11684 .cindex "expansion" "string comparison"
11685 .cindex "&%gt%& expansion condition"
11686 .cindex "&%gti%& expansion condition"
11687 The two substrings are first expanded. The condition is true if the first
11688 string is lexically greater than the second string. For &%gt%& the comparison
11689 includes the case of letters, whereas for &%gti%& the comparison is
11690 case-independent.
11691 Case and collation order are defined per the system C locale.
11692
11693 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11694        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11695 .cindex "string" "comparison"
11696 .cindex "list" "iterative conditions"
11697 Both strings are expanded; the second string is treated as a list of simple
11698 strings; if the first string is a member of the second, then the condition
11699 is true.
11700 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11701
11702 These are simpler to use versions of the more powerful &*forany*& condition.
11703 Examples, and the &*forany*& equivalents:
11704 .code
11705 ${if inlist{needle}{foo:needle:bar}}
11706   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11707 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11708   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11709 .endd
11710
11711 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11712        &*isip4&~{*&<&'string'&>&*}*& &&&
11713        &*isip6&~{*&<&'string'&>&*}*&
11714 .cindex "IP address" "testing string format"
11715 .cindex "string" "testing for IP address"
11716 .cindex "&%isip%& expansion condition"
11717 .cindex "&%isip4%& expansion condition"
11718 .cindex "&%isip6%& expansion condition"
11719 The substring is first expanded, and then tested to see if it has the form of
11720 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11721 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11722
11723 For an IPv4 address, the test is for four dot-separated components, each of
11724 which consists of from one to three digits. For an IPv6 address, up to eight
11725 colon-separated components are permitted, each containing from one to four
11726 hexadecimal digits. There may be fewer than eight components if an empty
11727 component (adjacent colons) is present. Only one empty component is permitted.
11728
11729 &*Note*&: The checks used to be just on the form of the address; actual numerical
11730 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11731 check.
11732 This is no longer the case.
11733
11734 The main use of these tests is to distinguish between IP addresses and
11735 host names, or between IPv4 and IPv6 addresses. For example, you could use
11736 .code
11737 ${if isip4{$sender_host_address}...
11738 .endd
11739 to test which IP version an incoming SMTP connection is using.
11740
11741 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11742 .cindex "LDAP" "use for authentication"
11743 .cindex "expansion" "LDAP authentication test"
11744 .cindex "&%ldapauth%& expansion condition"
11745 This condition supports user authentication using LDAP. See section
11746 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11747 queries. For this use, the query must contain a user name and password. The
11748 query itself is not used, and can be empty. The condition is true if the
11749 password is not empty, and the user name and password are accepted by the LDAP
11750 server. An empty password is rejected without calling LDAP because LDAP binds
11751 with an empty password are considered anonymous regardless of the username, and
11752 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11753 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11754 this can be used.
11755
11756
11757 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11758        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11759 .cindex "string" "comparison"
11760 .cindex "expansion" "string comparison"
11761 .cindex "&%le%& expansion condition"
11762 .cindex "&%lei%& expansion condition"
11763 The two substrings are first expanded. The condition is true if the first
11764 string is lexically less than or equal to the second string. For &%le%& the
11765 comparison includes the case of letters, whereas for &%lei%& the comparison is
11766 case-independent.
11767 Case and collation order are defined per the system C locale.
11768
11769 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11770        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11771 .cindex "string" "comparison"
11772 .cindex "expansion" "string comparison"
11773 .cindex "&%lt%& expansion condition"
11774 .cindex "&%lti%& expansion condition"
11775 The two substrings are first expanded. The condition is true if the first
11776 string is lexically less than the second string. For &%lt%& the comparison
11777 includes the case of letters, whereas for &%lti%& the comparison is
11778 case-independent.
11779 Case and collation order are defined per the system C locale.
11780
11781
11782 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11783 .cindex "expansion" "regular expression comparison"
11784 .cindex "regular expressions" "match in expanded string"
11785 .cindex "&%match%& expansion condition"
11786 The two substrings are first expanded. The second is then treated as a regular
11787 expression and applied to the first. Because of the pre-expansion, if the
11788 regular expression contains dollar, or backslash characters, they must be
11789 escaped. Care must also be taken if the regular expression contains braces
11790 (curly brackets). A closing brace must be escaped so that it is not taken as a
11791 premature termination of <&'string2'&>. The easiest approach is to use the
11792 &`\N`& feature to disable expansion of the regular expression.
11793 For example,
11794 .code
11795 ${if match {$local_part}{\N^\d{3}\N} ...
11796 .endd
11797 If the whole expansion string is in double quotes, further escaping of
11798 backslashes is also required.
11799
11800 The condition is true if the regular expression match succeeds.
11801 The regular expression is not required to begin with a circumflex
11802 metacharacter, but if there is no circumflex, the expression is not anchored,
11803 and it may match anywhere in the subject, not just at the start. If you want
11804 the pattern to match at the end of the subject, you must include the &`$`&
11805 metacharacter at an appropriate point.
11806 All character handling is done in bytes and is not UTF-8 aware,
11807 but we might change this in a future Exim release.
11808
11809 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11810 At the start of an &%if%& expansion the values of the numeric variable
11811 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11812 succeeds causes them to be reset to the substrings of that condition and they
11813 will have these values during the expansion of the success string. At the end
11814 of the &%if%& expansion, the previous values are restored. After testing a
11815 combination of conditions using &%or%&, the subsequent values of the numeric
11816 variables are those of the condition that succeeded.
11817
11818 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11819 .cindex "&%match_address%& expansion condition"
11820 See &*match_local_part*&.
11821
11822 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11823 .cindex "&%match_domain%& expansion condition"
11824 See &*match_local_part*&.
11825
11826 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11827 .cindex "&%match_ip%& expansion condition"
11828 This condition matches an IP address to a list of IP address patterns. It must
11829 be followed by two argument strings. The first (after expansion) must be an IP
11830 address or an empty string. The second (not expanded) is a restricted host
11831 list that can match only an IP address, not a host name. For example:
11832 .code
11833 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11834 .endd
11835 The specific types of host list item that are permitted in the list are:
11836
11837 .ilist
11838 An IP address, optionally with a CIDR mask.
11839 .next
11840 A single asterisk, which matches any IP address.
11841 .next
11842 An empty item, which matches only if the IP address is empty. This could be
11843 useful for testing for a locally submitted message or one from specific hosts
11844 in a single test such as
11845 . ==== As this is a nested list, any displays it contains must be indented
11846 . ==== as otherwise they are too far to the left. This comment applies to
11847 . ==== the use of xmlto plus fop. There's no problem when formatting with
11848 . ==== sdop, with or without the extra indent.
11849 .code
11850   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11851 .endd
11852 where the first item in the list is the empty string.
11853 .next
11854 The item @[] matches any of the local host's interface addresses.
11855 .next
11856 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11857 even if &`net-`& is not specified. There is never any attempt to turn the IP
11858 address into a host name. The most common type of linear search for
11859 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11860 masks. For example:
11861 .code
11862   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11863 .endd
11864 It is of course possible to use other kinds of lookup, and in such a case, you
11865 do need to specify the &`net-`& prefix if you want to specify a specific
11866 address mask, for example:
11867 .code
11868   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11869 .endd
11870 However, unless you are combining a &%match_ip%& condition with others, it is
11871 just as easy to use the fact that a lookup is itself a condition, and write:
11872 .code
11873   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11874 .endd
11875 .endlist ilist
11876
11877 Note that <&'string2'&> is not itself subject to string expansion, unless
11878 Exim was built with the EXPAND_LISTMATCH_RHS option.
11879
11880 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11881
11882 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11883 .cindex "domain list" "in expansion condition"
11884 .cindex "address list" "in expansion condition"
11885 .cindex "local part" "list, in expansion condition"
11886 .cindex "&%match_local_part%& expansion condition"
11887 This condition, together with &%match_address%& and &%match_domain%&, make it
11888 possible to test domain, address, and local part lists within expansions. Each
11889 condition requires two arguments: an item and a list to match. A trivial
11890 example is:
11891 .code
11892 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11893 .endd
11894 In each case, the second argument may contain any of the allowable items for a
11895 list of the appropriate type. Also, because the second argument
11896 is a standard form of list, it is possible to refer to a named list.
11897 Thus, you can use conditions like this:
11898 .code
11899 ${if match_domain{$domain}{+local_domains}{...
11900 .endd
11901 .cindex "&`+caseful`&"
11902 For address lists, the matching starts off caselessly, but the &`+caseful`&
11903 item can be used, as in all address lists, to cause subsequent items to
11904 have their local parts matched casefully. Domains are always matched
11905 caselessly.
11906
11907 Note that <&'string2'&> is not itself subject to string expansion, unless
11908 Exim was built with the EXPAND_LISTMATCH_RHS option.
11909
11910 &*Note*&: Host lists are &'not'& supported in this way. This is because
11911 hosts have two identities: a name and an IP address, and it is not clear
11912 how to specify cleanly how such a test would work. However, IP addresses can be
11913 matched using &%match_ip%&.
11914
11915 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11916 .cindex "PAM authentication"
11917 .cindex "AUTH" "with PAM"
11918 .cindex "Solaris" "PAM support"
11919 .cindex "expansion" "PAM authentication test"
11920 .cindex "&%pam%& expansion condition"
11921 &'Pluggable Authentication Modules'&
11922 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11923 available in the latest releases of Solaris and in some GNU/Linux
11924 distributions. The Exim support, which is intended for use in conjunction with
11925 the SMTP AUTH command, is available only if Exim is compiled with
11926 .code
11927 SUPPORT_PAM=yes
11928 .endd
11929 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11930 in some releases of GNU/Linux &%-ldl%& is also needed.
11931
11932 The argument string is first expanded, and the result must be a
11933 colon-separated list of strings. Leading and trailing white space is ignored.
11934 The PAM module is initialized with the service name &"exim"& and the user name
11935 taken from the first item in the colon-separated data string (<&'string1'&>).
11936 The remaining items in the data string are passed over in response to requests
11937 from the authentication function. In the simple case there will only be one
11938 request, for a password, so the data consists of just two strings.
11939
11940 There can be problems if any of the strings are permitted to contain colon
11941 characters. In the usual way, these have to be doubled to avoid being taken as
11942 separators.
11943 The &%listquote%& expansion item can be used for this.
11944 For example, the configuration
11945 of a LOGIN authenticator might contain this setting:
11946 .code
11947 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
11948 .endd
11949 In some operating systems, PAM authentication can be done only from a process
11950 running as root. Since Exim is running as the Exim user when receiving
11951 messages, this means that PAM cannot be used directly in those systems.
11952 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11953
11954
11955 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11956 .cindex "&'pwcheck'& daemon"
11957 .cindex "Cyrus"
11958 .cindex "expansion" "&'pwcheck'& authentication test"
11959 .cindex "&%pwcheck%& expansion condition"
11960 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11961 This is one way of making it possible for passwords to be checked by a process
11962 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11963 deprecated. Its replacement is &'saslauthd'& (see below).
11964
11965 The pwcheck support is not included in Exim by default. You need to specify
11966 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11967 building Exim. For example:
11968 .code
11969 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11970 .endd
11971 You do not need to install the full Cyrus software suite in order to use
11972 the pwcheck daemon. You can compile and install just the daemon alone
11973 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11974 access to the &_/var/pwcheck_& directory.
11975
11976 The &%pwcheck%& condition takes one argument, which must be the user name and
11977 password, separated by a colon. For example, in a LOGIN authenticator
11978 configuration, you might have this:
11979 .code
11980 server_condition = ${if pwcheck{$auth1:$auth2}}
11981 .endd
11982 Again, for a PLAIN authenticator configuration, this would be:
11983 .code
11984 server_condition = ${if pwcheck{$auth2:$auth3}}
11985 .endd
11986 .vitem &*queue_running*&
11987 .cindex "queue runner" "detecting when delivering from"
11988 .cindex "expansion" "queue runner test"
11989 .cindex "&%queue_running%& expansion condition"
11990 This condition, which has no data, is true during delivery attempts that are
11991 initiated by queue runner processes, and false otherwise.
11992
11993
11994 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11995 .cindex "Radius"
11996 .cindex "expansion" "Radius authentication"
11997 .cindex "&%radius%& expansion condition"
11998 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11999 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12000 the Radius client configuration file in order to build Exim with Radius
12001 support.
12002
12003 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12004 library, using the original API. If you are using release 0.4.0 or later of
12005 this library, you need to set
12006 .code
12007 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12008 .endd
12009 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12010 &%libradius%& library that comes with FreeBSD. To do this, set
12011 .code
12012 RADIUS_LIB_TYPE=RADLIB
12013 .endd
12014 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12015 You may also have to supply a suitable setting in EXTRALIBS so that the
12016 Radius library can be found when Exim is linked.
12017
12018 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12019 Radius client library, which calls the Radius server. The condition is true if
12020 the authentication is successful. For example:
12021 .code
12022 server_condition = ${if radius{<arguments>}}
12023 .endd
12024
12025
12026 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12027         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12028 .cindex "&'saslauthd'& daemon"
12029 .cindex "Cyrus"
12030 .cindex "expansion" "&'saslauthd'& authentication test"
12031 .cindex "&%saslauthd%& expansion condition"
12032 This condition supports user authentication using the Cyrus &'saslauthd'&
12033 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12034 Using this daemon is one way of making it possible for passwords to be checked
12035 by a process that is not running as root.
12036
12037 The saslauthd support is not included in Exim by default. You need to specify
12038 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12039 building Exim. For example:
12040 .code
12041 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12042 .endd
12043 You do not need to install the full Cyrus software suite in order to use
12044 the saslauthd daemon. You can compile and install just the daemon alone
12045 from the Cyrus SASL library.
12046
12047 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12048 two are mandatory. For example:
12049 .code
12050 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12051 .endd
12052 The service and the realm are optional (which is why the arguments are enclosed
12053 in their own set of braces). For details of the meaning of the service and
12054 realm, and how to run the daemon, consult the Cyrus documentation.
12055 .endlist vlist
12056
12057
12058
12059 .section "Combining expansion conditions" "SECID84"
12060 .cindex "expansion" "combining conditions"
12061 Several conditions can be tested at once by combining them using the &%and%&
12062 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12063 conditions on their own, and precede their lists of sub-conditions. Each
12064 sub-condition must be enclosed in braces within the overall braces that contain
12065 the list. No repetition of &%if%& is used.
12066
12067
12068 .vlist
12069 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12070 .cindex "&""or""& expansion condition"
12071 .cindex "expansion" "&""or""& of conditions"
12072 The sub-conditions are evaluated from left to right. The condition is true if
12073 any one of the sub-conditions is true.
12074 For example,
12075 .code
12076 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12077 .endd
12078 When a true sub-condition is found, the following ones are parsed but not
12079 evaluated. If there are several &"match"& sub-conditions the values of the
12080 numeric variables afterwards are taken from the first one that succeeds.
12081
12082 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12083 .cindex "&""and""& expansion condition"
12084 .cindex "expansion" "&""and""& of conditions"
12085 The sub-conditions are evaluated from left to right. The condition is true if
12086 all of the sub-conditions are true. If there are several &"match"&
12087 sub-conditions, the values of the numeric variables afterwards are taken from
12088 the last one. When a false sub-condition is found, the following ones are
12089 parsed but not evaluated.
12090 .endlist
12091 .ecindex IIDexpcond
12092
12093
12094
12095
12096 .section "Expansion variables" "SECTexpvar"
12097 .cindex "expansion" "variables, list of"
12098 This section contains an alphabetical list of all the expansion variables. Some
12099 of them are available only when Exim is compiled with specific options such as
12100 support for TLS or the content scanning extension.
12101
12102 .vlist
12103 .vitem "&$0$&, &$1$&, etc"
12104 .cindex "numerical variables (&$1$& &$2$& etc)"
12105 When a &%match%& expansion condition succeeds, these variables contain the
12106 captured substrings identified by the regular expression during subsequent
12107 processing of the success string of the containing &%if%& expansion item.
12108 In the expansion condition case
12109 they do not retain their values afterwards; in fact, their previous
12110 values are restored at the end of processing an &%if%& item. The numerical
12111 variables may also be set externally by some other matching process which
12112 precedes the expansion of the string. For example, the commands available in
12113 Exim filter files include an &%if%& command with its own regular expression
12114 matching condition.
12115
12116 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12117 Within an acl condition, expansion condition or expansion item
12118 any arguments are copied to these variables,
12119 any unused variables being made empty.
12120
12121 .vitem "&$acl_c...$&"
12122 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12123 can be given any name that starts with &$acl_c$& and is at least six characters
12124 long, but the sixth character must be either a digit or an underscore. For
12125 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12126 variables persist throughout the lifetime of an SMTP connection. They can be
12127 used to pass information between ACLs and between different invocations of the
12128 same ACL. When a message is received, the values of these variables are saved
12129 with the message, and can be accessed by filters, routers, and transports
12130 during subsequent delivery.
12131
12132 .vitem "&$acl_m...$&"
12133 These variables are like the &$acl_c...$& variables, except that their values
12134 are reset after a message has been received. Thus, if several messages are
12135 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12136 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12137 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12138 message is received, the values of these variables are saved with the message,
12139 and can be accessed by filters, routers, and transports during subsequent
12140 delivery.
12141
12142 .vitem &$acl_narg$&
12143 Within an acl condition, expansion condition or expansion item
12144 this variable has the number of arguments.
12145
12146 .vitem &$acl_verify_message$&
12147 .vindex "&$acl_verify_message$&"
12148 After an address verification has failed, this variable contains the failure
12149 message. It retains its value for use in subsequent modifiers. The message can
12150 be preserved by coding like this:
12151 .code
12152 warn !verify = sender
12153      set acl_m0 = $acl_verify_message
12154 .endd
12155 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12156 &%log_message%& modifiers, to include information about the verification
12157 failure.
12158
12159 .vitem &$address_data$&
12160 .vindex "&$address_data$&"
12161 This variable is set by means of the &%address_data%& option in routers. The
12162 value then remains with the address while it is processed by subsequent routers
12163 and eventually a transport. If the transport is handling multiple addresses,
12164 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12165 for more details. &*Note*&: The contents of &$address_data$& are visible in
12166 user filter files.
12167
12168 If &$address_data$& is set when the routers are called from an ACL to verify
12169 a recipient address, the final value is still in the variable for subsequent
12170 conditions and modifiers of the ACL statement. If routing the address caused it
12171 to be redirected to just one address, the child address is also routed as part
12172 of the verification, and in this case the final value of &$address_data$& is
12173 from the child's routing.
12174
12175 If &$address_data$& is set when the routers are called from an ACL to verify a
12176 sender address, the final value is also preserved, but this time in
12177 &$sender_address_data$&, to distinguish it from data from a recipient
12178 address.
12179
12180 In both cases (recipient and sender verification), the value does not persist
12181 after the end of the current ACL statement. If you want to preserve
12182 these values for longer, you can save them in ACL variables.
12183
12184 .vitem &$address_file$&
12185 .vindex "&$address_file$&"
12186 When, as a result of aliasing, forwarding, or filtering, a message is directed
12187 to a specific file, this variable holds the name of the file when the transport
12188 is running. At other times, the variable is empty. For example, using the
12189 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12190 .code
12191 /home/r2d2/savemail
12192 .endd
12193 then when the &(address_file)& transport is running, &$address_file$&
12194 contains the text string &`/home/r2d2/savemail`&.
12195 .cindex "Sieve filter" "value of &$address_file$&"
12196 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12197 then up to the transport configuration to generate an appropriate absolute path
12198 to the relevant file.
12199
12200 .vitem &$address_pipe$&
12201 .vindex "&$address_pipe$&"
12202 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12203 this variable holds the pipe command when the transport is running.
12204
12205 .vitem "&$auth1$& &-- &$auth3$&"
12206 .vindex "&$auth1$&, &$auth2$&, etc"
12207 These variables are used in SMTP authenticators (see chapters
12208 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12209
12210 .vitem &$authenticated_id$&
12211 .cindex "authentication" "id"
12212 .vindex "&$authenticated_id$&"
12213 When a server successfully authenticates a client it may be configured to
12214 preserve some of the authentication information in the variable
12215 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12216 user/password authenticator configuration might preserve the user name for use
12217 in the routers. Note that this is not the same information that is saved in
12218 &$sender_host_authenticated$&.
12219
12220 When a message is submitted locally (that is, not over a TCP connection)
12221 the value of &$authenticated_id$& is normally the login name of the calling
12222 process. However, a trusted user can override this by means of the &%-oMai%&
12223 command line option.
12224 This second case also sets up information used by the
12225 &$authresults$& expansion item.
12226
12227 .vitem &$authenticated_fail_id$&
12228 .cindex "authentication" "fail" "id"
12229 .vindex "&$authenticated_fail_id$&"
12230 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12231 will contain the failed authentication id. If more than one authentication
12232 id is attempted, it will contain only the last one. The variable is
12233 available for processing in the ACL's, generally the quit or notquit ACL.
12234 A message to a local recipient could still be accepted without requiring
12235 authentication, which means this variable could also be visible in all of
12236 the ACL's as well.
12237
12238
12239 .vitem &$authenticated_sender$&
12240 .cindex "sender" "authenticated"
12241 .cindex "authentication" "sender"
12242 .cindex "AUTH" "on MAIL command"
12243 .vindex "&$authenticated_sender$&"
12244 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12245 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12246 described in section &<<SECTauthparamail>>&. Unless the data is the string
12247 &"<>"&, it is set as the authenticated sender of the message, and the value is
12248 available during delivery in the &$authenticated_sender$& variable. If the
12249 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12250
12251 .vindex "&$qualify_domain$&"
12252 When a message is submitted locally (that is, not over a TCP connection), the
12253 value of &$authenticated_sender$& is an address constructed from the login
12254 name of the calling process and &$qualify_domain$&, except that a trusted user
12255 can override this by means of the &%-oMas%& command line option.
12256
12257
12258 .vitem &$authentication_failed$&
12259 .cindex "authentication" "failure"
12260 .vindex "&$authentication_failed$&"
12261 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12262 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12263 possible to distinguish between &"did not try to authenticate"&
12264 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12265 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12266 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12267 negative response to an AUTH command, including (for example) an attempt to use
12268 an undefined mechanism.
12269
12270 .vitem &$av_failed$&
12271 .cindex "content scanning" "AV scanner failure"
12272 This variable is available when Exim is compiled with the content-scanning
12273 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12274 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12275 the ACL malware condition.
12276
12277 .vitem &$body_linecount$&
12278 .cindex "message body" "line count"
12279 .cindex "body of message" "line count"
12280 .vindex "&$body_linecount$&"
12281 When a message is being received or delivered, this variable contains the
12282 number of lines in the message's body. See also &$message_linecount$&.
12283
12284 .vitem &$body_zerocount$&
12285 .cindex "message body" "binary zero count"
12286 .cindex "body of message" "binary zero count"
12287 .cindex "binary zero" "in message body"
12288 .vindex "&$body_zerocount$&"
12289 When a message is being received or delivered, this variable contains the
12290 number of binary zero bytes (ASCII NULs) in the message's body.
12291
12292 .vitem &$bounce_recipient$&
12293 .vindex "&$bounce_recipient$&"
12294 This is set to the recipient address of a bounce message while Exim is creating
12295 it. It is useful if a customized bounce message text file is in use (see
12296 chapter &<<CHAPemsgcust>>&).
12297
12298 .vitem &$bounce_return_size_limit$&
12299 .vindex "&$bounce_return_size_limit$&"
12300 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12301 up to a multiple of 1000. It is useful when a customized error message text
12302 file is in use (see chapter &<<CHAPemsgcust>>&).
12303
12304 .vitem &$caller_gid$&
12305 .cindex "gid (group id)" "caller"
12306 .vindex "&$caller_gid$&"
12307 The real group id under which the process that called Exim was running. This is
12308 not the same as the group id of the originator of a message (see
12309 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12310 incarnation normally contains the Exim gid.
12311
12312 .vitem &$caller_uid$&
12313 .cindex "uid (user id)" "caller"
12314 .vindex "&$caller_uid$&"
12315 The real user id under which the process that called Exim was running. This is
12316 not the same as the user id of the originator of a message (see
12317 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12318 incarnation normally contains the Exim uid.
12319
12320 .vitem &$callout_address$&
12321 .vindex "&$callout_address$&"
12322 After a callout for verification, spamd or malware daemon service, the
12323 address that was connected to.
12324
12325 .vitem &$compile_number$&
12326 .vindex "&$compile_number$&"
12327 The building process for Exim keeps a count of the number
12328 of times it has been compiled. This serves to distinguish different
12329 compilations of the same version of Exim.
12330
12331 .vitem &$config_dir$&
12332 .vindex "&$config_dir$&"
12333 The directory name of the main configuration file. That is, the content of
12334 &$config_file$& with the last component stripped. The value does not
12335 contain the trailing slash. If &$config_file$& does not contain a slash,
12336 &$config_dir$& is ".".
12337
12338 .vitem &$config_file$&
12339 .vindex "&$config_file$&"
12340 The name of the main configuration file Exim is using.
12341
12342 .vitem &$dkim_verify_status$&
12343 Results of DKIM verification.
12344 For details see section &<<SECDKIMVFY>>&.
12345
12346 .vitem &$dkim_cur_signer$& &&&
12347        &$dkim_verify_reason$& &&&
12348        &$dkim_domain$& &&&
12349        &$dkim_identity$& &&&
12350        &$dkim_selector$& &&&
12351        &$dkim_algo$& &&&
12352        &$dkim_canon_body$& &&&
12353        &$dkim_canon_headers$& &&&
12354        &$dkim_copiedheaders$& &&&
12355        &$dkim_bodylength$& &&&
12356        &$dkim_created$& &&&
12357        &$dkim_expires$& &&&
12358        &$dkim_headernames$& &&&
12359        &$dkim_key_testing$& &&&
12360        &$dkim_key_nosubdomains$& &&&
12361        &$dkim_key_srvtype$& &&&
12362        &$dkim_key_granularity$& &&&
12363        &$dkim_key_notes$& &&&
12364        &$dkim_key_length$&
12365 These variables are only available within the DKIM ACL.
12366 For details see section &<<SECDKIMVFY>>&.
12367
12368 .vitem &$dkim_signers$&
12369 .vindex &$dkim_signers$&
12370 When a message has been received this variable contains
12371 a colon-separated list of signer domains and identities for the message.
12372 For details see section &<<SECDKIMVFY>>&.
12373
12374 .vitem &$dmarc_domain_policy$& &&&
12375        &$dmarc_status$& &&&
12376        &$dmarc_status_text$& &&&
12377        &$dmarc_used_domains$&
12378 Results of DMARC verification.
12379 For details see section &<<SECDMARC>>&.
12380
12381 .vitem &$dnslist_domain$& &&&
12382        &$dnslist_matched$& &&&
12383        &$dnslist_text$& &&&
12384        &$dnslist_value$&
12385 .vindex "&$dnslist_domain$&"
12386 .vindex "&$dnslist_matched$&"
12387 .vindex "&$dnslist_text$&"
12388 .vindex "&$dnslist_value$&"
12389 .cindex "black list (DNS)"
12390 When a DNS (black) list lookup succeeds, these variables are set to contain
12391 the following data from the lookup: the list's domain name, the key that was
12392 looked up, the contents of any associated TXT record, and the value from the
12393 main A record. See section &<<SECID204>>& for more details.
12394
12395 .vitem &$domain$&
12396 .vindex "&$domain$&"
12397 When an address is being routed, or delivered on its own, this variable
12398 contains the domain. Uppercase letters in the domain are converted into lower
12399 case for &$domain$&.
12400
12401 Global address rewriting happens when a message is received, so the value of
12402 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12403 is set during user filtering, but not during system filtering, because a
12404 message may have many recipients and the system filter is called just once.
12405
12406 When more than one address is being delivered at once (for example, several
12407 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12408 have the same domain. Transports can be restricted to handling only one domain
12409 at a time if the value of &$domain$& is required at transport time &-- this is
12410 the default for local transports. For further details of the environment in
12411 which local transports are run, see chapter &<<CHAPenvironment>>&.
12412
12413 .oindex "&%delay_warning_condition%&"
12414 At the end of a delivery, if all deferred addresses have the same domain, it is
12415 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12416
12417 The &$domain$& variable is also used in some other circumstances:
12418
12419 .ilist
12420 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12421 the recipient address. The domain of the &'sender'& address is in
12422 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12423 normally set during the running of the MAIL ACL. However, if the sender address
12424 is verified with a callout during the MAIL ACL, the sender domain is placed in
12425 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12426 the &(smtp)& transport.
12427
12428 .next
12429 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12430 &$domain$& contains the domain portion of the address that is being rewritten;
12431 it can be used in the expansion of the replacement address, for example, to
12432 rewrite domains by file lookup.
12433
12434 .next
12435 With one important exception, whenever a domain list is being scanned,
12436 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12437 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12438 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12439 that, in a RCPT ACL, the sender domain list can be dependent on the
12440 recipient domain (which is what is in &$domain$& at this time).
12441
12442 .next
12443 .cindex "ETRN" "value of &$domain$&"
12444 .oindex "&%smtp_etrn_command%&"
12445 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12446 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12447 .endlist
12448
12449 .new
12450 .cindex "tainted data"
12451 If the origin of the data is an incoming message,
12452 the result of expanding this variable is tainted.
12453 When un untainted version is needed, one should be obtained from
12454 looking up the value in a local (therefore trusted) database.
12455 Often &$domain_data$& is usable in this role.
12456 .wen
12457
12458
12459 .vitem &$domain_data$&
12460 .vindex "&$domain_data$&"
12461 When the &%domains%& condition on a router
12462 .new
12463 or an ACL
12464 matches a domain
12465 against a list, the match value is copied to &$domain_data$&.
12466 This is an enhancement over previous versions of Exim, when it only
12467 applied to the data read by a lookup.
12468 For details on match values see section &<<SECTlistresults>>& et. al.
12469 .wen
12470
12471 If the router routes the
12472 address to a transport, the value is available in that transport. If the
12473 transport is handling multiple addresses, the value from the first address is
12474 used.
12475
12476 &$domain_data$& set in an ACL is available during
12477 the rest of the ACL statement.
12478
12479 .vitem &$exim_gid$&
12480 .vindex "&$exim_gid$&"
12481 This variable contains the numerical value of the Exim group id.
12482
12483 .vitem &$exim_path$&
12484 .vindex "&$exim_path$&"
12485 This variable contains the path to the Exim binary.
12486
12487 .vitem &$exim_uid$&
12488 .vindex "&$exim_uid$&"
12489 This variable contains the numerical value of the Exim user id.
12490
12491 .vitem &$exim_version$&
12492 .vindex "&$exim_version$&"
12493 This variable contains the version string of the Exim build.
12494 The first character is a major version number, currently 4.
12495 Then after a dot, the next group of digits is a minor version number.
12496 There may be other characters following the minor version.
12497 This value may be overridden by the &%exim_version%& main config option.
12498
12499 .vitem &$header_$&<&'name'&>
12500 This is not strictly an expansion variable. It is expansion syntax for
12501 inserting the message header line with the given name. Note that the name must
12502 be terminated by colon or white space, because it may contain a wide variety of
12503 characters. Note also that braces must &'not'& be used.
12504 See the full description in section &<<SECTexpansionitems>>& above.
12505
12506 .vitem &$headers_added$&
12507 .vindex "&$headers_added$&"
12508 Within an ACL this variable contains the headers added so far by
12509 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12510 The headers are a newline-separated list.
12511
12512 .vitem &$home$&
12513 .vindex "&$home$&"
12514 When the &%check_local_user%& option is set for a router, the user's home
12515 directory is placed in &$home$& when the check succeeds. In particular, this
12516 means it is set during the running of users' filter files. A router may also
12517 explicitly set a home directory for use by a transport; this can be overridden
12518 by a setting on the transport itself.
12519
12520 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12521 of the environment variable HOME, which is subject to the
12522 &%keep_environment%& and &%add_environment%& main config options.
12523
12524 .vitem &$host$&
12525 .vindex "&$host$&"
12526 If a router assigns an address to a transport (any transport), and passes a
12527 list of hosts with the address, the value of &$host$& when the transport starts
12528 to run is the name of the first host on the list. Note that this applies both
12529 to local and remote transports.
12530
12531 .cindex "transport" "filter"
12532 .cindex "filter" "transport filter"
12533 For the &(smtp)& transport, if there is more than one host, the value of
12534 &$host$& changes as the transport works its way through the list. In
12535 particular, when the &(smtp)& transport is expanding its options for encryption
12536 using TLS, or for specifying a transport filter (see chapter
12537 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12538 is connected.
12539
12540 When used in the client part of an authenticator configuration (see chapter
12541 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12542 client is connected.
12543
12544
12545 .vitem &$host_address$&
12546 .vindex "&$host_address$&"
12547 This variable is set to the remote host's IP address whenever &$host$& is set
12548 for a remote connection. It is also set to the IP address that is being checked
12549 when the &%ignore_target_hosts%& option is being processed.
12550
12551 .vitem &$host_data$&
12552 .vindex "&$host_data$&"
12553 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12554 result of the lookup is made available in the &$host_data$& variable. This
12555 allows you, for example, to do things like this:
12556 .code
12557 deny  hosts = net-lsearch;/some/file
12558       message = $host_data
12559 .endd
12560 .vitem &$host_lookup_deferred$&
12561 .cindex "host name" "lookup, failure of"
12562 .vindex "&$host_lookup_deferred$&"
12563 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12564 message comes from a remote host and there is an attempt to look up the host's
12565 name from its IP address, and the attempt is not successful, one of these
12566 variables is set to &"1"&.
12567
12568 .ilist
12569 If the lookup receives a definite negative response (for example, a DNS lookup
12570 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12571
12572 .next
12573 If there is any kind of problem during the lookup, such that Exim cannot
12574 tell whether or not the host name is defined (for example, a timeout for a DNS
12575 lookup), &$host_lookup_deferred$& is set to &"1"&.
12576 .endlist ilist
12577
12578 Looking up a host's name from its IP address consists of more than just a
12579 single reverse lookup. Exim checks that a forward lookup of at least one of the
12580 names it receives from a reverse lookup yields the original IP address. If this
12581 is not the case, Exim does not accept the looked up name(s), and
12582 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12583 IP address (for example, the existence of a PTR record in the DNS) is not
12584 sufficient on its own for the success of a host name lookup. If the reverse
12585 lookup succeeds, but there is a lookup problem such as a timeout when checking
12586 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12587 &"1"&. See also &$sender_host_name$&.
12588
12589 .cindex authentication "expansion item"
12590 Performing these checks sets up information used by the
12591 &%authresults%& expansion item.
12592
12593
12594 .vitem &$host_lookup_failed$&
12595 .vindex "&$host_lookup_failed$&"
12596 See &$host_lookup_deferred$&.
12597
12598 .vitem &$host_port$&
12599 .vindex "&$host_port$&"
12600 This variable is set to the remote host's TCP port whenever &$host$& is set
12601 for an outbound connection.
12602
12603 .vitem &$initial_cwd$&
12604 .vindex "&$initial_cwd$&
12605 This variable contains the full path name of the initial working
12606 directory of the current Exim process. This may differ from the current
12607 working directory, as Exim changes this to "/" during early startup, and
12608 to &$spool_directory$& later.
12609
12610 .vitem &$inode$&
12611 .vindex "&$inode$&"
12612 The only time this variable is set is while expanding the &%directory_file%&
12613 option in the &(appendfile)& transport. The variable contains the inode number
12614 of the temporary file which is about to be renamed. It can be used to construct
12615 a unique name for the file.
12616
12617 .vitem &$interface_address$&
12618 .vindex "&$interface_address$&"
12619 This is an obsolete name for &$received_ip_address$&.
12620
12621 .vitem &$interface_port$&
12622 .vindex "&$interface_port$&"
12623 This is an obsolete name for &$received_port$&.
12624
12625 .vitem &$item$&
12626 .vindex "&$item$&"
12627 This variable is used during the expansion of &*forall*& and &*forany*&
12628 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12629 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12630 empty.
12631
12632 .vitem &$ldap_dn$&
12633 .vindex "&$ldap_dn$&"
12634 This variable, which is available only when Exim is compiled with LDAP support,
12635 contains the DN from the last entry in the most recently successful LDAP
12636 lookup.
12637
12638 .vitem &$load_average$&
12639 .vindex "&$load_average$&"
12640 This variable contains the system load average, multiplied by 1000 so that it
12641 is an integer. For example, if the load average is 0.21, the value of the
12642 variable is 210. The value is recomputed every time the variable is referenced.
12643
12644 .vitem &$local_part$&
12645 .vindex "&$local_part$&"
12646 When an address is being routed, or delivered on its own, this
12647 variable contains the local part. When a number of addresses are being
12648 delivered together (for example, multiple RCPT commands in an SMTP
12649 session), &$local_part$& is not set.
12650
12651 Global address rewriting happens when a message is received, so the value of
12652 &$local_part$& during routing and delivery is the value after rewriting.
12653 &$local_part$& is set during user filtering, but not during system filtering,
12654 because a message may have many recipients and the system filter is called just
12655 once.
12656
12657 .new
12658 .cindex "tainted data"
12659 If the origin of the data is an incoming message,
12660 the result of expanding this variable is tainted.
12661
12662 &*Warning*&: the content of this variable is usually provided by a potential
12663 attacker.
12664 Consider carefully the implications of using it unvalidated as a name
12665 for file access.
12666 This presents issues for users' &_.forward_& and filter files.
12667 For traditional full user accounts, use &%check_local_users%& and the
12668 &$local_part_data$& variable rather than this one.
12669 For virtual users, store a suitable pathname component in the database
12670 which is used for account name validation, and use that retrieved value
12671 rather than this variable.
12672 Often &$local_part_data$& is usable in this role.
12673 If needed, use a router &%address_data%& or &%set%& option for
12674 the retrieved data.
12675 .wen
12676
12677 When a message is being delivered to a file, pipe, or autoreply transport as a
12678 result of aliasing or forwarding, &$local_part$& is set to the local part of
12679 the parent address, not to the filename or command (see &$address_file$& and
12680 &$address_pipe$&).
12681
12682 When an ACL is running for a RCPT command, &$local_part$& contains the
12683 local part of the recipient address.
12684
12685 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12686 &$local_part$& contains the local part of the address that is being rewritten;
12687 it can be used in the expansion of the replacement address, for example.
12688
12689 In all cases, all quoting is removed from the local part. For example, for both
12690 the addresses
12691 .code
12692 "abc:xyz"@test.example
12693 abc\:xyz@test.example
12694 .endd
12695 the value of &$local_part$& is
12696 .code
12697 abc:xyz
12698 .endd
12699 If you use &$local_part$& to create another address, you should always wrap it
12700 inside a quoting operator. For example, in a &(redirect)& router you could
12701 have:
12702 .code
12703 data = ${quote_local_part:$local_part}@new.domain.example
12704 .endd
12705 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12706 to process local parts in a case-dependent manner in a router, you can set the
12707 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12708
12709 .vitem &$local_part_data$&
12710 .vindex "&$local_part_data$&"
12711 When the &%local_parts%& condition on a router or ACL
12712 matches a local part list
12713 .new
12714 the match value is copied to &$local_part_data$&.
12715 This is an enhancement over previous versions of Exim, when it only
12716 applied to the data read by a lookup.
12717 For details on match values see section &<<SECTlistresults>>& et. al.
12718 .wen
12719
12720 .new
12721 The &%check_local_user%& router option also sets this variable.
12722 .wen
12723
12724 .vindex &$local_part_prefix$& &&&
12725         &$local_part_prefix_v$& &&&
12726         &$local_part_suffix$& &&&
12727         &$local_part_suffix_v$&
12728 .cindex affix variables
12729 If a local part prefix or suffix has been recognized, it is not included in the
12730 value of &$local_part$& during routing and subsequent delivery. The values of
12731 any prefix or suffix are in &$local_part_prefix$& and
12732 &$local_part_suffix$&, respectively.
12733 .new
12734 .cindex "tainted data"
12735 If the specification did not include a wildcard then
12736 the affix variable value is not tainted.
12737
12738 If the affix specification included a wildcard then the portion of
12739 the affix matched by the wildcard is in
12740 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12741 and both the whole and varying values are tainted.
12742 .wen
12743
12744 .vitem &$local_scan_data$&
12745 .vindex "&$local_scan_data$&"
12746 This variable contains the text returned by the &[local_scan()]& function when
12747 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12748
12749 .vitem &$local_user_gid$&
12750 .vindex "&$local_user_gid$&"
12751 See &$local_user_uid$&.
12752
12753 .vitem &$local_user_uid$&
12754 .vindex "&$local_user_uid$&"
12755 This variable and &$local_user_gid$& are set to the uid and gid after the
12756 &%check_local_user%& router precondition succeeds. This means that their values
12757 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12758 and &%condition%&), for the &%address_data%& expansion, and for any
12759 router-specific expansions. At all other times, the values in these variables
12760 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12761
12762 .vitem &$localhost_number$&
12763 .vindex "&$localhost_number$&"
12764 This contains the expanded value of the
12765 &%localhost_number%& option. The expansion happens after the main options have
12766 been read.
12767
12768 .vitem &$log_inodes$&
12769 .vindex "&$log_inodes$&"
12770 The number of free inodes in the disk partition where Exim's
12771 log files are being written. The value is recalculated whenever the variable is
12772 referenced. If the relevant file system does not have the concept of inodes,
12773 the value of is -1. See also the &%check_log_inodes%& option.
12774
12775 .vitem &$log_space$&
12776 .vindex "&$log_space$&"
12777 The amount of free space (as a number of kilobytes) in the disk
12778 partition where Exim's log files are being written. The value is recalculated
12779 whenever the variable is referenced. If the operating system does not have the
12780 ability to find the amount of free space (only true for experimental systems),
12781 the space value is -1. See also the &%check_log_space%& option.
12782
12783
12784 .vitem &$lookup_dnssec_authenticated$&
12785 .vindex "&$lookup_dnssec_authenticated$&"
12786 This variable is set after a DNS lookup done by
12787 a dnsdb lookup expansion, dnslookup router or smtp transport.
12788 .cindex "DNS" "DNSSEC"
12789 It will be empty if &(DNSSEC)& was not requested,
12790 &"no"& if the result was not labelled as authenticated data
12791 and &"yes"& if it was.
12792 Results that are labelled as authoritative answer that match
12793 the &%dns_trust_aa%& configuration variable count also
12794 as authenticated data.
12795
12796 .vitem &$mailstore_basename$&
12797 .vindex "&$mailstore_basename$&"
12798 This variable is set only when doing deliveries in &"mailstore"& format in the
12799 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12800 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12801 contains the basename of the files that are being written, that is, the name
12802 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12803 variable is empty.
12804
12805 .vitem &$malware_name$&
12806 .vindex "&$malware_name$&"
12807 This variable is available when Exim is compiled with the
12808 content-scanning extension. It is set to the name of the virus that was found
12809 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12810
12811 .vitem &$max_received_linelength$&
12812 .vindex "&$max_received_linelength$&"
12813 .cindex "maximum" "line length"
12814 .cindex "line length" "maximum"
12815 This variable contains the number of bytes in the longest line that was
12816 received as part of the message, not counting the line termination
12817 character(s).
12818 It is not valid if the &%spool_files_wireformat%& option is used.
12819
12820 .vitem &$message_age$&
12821 .cindex "message" "age of"
12822 .vindex "&$message_age$&"
12823 This variable is set at the start of a delivery attempt to contain the number
12824 of seconds since the message was received. It does not change during a single
12825 delivery attempt.
12826
12827 .vitem &$message_body$&
12828 .cindex "body of message" "expansion variable"
12829 .cindex "message body" "in expansion"
12830 .cindex "binary zero" "in message body"
12831 .vindex "&$message_body$&"
12832 .oindex "&%message_body_visible%&"
12833 This variable contains the initial portion of a message's body while it is
12834 being delivered, and is intended mainly for use in filter files. The maximum
12835 number of characters of the body that are put into the variable is set by the
12836 &%message_body_visible%& configuration option; the default is 500.
12837
12838 .oindex "&%message_body_newlines%&"
12839 By default, newlines are converted into spaces in &$message_body$&, to make it
12840 easier to search for phrases that might be split over a line break. However,
12841 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12842 zeros are always converted into spaces.
12843
12844 .vitem &$message_body_end$&
12845 .cindex "body of message" "expansion variable"
12846 .cindex "message body" "in expansion"
12847 .vindex "&$message_body_end$&"
12848 This variable contains the final portion of a message's
12849 body while it is being delivered. The format and maximum size are as for
12850 &$message_body$&.
12851
12852 .vitem &$message_body_size$&
12853 .cindex "body of message" "size"
12854 .cindex "message body" "size"
12855 .vindex "&$message_body_size$&"
12856 When a message is being delivered, this variable contains the size of the body
12857 in bytes. The count starts from the character after the blank line that
12858 separates the body from the header. Newlines are included in the count. See
12859 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12860
12861 If the spool file is wireformat
12862 (see the &%spool_files_wireformat%& main option)
12863 the CRLF line-terminators are included in the count.
12864
12865 .vitem &$message_exim_id$&
12866 .vindex "&$message_exim_id$&"
12867 When a message is being received or delivered, this variable contains the
12868 unique message id that is generated and used by Exim to identify the message.
12869 An id is not created for a message until after its header has been successfully
12870 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12871 line; it is the local id that Exim assigns to the message, for example:
12872 &`1BXTIK-0001yO-VA`&.
12873
12874 .vitem &$message_headers$&
12875 .vindex &$message_headers$&
12876 This variable contains a concatenation of all the header lines when a message
12877 is being processed, except for lines added by routers or transports. The header
12878 lines are separated by newline characters. Their contents are decoded in the
12879 same way as a header line that is inserted by &%bheader%&.
12880
12881 .vitem &$message_headers_raw$&
12882 .vindex &$message_headers_raw$&
12883 This variable is like &$message_headers$& except that no processing of the
12884 contents of header lines is done.
12885
12886 .vitem &$message_id$&
12887 This is an old name for &$message_exim_id$&. It is now deprecated.
12888
12889 .vitem &$message_linecount$&
12890 .vindex "&$message_linecount$&"
12891 This variable contains the total number of lines in the header and body of the
12892 message. Compare &$body_linecount$&, which is the count for the body only.
12893 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12894 number of lines received. Before delivery happens (that is, before filters,
12895 routers, and transports run) the count is increased to include the
12896 &'Received:'& header line that Exim standardly adds, and also any other header
12897 lines that are added by ACLs. The blank line that separates the message header
12898 from the body is not counted.
12899
12900 As with the special case of &$message_size$&, during the expansion of the
12901 appendfile transport's maildir_tag option in maildir format, the value of
12902 &$message_linecount$& is the precise size of the number of newlines in the
12903 file that has been written (minus one for the blank line between the
12904 header and the body).
12905
12906 Here is an example of the use of this variable in a DATA ACL:
12907 .code
12908 deny condition = \
12909       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12910      message   = Too many lines in message header
12911 .endd
12912 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12913 message has not yet been received.
12914
12915 This variable is not valid if the &%spool_files_wireformat%& option is used.
12916
12917 .vitem &$message_size$&
12918 .cindex "size" "of message"
12919 .cindex "message" "size"
12920 .vindex "&$message_size$&"
12921 When a message is being processed, this variable contains its size in bytes. In
12922 most cases, the size includes those headers that were received with the
12923 message, but not those (such as &'Envelope-to:'&) that are added to individual
12924 deliveries as they are written. However, there is one special case: during the
12925 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12926 doing a delivery in maildir format, the value of &$message_size$& is the
12927 precise size of the file that has been written. See also
12928 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12929
12930 .cindex "RCPT" "value of &$message_size$&"
12931 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12932 contains the size supplied on the MAIL command, or -1 if no size was given. The
12933 value may not, of course, be truthful.
12934
12935 .vitem &$mime_$&&'xxx'&
12936 A number of variables whose names start with &$mime$& are
12937 available when Exim is compiled with the content-scanning extension. For
12938 details, see section &<<SECTscanmimepart>>&.
12939
12940 .vitem "&$n0$& &-- &$n9$&"
12941 These variables are counters that can be incremented by means
12942 of the &%add%& command in filter files.
12943
12944 .vitem &$original_domain$&
12945 .vindex "&$domain$&"
12946 .vindex "&$original_domain$&"
12947 When a top-level address is being processed for delivery, this contains the
12948 same value as &$domain$&. However, if a &"child"& address (for example,
12949 generated by an alias, forward, or filter file) is being processed, this
12950 variable contains the domain of the original address (lower cased). This
12951 differs from &$parent_domain$& only when there is more than one level of
12952 aliasing or forwarding. When more than one address is being delivered in a
12953 single transport run, &$original_domain$& is not set.
12954
12955 If a new address is created by means of a &%deliver%& command in a system
12956 filter, it is set up with an artificial &"parent"& address. This has the local
12957 part &'system-filter'& and the default qualify domain.
12958
12959 .vitem &$original_local_part$&
12960 .vindex "&$local_part$&"
12961 .vindex "&$original_local_part$&"
12962 When a top-level address is being processed for delivery, this contains the
12963 same value as &$local_part$&, unless a prefix or suffix was removed from the
12964 local part, because &$original_local_part$& always contains the full local
12965 part. When a &"child"& address (for example, generated by an alias, forward, or
12966 filter file) is being processed, this variable contains the full local part of
12967 the original address.
12968
12969 If the router that did the redirection processed the local part
12970 case-insensitively, the value in &$original_local_part$& is in lower case.
12971 This variable differs from &$parent_local_part$& only when there is more than
12972 one level of aliasing or forwarding. When more than one address is being
12973 delivered in a single transport run, &$original_local_part$& is not set.
12974
12975 If a new address is created by means of a &%deliver%& command in a system
12976 filter, it is set up with an artificial &"parent"& address. This has the local
12977 part &'system-filter'& and the default qualify domain.
12978
12979 .vitem &$originator_gid$&
12980 .cindex "gid (group id)" "of originating user"
12981 .cindex "sender" "gid"
12982 .vindex "&$caller_gid$&"
12983 .vindex "&$originator_gid$&"
12984 This variable contains the value of &$caller_gid$& that was set when the
12985 message was received. For messages received via the command line, this is the
12986 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12987 normally the gid of the Exim user.
12988
12989 .vitem &$originator_uid$&
12990 .cindex "uid (user id)" "of originating user"
12991 .cindex "sender" "uid"
12992 .vindex "&$caller_uid$&"
12993 .vindex "&$originator_uid$&"
12994 The value of &$caller_uid$& that was set when the message was received. For
12995 messages received via the command line, this is the uid of the sending user.
12996 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12997 user.
12998
12999 .vitem &$parent_domain$&
13000 .vindex "&$parent_domain$&"
13001 This variable is similar to &$original_domain$& (see
13002 above), except that it refers to the immediately preceding parent address.
13003
13004 .vitem &$parent_local_part$&
13005 .vindex "&$parent_local_part$&"
13006 This variable is similar to &$original_local_part$&
13007 (see above), except that it refers to the immediately preceding parent address.
13008
13009 .vitem &$pid$&
13010 .cindex "pid (process id)" "of current process"
13011 .vindex "&$pid$&"
13012 This variable contains the current process id.
13013
13014 .vitem &$pipe_addresses$&
13015 .cindex "filter" "transport filter"
13016 .cindex "transport" "filter"
13017 .vindex "&$pipe_addresses$&"
13018 This is not an expansion variable, but is mentioned here because the string
13019 &`$pipe_addresses`& is handled specially in the command specification for the
13020 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13021 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13022 It cannot be used in general expansion strings, and provokes an &"unknown
13023 variable"& error if encountered.
13024
13025 .vitem &$primary_hostname$&
13026 .vindex "&$primary_hostname$&"
13027 This variable contains the value set by &%primary_hostname%& in the
13028 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13029 a single-component name, Exim calls &[gethostbyname()]& (or
13030 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13031 qualified host name. See also &$smtp_active_hostname$&.
13032
13033
13034 .vitem &$proxy_external_address$& &&&
13035        &$proxy_external_port$& &&&
13036        &$proxy_local_address$& &&&
13037        &$proxy_local_port$& &&&
13038        &$proxy_session$&
13039 These variables are only available when built with Proxy Protocol
13040 or SOCKS5 support.
13041 For details see chapter &<<SECTproxyInbound>>&.
13042
13043 .vitem &$prdr_requested$&
13044 .cindex "PRDR" "variable for"
13045 This variable is set to &"yes"& if PRDR was requested by the client for the
13046 current message, otherwise &"no"&.
13047
13048 .vitem &$prvscheck_address$&
13049 This variable is used in conjunction with the &%prvscheck%& expansion item,
13050 which is described in sections &<<SECTexpansionitems>>& and
13051 &<<SECTverifyPRVS>>&.
13052
13053 .vitem &$prvscheck_keynum$&
13054 This variable is used in conjunction with the &%prvscheck%& expansion item,
13055 which is described in sections &<<SECTexpansionitems>>& and
13056 &<<SECTverifyPRVS>>&.
13057
13058 .vitem &$prvscheck_result$&
13059 This variable is used in conjunction with the &%prvscheck%& expansion item,
13060 which is described in sections &<<SECTexpansionitems>>& and
13061 &<<SECTverifyPRVS>>&.
13062
13063 .vitem &$qualify_domain$&
13064 .vindex "&$qualify_domain$&"
13065 The value set for the &%qualify_domain%& option in the configuration file.
13066
13067 .vitem &$qualify_recipient$&
13068 .vindex "&$qualify_recipient$&"
13069 The value set for the &%qualify_recipient%& option in the configuration file,
13070 or if not set, the value of &$qualify_domain$&.
13071
13072 .vitem &$queue_name$&
13073 .vindex &$queue_name$&
13074 .cindex "named queues" variable
13075 .cindex queues named
13076 The name of the spool queue in use; empty for the default queue.
13077
13078 .vitem &$queue_size$&
13079 .vindex "&$queue_size$&"
13080 .cindex "queue" "size of"
13081 .cindex "spool" "number of messages"
13082 This variable contains the number of messages queued.
13083 It is evaluated on demand, but no more often than once every minute.
13084
13085 .vitem &$r_...$&
13086 .vindex &$r_...$&
13087 .cindex router variables
13088 Values can be placed in these variables by the &%set%& option of a router.
13089 They can be given any name that starts with &$r_$&.
13090 The values persist for the address being handled through subsequent routers
13091 and the eventual transport.
13092
13093 .vitem &$rcpt_count$&
13094 .vindex "&$rcpt_count$&"
13095 When a message is being received by SMTP, this variable contains the number of
13096 RCPT commands received for the current message. If this variable is used in a
13097 RCPT ACL, its value includes the current command.
13098
13099 .vitem &$rcpt_defer_count$&
13100 .vindex "&$rcpt_defer_count$&"
13101 .cindex "4&'xx'& responses" "count of"
13102 When a message is being received by SMTP, this variable contains the number of
13103 RCPT commands in the current message that have previously been rejected with a
13104 temporary (4&'xx'&) response.
13105
13106 .vitem &$rcpt_fail_count$&
13107 .vindex "&$rcpt_fail_count$&"
13108 When a message is being received by SMTP, this variable contains the number of
13109 RCPT commands in the current message that have previously been rejected with a
13110 permanent (5&'xx'&) response.
13111
13112 .vitem &$received_count$&
13113 .vindex "&$received_count$&"
13114 This variable contains the number of &'Received:'& header lines in the message,
13115 including the one added by Exim (so its value is always greater than zero). It
13116 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13117 delivering.
13118
13119 .vitem &$received_for$&
13120 .vindex "&$received_for$&"
13121 If there is only a single recipient address in an incoming message, this
13122 variable contains that address when the &'Received:'& header line is being
13123 built. The value is copied after recipient rewriting has happened, but before
13124 the &[local_scan()]& function is run.
13125
13126 .vitem &$received_ip_address$&
13127 .vindex "&$received_ip_address$&"
13128 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13129 variable is set to the address of the local IP interface, and &$received_port$&
13130 is set to the local port number. (The remote IP address and port are in
13131 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13132 the port value is -1 unless it has been set using the &%-oMi%& command line
13133 option.
13134
13135 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13136 could be used, for example, to make the filename for a TLS certificate depend
13137 on which interface and/or port is being used for the incoming connection. The
13138 values of &$received_ip_address$& and &$received_port$& are saved with any
13139 messages that are received, thus making these variables available at delivery
13140 time.
13141 For outbound connections see &$sending_ip_address$&.
13142
13143 .vitem &$received_port$&
13144 .vindex "&$received_port$&"
13145 See &$received_ip_address$&.
13146
13147 .vitem &$received_protocol$&
13148 .vindex "&$received_protocol$&"
13149 When a message is being processed, this variable contains the name of the
13150 protocol by which it was received. Most of the names used by Exim are defined
13151 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13152 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13153 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13154 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13155 connection and the client was successfully authenticated.
13156
13157 Exim uses the protocol name &"smtps"& for the case when encryption is
13158 automatically set up on connection without the use of STARTTLS (see
13159 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13160 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13161 where the client initially uses EHLO, sets up an encrypted connection using
13162 STARTTLS, and then uses HELO afterwards.
13163
13164 The &%-oMr%& option provides a way of specifying a custom protocol name for
13165 messages that are injected locally by trusted callers. This is commonly used to
13166 identify messages that are being re-injected after some kind of scanning.
13167
13168 .vitem &$received_time$&
13169 .vindex "&$received_time$&"
13170 This variable contains the date and time when the current message was received,
13171 as a number of seconds since the start of the Unix epoch.
13172
13173 .vitem &$recipient_data$&
13174 .vindex "&$recipient_data$&"
13175 This variable is set after an indexing lookup success in an ACL &%recipients%&
13176 condition. It contains the data from the lookup, and the value remains set
13177 until the next &%recipients%& test. Thus, you can do things like this:
13178 .display
13179 &`require recipients  = cdb*@;/some/file`&
13180 &`deny    `&&'some further test involving'& &`$recipient_data`&
13181 .endd
13182 &*Warning*&: This variable is set only when a lookup is used as an indexing
13183 method in the address list, using the semicolon syntax as in the example above.
13184 The variable is not set for a lookup that is used as part of the string
13185 expansion that all such lists undergo before being interpreted.
13186
13187 .vitem &$recipient_verify_failure$&
13188 .vindex "&$recipient_verify_failure$&"
13189 In an ACL, when a recipient verification fails, this variable contains
13190 information about the failure. It is set to one of the following words:
13191
13192 .ilist
13193 &"qualify"&: The address was unqualified (no domain), and the message
13194 was neither local nor came from an exempted host.
13195
13196 .next
13197 &"route"&: Routing failed.
13198
13199 .next
13200 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13201 or before the MAIL command (that is, on initial connection, HELO, or
13202 MAIL).
13203
13204 .next
13205 &"recipient"&: The RCPT command in a callout was rejected.
13206 .next
13207
13208 &"postmaster"&: The postmaster check in a callout was rejected.
13209 .endlist
13210
13211 The main use of this variable is expected to be to distinguish between
13212 rejections of MAIL and rejections of RCPT.
13213
13214 .vitem &$recipients$&
13215 .vindex "&$recipients$&"
13216 This variable contains a list of envelope recipients for a message. A comma and
13217 a space separate the addresses in the replacement text. However, the variable
13218 is not generally available, to prevent exposure of Bcc recipients in
13219 unprivileged users' filter files. You can use &$recipients$& only in these
13220 cases:
13221
13222 .olist
13223 In a system filter file.
13224 .next
13225 In the ACLs associated with the DATA command and with non-SMTP messages, that
13226 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13227 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13228 &%acl_not_smtp_mime%&.
13229 .next
13230 From within a &[local_scan()]& function.
13231 .endlist
13232
13233
13234 .vitem &$recipients_count$&
13235 .vindex "&$recipients_count$&"
13236 When a message is being processed, this variable contains the number of
13237 envelope recipients that came with the message. Duplicates are not excluded
13238 from the count. While a message is being received over SMTP, the number
13239 increases for each accepted recipient. It can be referenced in an ACL.
13240
13241
13242 .vitem &$regex_match_string$&
13243 .vindex "&$regex_match_string$&"
13244 This variable is set to contain the matching regular expression after a
13245 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13246
13247 .vitem "&$regex1$&, &$regex2$&, etc"
13248 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13249 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13250 these variables contain the
13251 captured substrings identified by the regular expression.
13252
13253
13254 .vitem &$reply_address$&
13255 .vindex "&$reply_address$&"
13256 When a message is being processed, this variable contains the contents of the
13257 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13258 contents of the &'From:'& header line. Apart from the removal of leading
13259 white space, the value is not processed in any way. In particular, no RFC 2047
13260 decoding or character code translation takes place.
13261
13262 .vitem &$return_path$&
13263 .vindex "&$return_path$&"
13264 When a message is being delivered, this variable contains the return path &--
13265 the sender field that will be sent as part of the envelope. It is not enclosed
13266 in <> characters. At the start of routing an address, &$return_path$& has the
13267 same value as &$sender_address$&, but if, for example, an incoming message to a
13268 mailing list has been expanded by a router which specifies a different address
13269 for bounce messages, &$return_path$& subsequently contains the new bounce
13270 address, whereas &$sender_address$& always contains the original sender address
13271 that was received with the message. In other words, &$sender_address$& contains
13272 the incoming envelope sender, and &$return_path$& contains the outgoing
13273 envelope sender.
13274
13275 .vitem &$return_size_limit$&
13276 .vindex "&$return_size_limit$&"
13277 This is an obsolete name for &$bounce_return_size_limit$&.
13278
13279 .vitem &$router_name$&
13280 .cindex "router" "name"
13281 .cindex "name" "of router"
13282 .vindex "&$router_name$&"
13283 During the running of a router this variable contains its name.
13284
13285 .vitem &$runrc$&
13286 .cindex "return code" "from &%run%& expansion"
13287 .vindex "&$runrc$&"
13288 This variable contains the return code from a command that is run by the
13289 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13290 assume the order in which option values are expanded, except for those
13291 preconditions whose order of testing is documented. Therefore, you cannot
13292 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13293 another.
13294
13295 .vitem &$self_hostname$&
13296 .oindex "&%self%&" "value of host name"
13297 .vindex "&$self_hostname$&"
13298 When an address is routed to a supposedly remote host that turns out to be the
13299 local host, what happens is controlled by the &%self%& generic router option.
13300 One of its values causes the address to be passed to another router. When this
13301 happens, &$self_hostname$& is set to the name of the local host that the
13302 original router encountered. In other circumstances its contents are null.
13303
13304 .vitem &$sender_address$&
13305 .vindex "&$sender_address$&"
13306 When a message is being processed, this variable contains the sender's address
13307 that was received in the message's envelope. The case of letters in the address
13308 is retained, in both the local part and the domain. For bounce messages, the
13309 value of this variable is the empty string. See also &$return_path$&.
13310
13311 .vitem &$sender_address_data$&
13312 .vindex "&$address_data$&"
13313 .vindex "&$sender_address_data$&"
13314 If &$address_data$& is set when the routers are called from an ACL to verify a
13315 sender address, the final value is preserved in &$sender_address_data$&, to
13316 distinguish it from data from a recipient address. The value does not persist
13317 after the end of the current ACL statement. If you want to preserve it for
13318 longer, you can save it in an ACL variable.
13319
13320 .vitem &$sender_address_domain$&
13321 .vindex "&$sender_address_domain$&"
13322 The domain portion of &$sender_address$&.
13323
13324 .vitem &$sender_address_local_part$&
13325 .vindex "&$sender_address_local_part$&"
13326 The local part portion of &$sender_address$&.
13327
13328 .vitem &$sender_data$&
13329 .vindex "&$sender_data$&"
13330 This variable is set after a lookup success in an ACL &%senders%& condition or
13331 in a router &%senders%& option. It contains the data from the lookup, and the
13332 value remains set until the next &%senders%& test. Thus, you can do things like
13333 this:
13334 .display
13335 &`require senders      = cdb*@;/some/file`&
13336 &`deny    `&&'some further test involving'& &`$sender_data`&
13337 .endd
13338 &*Warning*&: This variable is set only when a lookup is used as an indexing
13339 method in the address list, using the semicolon syntax as in the example above.
13340 The variable is not set for a lookup that is used as part of the string
13341 expansion that all such lists undergo before being interpreted.
13342
13343 .vitem &$sender_fullhost$&
13344 .vindex "&$sender_fullhost$&"
13345 When a message is received from a remote host, this variable contains the host
13346 name and IP address in a single string. It ends with the IP address in square
13347 brackets, followed by a colon and a port number if the logging of ports is
13348 enabled. The format of the rest of the string depends on whether the host
13349 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13350 looking up its IP address. (Looking up the IP address can be forced by the
13351 &%host_lookup%& option, independent of verification.) A plain host name at the
13352 start of the string is a verified host name; if this is not present,
13353 verification either failed or was not requested. A host name in parentheses is
13354 the argument of a HELO or EHLO command. This is omitted if it is identical to
13355 the verified host name or to the host's IP address in square brackets.
13356
13357 .vitem &$sender_helo_dnssec$&
13358 .vindex "&$sender_helo_dnssec$&"
13359 This boolean variable is true if a successful HELO verification was
13360 .cindex "DNS" "DNSSEC"
13361 done using DNS information the resolver library stated was authenticated data.
13362
13363 .vitem &$sender_helo_name$&
13364 .vindex "&$sender_helo_name$&"
13365 When a message is received from a remote host that has issued a HELO or EHLO
13366 command, the argument of that command is placed in this variable. It is also
13367 set if HELO or EHLO is used when a message is received using SMTP locally via
13368 the &%-bs%& or &%-bS%& options.
13369
13370 .vitem &$sender_host_address$&
13371 .vindex "&$sender_host_address$&"
13372 When a message is received from a remote host using SMTP,
13373 this variable contains that
13374 host's IP address. For locally non-SMTP submitted messages, it is empty.
13375
13376 .vitem &$sender_host_authenticated$&
13377 .vindex "&$sender_host_authenticated$&"
13378 This variable contains the name (not the public name) of the authenticator
13379 driver that successfully authenticated the client from which the message was
13380 received. It is empty if there was no successful authentication. See also
13381 &$authenticated_id$&.
13382
13383 .vitem &$sender_host_dnssec$&
13384 .vindex "&$sender_host_dnssec$&"
13385 If an attempt to populate &$sender_host_name$& has been made
13386 (by reference, &%hosts_lookup%& or
13387 otherwise) then this boolean will have been set true if, and only if, the
13388 resolver library states that both
13389 the reverse and forward DNS were authenticated data.  At all
13390 other times, this variable is false.
13391
13392 .cindex "DNS" "DNSSEC"
13393 It is likely that you will need to coerce DNSSEC support on in the resolver
13394 library, by setting:
13395 .code
13396 dns_dnssec_ok = 1
13397 .endd
13398
13399 .new
13400 In addition, on Linux with glibc 2.31 or newer the resolver library will
13401 default to stripping out a successful validation status.
13402 This will break a previously working Exim installation.
13403 Provided that you do trust the resolver (ie, is on localhost) you can tell
13404 glibc to pass through any successful validation with a new option in
13405 &_/etc/resolv.conf_&:
13406 .code
13407 options trust-ad
13408 .endd
13409 .wen
13410
13411 Exim does not perform DNSSEC validation itself, instead leaving that to a
13412 validating resolver (e.g. unbound, or bind with suitable configuration).
13413
13414 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13415 mechanism in the list, then this variable will be false.
13416
13417 This requires that your system resolver library support EDNS0 (and that
13418 DNSSEC flags exist in the system headers).  If the resolver silently drops
13419 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13420 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13421
13422
13423 .vitem &$sender_host_name$&
13424 .vindex "&$sender_host_name$&"
13425 When a message is received from a remote host, this variable contains the
13426 host's name as obtained by looking up its IP address. For messages received by
13427 other means, this variable is empty.
13428
13429 .vindex "&$host_lookup_failed$&"
13430 If the host name has not previously been looked up, a reference to
13431 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13432 A looked up name is accepted only if it leads back to the original IP address
13433 via a forward lookup. If either the reverse or the forward lookup fails to find
13434 any data, or if the forward lookup does not yield the original IP address,
13435 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13436
13437 .vindex "&$host_lookup_deferred$&"
13438 However, if either of the lookups cannot be completed (for example, there is a
13439 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13440 &$host_lookup_failed$& remains set to &"0"&.
13441
13442 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13443 host name again if there is a subsequent reference to &$sender_host_name$&
13444 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13445 is set to &"1"&.
13446
13447 Exim does not automatically look up every calling host's name. If you want
13448 maximum efficiency, you should arrange your configuration so that it avoids
13449 these lookups altogether. The lookup happens only if one or more of the
13450 following are true:
13451
13452 .ilist
13453 A string containing &$sender_host_name$& is expanded.
13454 .next
13455 The calling host matches the list in &%host_lookup%&. In the default
13456 configuration, this option is set to *, so it must be changed if lookups are
13457 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13458 .next
13459 Exim needs the host name in order to test an item in a host list. The items
13460 that require this are described in sections &<<SECThoslispatnam>>& and
13461 &<<SECThoslispatnamsk>>&.
13462 .next
13463 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13464 In this case, the host name is required to compare with the name quoted in any
13465 EHLO or HELO commands that the client issues.
13466 .next
13467 The remote host issues a EHLO or HELO command that quotes one of the
13468 domains in &%helo_lookup_domains%&. The default value of this option is
13469 . ==== As this is a nested list, any displays it contains must be indented
13470 . ==== as otherwise they are too far to the left.
13471 .code
13472   helo_lookup_domains = @ : @[]
13473 .endd
13474 which causes a lookup if a remote host (incorrectly) gives the server's name or
13475 IP address in an EHLO or HELO command.
13476 .endlist
13477
13478
13479 .vitem &$sender_host_port$&
13480 .vindex "&$sender_host_port$&"
13481 When a message is received from a remote host, this variable contains the port
13482 number that was used on the remote host.
13483
13484 .vitem &$sender_ident$&
13485 .vindex "&$sender_ident$&"
13486 When a message is received from a remote host, this variable contains the
13487 identification received in response to an RFC 1413 request. When a message has
13488 been received locally, this variable contains the login name of the user that
13489 called Exim.
13490
13491 .vitem &$sender_rate_$&&'xxx'&
13492 A number of variables whose names begin &$sender_rate_$& are set as part of the
13493 &%ratelimit%& ACL condition. Details are given in section
13494 &<<SECTratelimiting>>&.
13495
13496 .vitem &$sender_rcvhost$&
13497 .cindex "DNS" "reverse lookup"
13498 .cindex "reverse DNS lookup"
13499 .vindex "&$sender_rcvhost$&"
13500 This is provided specifically for use in &'Received:'& headers. It starts with
13501 either the verified host name (as obtained from a reverse DNS lookup) or, if
13502 there is no verified host name, the IP address in square brackets. After that
13503 there may be text in parentheses. When the first item is a verified host name,
13504 the first thing in the parentheses is the IP address in square brackets,
13505 followed by a colon and a port number if port logging is enabled. When the
13506 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13507 the parentheses.
13508
13509 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13510 was used and its argument was not identical to the real host name or IP
13511 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13512 all three items are present in the parentheses, a newline and tab are inserted
13513 into the string, to improve the formatting of the &'Received:'& header.
13514
13515 .vitem &$sender_verify_failure$&
13516 .vindex "&$sender_verify_failure$&"
13517 In an ACL, when a sender verification fails, this variable contains information
13518 about the failure. The details are the same as for
13519 &$recipient_verify_failure$&.
13520
13521 .vitem &$sending_ip_address$&
13522 .vindex "&$sending_ip_address$&"
13523 This variable is set whenever an outgoing SMTP connection to another host has
13524 been set up. It contains the IP address of the local interface that is being
13525 used. This is useful if a host that has more than one IP address wants to take
13526 on different personalities depending on which one is being used. For incoming
13527 connections, see &$received_ip_address$&.
13528
13529 .vitem &$sending_port$&
13530 .vindex "&$sending_port$&"
13531 This variable is set whenever an outgoing SMTP connection to another host has
13532 been set up. It contains the local port that is being used. For incoming
13533 connections, see &$received_port$&.
13534
13535 .vitem &$smtp_active_hostname$&
13536 .vindex "&$smtp_active_hostname$&"
13537 During an incoming SMTP session, this variable contains the value of the active
13538 host name, as specified by the &%smtp_active_hostname%& option. The value of
13539 &$smtp_active_hostname$& is saved with any message that is received, so its
13540 value can be consulted during routing and delivery.
13541
13542 .vitem &$smtp_command$&
13543 .vindex "&$smtp_command$&"
13544 During the processing of an incoming SMTP command, this variable contains the
13545 entire command. This makes it possible to distinguish between HELO and EHLO in
13546 the HELO ACL, and also to distinguish between commands such as these:
13547 .code
13548 MAIL FROM:<>
13549 MAIL FROM: <>
13550 .endd
13551 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13552 command, the address in &$smtp_command$& is the original address before any
13553 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13554 the address after SMTP-time rewriting.
13555
13556 .vitem &$smtp_command_argument$&
13557 .cindex "SMTP" "command, argument for"
13558 .vindex "&$smtp_command_argument$&"
13559 While an ACL is running to check an SMTP command, this variable contains the
13560 argument, that is, the text that follows the command name, with leading white
13561 space removed. Following the introduction of &$smtp_command$&, this variable is
13562 somewhat redundant, but is retained for backwards compatibility.
13563
13564 .vitem &$smtp_command_history$&
13565 .cindex SMTP "command history"
13566 .vindex "&$smtp_command_history$&"
13567 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13568 received, in time-order left to right.  Only a limited number of commands
13569 are remembered.
13570
13571 .vitem &$smtp_count_at_connection_start$&
13572 .vindex "&$smtp_count_at_connection_start$&"
13573 This variable is set greater than zero only in processes spawned by the Exim
13574 daemon for handling incoming SMTP connections. The name is deliberately long,
13575 in order to emphasize what the contents are. When the daemon accepts a new
13576 connection, it increments this variable. A copy of the variable is passed to
13577 the child process that handles the connection, but its value is fixed, and
13578 never changes. It is only an approximation of how many incoming connections
13579 there actually are, because many other connections may come and go while a
13580 single connection is being processed. When a child process terminates, the
13581 daemon decrements its copy of the variable.
13582
13583 .vitem "&$sn0$& &-- &$sn9$&"
13584 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13585 that were current at the end of the system filter file. This allows a system
13586 filter file to set values that can be tested in users' filter files. For
13587 example, a system filter could set a value indicating how likely it is that a
13588 message is junk mail.
13589
13590 .vitem &$spam_$&&'xxx'&
13591 A number of variables whose names start with &$spam$& are available when Exim
13592 is compiled with the content-scanning extension. For details, see section
13593 &<<SECTscanspamass>>&.
13594
13595 .vitem &$spf_header_comment$& &&&
13596        &$spf_received$& &&&
13597        &$spf_result$& &&&
13598        &$spf_result_guessed$& &&&
13599        &$spf_smtp_comment$&
13600 These variables are only available if Exim is built with SPF support.
13601 For details see section &<<SECSPF>>&.
13602
13603 .vitem &$spool_directory$&
13604 .vindex "&$spool_directory$&"
13605 The name of Exim's spool directory.
13606
13607 .vitem &$spool_inodes$&
13608 .vindex "&$spool_inodes$&"
13609 The number of free inodes in the disk partition where Exim's spool files are
13610 being written. The value is recalculated whenever the variable is referenced.
13611 If the relevant file system does not have the concept of inodes, the value of
13612 is -1. See also the &%check_spool_inodes%& option.
13613
13614 .vitem &$spool_space$&
13615 .vindex "&$spool_space$&"
13616 The amount of free space (as a number of kilobytes) in the disk partition where
13617 Exim's spool files are being written. The value is recalculated whenever the
13618 variable is referenced. If the operating system does not have the ability to
13619 find the amount of free space (only true for experimental systems), the space
13620 value is -1. For example, to check in an ACL that there is at least 50
13621 megabytes free on the spool, you could write:
13622 .code
13623 condition = ${if > {$spool_space}{50000}}
13624 .endd
13625 See also the &%check_spool_space%& option.
13626
13627
13628 .vitem &$thisaddress$&
13629 .vindex "&$thisaddress$&"
13630 This variable is set only during the processing of the &%foranyaddress%&
13631 command in a filter file. Its use is explained in the description of that
13632 command, which can be found in the separate document entitled &'Exim's
13633 interfaces to mail filtering'&.
13634
13635 .vitem &$tls_in_bits$&
13636 .vindex "&$tls_in_bits$&"
13637 Contains an approximation of the TLS cipher's bit-strength
13638 on the inbound connection; the meaning of
13639 this depends upon the TLS implementation used.
13640 If TLS has not been negotiated, the value will be 0.
13641 The value of this is automatically fed into the Cyrus SASL authenticator
13642 when acting as a server, to specify the "external SSF" (a SASL term).
13643
13644 The deprecated &$tls_bits$& variable refers to the inbound side
13645 except when used in the context of an outbound SMTP delivery, when it refers to
13646 the outbound.
13647
13648 .vitem &$tls_out_bits$&
13649 .vindex "&$tls_out_bits$&"
13650 Contains an approximation of the TLS cipher's bit-strength
13651 on an outbound SMTP connection; the meaning of
13652 this depends upon the TLS implementation used.
13653 If TLS has not been negotiated, the value will be 0.
13654
13655 .vitem &$tls_in_ourcert$&
13656 .vindex "&$tls_in_ourcert$&"
13657 .cindex certificate variables
13658 This variable refers to the certificate presented to the peer of an
13659 inbound connection when the message was received.
13660 It is only useful as the argument of a
13661 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13662 or a &%def%& condition.
13663
13664 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13665 when a list of more than one
13666 file is used for &%tls_certificate%&, this variable is not reliable.
13667 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13668
13669 .vitem &$tls_in_peercert$&
13670 .vindex "&$tls_in_peercert$&"
13671 This variable refers to the certificate presented by the peer of an
13672 inbound connection when the message was received.
13673 It is only useful as the argument of a
13674 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13675 or a &%def%& condition.
13676 If certificate verification fails it may refer to a failing chain element
13677 which is not the leaf.
13678
13679 .vitem &$tls_out_ourcert$&
13680 .vindex "&$tls_out_ourcert$&"
13681 This variable refers to the certificate presented to the peer of an
13682 outbound connection.  It is only useful as the argument of a
13683 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13684 or a &%def%& condition.
13685
13686 .vitem &$tls_out_peercert$&
13687 .vindex "&$tls_out_peercert$&"
13688 This variable refers to the certificate presented by the peer of an
13689 outbound connection.  It is only useful as the argument of a
13690 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13691 or a &%def%& condition.
13692 If certificate verification fails it may refer to a failing chain element
13693 which is not the leaf.
13694
13695 .vitem &$tls_in_certificate_verified$&
13696 .vindex "&$tls_in_certificate_verified$&"
13697 This variable is set to &"1"& if a TLS certificate was verified when the
13698 message was received, and &"0"& otherwise.
13699
13700 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13701 except when used in the context of an outbound SMTP delivery, when it refers to
13702 the outbound.
13703
13704 .vitem &$tls_out_certificate_verified$&
13705 .vindex "&$tls_out_certificate_verified$&"
13706 This variable is set to &"1"& if a TLS certificate was verified when an
13707 outbound SMTP connection was made,
13708 and &"0"& otherwise.
13709
13710 .vitem &$tls_in_cipher$&
13711 .vindex "&$tls_in_cipher$&"
13712 .vindex "&$tls_cipher$&"
13713 When a message is received from a remote host over an encrypted SMTP
13714 connection, this variable is set to the cipher suite that was negotiated, for
13715 example DES-CBC3-SHA. In other circumstances, in particular, for message
13716 received over unencrypted connections, the variable is empty. Testing
13717 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13718 non-encrypted connections during ACL processing.
13719
13720 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13721 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13722 becomes the same as &$tls_out_cipher$&.
13723
13724 .vitem &$tls_in_cipher_std$&
13725 .vindex "&$tls_in_cipher_std$&"
13726 As above, but returning the RFC standard name for the cipher suite.
13727
13728 .vitem &$tls_out_cipher$&
13729 .vindex "&$tls_out_cipher$&"
13730 This variable is
13731 cleared before any outgoing SMTP connection is made,
13732 and then set to the outgoing cipher suite if one is negotiated. See chapter
13733 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13734 details of the &(smtp)& transport.
13735
13736 .vitem &$tls_out_cipher_std$&
13737 .vindex "&$tls_out_cipher_std$&"
13738 As above, but returning the RFC standard name for the cipher suite.
13739
13740 .vitem &$tls_out_dane$&
13741 .vindex &$tls_out_dane$&
13742 DANE active status.  See section &<<SECDANE>>&.
13743
13744 .vitem &$tls_in_ocsp$&
13745 .vindex "&$tls_in_ocsp$&"
13746 When a message is received from a remote client connection
13747 the result of any OCSP request from the client is encoded in this variable:
13748 .code
13749 0 OCSP proof was not requested (default value)
13750 1 No response to request
13751 2 Response not verified
13752 3 Verification failed
13753 4 Verification succeeded
13754 .endd
13755
13756 .vitem &$tls_out_ocsp$&
13757 .vindex "&$tls_out_ocsp$&"
13758 When a message is sent to a remote host connection
13759 the result of any OCSP request made is encoded in this variable.
13760 See &$tls_in_ocsp$& for values.
13761
13762 .vitem &$tls_in_peerdn$&
13763 .vindex "&$tls_in_peerdn$&"
13764 .vindex "&$tls_peerdn$&"
13765 .cindex certificate "extracting fields"
13766 When a message is received from a remote host over an encrypted SMTP
13767 connection, and Exim is configured to request a certificate from the client,
13768 the value of the Distinguished Name of the certificate is made available in the
13769 &$tls_in_peerdn$& during subsequent processing.
13770 If certificate verification fails it may refer to a failing chain element
13771 which is not the leaf.
13772
13773 The deprecated &$tls_peerdn$& variable refers to the inbound side
13774 except when used in the context of an outbound SMTP delivery, when it refers to
13775 the outbound.
13776
13777 .vitem &$tls_out_peerdn$&
13778 .vindex "&$tls_out_peerdn$&"
13779 When a message is being delivered to a remote host over an encrypted SMTP
13780 connection, and Exim is configured to request a certificate from the server,
13781 the value of the Distinguished Name of the certificate is made available in the
13782 &$tls_out_peerdn$& during subsequent processing.
13783 If certificate verification fails it may refer to a failing chain element
13784 which is not the leaf.
13785
13786 .vitem &$tls_in_sni$&
13787 .vindex "&$tls_in_sni$&"
13788 .vindex "&$tls_sni$&"
13789 .cindex "TLS" "Server Name Indication"
13790 When a TLS session is being established, if the client sends the Server
13791 Name Indication extension, the value will be placed in this variable.
13792 If the variable appears in &%tls_certificate%& then this option and
13793 some others, described in &<<SECTtlssni>>&,
13794 will be re-expanded early in the TLS session, to permit
13795 a different certificate to be presented (and optionally a different key to be
13796 used) to the client, based upon the value of the SNI extension.
13797
13798 The deprecated &$tls_sni$& variable refers to the inbound side
13799 except when used in the context of an outbound SMTP delivery, when it refers to
13800 the outbound.
13801
13802 .vitem &$tls_out_sni$&
13803 .vindex "&$tls_out_sni$&"
13804 .cindex "TLS" "Server Name Indication"
13805 During outbound
13806 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13807 the transport.
13808
13809 .vitem &$tls_out_tlsa_usage$&
13810 .vindex &$tls_out_tlsa_usage$&
13811 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13812
13813 .vitem &$tls_in_ver$&
13814 .vindex "&$tls_in_ver$&"
13815 When a message is received from a remote host over an encrypted SMTP connection
13816 this variable is set to the protocol version, eg &'TLS1.2'&.
13817
13818 .vitem &$tls_out_ver$&
13819 .vindex "&$tls_out_ver$&"
13820 When a message is being delivered to a remote host over an encrypted SMTP connection
13821 this variable is set to the protocol version.
13822
13823
13824 .vitem &$tod_bsdinbox$&
13825 .vindex "&$tod_bsdinbox$&"
13826 The time of day and the date, in the format required for BSD-style mailbox
13827 files, for example: Thu Oct 17 17:14:09 1995.
13828
13829 .vitem &$tod_epoch$&
13830 .vindex "&$tod_epoch$&"
13831 The time and date as a number of seconds since the start of the Unix epoch.
13832
13833 .vitem &$tod_epoch_l$&
13834 .vindex "&$tod_epoch_l$&"
13835 The time and date as a number of microseconds since the start of the Unix epoch.
13836
13837 .vitem &$tod_full$&
13838 .vindex "&$tod_full$&"
13839 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13840 +0100. The timezone is always given as a numerical offset from UTC, with
13841 positive values used for timezones that are ahead (east) of UTC, and negative
13842 values for those that are behind (west).
13843
13844 .vitem &$tod_log$&
13845 .vindex "&$tod_log$&"
13846 The time and date in the format used for writing Exim's log files, for example:
13847 1995-10-12 15:32:29, but without a timezone.
13848
13849 .vitem &$tod_logfile$&
13850 .vindex "&$tod_logfile$&"
13851 This variable contains the date in the format yyyymmdd. This is the format that
13852 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13853 flag.
13854
13855 .vitem &$tod_zone$&
13856 .vindex "&$tod_zone$&"
13857 This variable contains the numerical value of the local timezone, for example:
13858 -0500.
13859
13860 .vitem &$tod_zulu$&
13861 .vindex "&$tod_zulu$&"
13862 This variable contains the UTC date and time in &"Zulu"& format, as specified
13863 by ISO 8601, for example: 20030221154023Z.
13864
13865 .vitem &$transport_name$&
13866 .cindex "transport" "name"
13867 .cindex "name" "of transport"
13868 .vindex "&$transport_name$&"
13869 During the running of a transport, this variable contains its name.
13870
13871 .vitem &$value$&
13872 .vindex "&$value$&"
13873 This variable contains the result of an expansion lookup, extraction operation,
13874 or external command, as described above. It is also used during a
13875 &*reduce*& expansion.
13876
13877 .vitem &$verify_mode$&
13878 .vindex "&$verify_mode$&"
13879 While a router or transport is being run in verify mode or for cutthrough delivery,
13880 contains "S" for sender-verification or "R" for recipient-verification.
13881 Otherwise, empty.
13882
13883 .vitem &$version_number$&
13884 .vindex "&$version_number$&"
13885 The version number of Exim. Same as &$exim_version$&, may be overridden
13886 by the &%exim_version%& main config option.
13887
13888 .vitem &$warn_message_delay$&
13889 .vindex "&$warn_message_delay$&"
13890 This variable is set only during the creation of a message warning about a
13891 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13892
13893 .vitem &$warn_message_recipients$&
13894 .vindex "&$warn_message_recipients$&"
13895 This variable is set only during the creation of a message warning about a
13896 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13897 .endlist
13898 .ecindex IIDstrexp
13899
13900
13901
13902 . ////////////////////////////////////////////////////////////////////////////
13903 . ////////////////////////////////////////////////////////////////////////////
13904
13905 .chapter "Embedded Perl" "CHAPperl"
13906 .scindex IIDperl "Perl" "calling from Exim"
13907 Exim can be built to include an embedded Perl interpreter. When this is done,
13908 Perl subroutines can be called as part of the string expansion process. To make
13909 use of the Perl support, you need version 5.004 or later of Perl installed on
13910 your system. To include the embedded interpreter in the Exim binary, include
13911 the line
13912 .code
13913 EXIM_PERL = perl.o
13914 .endd
13915 in your &_Local/Makefile_& and then build Exim in the normal way.
13916
13917
13918 .section "Setting up so Perl can be used" "SECID85"
13919 .oindex "&%perl_startup%&"
13920 Access to Perl subroutines is via a global configuration option called
13921 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13922 no &%perl_startup%& option in the Exim configuration file then no Perl
13923 interpreter is started and there is almost no overhead for Exim (since none of
13924 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13925 option then the associated value is taken to be Perl code which is executed in
13926 a newly created Perl interpreter.
13927
13928 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13929 need backslashes before any characters to escape special meanings. The option
13930 should usually be something like
13931 .code
13932 perl_startup = do '/etc/exim.pl'
13933 .endd
13934 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13935 use from Exim. Exim can be configured either to start up a Perl interpreter as
13936 soon as it is entered, or to wait until the first time it is needed. Starting
13937 the interpreter at the beginning ensures that it is done while Exim still has
13938 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13939 fact used in a particular run. Also, note that this does not mean that Exim is
13940 necessarily running as root when Perl is called at a later time. By default,
13941 the interpreter is started only when it is needed, but this can be changed in
13942 two ways:
13943
13944 .ilist
13945 .oindex "&%perl_at_start%&"
13946 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13947 a startup when Exim is entered.
13948 .next
13949 The command line option &%-ps%& also requests a startup when Exim is entered,
13950 overriding the setting of &%perl_at_start%&.
13951 .endlist
13952
13953 There is also a command line option &%-pd%& (for delay) which suppresses the
13954 initial startup, even if &%perl_at_start%& is set.
13955
13956 .ilist
13957 .oindex "&%perl_taintmode%&"
13958 .cindex "Perl" "taintmode"
13959 To provide more security executing Perl code via the embedded Perl
13960 interpreter, the &%perl_taintmode%& option can be set. This enables the
13961 taint mode of the Perl interpreter. You are encouraged to set this
13962 option to a true value. To avoid breaking existing installations, it
13963 defaults to false.
13964
13965
13966 .section "Calling Perl subroutines" "SECID86"
13967 When the configuration file includes a &%perl_startup%& option you can make use
13968 of the string expansion item to call the Perl subroutines that are defined
13969 by the &%perl_startup%& code. The operator is used in any of the following
13970 forms:
13971 .code
13972 ${perl{foo}}
13973 ${perl{foo}{argument}}
13974 ${perl{foo}{argument1}{argument2} ... }
13975 .endd
13976 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13977 arguments may be passed. Passing more than this results in an expansion failure
13978 with an error message of the form
13979 .code
13980 Too many arguments passed to Perl subroutine "foo" (max is 8)
13981 .endd
13982 The return value of the Perl subroutine is evaluated in a scalar context before
13983 it is passed back to Exim to be inserted into the expanded string. If the
13984 return value is &'undef'&, the expansion is forced to fail in the same way as
13985 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13986 by obeying Perl's &%die%& function, the expansion fails with the error message
13987 that was passed to &%die%&.
13988
13989
13990 .section "Calling Exim functions from Perl" "SECID87"
13991 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13992 is available to call back into Exim's string expansion function. For example,
13993 the Perl code
13994 .code
13995 my $lp = Exim::expand_string('$local_part');
13996 .endd
13997 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13998 Note those are single quotes and not double quotes to protect against
13999 &$local_part$& being interpolated as a Perl variable.
14000
14001 If the string expansion is forced to fail by a &"fail"& item, the result of
14002 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14003 expansion string, the Perl call from the original expansion string fails with
14004 an appropriate error message, in the same way as if &%die%& were used.
14005
14006 .cindex "debugging" "from embedded Perl"
14007 .cindex "log" "writing from embedded Perl"
14008 Two other Exim functions are available for use from within Perl code.
14009 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14010 debugging is enabled. If you want a newline at the end, you must supply it.
14011 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14012 timestamp. In this case, you should not supply a terminating newline.
14013
14014
14015 .section "Use of standard output and error by Perl" "SECID88"
14016 .cindex "Perl" "standard output and error"
14017 You should not write to the standard error or output streams from within your
14018 Perl code, as it is not defined how these are set up. In versions of Exim
14019 before 4.50, it is possible for the standard output or error to refer to the
14020 SMTP connection during message reception via the daemon. Writing to this stream
14021 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14022 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14023 avoided, but the output is lost.
14024
14025 .cindex "Perl" "use of &%warn%&"
14026 The Perl &%warn%& statement writes to the standard error stream by default.
14027 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14028 you have no control. When Exim starts up the Perl interpreter, it arranges for
14029 output from the &%warn%& statement to be written to the Exim main log. You can
14030 change this by including appropriate Perl magic somewhere in your Perl code.
14031 For example, to discard &%warn%& output completely, you need this:
14032 .code
14033 $SIG{__WARN__} = sub { };
14034 .endd
14035 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14036 example, the code for the subroutine is empty, so it does nothing, but you can
14037 include any Perl code that you like. The text of the &%warn%& message is passed
14038 as the first subroutine argument.
14039 .ecindex IIDperl
14040
14041
14042 . ////////////////////////////////////////////////////////////////////////////
14043 . ////////////////////////////////////////////////////////////////////////////
14044
14045 .chapter "Starting the daemon and the use of network interfaces" &&&
14046          "CHAPinterfaces" &&&
14047          "Starting the daemon"
14048 .cindex "daemon" "starting"
14049 .cindex "interface" "listening"
14050 .cindex "network interface"
14051 .cindex "interface" "network"
14052 .cindex "IP address" "for listening"
14053 .cindex "daemon" "listening IP addresses"
14054 .cindex "TCP/IP" "setting listening interfaces"
14055 .cindex "TCP/IP" "setting listening ports"
14056 A host that is connected to a TCP/IP network may have one or more physical
14057 hardware network interfaces. Each of these interfaces may be configured as one
14058 or more &"logical"& interfaces, which are the entities that a program actually
14059 works with. Each of these logical interfaces is associated with an IP address.
14060 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14061 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14062 knowledge about the host's interfaces for use in three different circumstances:
14063
14064 .olist
14065 When a listening daemon is started, Exim needs to know which interfaces
14066 and ports to listen on.
14067 .next
14068 When Exim is routing an address, it needs to know which IP addresses
14069 are associated with local interfaces. This is required for the correct
14070 processing of MX lists by removing the local host and others with the
14071 same or higher priority values. Also, Exim needs to detect cases
14072 when an address is routed to an IP address that in fact belongs to the
14073 local host. Unless the &%self%& router option or the &%allow_localhost%&
14074 option of the smtp transport is set (as appropriate), this is treated
14075 as an error situation.
14076 .next
14077 When Exim connects to a remote host, it may need to know which interface to use
14078 for the outgoing connection.
14079 .endlist
14080
14081
14082 Exim's default behaviour is likely to be appropriate in the vast majority
14083 of cases. If your host has only one interface, and you want all its IP
14084 addresses to be treated in the same way, and you are using only the
14085 standard SMTP port, you should not need to take any special action. The
14086 rest of this chapter does not apply to you.
14087
14088 In a more complicated situation you may want to listen only on certain
14089 interfaces, or on different ports, and for this reason there are a number of
14090 options that can be used to influence Exim's behaviour. The rest of this
14091 chapter describes how they operate.
14092
14093 When a message is received over TCP/IP, the interface and port that were
14094 actually used are set in &$received_ip_address$& and &$received_port$&.
14095
14096
14097
14098 .section "Starting a listening daemon" "SECID89"
14099 When a listening daemon is started (by means of the &%-bd%& command line
14100 option), the interfaces and ports on which it listens are controlled by the
14101 following options:
14102
14103 .ilist
14104 &%daemon_smtp_ports%& contains a list of default ports
14105 or service names.
14106 (For backward compatibility, this option can also be specified in the singular.)
14107 .next
14108 &%local_interfaces%& contains list of interface IP addresses on which to
14109 listen. Each item may optionally also specify a port.
14110 .endlist
14111
14112 The default list separator in both cases is a colon, but this can be changed as
14113 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14114 it is usually best to change the separator to avoid having to double all the
14115 colons. For example:
14116 .code
14117 local_interfaces = <; 127.0.0.1 ; \
14118                       192.168.23.65 ; \
14119                       ::1 ; \
14120                       3ffe:ffff:836f::fe86:a061
14121 .endd
14122 There are two different formats for specifying a port along with an IP address
14123 in &%local_interfaces%&:
14124
14125 .olist
14126 The port is added onto the address with a dot separator. For example, to listen
14127 on port 1234 on two different IP addresses:
14128 .code
14129 local_interfaces = <; 192.168.23.65.1234 ; \
14130                       3ffe:ffff:836f::fe86:a061.1234
14131 .endd
14132 .next
14133 The IP address is enclosed in square brackets, and the port is added
14134 with a colon separator, for example:
14135 .code
14136 local_interfaces = <; [192.168.23.65]:1234 ; \
14137                       [3ffe:ffff:836f::fe86:a061]:1234
14138 .endd
14139 .endlist
14140
14141 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14142 default setting contains just one port:
14143 .code
14144 daemon_smtp_ports = smtp
14145 .endd
14146 If more than one port is listed, each interface that does not have its own port
14147 specified listens on all of them. Ports that are listed in
14148 &%daemon_smtp_ports%& can be identified either by name (defined in
14149 &_/etc/services_&) or by number. However, when ports are given with individual
14150 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14151
14152
14153
14154 .section "Special IP listening addresses" "SECID90"
14155 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14156 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14157 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14158 instead of setting up separate listening sockets for each interface. The
14159 default value of &%local_interfaces%& is
14160 .code
14161 local_interfaces = 0.0.0.0
14162 .endd
14163 when Exim is built without IPv6 support; otherwise it is:
14164 .code
14165 local_interfaces = <; ::0 ; 0.0.0.0
14166 .endd
14167 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14168
14169
14170
14171 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14172 The &%-oX%& command line option can be used to override the values of
14173 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14174 instance. Another way of doing this would be to use macros and the &%-D%&
14175 option. However, &%-oX%& can be used by any admin user, whereas modification of
14176 the runtime configuration by &%-D%& is allowed only when the caller is root or
14177 exim.
14178
14179 The value of &%-oX%& is a list of items. The default colon separator can be
14180 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14181 If there are any items that do not
14182 contain dots or colons (that is, are not IP addresses), the value of
14183 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14184 items that do contain dots or colons, the value of &%local_interfaces%& is
14185 replaced by those items. Thus, for example,
14186 .code
14187 -oX 1225
14188 .endd
14189 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14190 whereas
14191 .code
14192 -oX 192.168.34.5.1125
14193 .endd
14194 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14195 (However, since &%local_interfaces%& now contains no items without ports, the
14196 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14197
14198
14199
14200 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14201 .cindex "submissions protocol"
14202 .cindex "ssmtp protocol"
14203 .cindex "smtps protocol"
14204 .cindex "SMTP" "ssmtp protocol"
14205 .cindex "SMTP" "smtps protocol"
14206 Exim supports the use of TLS-on-connect, used by mail clients in the
14207 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14208 For some years, IETF Standards Track documents only blessed the
14209 STARTTLS-based Submission service (port 587) while common practice was to support
14210 the same feature set on port 465, but using TLS-on-connect.
14211 If your installation needs to provide service to mail clients
14212 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14213 the 465 TCP ports.
14214
14215 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14216 service names, connections to those ports must first establish TLS, before
14217 proceeding to the application layer use of the SMTP protocol.
14218
14219 The common use of this option is expected to be
14220 .code
14221 tls_on_connect_ports = 465
14222 .endd
14223 per RFC 8314.
14224 There is also a command line option &%-tls-on-connect%&, which forces all ports
14225 to behave in this way when a daemon is started.
14226
14227 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14228 daemon to listen on those ports. You must still specify them in
14229 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14230 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14231 connections via the daemon.)
14232
14233
14234
14235
14236 .section "IPv6 address scopes" "SECID92"
14237 .cindex "IPv6" "address scopes"
14238 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14239 can, in principle, have the same link-local IPv6 address on different
14240 interfaces. Thus, additional information is needed, over and above the IP
14241 address, to distinguish individual interfaces. A convention of using a
14242 percent sign followed by something (often the interface name) has been
14243 adopted in some cases, leading to addresses like this:
14244 .code
14245 fe80::202:b3ff:fe03:45c1%eth0
14246 .endd
14247 To accommodate this usage, a percent sign followed by an arbitrary string is
14248 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14249 to convert a textual IPv6 address for actual use. This function recognizes the
14250 percent convention in operating systems that support it, and it processes the
14251 address appropriately. Unfortunately, some older libraries have problems with
14252 &[getaddrinfo()]&. If
14253 .code
14254 IPV6_USE_INET_PTON=yes
14255 .endd
14256 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14257 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14258 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14259 function.) Of course, this means that the additional functionality of
14260 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14261
14262 .section "Disabling IPv6" "SECID93"
14263 .cindex "IPv6" "disabling"
14264 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14265 run on a host whose kernel does not support IPv6. The binary will fall back to
14266 using IPv4, but it may waste resources looking up AAAA records, and trying to
14267 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14268 .oindex "&%disable_ipv6%&"
14269 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14270 activities take place. AAAA records are never looked up, and any IPv6 addresses
14271 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14272 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14273 to handle IPv6 literal addresses.
14274
14275 On the other hand, when IPv6 is in use, there may be times when you want to
14276 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14277 option to globally suppress the lookup of AAAA records for specified domains,
14278 and you can use the &%ignore_target_hosts%& generic router option to ignore
14279 IPv6 addresses in an individual router.
14280
14281
14282
14283 .section "Examples of starting a listening daemon" "SECID94"
14284 The default case in an IPv6 environment is
14285 .code
14286 daemon_smtp_ports = smtp
14287 local_interfaces = <; ::0 ; 0.0.0.0
14288 .endd
14289 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14290 Either one or two sockets may be used, depending on the characteristics of
14291 the TCP/IP stack. (This is complicated and messy; for more information,
14292 read the comments in the &_daemon.c_& source file.)
14293
14294 To specify listening on ports 25 and 26 on all interfaces:
14295 .code
14296 daemon_smtp_ports = 25 : 26
14297 .endd
14298 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14299 .code
14300 local_interfaces = <; ::0.25     ; ::0.26 \
14301                       0.0.0.0.25 ; 0.0.0.0.26
14302 .endd
14303 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14304 IPv4 loopback address only:
14305 .code
14306 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14307 .endd
14308 To specify listening on the default port on specific interfaces only:
14309 .code
14310 local_interfaces = 10.0.0.67 : 192.168.34.67
14311 .endd
14312 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14313
14314
14315
14316 .section "Recognizing the local host" "SECTreclocipadd"
14317 The &%local_interfaces%& option is also used when Exim needs to determine
14318 whether or not an IP address refers to the local host. That is, the IP
14319 addresses of all the interfaces on which a daemon is listening are always
14320 treated as local.
14321
14322 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14323 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14324 available interfaces from the operating system, and extracts the relevant
14325 (that is, IPv4 or IPv6) addresses to use for checking.
14326
14327 Some systems set up large numbers of virtual interfaces in order to provide
14328 many virtual web servers. In this situation, you may want to listen for
14329 email on only a few of the available interfaces, but nevertheless treat all
14330 interfaces as local when routing. You can do this by setting
14331 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14332 &"all"& wildcard values. These addresses are recognized as local, but are not
14333 used for listening. Consider this example:
14334 .code
14335 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14336                       192.168.53.235 ; \
14337                       3ffe:2101:12:1:a00:20ff:fe86:a061
14338
14339 extra_local_interfaces = <; ::0 ; 0.0.0.0
14340 .endd
14341 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14342 address, but all available interface addresses are treated as local when
14343 Exim is routing.
14344
14345 In some environments the local host name may be in an MX list, but with an IP
14346 address that is not assigned to any local interface. In other cases it may be
14347 desirable to treat other host names as if they referred to the local host. Both
14348 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14349 This contains host names rather than IP addresses. When a host is referenced
14350 during routing, either via an MX record or directly, it is treated as the local
14351 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14352 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14353
14354
14355
14356 .section "Delivering to a remote host" "SECID95"
14357 Delivery to a remote host is handled by the smtp transport. By default, it
14358 allows the system's TCP/IP functions to choose which interface to use (if
14359 there is more than one) when connecting to a remote host. However, the
14360 &%interface%& option can be set to specify which interface is used. See the
14361 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14362 details.
14363
14364
14365
14366
14367 . ////////////////////////////////////////////////////////////////////////////
14368 . ////////////////////////////////////////////////////////////////////////////
14369
14370 .chapter "Main configuration" "CHAPmainconfig"
14371 .scindex IIDconfima "configuration file" "main section"
14372 .scindex IIDmaiconf "main configuration"
14373 The first part of the runtime configuration file contains three types of item:
14374
14375 .ilist
14376 Macro definitions: These lines start with an upper case letter. See section
14377 &<<SECTmacrodefs>>& for details of macro processing.
14378 .next
14379 Named list definitions: These lines start with one of the words &"domainlist"&,
14380 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14381 section &<<SECTnamedlists>>&.
14382 .next
14383 Main configuration settings: Each setting occupies one line of the file
14384 (with possible continuations). If any setting is preceded by the word
14385 &"hide"&, the &%-bP%& command line option displays its value to admin users
14386 only. See section &<<SECTcos>>& for a description of the syntax of these option
14387 settings.
14388 .endlist
14389
14390 This chapter specifies all the main configuration options, along with their
14391 types and default values. For ease of finding a particular option, they appear
14392 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14393 are now so many options, they are first listed briefly in functional groups, as
14394 an aid to finding the name of the option you are looking for. Some options are
14395 listed in more than one group.
14396
14397 .section "Miscellaneous" "SECID96"
14398 .table2
14399 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14400 .row &%debug_store%&                 "do extra internal checks"
14401 .row &%disable_ipv6%&                "do no IPv6 processing"
14402 .row &%keep_malformed%&              "for broken files &-- should not happen"
14403 .row &%localhost_number%&            "for unique message ids in clusters"
14404 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14405 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14406 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14407 .row &%print_topbitchars%&           "top-bit characters are printing"
14408 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14409 .row &%timezone%&                    "force time zone"
14410 .endtable
14411
14412
14413 .section "Exim parameters" "SECID97"
14414 .table2
14415 .row &%exim_group%&                  "override compiled-in value"
14416 .row &%exim_path%&                   "override compiled-in value"
14417 .row &%exim_user%&                   "override compiled-in value"
14418 .row &%primary_hostname%&            "default from &[uname()]&"
14419 .row &%split_spool_directory%&       "use multiple directories"
14420 .row &%spool_directory%&             "override compiled-in value"
14421 .endtable
14422
14423
14424
14425 .section "Privilege controls" "SECID98"
14426 .table2
14427 .row &%admin_groups%&                "groups that are Exim admin users"
14428 .row &%commandline_checks_require_admin%& "require admin for various checks"
14429 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14430 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14431 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14432 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14433 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14434 .row &%never_users%&                 "do not run deliveries as these"
14435 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14436 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14437 .row &%trusted_groups%&              "groups that are trusted"
14438 .row &%trusted_users%&               "users that are trusted"
14439 .endtable
14440
14441
14442
14443 .section "Logging" "SECID99"
14444 .table2
14445 .row &%event_action%&                "custom logging"
14446 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14447 .row &%log_file_path%&               "override compiled-in value"
14448 .row &%log_selector%&                "set/unset optional logging"
14449 .row &%log_timezone%&                "add timezone to log lines"
14450 .row &%message_logs%&                "create per-message logs"
14451 .row &%preserve_message_logs%&       "after message completion"
14452 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14453 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14454 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14455 .row &%syslog_facility%&             "set syslog &""facility""& field"
14456 .row &%syslog_pid%&                  "pid in syslog lines"
14457 .row &%syslog_processname%&          "set syslog &""ident""& field"
14458 .row &%syslog_timestamp%&            "timestamp syslog lines"
14459 .row &%write_rejectlog%&             "control use of message log"
14460 .endtable
14461
14462
14463
14464 .section "Frozen messages" "SECID100"
14465 .table2
14466 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14467 .row &%freeze_tell%&                 "send message when freezing"
14468 .row &%move_frozen_messages%&        "to another directory"
14469 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14470 .endtable
14471
14472
14473
14474 .section "Data lookups" "SECID101"
14475 .table2
14476 .row &%ibase_servers%&               "InterBase servers"
14477 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14478 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14479 .row &%ldap_cert_file%&              "client cert file for LDAP"
14480 .row &%ldap_cert_key%&               "client key file for LDAP"
14481 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14482 .row &%ldap_default_servers%&        "used if no server in query"
14483 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14484 .row &%ldap_start_tls%&              "require TLS within LDAP"
14485 .row &%ldap_version%&                "set protocol version"
14486 .row &%lookup_open_max%&             "lookup files held open"
14487 .row &%mysql_servers%&               "default MySQL servers"
14488 .row &%oracle_servers%&              "Oracle servers"
14489 .row &%pgsql_servers%&               "default PostgreSQL servers"
14490 .row &%sqlite_lock_timeout%&         "as it says"
14491 .endtable
14492
14493
14494
14495 .section "Message ids" "SECID102"
14496 .table2
14497 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14498 .row &%message_id_header_text%&      "ditto"
14499 .endtable
14500
14501
14502
14503 .section "Embedded Perl Startup" "SECID103"
14504 .table2
14505 .row &%perl_at_start%&               "always start the interpreter"
14506 .row &%perl_startup%&                "code to obey when starting Perl"
14507 .row &%perl_taintmode%&              "enable taint mode in Perl"
14508 .endtable
14509
14510
14511
14512 .section "Daemon" "SECID104"
14513 .table2
14514 .row &%daemon_smtp_ports%&           "default ports"
14515 .row &%daemon_startup_retries%&      "number of times to retry"
14516 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14517 .row &%extra_local_interfaces%&      "not necessarily listened on"
14518 .row &%local_interfaces%&            "on which to listen, with optional ports"
14519 .row &%notifier_socket%&             "override compiled-in value"
14520 .row &%pid_file_path%&               "override compiled-in value"
14521 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14522 .endtable
14523
14524
14525
14526 .section "Resource control" "SECID105"
14527 .table2
14528 .row &%check_log_inodes%&            "before accepting a message"
14529 .row &%check_log_space%&             "before accepting a message"
14530 .row &%check_spool_inodes%&          "before accepting a message"
14531 .row &%check_spool_space%&           "before accepting a message"
14532 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14533 .row &%queue_only_load%&             "queue incoming if load high"
14534 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14535 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14536 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14537 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14538 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14539 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14540 .row &%smtp_accept_max_per_connection%& "messages per connection"
14541 .row &%smtp_accept_max_per_host%&    "connections from one host"
14542 .row &%smtp_accept_queue%&           "queue mail if more connections"
14543 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14544                                            connection"
14545 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14546 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14547 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14548 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14549 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14550 .endtable
14551
14552
14553
14554 .section "Policy controls" "SECID106"
14555 .table2
14556 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14557 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14558 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14559 .row &%acl_smtp_auth%&               "ACL for AUTH"
14560 .row &%acl_smtp_connect%&            "ACL for connection"
14561 .row &%acl_smtp_data%&               "ACL for DATA"
14562 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14563 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14564 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14565 .row &%acl_smtp_expn%&               "ACL for EXPN"
14566 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14567 .row &%acl_smtp_mail%&               "ACL for MAIL"
14568 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14569 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14570 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14571 .row &%acl_smtp_predata%&            "ACL for start of data"
14572 .row &%acl_smtp_quit%&               "ACL for QUIT"
14573 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14574 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14575 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14576 .row &%av_scanner%&                  "specify virus scanner"
14577 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14578                                       words""&"
14579 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14580 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14581 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14582 .row &%header_maxsize%&              "total size of message header"
14583 .row &%header_line_maxsize%&         "individual header line limit"
14584 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14585 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14586 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14587 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14588 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14589 .row &%host_lookup%&                 "host name looked up for these hosts"
14590 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14591 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14592 .row &%host_reject_connection%&      "reject connection from these hosts"
14593 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14594 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14595 .row &%message_size_limit%&          "for all messages"
14596 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14597 .row &%spamd_address%&               "set interface to SpamAssassin"
14598 .row &%strict_acl_vars%&             "object to unset ACL variables"
14599 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14600 .endtable
14601
14602
14603
14604 .section "Callout cache" "SECID107"
14605 .table2
14606 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14607                                          item"
14608 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14609                                          item"
14610 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14611 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14612 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14613 .endtable
14614
14615
14616
14617 .section "TLS" "SECID108"
14618 .table2
14619 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14620 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14621 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14622 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14623 .row &%tls_certificate%&             "location of server certificate"
14624 .row &%tls_crl%&                     "certificate revocation list"
14625 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14626 .row &%tls_dhparam%&                 "DH parameters for server"
14627 .row &%tls_eccurve%&                 "EC curve selection for server"
14628 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14629 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14630 .row &%tls_privatekey%&              "location of server private key"
14631 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14632 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14633 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14634 .row &%tls_verify_certificates%&     "expected client certificates"
14635 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14636 .endtable
14637
14638
14639
14640 .section "Local user handling" "SECID109"
14641 .table2
14642 .row &%finduser_retries%&            "useful in NIS environments"
14643 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14644 .row &%gecos_pattern%&               "ditto"
14645 .row &%max_username_length%&         "for systems that truncate"
14646 .row &%unknown_login%&               "used when no login name found"
14647 .row &%unknown_username%&            "ditto"
14648 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14649 .row &%uucp_from_sender%&            "ditto"
14650 .endtable
14651
14652
14653
14654 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14655 .table2
14656 .row &%header_maxsize%&              "total size of message header"
14657 .row &%header_line_maxsize%&         "individual header line limit"
14658 .row &%message_size_limit%&          "applies to all messages"
14659 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14660 .row &%received_header_text%&        "expanded to make &'Received:'&"
14661 .row &%received_headers_max%&        "for mail loop detection"
14662 .row &%recipients_max%&              "limit per message"
14663 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14664 .endtable
14665
14666
14667
14668
14669 .section "Non-SMTP incoming messages" "SECID111"
14670 .table2
14671 .row &%receive_timeout%&             "for non-SMTP messages"
14672 .endtable
14673
14674
14675
14676
14677
14678 .section "Incoming SMTP messages" "SECID112"
14679 See also the &'Policy controls'& section above.
14680
14681 .table2
14682 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14683 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14684 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14685 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14686 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14687 .row &%dmarc_history_file%&          "DMARC results log"
14688 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14689 .row &%host_lookup%&                 "host name looked up for these hosts"
14690 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14691 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14692 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14693 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14694 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14695 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14696 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14697 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14698 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14699 .row &%smtp_accept_max_per_connection%& "messages per connection"
14700 .row &%smtp_accept_max_per_host%&    "connections from one host"
14701 .row &%smtp_accept_queue%&           "queue mail if more connections"
14702 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14703                                            connection"
14704 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14705 .row &%smtp_active_hostname%&        "host name to use in messages"
14706 .row &%smtp_banner%&                 "text for welcome banner"
14707 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14708 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14709 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14710 .row &%smtp_etrn_command%&           "what to run for ETRN"
14711 .row &%smtp_etrn_serialize%&         "only one at once"
14712 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14713 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14714 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14715 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14716 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14717 .row &%smtp_receive_timeout%&        "per command or data line"
14718 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14719 .row &%smtp_return_error_details%&   "give detail on rejections"
14720 .endtable
14721
14722
14723
14724 .section "SMTP extensions" "SECID113"
14725 .table2
14726 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14727 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14728 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14729 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14730 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14731 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14732 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14733 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14734 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14735 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14736 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14737 .endtable
14738
14739
14740
14741 .section "Processing messages" "SECID114"
14742 .table2
14743 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14744 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14745 .row &%allow_utf8_domains%&          "in addresses"
14746 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14747                                       words""&"
14748 .row &%delivery_date_remove%&        "from incoming messages"
14749 .row &%envelope_to_remove%&          "from incoming messages"
14750 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14751 .row &%headers_charset%&             "default for translations"
14752 .row &%qualify_domain%&              "default for senders"
14753 .row &%qualify_recipient%&           "default for recipients"
14754 .row &%return_path_remove%&          "from incoming messages"
14755 .row &%strip_excess_angle_brackets%& "in addresses"
14756 .row &%strip_trailing_dot%&          "at end of addresses"
14757 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14758 .endtable
14759
14760
14761
14762 .section "System filter" "SECID115"
14763 .table2
14764 .row &%system_filter%&               "locate system filter"
14765 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14766                                             directory"
14767 .row &%system_filter_file_transport%& "transport for delivery to a file"
14768 .row &%system_filter_group%&         "group for filter running"
14769 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14770 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14771 .row &%system_filter_user%&          "user for filter running"
14772 .endtable
14773
14774
14775
14776 .section "Routing and delivery" "SECID116"
14777 .table2
14778 .row &%disable_ipv6%&                "do no IPv6 processing"
14779 .row &%dns_again_means_nonexist%&    "for broken domains"
14780 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14781 .row &%dns_dnssec_ok%&               "parameter for resolver"
14782 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14783 .row &%dns_retrans%&                 "parameter for resolver"
14784 .row &%dns_retry%&                   "parameter for resolver"
14785 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14786 .row &%dns_use_edns0%&               "parameter for resolver"
14787 .row &%hold_domains%&                "hold delivery for these domains"
14788 .row &%local_interfaces%&            "for routing checks"
14789 .row &%queue_domains%&               "no immediate delivery for these"
14790 .row &%queue_only%&                  "no immediate delivery at all"
14791 .row &%queue_only_file%&             "no immediate delivery if file exists"
14792 .row &%queue_only_load%&             "no immediate delivery if load is high"
14793 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14794 .row &%queue_only_override%&         "allow command line to override"
14795 .row &%queue_run_in_order%&          "order of arrival"
14796 .row &%queue_run_max%&               "of simultaneous queue runners"
14797 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14798 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14799 .row &%remote_sort_domains%&         "order of remote deliveries"
14800 .row &%retry_data_expire%&           "timeout for retry data"
14801 .row &%retry_interval_max%&          "safety net for retry rules"
14802 .endtable
14803
14804
14805
14806 .section "Bounce and warning messages" "SECID117"
14807 .table2
14808 .row &%bounce_message_file%&         "content of bounce"
14809 .row &%bounce_message_text%&         "content of bounce"
14810 .row &%bounce_return_body%&          "include body if returning message"
14811 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14812 .row &%bounce_return_message%&       "include original message in bounce"
14813 .row &%bounce_return_size_limit%&    "limit on returned message"
14814 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14815 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14816 .row &%errors_copy%&                 "copy bounce messages"
14817 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14818 .row &%delay_warning%&               "time schedule"
14819 .row &%delay_warning_condition%&     "condition for warning messages"
14820 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14821 .row &%smtp_return_error_details%&   "give detail on rejections"
14822 .row &%warn_message_file%&           "content of warning message"
14823 .endtable
14824
14825
14826
14827 .section "Alphabetical list of main options" "SECTalomo"
14828 Those options that undergo string expansion before use are marked with
14829 &dagger;.
14830
14831 .option accept_8bitmime main boolean true
14832 .cindex "8BITMIME"
14833 .cindex "8-bit characters"
14834 .cindex "log" "selectors"
14835 .cindex "log" "8BITMIME"
14836 .cindex "ESMTP extensions" 8BITMIME
14837 This option causes Exim to send 8BITMIME in its response to an SMTP
14838 EHLO command, and to accept the BODY= parameter on MAIL commands.
14839 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14840 takes no steps to do anything special with messages received by this route.
14841
14842 Historically Exim kept this option off by default, but the maintainers
14843 feel that in today's Internet, this causes more problems than it solves.
14844 It now defaults to true.
14845 A more detailed analysis of the issues is provided by Dan Bernstein:
14846 .display
14847 &url(https://cr.yp.to/smtp/8bitmime.html)
14848 .endd
14849
14850 To log received 8BITMIME status use
14851 .code
14852 log_selector = +8bitmime
14853 .endd
14854
14855 .option acl_not_smtp main string&!! unset
14856 .cindex "&ACL;" "for non-SMTP messages"
14857 .cindex "non-SMTP messages" "ACLs for"
14858 This option defines the ACL that is run when a non-SMTP message has been
14859 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14860 further details.
14861
14862 .option acl_not_smtp_mime main string&!! unset
14863 This option defines the ACL that is run for individual MIME parts of non-SMTP
14864 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14865 SMTP messages.
14866
14867 .option acl_not_smtp_start main string&!! unset
14868 .cindex "&ACL;" "at start of non-SMTP message"
14869 .cindex "non-SMTP messages" "ACLs for"
14870 This option defines the ACL that is run before Exim starts reading a
14871 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14872
14873 .option acl_smtp_auth main string&!! unset
14874 .cindex "&ACL;" "setting up for SMTP commands"
14875 .cindex "AUTH" "ACL for"
14876 This option defines the ACL that is run when an SMTP AUTH command is
14877 received. See chapter &<<CHAPACL>>& for further details.
14878
14879 .option acl_smtp_connect main string&!! unset
14880 .cindex "&ACL;" "on SMTP connection"
14881 This option defines the ACL that is run when an SMTP connection is received.
14882 See chapter &<<CHAPACL>>& for further details.
14883
14884 .option acl_smtp_data main string&!! unset
14885 .cindex "DATA" "ACL for"
14886 This option defines the ACL that is run after an SMTP DATA command has been
14887 processed and the message itself has been received, but before the final
14888 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14889
14890 .option acl_smtp_data_prdr main string&!! accept
14891 .cindex "PRDR" "ACL for"
14892 .cindex "DATA" "PRDR ACL for"
14893 .cindex "&ACL;" "PRDR-related"
14894 .cindex "&ACL;" "per-user data processing"
14895 This option defines the ACL that,
14896 if the PRDR feature has been negotiated,
14897 is run for each recipient after an SMTP DATA command has been
14898 processed and the message itself has been received, but before the
14899 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14900
14901 .option acl_smtp_dkim main string&!! unset
14902 .cindex DKIM "ACL for"
14903 This option defines the ACL that is run for each DKIM signature
14904 (by default, or as specified in the dkim_verify_signers option)
14905 of a received message.
14906 See section &<<SECDKIMVFY>>& for further details.
14907
14908 .option acl_smtp_etrn main string&!! unset
14909 .cindex "ETRN" "ACL for"
14910 This option defines the ACL that is run when an SMTP ETRN command is
14911 received. See chapter &<<CHAPACL>>& for further details.
14912
14913 .option acl_smtp_expn main string&!! unset
14914 .cindex "EXPN" "ACL for"
14915 This option defines the ACL that is run when an SMTP EXPN command is
14916 received. See chapter &<<CHAPACL>>& for further details.
14917
14918 .option acl_smtp_helo main string&!! unset
14919 .cindex "EHLO" "ACL for"
14920 .cindex "HELO" "ACL for"
14921 This option defines the ACL that is run when an SMTP EHLO or HELO
14922 command is received. See chapter &<<CHAPACL>>& for further details.
14923
14924
14925 .option acl_smtp_mail main string&!! unset
14926 .cindex "MAIL" "ACL for"
14927 This option defines the ACL that is run when an SMTP MAIL command is
14928 received. See chapter &<<CHAPACL>>& for further details.
14929
14930 .option acl_smtp_mailauth main string&!! unset
14931 .cindex "AUTH" "on MAIL command"
14932 This option defines the ACL that is run when there is an AUTH parameter on
14933 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14934 &<<CHAPSMTPAUTH>>& for details of authentication.
14935
14936 .option acl_smtp_mime main string&!! unset
14937 .cindex "MIME content scanning" "ACL for"
14938 This option is available when Exim is built with the content-scanning
14939 extension. It defines the ACL that is run for each MIME part in a message. See
14940 section &<<SECTscanmimepart>>& for details.
14941
14942 .option acl_smtp_notquit main string&!! unset
14943 .cindex "not-QUIT, ACL for"
14944 This option defines the ACL that is run when an SMTP session
14945 ends without a QUIT command being received.
14946 See chapter &<<CHAPACL>>& for further details.
14947
14948 .option acl_smtp_predata main string&!! unset
14949 This option defines the ACL that is run when an SMTP DATA command is
14950 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14951 further details.
14952
14953 .option acl_smtp_quit main string&!! unset
14954 .cindex "QUIT, ACL for"
14955 This option defines the ACL that is run when an SMTP QUIT command is
14956 received. See chapter &<<CHAPACL>>& for further details.
14957
14958 .option acl_smtp_rcpt main string&!! unset
14959 .cindex "RCPT" "ACL for"
14960 This option defines the ACL that is run when an SMTP RCPT command is
14961 received. See chapter &<<CHAPACL>>& for further details.
14962
14963 .option acl_smtp_starttls main string&!! unset
14964 .cindex "STARTTLS, ACL for"
14965 This option defines the ACL that is run when an SMTP STARTTLS command is
14966 received. See chapter &<<CHAPACL>>& for further details.
14967
14968 .option acl_smtp_vrfy main string&!! unset
14969 .cindex "VRFY" "ACL for"
14970 This option defines the ACL that is run when an SMTP VRFY command is
14971 received. See chapter &<<CHAPACL>>& for further details.
14972
14973 .option add_environment main "string list" empty
14974 .cindex "environment" "set values"
14975 This option adds individual environment variables that the
14976 currently linked libraries and programs in child processes may use.
14977 Each list element should be of the form &"name=value"&.
14978
14979 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14980
14981 .option admin_groups main "string list&!!" unset
14982 .cindex "admin user"
14983 This option is expanded just once, at the start of Exim's processing. If the
14984 current group or any of the supplementary groups of an Exim caller is in this
14985 colon-separated list, the caller has admin privileges. If all your system
14986 programmers are in a specific group, for example, you can give them all Exim
14987 admin privileges by putting that group in &%admin_groups%&. However, this does
14988 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14989 To permit this, you have to add individuals to the Exim group.
14990
14991 .option allow_domain_literals main boolean false
14992 .cindex "domain literal"
14993 If this option is set, the RFC 2822 domain literal format is permitted in
14994 email addresses. The option is not set by default, because the domain literal
14995 format is not normally required these days, and few people know about it. It
14996 has, however, been exploited by mail abusers.
14997
14998 Unfortunately, it seems that some DNS black list maintainers are using this
14999 format to report black listing to postmasters. If you want to accept messages
15000 addressed to your hosts by IP address, you need to set
15001 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15002 domains (defined in the named domain list &%local_domains%& in the default
15003 configuration). This &"magic string"& matches the domain literal form of all
15004 the local host's IP addresses.
15005
15006
15007 .option allow_mx_to_ip main boolean false
15008 .cindex "MX record" "pointing to IP address"
15009 It appears that more and more DNS zone administrators are breaking the rules
15010 and putting domain names that look like IP addresses on the right hand side of
15011 MX records. Exim follows the rules and rejects this, giving an error message
15012 that explains the misconfiguration. However, some other MTAs support this
15013 practice, so to avoid &"Why can't Exim do this?"& complaints,
15014 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15015 recommended, except when you have no other choice.
15016
15017 .option allow_utf8_domains main boolean false
15018 .cindex "domain" "UTF-8 characters in"
15019 .cindex "UTF-8" "in domain name"
15020 Lots of discussion is going on about internationalized domain names. One
15021 camp is strongly in favour of just using UTF-8 characters, and it seems
15022 that at least two other MTAs permit this.
15023 This option allows Exim users to experiment if they wish.
15024
15025 If it is set true, Exim's domain parsing function allows valid
15026 UTF-8 multicharacters to appear in domain name components, in addition to
15027 letters, digits, and hyphens.
15028
15029 If Exim is built with internationalization support
15030 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15031 this option can be left as default.
15032 Without that,
15033 if you want to look up such domain names in the DNS, you must also
15034 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15035 suitable setting is:
15036 .code
15037 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15038   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15039 .endd
15040 Alternatively, you can just disable this feature by setting
15041 .code
15042 dns_check_names_pattern =
15043 .endd
15044 That is, set the option to an empty string so that no check is done.
15045
15046
15047 .option auth_advertise_hosts main "host list&!!" *
15048 .cindex "authentication" "advertising"
15049 .cindex "AUTH" "advertising"
15050 .cindex "ESMTP extensions" AUTH
15051 If any server authentication mechanisms are configured, Exim advertises them in
15052 response to an EHLO command only if the calling host matches this list.
15053 Otherwise, Exim does not advertise AUTH.
15054 Exim does not accept AUTH commands from clients to which it has not
15055 advertised the availability of AUTH. The advertising of individual
15056 authentication mechanisms can be controlled by the use of the
15057 &%server_advertise_condition%& generic authenticator option on the individual
15058 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15059
15060 Certain mail clients (for example, Netscape) require the user to provide a name
15061 and password for authentication if AUTH is advertised, even though it may
15062 not be needed (the host may accept messages from hosts on its local LAN without
15063 authentication, for example). The &%auth_advertise_hosts%& option can be used
15064 to make these clients more friendly by excluding them from the set of hosts to
15065 which Exim advertises AUTH.
15066
15067 .cindex "AUTH" "advertising when encrypted"
15068 If you want to advertise the availability of AUTH only when the connection
15069 is encrypted using TLS, you can make use of the fact that the value of this
15070 option is expanded, with a setting like this:
15071 .code
15072 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15073 .endd
15074 .vindex "&$tls_in_cipher$&"
15075 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15076 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15077 expansion is *, which matches all hosts.
15078
15079
15080 .option auto_thaw main time 0s
15081 .cindex "thawing messages"
15082 .cindex "unfreezing messages"
15083 If this option is set to a time greater than zero, a queue runner will try a
15084 new delivery attempt on any frozen message, other than a bounce message, if
15085 this much time has passed since it was frozen. This may result in the message
15086 being re-frozen if nothing has changed since the last attempt. It is a way of
15087 saying &"keep on trying, even though there are big problems"&.
15088
15089 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15090 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15091 thought to be very useful any more, and its use should probably be avoided.
15092
15093
15094 .option av_scanner main string "see below"
15095 This option is available if Exim is built with the content-scanning extension.
15096 It specifies which anti-virus scanner to use. The default value is:
15097 .code
15098 sophie:/var/run/sophie
15099 .endd
15100 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15101 before use. See section &<<SECTscanvirus>>& for further details.
15102
15103
15104 .option bi_command main string unset
15105 .oindex "&%-bi%&"
15106 This option supplies the name of a command that is run when Exim is called with
15107 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15108 just the command name, it is not a complete command line. If an argument is
15109 required, it must come from the &%-oA%& command line option.
15110
15111
15112 .option bounce_message_file main string&!! unset
15113 .cindex "bounce message" "customizing"
15114 .cindex "customizing" "bounce message"
15115 This option defines a template file containing paragraphs of text to be used
15116 for constructing bounce messages.  Details of the file's contents are given in
15117 chapter &<<CHAPemsgcust>>&.
15118 .new
15119 .cindex bounce_message_file "tainted data"
15120 The option is expanded to give the file path, which must be
15121 absolute and untainted.
15122 .wen
15123 See also &%warn_message_file%&.
15124
15125
15126 .option bounce_message_text main string unset
15127 When this option is set, its contents are included in the default bounce
15128 message immediately after &"This message was created automatically by mail
15129 delivery software."& It is not used if &%bounce_message_file%& is set.
15130
15131 .option bounce_return_body main boolean true
15132 .cindex "bounce message" "including body"
15133 This option controls whether the body of an incoming message is included in a
15134 bounce message when &%bounce_return_message%& is true. The default setting
15135 causes the entire message, both header and body, to be returned (subject to the
15136 value of &%bounce_return_size_limit%&). If this option is false, only the
15137 message header is included. In the case of a non-SMTP message containing an
15138 error that is detected during reception, only those header lines preceding the
15139 point at which the error was detected are returned.
15140 .cindex "bounce message" "including original"
15141
15142 .option bounce_return_linesize_limit main integer 998
15143 .cindex "size" "of bounce lines, limit"
15144 .cindex "bounce message" "line length limit"
15145 .cindex "limit" "bounce message line length"
15146 This option sets a limit in bytes on the line length of messages
15147 that are returned to senders due to delivery problems,
15148 when &%bounce_return_message%& is true.
15149 The default value corresponds to RFC limits.
15150 If the message being returned has lines longer than this value it is
15151 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15152
15153 The option also applies to bounces returned when an error is detected
15154 during reception of a message.
15155 In this case lines from the original are truncated.
15156
15157 The option does not apply to messages generated by an &(autoreply)& transport.
15158
15159
15160 .option bounce_return_message main boolean true
15161 If this option is set false, none of the original message is included in
15162 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15163 &%bounce_return_body%&.
15164
15165
15166 .option bounce_return_size_limit main integer 100K
15167 .cindex "size" "of bounce, limit"
15168 .cindex "bounce message" "size limit"
15169 .cindex "limit" "bounce message size"
15170 This option sets a limit in bytes on the size of messages that are returned to
15171 senders as part of bounce messages when &%bounce_return_message%& is true. The
15172 limit should be less than the value of the global &%message_size_limit%& and of
15173 any &%message_size_limit%& settings on transports, to allow for the bounce text
15174 that Exim generates. If this option is set to zero there is no limit.
15175
15176 When the body of any message that is to be included in a bounce message is
15177 greater than the limit, it is truncated, and a comment pointing this out is
15178 added at the top. The actual cutoff may be greater than the value given, owing
15179 to the use of buffering for transferring the message in chunks (typically 8K in
15180 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15181 messages.
15182
15183 .option bounce_sender_authentication main string unset
15184 .cindex "bounce message" "sender authentication"
15185 .cindex "authentication" "bounce message"
15186 .cindex "AUTH" "on bounce message"
15187 This option provides an authenticated sender address that is sent with any
15188 bounce messages generated by Exim that are sent over an authenticated SMTP
15189 connection. A typical setting might be:
15190 .code
15191 bounce_sender_authentication = mailer-daemon@my.domain.example
15192 .endd
15193 which would cause bounce messages to be sent using the SMTP command:
15194 .code
15195 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15196 .endd
15197 The value of &%bounce_sender_authentication%& must always be a complete email
15198 address.
15199
15200 .option callout_domain_negative_expire main time 3h
15201 .cindex "caching" "callout timeouts"
15202 .cindex "callout" "caching timeouts"
15203 This option specifies the expiry time for negative callout cache data for a
15204 domain. See section &<<SECTcallver>>& for details of callout verification, and
15205 section &<<SECTcallvercache>>& for details of the caching.
15206
15207
15208 .option callout_domain_positive_expire main time 7d
15209 This option specifies the expiry time for positive callout cache data for a
15210 domain. See section &<<SECTcallver>>& for details of callout verification, and
15211 section &<<SECTcallvercache>>& for details of the caching.
15212
15213
15214 .option callout_negative_expire main time 2h
15215 This option specifies the expiry time for negative callout cache data for an
15216 address. See section &<<SECTcallver>>& for details of callout verification, and
15217 section &<<SECTcallvercache>>& for details of the caching.
15218
15219
15220 .option callout_positive_expire main time 24h
15221 This option specifies the expiry time for positive callout cache data for an
15222 address. See section &<<SECTcallver>>& for details of callout verification, and
15223 section &<<SECTcallvercache>>& for details of the caching.
15224
15225
15226 .option callout_random_local_part main string&!! "see below"
15227 This option defines the &"random"& local part that can be used as part of
15228 callout verification. The default value is
15229 .code
15230 $primary_hostname-$tod_epoch-testing
15231 .endd
15232 See section &<<CALLaddparcall>>& for details of how this value is used.
15233
15234
15235 .option check_log_inodes main integer 100
15236 See &%check_spool_space%& below.
15237
15238
15239 .option check_log_space main integer 10M
15240 See &%check_spool_space%& below.
15241
15242 .oindex "&%check_rfc2047_length%&"
15243 .cindex "RFC 2047" "disabling length check"
15244 .option check_rfc2047_length main boolean true
15245 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15246 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15247 word; strings to be encoded that exceed this length are supposed to use
15248 multiple encoded words. By default, Exim does not recognize encoded words that
15249 exceed the maximum length. However, it seems that some software, in violation
15250 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15251 set false, Exim recognizes encoded words of any length.
15252
15253
15254 .option check_spool_inodes main integer 100
15255 See &%check_spool_space%& below.
15256
15257
15258 .option check_spool_space main integer 10M
15259 .cindex "checking disk space"
15260 .cindex "disk space, checking"
15261 .cindex "spool directory" "checking space"
15262 The four &%check_...%& options allow for checking of disk resources before a
15263 message is accepted.
15264
15265 .vindex "&$log_inodes$&"
15266 .vindex "&$log_space$&"
15267 .vindex "&$spool_inodes$&"
15268 .vindex "&$spool_space$&"
15269 When any of these options are nonzero, they apply to all incoming messages. If you
15270 want to apply different checks to different kinds of message, you can do so by
15271 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15272 &$spool_space$& in an ACL with appropriate additional conditions.
15273
15274
15275 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15276 either value is greater than zero, for example:
15277 .code
15278 check_spool_space = 100M
15279 check_spool_inodes = 100
15280 .endd
15281 The spool partition is the one that contains the directory defined by
15282 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15283 transit.
15284
15285 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15286 files are written if either is greater than zero. These should be set only if
15287 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15288
15289 If there is less space or fewer inodes than requested, Exim refuses to accept
15290 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15291 error response to the MAIL command. If ESMTP is in use and there was a
15292 SIZE parameter on the MAIL command, its value is added to the
15293 &%check_spool_space%& value, and the check is performed even if
15294 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15295
15296 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15297 number of kilobytes (though specified in bytes).
15298 If a non-multiple of 1024 is specified, it is rounded up.
15299
15300 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15301 failure a message is written to stderr and Exim exits with a non-zero code, as
15302 it obviously cannot send an error message of any kind.
15303
15304 There is a slight performance penalty for these checks.
15305 Versions of Exim preceding 4.88 had these disabled by default;
15306 high-rate installations confident they will never run out of resources
15307 may wish to deliberately disable them.
15308
15309 .option chunking_advertise_hosts main "host list&!!" *
15310 .cindex CHUNKING advertisement
15311 .cindex "RFC 3030" "CHUNKING"
15312 .cindex "ESMTP extensions" CHUNKING
15313 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15314 these hosts.
15315 Hosts may use the BDAT command as an alternate to DATA.
15316
15317 .option commandline_checks_require_admin main boolean &`false`&
15318 .cindex "restricting access to features"
15319 This option restricts various basic checking features to require an
15320 administrative user.
15321 This affects most of the &%-b*%& options, such as &%-be%&.
15322
15323 .option debug_store main boolean &`false`&
15324 .cindex debugging "memory corruption"
15325 .cindex memory debugging
15326 This option, when true, enables extra checking in Exim's internal memory
15327 management.  For use when a memory corruption issue is being investigated,
15328 it should normally be left as default.
15329
15330 .option daemon_smtp_ports main string &`smtp`&
15331 .cindex "port" "for daemon"
15332 .cindex "TCP/IP" "setting listening ports"
15333 This option specifies one or more default SMTP ports on which the Exim daemon
15334 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15335 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15336
15337 .option daemon_startup_retries main integer 9
15338 .cindex "daemon startup, retrying"
15339 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15340 the daemon at startup when it cannot immediately bind a listening socket
15341 (typically because the socket is already in use): &%daemon_startup_retries%&
15342 defines the number of retries after the first failure, and
15343 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15344
15345 .option daemon_startup_sleep main time 30s
15346 See &%daemon_startup_retries%&.
15347
15348 .option delay_warning main "time list" 24h
15349 .cindex "warning of delay"
15350 .cindex "delay warning, specifying"
15351 .cindex "queue" "delay warning"
15352 When a message is delayed, Exim sends a warning message to the sender at
15353 intervals specified by this option. The data is a colon-separated list of times
15354 after which to send warning messages. If the value of the option is an empty
15355 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15356 message has been in the queue for longer than the last time, the last interval
15357 between the times is used to compute subsequent warning times. For example,
15358 with
15359 .code
15360 delay_warning = 4h:8h:24h
15361 .endd
15362 the first message is sent after 4 hours, the second after 8 hours, and
15363 the third one after 24 hours. After that, messages are sent every 16 hours,
15364 because that is the interval between the last two times on the list. If you set
15365 just one time, it specifies the repeat interval. For example, with:
15366 .code
15367 delay_warning = 6h
15368 .endd
15369 messages are repeated every six hours. To stop warnings after a given time, set
15370 a very large time at the end of the list. For example:
15371 .code
15372 delay_warning = 2h:12h:99d
15373 .endd
15374 Note that the option is only evaluated at the time a delivery attempt fails,
15375 which depends on retry and queue-runner configuration.
15376 Typically retries will be configured more frequently than warning messages.
15377
15378 .option delay_warning_condition main string&!! "see below"
15379 .vindex "&$domain$&"
15380 The string is expanded at the time a warning message might be sent. If all the
15381 deferred addresses have the same domain, it is set in &$domain$& during the
15382 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15383 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15384 &"false"& (the comparison being done caselessly) then the warning message is
15385 not sent. The default is:
15386 .code
15387 delay_warning_condition = ${if or {\
15388   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15389   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15390   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15391   } {no}{yes}}
15392 .endd
15393 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15394 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15395 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15396 &"auto-replied"& in an &'Auto-Submitted:'& header.
15397
15398 .option deliver_drop_privilege main boolean false
15399 .cindex "unprivileged delivery"
15400 .cindex "delivery" "unprivileged"
15401 If this option is set true, Exim drops its root privilege at the start of a
15402 delivery process, and runs as the Exim user throughout. This severely restricts
15403 the kinds of local delivery that are possible, but is viable in certain types
15404 of configuration. There is a discussion about the use of root privilege in
15405 chapter &<<CHAPsecurity>>&.
15406
15407 .option deliver_queue_load_max main fixed-point unset
15408 .cindex "load average"
15409 .cindex "queue runner" "abandoning"
15410 When this option is set, a queue run is abandoned if the system load average
15411 becomes greater than the value of the option. The option has no effect on
15412 ancient operating systems on which Exim cannot determine the load average.
15413 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15414
15415
15416 .option delivery_date_remove main boolean true
15417 .cindex "&'Delivery-date:'& header line"
15418 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15419 message when it is delivered, in exactly the same way as &'Return-path:'& is
15420 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15421 should not be present in incoming messages, and this option causes them to be
15422 removed at the time the message is received, to avoid any problems that might
15423 occur when a delivered message is subsequently sent on to some other recipient.
15424
15425 .option disable_fsync main boolean false
15426 .cindex "&[fsync()]&, disabling"
15427 This option is available only if Exim was built with the compile-time option
15428 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15429 a runtime configuration generates an &"unknown option"& error. You should not
15430 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15431 really, really, really understand what you are doing. &'No pre-compiled
15432 distributions of Exim should ever make this option available.'&
15433
15434 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15435 updated files' data to be written to disc before continuing. Unexpected events
15436 such as crashes and power outages may cause data to be lost or scrambled.
15437 Here be Dragons. &*Beware.*&
15438
15439
15440 .option disable_ipv6 main boolean false
15441 .cindex "IPv6" "disabling"
15442 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15443 activities take place. AAAA records are never looked up, and any IPv6 addresses
15444 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15445 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15446 to handle IPv6 literal addresses.
15447
15448
15449 .new
15450 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15451 .cindex DKIM "selecting signature algorithms"
15452 This option gives a list of hash types which are acceptable in signatures,
15453 .wen
15454 and an order of processing.
15455 Signatures with algorithms not in the list will be ignored.
15456
15457 Acceptable values include:
15458 .code
15459 sha1
15460 sha256
15461 sha512
15462 .endd
15463
15464 Note that the acceptance of sha1 violates RFC 8301.
15465
15466 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15467 This option gives a list of key types which are acceptable in signatures,
15468 and an order of processing.
15469 Signatures with algorithms not in the list will be ignored.
15470
15471
15472 .new
15473 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15474 This option gives a list of key sizes which are acceptable in signatures.
15475 The list is keyed by the algorithm type for the key; the values are in bits.
15476 Signatures with keys smaller than given by this option will fail verification.
15477
15478 The default enforces the RFC 8301 minimum key size for RSA signatures.
15479 .wen
15480
15481 .option dkim_verify_minimal main boolean false
15482 If set to true, verification of signatures will terminate after the
15483 first success.
15484
15485 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15486 .cindex DKIM "controlling calls to the ACL"
15487 This option gives a list of DKIM domains for which the DKIM ACL is run.
15488 It is expanded after the message is received; by default it runs
15489 the ACL once for each signature in the message.
15490 See section &<<SECDKIMVFY>>&.
15491
15492
15493 .option dmarc_forensic_sender main string&!! unset
15494 .option dmarc_history_file main string unset
15495 .option dmarc_tld_file main string unset
15496 .cindex DMARC "main section options"
15497 These options control DMARC processing.
15498 See section &<<SECDMARC>>& for details.
15499
15500
15501 .option dns_again_means_nonexist main "domain list&!!" unset
15502 .cindex "DNS" "&""try again""& response; overriding"
15503 DNS lookups give a &"try again"& response for the DNS errors
15504 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15505 keep trying to deliver a message, or to give repeated temporary errors to
15506 incoming mail. Sometimes the effect is caused by a badly set up name server and
15507 may persist for a long time. If a domain which exhibits this problem matches
15508 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15509 This option should be used with care. You can make it apply to reverse lookups
15510 by a setting such as this:
15511 .code
15512 dns_again_means_nonexist = *.in-addr.arpa
15513 .endd
15514 This option applies to all DNS lookups that Exim does. It also applies when the
15515 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15516 since these are most likely to be caused by DNS lookup problems. The
15517 &(dnslookup)& router has some options of its own for controlling what happens
15518 when lookups for MX or SRV records give temporary errors. These more specific
15519 options are applied after this global option.
15520
15521 .option dns_check_names_pattern main string "see below"
15522 .cindex "DNS" "pre-check of name syntax"
15523 When this option is set to a non-empty string, it causes Exim to check domain
15524 names for characters that are not allowed in host names before handing them to
15525 the DNS resolver, because some resolvers give temporary errors for names that
15526 contain unusual characters. If a domain name contains any unwanted characters,
15527 a &"not found"& result is forced, and the resolver is not called. The check is
15528 done by matching the domain name against a regular expression, which is the
15529 value of this option. The default pattern is
15530 .code
15531 dns_check_names_pattern = \
15532   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15533 .endd
15534 which permits only letters, digits, slashes, and hyphens in components, but
15535 they must start and end with a letter or digit. Slashes are not, in fact,
15536 permitted in host names, but they are found in certain NS records (which can be
15537 accessed in Exim by using a &%dnsdb%& lookup). If you set
15538 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15539 empty string.
15540
15541 .option dns_csa_search_limit main integer 5
15542 This option controls the depth of parental searching for CSA SRV records in the
15543 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15544
15545 .option dns_csa_use_reverse main boolean true
15546 This option controls whether or not an IP address, given as a CSA domain, is
15547 reversed and looked up in the reverse DNS, as described in more detail in
15548 section &<<SECTverifyCSA>>&.
15549
15550 .option dns_cname_loops main integer 1
15551 .cindex DNS "CNAME following"
15552 This option controls the following of CNAME chains, needed if the resolver does
15553 not do it internally.
15554 As of 2018 most should, and the default can be left.
15555 If you have an ancient one, a value of 10 is likely needed.
15556
15557 The default value of one CNAME-follow is needed
15558 thanks to the observed return for an MX request,
15559 given no MX presence but a CNAME to an A, of the CNAME.
15560
15561
15562 .option dns_dnssec_ok main integer -1
15563 .cindex "DNS" "resolver options"
15564 .cindex "DNS" "DNSSEC"
15565 If this option is set to a non-negative number then Exim will initialise the
15566 DNS resolver library to either use or not use DNSSEC, overriding the system
15567 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15568
15569 If the resolver library does not support DNSSEC then this option has no effect.
15570
15571 .new
15572 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15573 will default to stripping out a successful validation status.
15574 This will break a previously working Exim installation.
15575 Provided that you do trust the resolver (ie, is on localhost) you can tell
15576 glibc to pass through any successful validation with a new option in
15577 &_/etc/resolv.conf_&:
15578 .code
15579 options trust-ad
15580 .endd
15581 .wen
15582
15583
15584 .option dns_ipv4_lookup main "domain list&!!" unset
15585 .cindex "IPv6" "DNS lookup for AAAA records"
15586 .cindex "DNS" "IPv6 lookup for AAAA records"
15587 .cindex DNS "IPv6 disabling"
15588 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15589 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15590 (A records) when trying to find IP addresses for hosts, unless the host's
15591 domain matches this list.
15592
15593 This is a fudge to help with name servers that give big delays or otherwise do
15594 not work for the AAAA record type. In due course, when the world's name
15595 servers have all been upgraded, there should be no need for this option.
15596 Note that all lookups, including those done for verification, are affected;
15597 this will result in verify failure for IPv6 connections or ones using names
15598 only valid for IPv6 addresses.
15599
15600
15601 .option dns_retrans main time 0s
15602 .cindex "DNS" "resolver options"
15603 .cindex timeout "dns lookup"
15604 .cindex "DNS" timeout
15605 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15606 retransmission and retry parameters for DNS lookups. Values of zero (the
15607 defaults) leave the system default settings unchanged. The first value is the
15608 time between retries, and the second is the number of retries. It isn't
15609 totally clear exactly how these settings affect the total time a DNS lookup may
15610 take. I haven't found any documentation about timeouts on DNS lookups; these
15611 parameter values are available in the external resolver interface structure,
15612 but nowhere does it seem to describe how they are used or what you might want
15613 to set in them.
15614 See also the &%slow_lookup_log%& option.
15615
15616
15617 .option dns_retry main integer 0
15618 See &%dns_retrans%& above.
15619
15620
15621 .option dns_trust_aa main "domain list&!!" unset
15622 .cindex "DNS" "resolver options"
15623 .cindex "DNS" "DNSSEC"
15624 If this option is set then lookup results marked with the AA bit
15625 (Authoritative Answer) are trusted the same way as if they were
15626 DNSSEC-verified. The authority section's name of the answer must
15627 match with this expanded domain list.
15628
15629 Use this option only if you talk directly to a resolver that is
15630 authoritative for some zones and does not set the AD (Authentic Data)
15631 bit in the answer. Some DNS servers may have an configuration option to
15632 mark the answers from their own zones as verified (they set the AD bit).
15633 Others do not have this option. It is considered as poor practice using
15634 a resolver that is an authoritative server for some zones.
15635
15636 Use this option only if you really have to (e.g. if you want
15637 to use DANE for remote delivery to a server that is listed in the DNS
15638 zones that your resolver is authoritative for).
15639
15640 If the DNS answer packet has the AA bit set and contains resource record
15641 in the answer section, the name of the first NS record appearing in the
15642 authority section is compared against the list. If the answer packet is
15643 authoritative but the answer section is empty, the name of the first SOA
15644 record in the authoritative section is used instead.
15645
15646 .cindex "DNS" "resolver options"
15647 .option dns_use_edns0 main integer -1
15648 .cindex "DNS" "resolver options"
15649 .cindex "DNS" "EDNS0"
15650 .cindex "DNS" "OpenBSD
15651 If this option is set to a non-negative number then Exim will initialise the
15652 DNS resolver library to either use or not use EDNS0 extensions, overriding
15653 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15654 on.
15655
15656 If the resolver library does not support EDNS0 then this option has no effect.
15657
15658 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15659 means that DNSSEC will not work with Exim on that platform either, unless Exim
15660 is linked against an alternative DNS client library.
15661
15662
15663 .option drop_cr main boolean false
15664 This is an obsolete option that is now a no-op. It used to affect the way Exim
15665 handled CR and LF characters in incoming messages. What happens now is
15666 described in section &<<SECTlineendings>>&.
15667
15668 .option dsn_advertise_hosts main "host list&!!" unset
15669 .cindex "bounce messages" "success"
15670 .cindex "DSN" "success"
15671 .cindex "Delivery Status Notification" "success"
15672 .cindex "ESMTP extensions" DSN
15673 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15674 and accepted from, these hosts.
15675 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15676 and RET and ORCPT options on MAIL FROM commands.
15677 A NOTIFY=SUCCESS option requests success-DSN messages.
15678 A NOTIFY= option with no argument requests that no delay or failure DSNs
15679 are sent.
15680 .new
15681 &*Note*&: Supplying success-DSN messages has been criticised
15682 on privacy grounds; it can leak details of internal forwarding.
15683 .wen
15684
15685 .option dsn_from main "string&!!" "see below"
15686 .cindex "&'From:'& header line" "in bounces"
15687 .cindex "bounce messages" "&'From:'& line, specifying"
15688 This option can be used to vary the contents of &'From:'& header lines in
15689 bounces and other automatically generated messages (&"Delivery Status
15690 Notifications"& &-- hence the name of the option). The default setting is:
15691 .code
15692 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15693 .endd
15694 The value is expanded every time it is needed. If the expansion fails, a
15695 panic is logged, and the default value is used.
15696
15697 .option envelope_to_remove main boolean true
15698 .cindex "&'Envelope-to:'& header line"
15699 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15700 message when it is delivered, in exactly the same way as &'Return-path:'& is
15701 handled. &'Envelope-to:'& records the original recipient address from the
15702 message's envelope that caused the delivery to happen. Such headers should not
15703 be present in incoming messages, and this option causes them to be removed at
15704 the time the message is received, to avoid any problems that might occur when a
15705 delivered message is subsequently sent on to some other recipient.
15706
15707
15708 .option errors_copy main "string list&!!" unset
15709 .cindex "bounce message" "copy to other address"
15710 .cindex "copy of bounce message"
15711 Setting this option causes Exim to send bcc copies of bounce messages that it
15712 generates to other addresses. &*Note*&: This does not apply to bounce messages
15713 coming from elsewhere. The value of the option is a colon-separated list of
15714 items. Each item consists of a pattern, terminated by white space, followed by
15715 a comma-separated list of email addresses. If a pattern contains spaces, it
15716 must be enclosed in double quotes.
15717
15718 Each pattern is processed in the same way as a single item in an address list
15719 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15720 the bounce message, the message is copied to the addresses on the list. The
15721 items are scanned in order, and once a matching one is found, no further items
15722 are examined. For example:
15723 .code
15724 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15725               rqps@mydomain   hostmaster@mydomain.example,\
15726                               postmaster@mydomain.example
15727 .endd
15728 .vindex "&$domain$&"
15729 .vindex "&$local_part$&"
15730 The address list is expanded before use. The expansion variables &$local_part$&
15731 and &$domain$& are set from the original recipient of the error message, and if
15732 there was any wildcard matching in the pattern, the expansion
15733 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15734 variables &$0$&, &$1$&, etc. are set in the normal way.
15735
15736
15737 .option errors_reply_to main string unset
15738 .cindex "bounce message" "&'Reply-to:'& in"
15739 By default, Exim's bounce and delivery warning messages contain the header line
15740 .display
15741 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15742 .endd
15743 .oindex &%quota_warn_message%&
15744 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15745 A warning message that is generated by the &%quota_warn_message%& option in an
15746 &(appendfile)& transport may contain its own &'From:'& header line that
15747 overrides the default.
15748
15749 Experience shows that people reply to bounce messages. If the
15750 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15751 and warning messages. For example:
15752 .code
15753 errors_reply_to = postmaster@my.domain.example
15754 .endd
15755 The value of the option is not expanded. It must specify a valid RFC 2822
15756 address. However, if a warning message that is generated by the
15757 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15758 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15759 not used.
15760
15761
15762 .option event_action main string&!! unset
15763 .cindex events
15764 This option declares a string to be expanded for Exim's events mechanism.
15765 For details see chapter &<<CHAPevents>>&.
15766
15767
15768 .option exim_group main string "compile-time configured"
15769 .cindex "gid (group id)" "Exim's own"
15770 .cindex "Exim group"
15771 This option changes the gid under which Exim runs when it gives up root
15772 privilege. The default value is compiled into the binary. The value of this
15773 option is used only when &%exim_user%& is also set. Unless it consists entirely
15774 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15775 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15776 security issues.
15777
15778
15779 .option exim_path main string "see below"
15780 .cindex "Exim binary, path name"
15781 This option specifies the path name of the Exim binary, which is used when Exim
15782 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15783 the directory configured at compile time by the BIN_DIRECTORY setting. It
15784 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15785 other place.
15786 &*Warning*&: Do not use a macro to define the value of this option, because
15787 you will break those Exim utilities that scan the configuration file to find
15788 where the binary is. (They then use the &%-bP%& option to extract option
15789 settings such as the value of &%spool_directory%&.)
15790
15791
15792 .option exim_user main string "compile-time configured"
15793 .cindex "uid (user id)" "Exim's own"
15794 .cindex "Exim user"
15795 This option changes the uid under which Exim runs when it gives up root
15796 privilege. The default value is compiled into the binary. Ownership of the run
15797 time configuration file and the use of the &%-C%& and &%-D%& command line
15798 options is checked against the values in the binary, not what is set here.
15799
15800 Unless it consists entirely of digits, the string is looked up using
15801 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15802 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15803 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15804
15805
15806 .option exim_version main string "current version"
15807 .cindex "Exim version"
15808 .cindex customizing "version number"
15809 .cindex "version number of Exim" override
15810 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15811 various places.  Use with care; this may fool stupid security scanners.
15812
15813
15814 .option extra_local_interfaces main "string list" unset
15815 This option defines network interfaces that are to be considered local when
15816 routing, but which are not used for listening by the daemon. See section
15817 &<<SECTreclocipadd>>& for details.
15818
15819
15820 . Allow this long option name to split; give it unsplit as a fifth argument
15821 . for the automatic .oindex that is generated by .option.
15822
15823 .option "extract_addresses_remove_arguments" main boolean true &&&
15824          extract_addresses_remove_arguments
15825 .oindex "&%-t%&"
15826 .cindex "command line" "addresses with &%-t%&"
15827 .cindex "Sendmail compatibility" "&%-t%& option"
15828 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15829 are present on the command line when the &%-t%& option is used to build an
15830 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15831 line addresses are removed from the recipients list. This is also how Smail
15832 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15833 command line addresses are added to those obtained from the header lines. When
15834 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15835 argument headers. If it is set false, Exim adds rather than removes argument
15836 addresses.
15837
15838
15839 .option finduser_retries main integer 0
15840 .cindex "NIS, retrying user lookups"
15841 On systems running NIS or other schemes in which user and group information is
15842 distributed from a remote system, there can be times when &[getpwnam()]& and
15843 related functions fail, even when given valid data, because things time out.
15844 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15845 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15846 many extra times to find a user or a group, waiting for one second between
15847 retries.
15848
15849 .cindex "&_/etc/passwd_&" "multiple reading of"
15850 You should not set this option greater than zero if your user information is in
15851 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15852 search the file multiple times for non-existent users, and also cause delay.
15853
15854
15855
15856 .option freeze_tell main "string list, comma separated" unset
15857 .cindex "freezing messages" "sending a message when freezing"
15858 On encountering certain errors, or when configured to do so in a system filter,
15859 ACL, or special router, Exim freezes a message. This means that no further
15860 delivery attempts take place until an administrator thaws the message, or the
15861 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15862 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15863 warning message whenever it freezes something, unless the message it is
15864 freezing is a locally-generated bounce message. (Without this exception there
15865 is the possibility of looping.) The warning message is sent to the addresses
15866 supplied as the comma-separated value of this option. If several of the
15867 message's addresses cause freezing, only a single message is sent. If the
15868 freezing was automatic, the reason(s) for freezing can be found in the message
15869 log. If you configure freezing in a filter or ACL, you must arrange for any
15870 logging that you require.
15871
15872
15873 .option gecos_name main string&!! unset
15874 .cindex "HP-UX"
15875 .cindex "&""gecos""& field, parsing"
15876 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15877 password file to hold other information in addition to users' real names. Exim
15878 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15879 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15880 of the field are used unchanged, except that, if an ampersand is encountered,
15881 it is replaced by the user's login name with the first character forced to
15882 upper case, since this is a convention that is observed on many systems.
15883
15884 When these options are set, &%gecos_pattern%& is treated as a regular
15885 expression that is to be applied to the field (again with && replaced by the
15886 login name), and if it matches, &%gecos_name%& is expanded and used as the
15887 user's name.
15888
15889 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15890 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15891 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15892 name terminates at the first comma, the following can be used:
15893 .code
15894 gecos_pattern = ([^,]*)
15895 gecos_name = $1
15896 .endd
15897
15898 .option gecos_pattern main string unset
15899 See &%gecos_name%& above.
15900
15901
15902 .option gnutls_compat_mode main boolean unset
15903 This option controls whether GnuTLS is used in compatibility mode in an Exim
15904 server. This reduces security slightly, but improves interworking with older
15905 implementations of TLS.
15906
15907
15908 .option gnutls_allow_auto_pkcs11 main boolean unset
15909 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15910 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15911
15912 See
15913 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15914 for documentation.
15915
15916
15917
15918 .option headers_charset main string "see below"
15919 This option sets a default character set for translating from encoded MIME
15920 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15921 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15922 ultimate default is ISO-8859-1. For more details see the description of header
15923 insertions in section &<<SECTexpansionitems>>&.
15924
15925
15926
15927 .option header_maxsize main integer "see below"
15928 .cindex "header section" "maximum size of"
15929 .cindex "limit" "size of message header section"
15930 This option controls the overall maximum size of a message's header
15931 section. The default is the value of HEADER_MAXSIZE in
15932 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15933 sections are rejected.
15934
15935
15936 .option header_line_maxsize main integer 0
15937 .cindex "header lines" "maximum size of"
15938 .cindex "limit" "size of one header line"
15939 This option limits the length of any individual header line in a message, after
15940 all the continuations have been joined together. Messages with individual
15941 header lines that are longer than the limit are rejected. The default value of
15942 zero means &"no limit"&.
15943
15944
15945
15946
15947 .option helo_accept_junk_hosts main "host list&!!" unset
15948 .cindex "HELO" "accepting junk data"
15949 .cindex "EHLO" "accepting junk data"
15950 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15951 mail, and gives an error response for invalid data. Unfortunately, there are
15952 some SMTP clients that send syntactic junk. They can be accommodated by setting
15953 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15954 if you want to do semantic checking.
15955 See also &%helo_allow_chars%& for a way of extending the permitted character
15956 set.
15957
15958
15959 .option helo_allow_chars main string unset
15960 .cindex "HELO" "underscores in"
15961 .cindex "EHLO" "underscores in"
15962 .cindex "underscore in EHLO/HELO"
15963 This option can be set to a string of rogue characters that are permitted in
15964 all EHLO and HELO names in addition to the standard letters, digits,
15965 hyphens, and dots. If you really must allow underscores, you can set
15966 .code
15967 helo_allow_chars = _
15968 .endd
15969 Note that the value is one string, not a list.
15970
15971
15972 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15973 .cindex "HELO" "forcing reverse lookup"
15974 .cindex "EHLO" "forcing reverse lookup"
15975 If the domain given by a client in a HELO or EHLO command matches this
15976 list, a reverse lookup is done in order to establish the host's true name. The
15977 default forces a lookup if the client host gives the server's name or any of
15978 its IP addresses (in brackets), something that broken clients have been seen to
15979 do.
15980
15981
15982 .option helo_try_verify_hosts main "host list&!!" unset
15983 .cindex "HELO verifying" "optional"
15984 .cindex "EHLO" "verifying, optional"
15985 By default, Exim just checks the syntax of HELO and EHLO commands (see
15986 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15987 to do more extensive checking of the data supplied by these commands. The ACL
15988 condition &`verify = helo`& is provided to make this possible.
15989 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15990 to force the check to occur. From release 4.53 onwards, this is no longer
15991 necessary. If the check has not been done before &`verify = helo`& is
15992 encountered, it is done at that time. Consequently, this option is obsolete.
15993 Its specification is retained here for backwards compatibility.
15994
15995 When an EHLO or HELO command is received, if the calling host matches
15996 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15997 EHLO command either:
15998
15999 .ilist
16000 is an IP literal matching the calling address of the host, or
16001 .next
16002 .cindex "DNS" "reverse lookup"
16003 .cindex "reverse DNS lookup"
16004 matches the host name that Exim obtains by doing a reverse lookup of the
16005 calling host address, or
16006 .next
16007 when looked up in DNS yields the calling host address.
16008 .endlist
16009
16010 However, the EHLO or HELO command is not rejected if any of the checks
16011 fail. Processing continues, but the result of the check is remembered, and can
16012 be detected later in an ACL by the &`verify = helo`& condition.
16013
16014 If DNS was used for successful verification, the variable
16015 .cindex "DNS" "DNSSEC"
16016 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16017
16018 .option helo_verify_hosts main "host list&!!" unset
16019 .cindex "HELO verifying" "mandatory"
16020 .cindex "EHLO" "verifying, mandatory"
16021 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16022 backwards compatibility. For hosts that match this option, Exim checks the host
16023 name given in the HELO or EHLO in the same way as for
16024 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16025 rejected with a 550 error, and entries are written to the main and reject logs.
16026 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16027 error.
16028
16029 .option hold_domains main "domain list&!!" unset
16030 .cindex "domain" "delaying delivery"
16031 .cindex "delivery" "delaying certain domains"
16032 This option allows mail for particular domains to be held in the queue
16033 manually. The option is overridden if a message delivery is forced with the
16034 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16035 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16036 item in &%hold_domains%&, no routing or delivery for that address is done, and
16037 it is deferred every time the message is looked at.
16038
16039 This option is intended as a temporary operational measure for delaying the
16040 delivery of mail while some problem is being sorted out, or some new
16041 configuration tested. If you just want to delay the processing of some
16042 domains until a queue run occurs, you should use &%queue_domains%& or
16043 &%queue_smtp_domains%&, not &%hold_domains%&.
16044
16045 A setting of &%hold_domains%& does not override Exim's code for removing
16046 messages from the queue if they have been there longer than the longest retry
16047 time in any retry rule. If you want to hold messages for longer than the normal
16048 retry times, insert a dummy retry rule with a long retry time.
16049
16050
16051 .option host_lookup main "host list&!!" unset
16052 .cindex "host name" "lookup, forcing"
16053 Exim does not look up the name of a calling host from its IP address unless it
16054 is required to compare against some host list, or the host matches
16055 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16056 option (which normally contains IP addresses rather than host names). The
16057 default configuration file contains
16058 .code
16059 host_lookup = *
16060 .endd
16061 which causes a lookup to happen for all hosts. If the expense of these lookups
16062 is felt to be too great, the setting can be changed or removed.
16063
16064 After a successful reverse lookup, Exim does a forward lookup on the name it
16065 has obtained, to verify that it yields the IP address that it started with. If
16066 this check fails, Exim behaves as if the name lookup failed.
16067
16068 .vindex "&$host_lookup_failed$&"
16069 .vindex "&$sender_host_name$&"
16070 After any kind of failure, the host name (in &$sender_host_name$&) remains
16071 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16072 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16073 &`verify = reverse_host_lookup`& in ACLs.
16074
16075
16076 .option host_lookup_order main "string list" &`bydns:byaddr`&
16077 This option specifies the order of different lookup methods when Exim is trying
16078 to find a host name from an IP address. The default is to do a DNS lookup
16079 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16080 if that fails. You can change the order of these lookups, or omit one entirely,
16081 if you want.
16082
16083 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16084 multiple PTR records in the DNS and the IP address is not listed in
16085 &_/etc/hosts_&. Different operating systems give different results in this
16086 case. That is why the default tries a DNS lookup first.
16087
16088
16089
16090 .option host_reject_connection main "host list&!!" unset
16091 .cindex "host" "rejecting connections from"
16092 If this option is set, incoming SMTP calls from the hosts listed are rejected
16093 as soon as the connection is made.
16094 This option is obsolete, and retained only for backward compatibility, because
16095 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16096 connections immediately.
16097
16098 The ability to give an immediate rejection (either by this option or using an
16099 ACL) is provided for use in unusual cases. Many hosts will just try again,
16100 sometimes without much delay. Normally, it is better to use an ACL to reject
16101 incoming messages at a later stage, such as after RCPT commands. See
16102 chapter &<<CHAPACL>>&.
16103
16104
16105 .option hosts_connection_nolog main "host list&!!" unset
16106 .cindex "host" "not logging connections from"
16107 This option defines a list of hosts for which connection logging does not
16108 happen, even though the &%smtp_connection%& log selector is set. For example,
16109 you might want not to log SMTP connections from local processes, or from
16110 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16111 the daemon; you should therefore strive to restrict its value to a short inline
16112 list of IP addresses and networks. To disable logging SMTP connections from
16113 local processes, you must create a host list with an empty item. For example:
16114 .code
16115 hosts_connection_nolog = :
16116 .endd
16117 If the &%smtp_connection%& log selector is not set, this option has no effect.
16118
16119
16120
16121 .option hosts_proxy main "host list&!!" unset
16122 .cindex proxy "proxy protocol"
16123 This option enables use of Proxy Protocol proxies for incoming
16124 connections.  For details see section &<<SECTproxyInbound>>&.
16125
16126
16127 .option hosts_treat_as_local main "domain list&!!" unset
16128 .cindex "local host" "domains treated as"
16129 .cindex "host" "treated as local"
16130 If this option is set, any host names that match the domain list are treated as
16131 if they were the local host when Exim is scanning host lists obtained from MX
16132 records
16133 or other sources. Note that the value of this option is a domain list, not a
16134 host list, because it is always used to check host names, not IP addresses.
16135
16136 This option also applies when Exim is matching the special items
16137 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16138 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16139 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16140 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16141 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16142 interfaces and recognizing the local host.
16143
16144
16145 .option ibase_servers main "string list" unset
16146 .cindex "InterBase" "server list"
16147 This option provides a list of InterBase servers and associated connection data,
16148 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16149 The option is available only if Exim has been built with InterBase support.
16150
16151
16152
16153 .option ignore_bounce_errors_after main time 10w
16154 .cindex "bounce message" "discarding"
16155 .cindex "discarding bounce message"
16156 This option affects the processing of bounce messages that cannot be delivered,
16157 that is, those that suffer a permanent delivery failure. (Bounce messages that
16158 suffer temporary delivery failures are of course retried in the usual way.)
16159
16160 After a permanent delivery failure, bounce messages are frozen,
16161 because there is no sender to whom they can be returned. When a frozen bounce
16162 message has been in the queue for more than the given time, it is unfrozen at
16163 the next queue run, and a further delivery is attempted. If delivery fails
16164 again, the bounce message is discarded. This makes it possible to keep failed
16165 bounce messages around for a shorter time than the normal maximum retry time
16166 for frozen messages. For example,
16167 .code
16168 ignore_bounce_errors_after = 12h
16169 .endd
16170 retries failed bounce message deliveries after 12 hours, discarding any further
16171 failures. If the value of this option is set to a zero time period, bounce
16172 failures are discarded immediately. Setting a very long time (as in the default
16173 value) has the effect of disabling this option. For ways of automatically
16174 dealing with other kinds of frozen message, see &%auto_thaw%& and
16175 &%timeout_frozen_after%&.
16176
16177
16178 .option ignore_fromline_hosts main "host list&!!" unset
16179 .cindex "&""From""& line"
16180 .cindex "UUCP" "&""From""& line"
16181 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16182 the headers of a message. By default this is treated as the start of the
16183 message's body, which means that any following headers are not recognized as
16184 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16185 match those hosts that insist on sending it. If the sender is actually a local
16186 process rather than a remote host, and is using &%-bs%& to inject the messages,
16187 &%ignore_fromline_local%& must be set to achieve this effect.
16188
16189
16190 .option ignore_fromline_local main boolean false
16191 See &%ignore_fromline_hosts%& above.
16192
16193 .option keep_environment main "string list" unset
16194 .cindex "environment" "values from"
16195 This option contains a string list of environment variables to keep.
16196 You have to trust these variables or you have to be sure that
16197 these variables do not impose any security risk. Keep in mind that
16198 during the startup phase Exim is running with an effective UID 0 in most
16199 installations. As the default value is an empty list, the default
16200 environment for using libraries, running embedded Perl code, or running
16201 external binaries is empty, and does not not even contain PATH or HOME.
16202
16203 Actually the list is interpreted as a list of patterns
16204 (&<<SECTlistexpand>>&), except that it is not expanded first.
16205
16206 WARNING: Macro substitution is still done first, so having a macro
16207 FOO and having FOO_HOME in your &%keep_environment%& option may have
16208 unexpected results. You may work around this using a regular expression
16209 that does not match the macro name: ^[F]OO_HOME$.
16210
16211 Current versions of Exim issue a warning during startup if you do not mention
16212 &%keep_environment%& in your runtime configuration file and if your
16213 current environment is not empty. Future versions may not issue that warning
16214 anymore.
16215
16216 See the &%add_environment%& main config option for a way to set
16217 environment variables to a fixed value.  The environment for &(pipe)&
16218 transports is handled separately, see section &<<SECTpipeenv>>& for
16219 details.
16220
16221
16222 .option keep_malformed main time 4d
16223 This option specifies the length of time to keep messages whose spool files
16224 have been corrupted in some way. This should, of course, never happen. At the
16225 next attempt to deliver such a message, it gets removed. The incident is
16226 logged.
16227
16228
16229 .option ldap_ca_cert_dir main string unset
16230 .cindex "LDAP", "TLS CA certificate directory"
16231 .cindex certificate "directory for LDAP"
16232 This option indicates which directory contains CA certificates for verifying
16233 a TLS certificate presented by an LDAP server.
16234 While Exim does not provide a default value, your SSL library may.
16235 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16236 and constrained to be a directory.
16237
16238
16239 .option ldap_ca_cert_file main string unset
16240 .cindex "LDAP", "TLS CA certificate file"
16241 .cindex certificate "file for LDAP"
16242 This option indicates which file contains CA certificates for verifying
16243 a TLS certificate presented by an LDAP server.
16244 While Exim does not provide a default value, your SSL library may.
16245 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16246 and constrained to be a file.
16247
16248
16249 .option ldap_cert_file main string unset
16250 .cindex "LDAP" "TLS client certificate file"
16251 .cindex certificate "file for LDAP"
16252 This option indicates which file contains an TLS client certificate which
16253 Exim should present to the LDAP server during TLS negotiation.
16254 Should be used together with &%ldap_cert_key%&.
16255
16256
16257 .option ldap_cert_key main string unset
16258 .cindex "LDAP" "TLS client key file"
16259 .cindex certificate "key for LDAP"
16260 This option indicates which file contains the secret/private key to use
16261 to prove identity to the LDAP server during TLS negotiation.
16262 Should be used together with &%ldap_cert_file%&, which contains the
16263 identity to be proven.
16264
16265
16266 .option ldap_cipher_suite main string unset
16267 .cindex "LDAP" "TLS cipher suite"
16268 This controls the TLS cipher-suite negotiation during TLS negotiation with
16269 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16270 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16271
16272
16273 .option ldap_default_servers main "string list" unset
16274 .cindex "LDAP" "default servers"
16275 This option provides a list of LDAP servers which are tried in turn when an
16276 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16277 details of LDAP queries. This option is available only when Exim has been built
16278 with LDAP support.
16279
16280
16281 .option ldap_require_cert main string unset.
16282 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16283 This should be one of the values "hard", "demand", "allow", "try" or "never".
16284 A value other than one of these is interpreted as "never".
16285 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16286 Although Exim does not set a default, the LDAP library probably defaults
16287 to hard/demand.
16288
16289
16290 .option ldap_start_tls main boolean false
16291 .cindex "LDAP" "whether or not to negotiate TLS"
16292 If set, Exim will attempt to negotiate TLS with the LDAP server when
16293 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16294 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16295 of SSL-on-connect.
16296 In the event of failure to negotiate TLS, the action taken is controlled
16297 by &%ldap_require_cert%&.
16298 This option is ignored for &`ldapi`& connections.
16299
16300
16301 .option ldap_version main integer unset
16302 .cindex "LDAP" "protocol version, forcing"
16303 This option can be used to force Exim to set a specific protocol version for
16304 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16305 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16306 the LDAP headers; otherwise it is 2. This option is available only when Exim
16307 has been built with LDAP support.
16308
16309
16310
16311 .option local_from_check main boolean true
16312 .cindex "&'Sender:'& header line" "disabling addition of"
16313 .cindex "&'From:'& header line" "disabling checking of"
16314 When a message is submitted locally (that is, not over a TCP/IP connection) by
16315 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16316 checks that the &'From:'& header line matches the login of the calling user and
16317 the domain specified by &%qualify_domain%&.
16318
16319 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16320 locally submitted message is automatically qualified by Exim, unless the
16321 &%-bnq%& command line option is used.
16322
16323 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16324 on the local part. If the &'From:'& header line does not match, Exim adds a
16325 &'Sender:'& header with an address constructed from the calling user's login
16326 and the default qualify domain.
16327
16328 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16329 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16330 &'Sender:'& header lines supplied by untrusted users, you must also set
16331 &%local_sender_retain%& to be true.
16332
16333 .cindex "envelope from"
16334 .cindex "envelope sender"
16335 These options affect only the header lines in the message. The envelope sender
16336 is still forced to be the login id at the qualify domain unless
16337 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16338
16339 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16340 request similar header line checking. See section &<<SECTthesenhea>>&, which
16341 has more details about &'Sender:'& processing.
16342
16343
16344
16345
16346 .option local_from_prefix main string unset
16347 When Exim checks the &'From:'& header line of locally submitted messages for
16348 matching the login id (see &%local_from_check%& above), it can be configured to
16349 ignore certain prefixes and suffixes in the local part of the address. This is
16350 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16351 appropriate lists, in the same form as the &%local_part_prefix%& and
16352 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16353 example, if
16354 .code
16355 local_from_prefix = *-
16356 .endd
16357 is set, a &'From:'& line containing
16358 .code
16359 From: anything-user@your.domain.example
16360 .endd
16361 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16362 matches the actual sender address that is constructed from the login name and
16363 qualify domain.
16364
16365
16366 .option local_from_suffix main string unset
16367 See &%local_from_prefix%& above.
16368
16369
16370 .option local_interfaces main "string list" "see below"
16371 This option controls which network interfaces are used by the daemon for
16372 listening; they are also used to identify the local host when routing. Chapter
16373 &<<CHAPinterfaces>>& contains a full description of this option and the related
16374 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16375 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16376 &%local_interfaces%& is
16377 .code
16378 local_interfaces = 0.0.0.0
16379 .endd
16380 when Exim is built without IPv6 support; otherwise it is
16381 .code
16382 local_interfaces = <; ::0 ; 0.0.0.0
16383 .endd
16384
16385 .option local_scan_timeout main time 5m
16386 .cindex "timeout" "for &[local_scan()]& function"
16387 .cindex "&[local_scan()]& function" "timeout"
16388 This timeout applies to the &[local_scan()]& function (see chapter
16389 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16390 the incoming message is rejected with a temporary error if it is an SMTP
16391 message. For a non-SMTP message, the message is dropped and Exim ends with a
16392 non-zero code. The incident is logged on the main and reject logs.
16393
16394
16395
16396 .option local_sender_retain main boolean false
16397 .cindex "&'Sender:'& header line" "retaining from local submission"
16398 When a message is submitted locally (that is, not over a TCP/IP connection) by
16399 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16400 do not want this to happen, you must set &%local_sender_retain%&, and you must
16401 also set &%local_from_check%& to be false (Exim will complain if you do not).
16402 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16403 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16404
16405
16406
16407
16408 .option localhost_number main string&!! unset
16409 .cindex "host" "locally unique number for"
16410 .cindex "message ids" "with multiple hosts"
16411 .vindex "&$localhost_number$&"
16412 Exim's message ids are normally unique only within the local host. If
16413 uniqueness among a set of hosts is required, each host must set a different
16414 value for the &%localhost_number%& option. The string is expanded immediately
16415 after reading the configuration file (so that a number can be computed from the
16416 host name, for example) and the result of the expansion must be a number in the
16417 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16418 systems). This is available in subsequent string expansions via the variable
16419 &$localhost_number$&. When &%localhost_number is set%&, the final two
16420 characters of the message id, instead of just being a fractional part of the
16421 time, are computed from the time and the local host number as described in
16422 section &<<SECTmessiden>>&.
16423
16424
16425
16426 .option log_file_path main "string list&!!" "set at compile time"
16427 .cindex "log" "file path for"
16428 This option sets the path which is used to determine the names of Exim's log
16429 files, or indicates that logging is to be to syslog, or both. It is expanded
16430 when Exim is entered, so it can, for example, contain a reference to the host
16431 name. If no specific path is set for the log files at compile or runtime,
16432 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16433 they are written in a sub-directory called &_log_& in Exim's spool directory.
16434 A path must start with a slash.
16435 To send to syslog, use the word &"syslog"&.
16436 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16437 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16438 used. If this string is fixed at your installation (contains no expansion
16439 variables) it is recommended that you do not set this option in the
16440 configuration file, but instead supply the path using LOG_FILE_PATH in
16441 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16442 early on &-- in particular, failure to read the configuration file.
16443
16444
16445 .option log_selector main string unset
16446 .cindex "log" "selectors"
16447 This option can be used to reduce or increase the number of things that Exim
16448 writes to its log files. Its argument is made up of names preceded by plus or
16449 minus characters. For example:
16450 .code
16451 log_selector = +arguments -retry_defer
16452 .endd
16453 A list of possible names and what they control is given in the chapter on
16454 logging, in section &<<SECTlogselector>>&.
16455
16456
16457 .option log_timezone main boolean false
16458 .cindex "log" "timezone for entries"
16459 .vindex "&$tod_log$&"
16460 .vindex "&$tod_zone$&"
16461 By default, the timestamps on log lines are in local time without the
16462 timezone. This means that if your timezone changes twice a year, the timestamps
16463 in log lines are ambiguous for an hour when the clocks go back. One way of
16464 avoiding this problem is to set the timezone to UTC. An alternative is to set
16465 &%log_timezone%& true. This turns on the addition of the timezone offset to
16466 timestamps in log lines. Turning on this option can add quite a lot to the size
16467 of log files because each line is extended by 6 characters. Note that the
16468 &$tod_log$& variable contains the log timestamp without the zone, but there is
16469 another variable called &$tod_zone$& that contains just the timezone offset.
16470
16471
16472 .option lookup_open_max main integer 25
16473 .cindex "too many open files"
16474 .cindex "open files, too many"
16475 .cindex "file" "too many open"
16476 .cindex "lookup" "maximum open files"
16477 .cindex "limit" "open files for lookups"
16478 This option limits the number of simultaneously open files for single-key
16479 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16480 Exim normally keeps these files open during routing, because often the same
16481 file is required several times. If the limit is reached, Exim closes the least
16482 recently used file. Note that if you are using the &'ndbm'& library, it
16483 actually opens two files for each logical DBM database, though it still counts
16484 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16485 open files"& errors with NDBM, you need to reduce the value of
16486 &%lookup_open_max%&.
16487
16488
16489 .option max_username_length main integer 0
16490 .cindex "length of login name"
16491 .cindex "user name" "maximum length"
16492 .cindex "limit" "user name length"
16493 Some operating systems are broken in that they truncate long arguments to
16494 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16495 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16496 an argument that is longer behaves as if &[getpwnam()]& failed.
16497
16498
16499 .option message_body_newlines main bool false
16500 .cindex "message body" "newlines in variables"
16501 .cindex "newline" "in message body variables"
16502 .vindex "&$message_body$&"
16503 .vindex "&$message_body_end$&"
16504 By default, newlines in the message body are replaced by spaces when setting
16505 the &$message_body$& and &$message_body_end$& expansion variables. If this
16506 option is set true, this no longer happens.
16507
16508
16509 .option message_body_visible main integer 500
16510 .cindex "body of message" "visible size"
16511 .cindex "message body" "visible size"
16512 .vindex "&$message_body$&"
16513 .vindex "&$message_body_end$&"
16514 This option specifies how much of a message's body is to be included in the
16515 &$message_body$& and &$message_body_end$& expansion variables.
16516
16517
16518 .option message_id_header_domain main string&!! unset
16519 .cindex "&'Message-ID:'& header line"
16520 If this option is set, the string is expanded and used as the right hand side
16521 (domain) of the &'Message-ID:'& header that Exim creates if a
16522 locally-originated incoming message does not have one. &"Locally-originated"&
16523 means &"not received over TCP/IP."&
16524 Otherwise, the primary host name is used.
16525 Only letters, digits, dot and hyphen are accepted; any other characters are
16526 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16527 empty string, the option is ignored.
16528
16529
16530 .option message_id_header_text main string&!! unset
16531 If this variable is set, the string is expanded and used to augment the text of
16532 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16533 message does not have one. The text of this header is required by RFC 2822 to
16534 take the form of an address. By default, Exim uses its internal message id as
16535 the local part, and the primary host name as the domain. If this option is set,
16536 it is expanded, and provided the expansion is not forced to fail, and does not
16537 yield an empty string, the result is inserted into the header immediately
16538 before the @, separated from the internal message id by a dot. Any characters
16539 that are illegal in an address are automatically converted into hyphens. This
16540 means that variables such as &$tod_log$& can be used, because the spaces and
16541 colons will become hyphens.
16542
16543
16544 .option message_logs main boolean true
16545 .cindex "message logs" "disabling"
16546 .cindex "log" "message log; disabling"
16547 If this option is turned off, per-message log files are not created in the
16548 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16549 Exim, by reducing the number of files involved in handling a message from a
16550 minimum of four (header spool file, body spool file, delivery journal, and
16551 per-message log) to three. The other major I/O activity is Exim's main log,
16552 which is not affected by this option.
16553
16554
16555 .option message_size_limit main string&!! 50M
16556 .cindex "message" "size limit"
16557 .cindex "limit" "message size"
16558 .cindex "size" "of message, limit"
16559 This option limits the maximum size of message that Exim will process. The
16560 value is expanded for each incoming connection so, for example, it can be made
16561 to depend on the IP address of the remote host for messages arriving via
16562 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16563 optionally followed by K or M.
16564
16565 .cindex "SIZE" "ESMTP extension, advertising"
16566 .cindex "ESMTP extensions" SIZE
16567 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16568 service extension keyword.
16569
16570 &*Note*&: This limit cannot be made to depend on a message's sender or any
16571 other properties of an individual message, because it has to be advertised in
16572 the server's response to EHLO. String expansion failure causes a temporary
16573 error. A value of zero means no limit, but its use is not recommended. See also
16574 &%bounce_return_size_limit%&.
16575
16576 Incoming SMTP messages are failed with a 552 error if the limit is
16577 exceeded; locally-generated messages either get a stderr message or a delivery
16578 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16579 an oversized message is logged in both the main and the reject logs. See also
16580 the generic transport option &%message_size_limit%&, which limits the size of
16581 message that an individual transport can process.
16582
16583 If you use a virus-scanner and set this option to to a value larger than the
16584 maximum size that your virus-scanner is configured to support, you may get
16585 failures triggered by large mails.  The right size to configure for the
16586 virus-scanner depends upon what data is passed and the options in use but it's
16587 probably safest to just set it to a little larger than this value.  E.g., with a
16588 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16589 some problems may result.
16590
16591 A value of 0 will disable size limit checking; Exim will still advertise the
16592 SIZE extension in an EHLO response, but without a limit, so as to permit
16593 SMTP clients to still indicate the message size along with the MAIL verb.
16594
16595
16596 .option move_frozen_messages main boolean false
16597 .cindex "frozen messages" "moving"
16598 This option, which is available only if Exim has been built with the setting
16599 .code
16600 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16601 .endd
16602 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16603 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16604 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16605 standard utilities for handling such moved messages, and they do not show up in
16606 lists generated by &%-bp%& or by the Exim monitor.
16607
16608
16609 .option mua_wrapper main boolean false
16610 Setting this option true causes Exim to run in a very restrictive mode in which
16611 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16612 contains a full description of this facility.
16613
16614
16615
16616 .option mysql_servers main "string list" unset
16617 .cindex "MySQL" "server list"
16618 This option provides a list of MySQL servers and associated connection data, to
16619 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16620 option is available only if Exim has been built with MySQL support.
16621
16622
16623 .option never_users main "string list&!!" unset
16624 This option is expanded just once, at the start of Exim's processing. Local
16625 message deliveries are normally run in processes that are setuid to the
16626 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16627 It is usually desirable to prevent any deliveries from running as root, as a
16628 safety precaution.
16629
16630 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16631 list of users that must not be used for local deliveries. This list is fixed in
16632 the binary and cannot be overridden by the configuration file. By default, it
16633 contains just the single user name &"root"&. The &%never_users%& runtime option
16634 can be used to add more users to the fixed list.
16635
16636 If a message is to be delivered as one of the users on the fixed list or the
16637 &%never_users%& list, an error occurs, and delivery is deferred. A common
16638 example is
16639 .code
16640 never_users = root:daemon:bin
16641 .endd
16642 Including root is redundant if it is also on the fixed list, but it does no
16643 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16644 transport driver.
16645
16646
16647 .new
16648 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16649 This option gives the name for a unix-domain socket on which the daemon
16650 listens for work and information-requests.
16651 Only installations running multiple daemons sharing a spool directory
16652 should need to modify the default.
16653
16654 The option is expanded before use.
16655 If the platform supports Linux-style abstract socket names, the result
16656 is used with a nul byte prefixed.
16657 Otherwise, it should be a full path name and use a directory accessible
16658 to Exim.
16659
16660 If the Exim command line uses a &%-oX%& option and does not use &%-oP%&
16661 then a notifier socket is not created.
16662 .wen
16663
16664
16665 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16666 .cindex "OpenSSL "compatibility options"
16667 This option allows an administrator to adjust the SSL options applied
16668 by OpenSSL to connections.  It is given as a space-separated list of items,
16669 each one to be +added or -subtracted from the current value.
16670
16671 This option is only available if Exim is built against OpenSSL.  The values
16672 available for this option vary according to the age of your OpenSSL install.
16673 The &"all"& value controls a subset of flags which are available, typically
16674 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16675 list the values known on your system and Exim should support all the
16676 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16677 names lose the leading &"SSL_OP_"& and are lower-cased.
16678
16679 Note that adjusting the options can have severe impact upon the security of
16680 SSL as used by Exim.  It is possible to disable safety checks and shoot
16681 yourself in the foot in various unpleasant ways.  This option should not be
16682 adjusted lightly.  An unrecognised item will be detected at startup, by
16683 invoking Exim with the &%-bV%& flag.
16684
16685 The option affects Exim operating both as a server and as a client.
16686
16687 Historical note: prior to release 4.80, Exim defaulted this value to
16688 "+dont_insert_empty_fragments", which may still be needed for compatibility
16689 with some clients, but which lowers security by increasing exposure to
16690 some now infamous attacks.
16691
16692 Examples:
16693 .code
16694 # Make both old MS and old Eudora happy:
16695 openssl_options = -all +microsoft_big_sslv3_buffer \
16696                        +dont_insert_empty_fragments
16697
16698 # Disable older protocol versions:
16699 openssl_options = +no_sslv2 +no_sslv3
16700 .endd
16701
16702 Possible options may include:
16703 .ilist
16704 &`all`&
16705 .next
16706 &`allow_unsafe_legacy_renegotiation`&
16707 .next
16708 &`cipher_server_preference`&
16709 .next
16710 &`dont_insert_empty_fragments`&
16711 .next
16712 &`ephemeral_rsa`&
16713 .next
16714 &`legacy_server_connect`&
16715 .next
16716 &`microsoft_big_sslv3_buffer`&
16717 .next
16718 &`microsoft_sess_id_bug`&
16719 .next
16720 &`msie_sslv2_rsa_padding`&
16721 .next
16722 &`netscape_challenge_bug`&
16723 .next
16724 &`netscape_reuse_cipher_change_bug`&
16725 .next
16726 &`no_compression`&
16727 .next
16728 &`no_session_resumption_on_renegotiation`&
16729 .next
16730 &`no_sslv2`&
16731 .next
16732 &`no_sslv3`&
16733 .next
16734 &`no_ticket`&
16735 .next
16736 &`no_tlsv1`&
16737 .next
16738 &`no_tlsv1_1`&
16739 .next
16740 &`no_tlsv1_2`&
16741 .next
16742 &`safari_ecdhe_ecdsa_bug`&
16743 .next
16744 &`single_dh_use`&
16745 .next
16746 &`single_ecdh_use`&
16747 .next
16748 &`ssleay_080_client_dh_bug`&
16749 .next
16750 &`sslref2_reuse_cert_type_bug`&
16751 .next
16752 &`tls_block_padding_bug`&
16753 .next
16754 &`tls_d5_bug`&
16755 .next
16756 &`tls_rollback_bug`&
16757 .endlist
16758
16759 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16760 all clients connecting using the MacOS SecureTransport TLS facility prior
16761 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16762 to negotiate TLS then this option value might help, provided that your OpenSSL
16763 release is new enough to contain this work-around.  This may be a situation
16764 where you have to upgrade OpenSSL to get buggy clients working.
16765
16766
16767 .option oracle_servers main "string list" unset
16768 .cindex "Oracle" "server list"
16769 This option provides a list of Oracle servers and associated connection data,
16770 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16771 The option is available only if Exim has been built with Oracle support.
16772
16773
16774 .option percent_hack_domains main "domain list&!!" unset
16775 .cindex "&""percent hack""&"
16776 .cindex "source routing" "in email address"
16777 .cindex "address" "source-routed"
16778 The &"percent hack"& is the convention whereby a local part containing a
16779 percent sign is re-interpreted as a new email address, with the percent
16780 replaced by @. This is sometimes called &"source routing"&, though that term is
16781 also applied to RFC 2822 addresses that begin with an @ character. If this
16782 option is set, Exim implements the percent facility for those domains listed,
16783 but no others. This happens before an incoming SMTP address is tested against
16784 an ACL.
16785
16786 &*Warning*&: The &"percent hack"& has often been abused by people who are
16787 trying to get round relaying restrictions. For this reason, it is best avoided
16788 if at all possible. Unfortunately, a number of less security-conscious MTAs
16789 implement it unconditionally. If you are running Exim on a gateway host, and
16790 routing mail through to internal MTAs without processing the local parts, it is
16791 a good idea to reject recipient addresses with percent characters in their
16792 local parts. Exim's default configuration does this.
16793
16794
16795 .option perl_at_start main boolean false
16796 .cindex "Perl"
16797 This option is available only when Exim is built with an embedded Perl
16798 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16799
16800
16801 .option perl_startup main string unset
16802 .cindex "Perl"
16803 This option is available only when Exim is built with an embedded Perl
16804 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16805
16806 .option perl_taintmode main boolean false
16807 .cindex "Perl"
16808 This option enables the taint mode of the embedded Perl interpreter.
16809
16810
16811 .option pgsql_servers main "string list" unset
16812 .cindex "PostgreSQL lookup type" "server list"
16813 This option provides a list of PostgreSQL servers and associated connection
16814 data, to be used in conjunction with &(pgsql)& lookups (see section
16815 &<<SECID72>>&). The option is available only if Exim has been built with
16816 PostgreSQL support.
16817
16818
16819 .option pid_file_path main string&!! "set at compile time"
16820 .cindex "daemon" "pid file path"
16821 .cindex "pid file, path for"
16822 This option sets the name of the file to which the Exim daemon writes its
16823 process id. The string is expanded, so it can contain, for example, references
16824 to the host name:
16825 .code
16826 pid_file_path = /var/log/$primary_hostname/exim.pid
16827 .endd
16828 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16829 spool directory.
16830 The value set by the option can be overridden by the &%-oP%& command line
16831 option. A pid file is not written if a &"non-standard"& daemon is run by means
16832 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16833
16834
16835 .option pipelining_advertise_hosts main "host list&!!" *
16836 .cindex "PIPELINING" "suppressing advertising"
16837 .cindex "ESMTP extensions" PIPELINING
16838 This option can be used to suppress the advertisement of the SMTP
16839 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16840 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16841 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16842 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16843 that clients will use it; &"out of order"& commands that are &"expected"& do
16844 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16845
16846 .option pipelining_connect_advertise_hosts main "host list&!!" *
16847 .cindex "pipelining" "early connection"
16848 .cindex "pipelining" PIPE_CONNECT
16849 .cindex "ESMTP extensions" X_PIPE_CONNECT
16850 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16851 this option controls which hosts the facility is advertised to
16852 and from which pipeline early-connection (before MAIL) SMTP
16853 commands are acceptable.
16854 When used, the pipelining saves on roundtrip times.
16855
16856 See also the &%hosts_pipe_connect%& smtp transport option.
16857
16858 Currently the option name &"X_PIPE_CONNECT"& is used.
16859
16860
16861 .option prdr_enable main boolean false
16862 .cindex "PRDR" "enabling on server"
16863 .cindex "ESMTP extensions" PRDR
16864 This option can be used to enable the Per-Recipient Data Response extension
16865 to SMTP, defined by Eric Hall.
16866 If the option is set, PRDR is advertised by Exim when operating as a server.
16867 If the client requests PRDR, and more than one recipient, for a message
16868 an additional ACL is called for each recipient after the message content
16869 is received.  See section &<<SECTPRDRACL>>&.
16870
16871 .option preserve_message_logs main boolean false
16872 .cindex "message logs" "preserving"
16873 If this option is set, message log files are not deleted when messages are
16874 completed. Instead, they are moved to a sub-directory of the spool directory
16875 called &_msglog.OLD_&, where they remain available for statistical or debugging
16876 purposes. This is a dangerous option to set on systems with any appreciable
16877 volume of mail. Use with care!
16878
16879
16880 .option primary_hostname main string "see below"
16881 .cindex "name" "of local host"
16882 .cindex "host" "name of local"
16883 .cindex "local host" "name of"
16884 .vindex "&$primary_hostname$&"
16885 This specifies the name of the current host. It is used in the default EHLO or
16886 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16887 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16888 The value is also used by default in some SMTP response messages from an Exim
16889 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16890
16891 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16892 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16893 contains only one component, Exim passes it to &[gethostbyname()]& (or
16894 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16895 version. The variable &$primary_hostname$& contains the host name, whether set
16896 explicitly by this option, or defaulted.
16897
16898
16899 .option print_topbitchars main boolean false
16900 .cindex "printing characters"
16901 .cindex "8-bit characters"
16902 By default, Exim considers only those characters whose codes lie in the range
16903 32&--126 to be printing characters. In a number of circumstances (for example,
16904 when writing log entries) non-printing characters are converted into escape
16905 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16906 is set, code values of 128 and above are also considered to be printing
16907 characters.
16908
16909 This option also affects the header syntax checks performed by the
16910 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16911 the user's full name when constructing From: and Sender: addresses (as
16912 described in section &<<SECTconstr>>&). Setting this option can cause
16913 Exim to generate eight bit message headers that do not conform to the
16914 standards.
16915
16916
16917 .option process_log_path main string unset
16918 .cindex "process log path"
16919 .cindex "log" "process log"
16920 .cindex "&'exiwhat'&"
16921 This option sets the name of the file to which an Exim process writes its
16922 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16923 utility script. If this option is unset, the file called &_exim-process.info_&
16924 in Exim's spool directory is used. The ability to specify the name explicitly
16925 can be useful in environments where two different Exims are running, using
16926 different spool directories.
16927
16928
16929 .option prod_requires_admin main boolean true
16930 .cindex "restricting access to features"
16931 .oindex "&%-M%&"
16932 .oindex "&%-R%&"
16933 .oindex "&%-q%&"
16934 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16935 admin user unless &%prod_requires_admin%& is set false. See also
16936 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16937
16938
16939 .option qualify_domain main string "see below"
16940 .cindex "domain" "for qualifying addresses"
16941 .cindex "address" "qualification"
16942 This option specifies the domain name that is added to any envelope sender
16943 addresses that do not have a domain qualification. It also applies to
16944 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16945 are accepted by default only for locally-generated messages. Qualification is
16946 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16947 locally-generated messages, unless the &%-bnq%& command line option is used.
16948
16949 Messages from external sources must always contain fully qualified addresses,
16950 unless the sending host matches &%sender_unqualified_hosts%& or
16951 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16952 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16953 necessary. Internally, Exim always works with fully qualified envelope
16954 addresses. If &%qualify_domain%& is not set, it defaults to the
16955 &%primary_hostname%& value.
16956
16957
16958 .option qualify_recipient main string "see below"
16959 This option allows you to specify a different domain for qualifying recipient
16960 addresses to the one that is used for senders. See &%qualify_domain%& above.
16961
16962
16963
16964 .option queue_domains main "domain list&!!" unset
16965 .cindex "domain" "specifying non-immediate delivery"
16966 .cindex "queueing incoming messages"
16967 .cindex "message" "queueing certain domains"
16968 This option lists domains for which immediate delivery is not required.
16969 A delivery process is started whenever a message is received, but only those
16970 domains that do not match are processed. All other deliveries wait until the
16971 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16972
16973
16974 .option queue_list_requires_admin main boolean true
16975 .cindex "restricting access to features"
16976 .oindex "&%-bp%&"
16977 The &%-bp%& command-line option, which lists the messages that are on the
16978 queue, requires the caller to be an admin user unless
16979 &%queue_list_requires_admin%& is set false.
16980 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16981
16982
16983 .option queue_only main boolean false
16984 .cindex "queueing incoming messages"
16985 .cindex "message" "queueing unconditionally"
16986 If &%queue_only%& is set, a delivery process is not automatically started
16987 whenever a message is received. Instead, the message waits in the queue for the
16988 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16989 delivered immediately when certain conditions (such as heavy load) occur.
16990
16991 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16992 and &%-odi%& command line options override &%queue_only%& unless
16993 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16994 &%queue_only_load%&, and &%smtp_accept_queue%&.
16995
16996
16997 .option queue_only_file main string unset
16998 .cindex "queueing incoming messages"
16999 .cindex "message" "queueing by file existence"
17000 This option can be set to a colon-separated list of absolute path names, each
17001 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17002 it tests for the existence of each listed path using a call to &[stat()]&. For
17003 each path that exists, the corresponding queueing option is set.
17004 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17005 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17006 .code
17007 queue_only_file = smtp/some/file
17008 .endd
17009 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17010 &_/some/file_& exists.
17011
17012
17013 .option queue_only_load main fixed-point unset
17014 .cindex "load average"
17015 .cindex "queueing incoming messages"
17016 .cindex "message" "queueing by load"
17017 If the system load average is higher than this value, incoming messages from
17018 all sources are queued, and no automatic deliveries are started. If this
17019 happens during local or remote SMTP input, all subsequent messages received on
17020 the same SMTP connection are queued by default, whatever happens to the load in
17021 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17022 false.
17023
17024 Deliveries will subsequently be performed by queue runner processes. This
17025 option has no effect on ancient operating systems on which Exim cannot
17026 determine the load average. See also &%deliver_queue_load_max%& and
17027 &%smtp_load_reserve%&.
17028
17029
17030 .option queue_only_load_latch main boolean true
17031 .cindex "load average" "re-evaluating per message"
17032 When this option is true (the default), once one message has been queued
17033 because the load average is higher than the value set by &%queue_only_load%&,
17034 all subsequent messages received on the same SMTP connection are also queued.
17035 This is a deliberate choice; even though the load average may fall below the
17036 threshold, it doesn't seem right to deliver later messages on the same
17037 connection when not delivering earlier ones. However, there are special
17038 circumstances such as very long-lived connections from scanning appliances
17039 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17040 should be set false. This causes the value of the load average to be
17041 re-evaluated for each message.
17042
17043
17044 .option queue_only_override main boolean true
17045 .cindex "queueing incoming messages"
17046 When this option is true, the &%-od%&&'x'& command line options override the
17047 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17048 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17049 to override; they are accepted, but ignored.
17050
17051
17052 .option queue_run_in_order main boolean false
17053 .cindex "queue runner" "processing messages in order"
17054 If this option is set, queue runs happen in order of message arrival instead of
17055 in an arbitrary order. For this to happen, a complete list of the entire queue
17056 must be set up before the deliveries start. When the queue is all held in a
17057 single directory (the default), a single list is created for both the ordered
17058 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17059 single list is not created when &%queue_run_in_order%& is false. In this case,
17060 the sub-directories are processed one at a time (in a random order), and this
17061 avoids setting up one huge list for the whole queue. Thus, setting
17062 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17063 when the queue is large, because of the extra work in setting up the single,
17064 large list. In most situations, &%queue_run_in_order%& should not be set.
17065
17066
17067
17068 .option queue_run_max main integer&!! 5
17069 .cindex "queue runner" "maximum number of"
17070 This controls the maximum number of queue runner processes that an Exim daemon
17071 can run simultaneously. This does not mean that it starts them all at once,
17072 but rather that if the maximum number are still running when the time comes to
17073 start another one, it refrains from starting another one. This can happen with
17074 very large queues and/or very sluggish deliveries. This option does not,
17075 however, interlock with other processes, so additional queue runners can be
17076 started by other means, or by killing and restarting the daemon.
17077
17078 Setting this option to zero does not suppress queue runs; rather, it disables
17079 the limit, allowing any number of simultaneous queue runner processes to be
17080 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17081 the daemon's command line.
17082
17083 .cindex queues named
17084 .cindex "named queues" "resource limit"
17085 To set limits for different named queues use
17086 an expansion depending on the &$queue_name$& variable.
17087
17088 .option queue_smtp_domains main "domain list&!!" unset
17089 .cindex "queueing incoming messages"
17090 .cindex "message" "queueing remote deliveries"
17091 .cindex "first pass routing"
17092 When this option is set, a delivery process is started whenever a message is
17093 received, routing is performed, and local deliveries take place.
17094 However, if any SMTP deliveries are required for domains that match
17095 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17096 message waits in the queue for the next queue run. Since routing of the message
17097 has taken place, Exim knows to which remote hosts it must be delivered, and so
17098 when the queue run happens, multiple messages for the same host are delivered
17099 over a single SMTP connection. The &%-odqs%& command line option causes all
17100 SMTP deliveries to be queued in this way, and is equivalent to setting
17101 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17102 &%queue_domains%&.
17103
17104
17105 .option receive_timeout main time 0s
17106 .cindex "timeout" "for non-SMTP input"
17107 This option sets the timeout for accepting a non-SMTP message, that is, the
17108 maximum time that Exim waits when reading a message on the standard input. If
17109 the value is zero, it will wait forever. This setting is overridden by the
17110 &%-or%& command line option. The timeout for incoming SMTP messages is
17111 controlled by &%smtp_receive_timeout%&.
17112
17113 .option received_header_text main string&!! "see below"
17114 .cindex "customizing" "&'Received:'& header"
17115 .cindex "&'Received:'& header line" "customizing"
17116 This string defines the contents of the &'Received:'& message header that is
17117 added to each message, except for the timestamp, which is automatically added
17118 on at the end (preceded by a semicolon). The string is expanded each time it is
17119 used. If the expansion yields an empty string, no &'Received:'& header line is
17120 added to the message. Otherwise, the string should start with the text
17121 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17122 header lines.
17123 The default setting is:
17124
17125 .code
17126 received_header_text = Received: \
17127   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17128     {${if def:sender_ident \
17129       {from ${quote_local_part:$sender_ident} }}\
17130         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17131   by $primary_hostname \
17132   ${if def:received_protocol {with $received_protocol }}\
17133   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17134   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17135   (Exim $version_number)\n\t\
17136   ${if def:sender_address \
17137   {(envelope-from <$sender_address>)\n\t}}\
17138   id $message_exim_id\
17139   ${if def:received_for {\n\tfor $received_for}}
17140 .endd
17141
17142 The references to the TLS version and cipher are
17143 omitted when Exim is built without TLS
17144 support. The use of conditional expansions ensures that this works for both
17145 locally generated messages and messages received from remote hosts, giving
17146 header lines such as the following:
17147 .code
17148 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17149 by marley.carol.example with esmtp (Exim 4.00)
17150 (envelope-from <bob@carol.example>)
17151 id 16IOWa-00019l-00
17152 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17153 Received: by scrooge.carol.example with local (Exim 4.00)
17154 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17155 .endd
17156 Until the body of the message has been received, the timestamp is the time when
17157 the message started to be received. Once the body has arrived, and all policy
17158 checks have taken place, the timestamp is updated to the time at which the
17159 message was accepted.
17160
17161
17162 .option received_headers_max main integer 30
17163 .cindex "loop" "prevention"
17164 .cindex "mail loop prevention"
17165 .cindex "&'Received:'& header line" "counting"
17166 When a message is to be delivered, the number of &'Received:'& headers is
17167 counted, and if it is greater than this parameter, a mail loop is assumed to
17168 have occurred, the delivery is abandoned, and an error message is generated.
17169 This applies to both local and remote deliveries.
17170
17171
17172 .option recipient_unqualified_hosts main "host list&!!" unset
17173 .cindex "unqualified addresses"
17174 .cindex "host" "unqualified addresses from"
17175 This option lists those hosts from which Exim is prepared to accept unqualified
17176 recipient addresses in message envelopes. The addresses are made fully
17177 qualified by the addition of the &%qualify_recipient%& value. This option also
17178 affects message header lines. Exim does not reject unqualified recipient
17179 addresses in headers, but it qualifies them only if the message came from a
17180 host that matches &%recipient_unqualified_hosts%&,
17181 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17182 option was not set.
17183
17184
17185 .option recipients_max main integer 0
17186 .cindex "limit" "number of recipients"
17187 .cindex "recipient" "maximum number"
17188 If this option is set greater than zero, it specifies the maximum number of
17189 original recipients for any message. Additional recipients that are generated
17190 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17191 all recipients over the limit; earlier recipients are delivered as normal.
17192 Non-SMTP messages with too many recipients are failed, and no deliveries are
17193 done.
17194
17195 .cindex "RCPT" "maximum number of incoming"
17196 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17197 RCPT commands in a single message.
17198
17199
17200 .option recipients_max_reject main boolean false
17201 If this option is set true, Exim rejects SMTP messages containing too many
17202 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17203 error to the eventual DATA command. Otherwise (the default) it gives a 452
17204 error to the surplus RCPT commands and accepts the message on behalf of the
17205 initial set of recipients. The remote server should then re-send the message
17206 for the remaining recipients at a later time.
17207
17208
17209 .option remote_max_parallel main integer 2
17210 .cindex "delivery" "parallelism for remote"
17211 This option controls parallel delivery of one message to a number of remote
17212 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17213 does all the remote deliveries for a message one by one. Otherwise, if a single
17214 message has to be delivered to more than one remote host, or if several copies
17215 have to be sent to the same remote host, up to &%remote_max_parallel%&
17216 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17217 deliveries are required, the maximum number of processes are started, and as
17218 each one finishes, another is begun. The order of starting processes is the
17219 same as if sequential delivery were being done, and can be controlled by the
17220 &%remote_sort_domains%& option. If parallel delivery takes place while running
17221 with debugging turned on, the debugging output from each delivery process is
17222 tagged with its process id.
17223
17224 This option controls only the maximum number of parallel deliveries for one
17225 message in one Exim delivery process. Because Exim has no central queue
17226 manager, there is no way of controlling the total number of simultaneous
17227 deliveries if the configuration allows a delivery attempt as soon as a message
17228 is received.
17229
17230 .cindex "number of deliveries"
17231 .cindex "delivery" "maximum number of"
17232 If you want to control the total number of deliveries on the system, you
17233 need to set the &%queue_only%& option. This ensures that all incoming messages
17234 are added to the queue without starting a delivery process. Then set up an Exim
17235 daemon to start queue runner processes at appropriate intervals (probably
17236 fairly often, for example, every minute), and limit the total number of queue
17237 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17238 delivers only one message at a time, the maximum number of deliveries that can
17239 then take place at once is &%queue_run_max%& multiplied by
17240 &%remote_max_parallel%&.
17241
17242 If it is purely remote deliveries you want to control, use
17243 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17244 doing the SMTP routing before queueing, so that several messages for the same
17245 host will eventually get delivered down the same connection.
17246
17247
17248 .option remote_sort_domains main "domain list&!!" unset
17249 .cindex "sorting remote deliveries"
17250 .cindex "delivery" "sorting remote"
17251 When there are a number of remote deliveries for a message, they are sorted by
17252 domain into the order given by this list. For example,
17253 .code
17254 remote_sort_domains = *.cam.ac.uk:*.uk
17255 .endd
17256 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17257 then to those in the &%uk%& domain, then to any others.
17258
17259
17260 .option retry_data_expire main time 7d
17261 .cindex "hints database" "data expiry"
17262 This option sets a &"use before"& time on retry information in Exim's hints
17263 database. Any older retry data is ignored. This means that, for example, once a
17264 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17265 past failures.
17266
17267
17268 .option retry_interval_max main time 24h
17269 .cindex "retry" "limit on interval"
17270 .cindex "limit" "on retry interval"
17271 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17272 intervals between delivery attempts for messages that cannot be delivered
17273 straight away. This option sets an overall limit to the length of time between
17274 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17275 the default value.
17276
17277
17278 .option return_path_remove main boolean true
17279 .cindex "&'Return-path:'& header line" "removing"
17280 RFC 2821, section 4.4, states that an SMTP server must insert a
17281 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17282 The &'Return-path:'& header preserves the sender address as received in the
17283 MAIL command. This description implies that this header should not be present
17284 in an incoming message. If &%return_path_remove%& is true, any existing
17285 &'Return-path:'& headers are removed from messages at the time they are
17286 received. Exim's transports have options for adding &'Return-path:'& headers at
17287 the time of delivery. They are normally used only for final local deliveries.
17288
17289
17290 .option return_size_limit main integer 100K
17291 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17292
17293
17294 .option rfc1413_hosts main "host list&!!" @[]
17295 .cindex "RFC 1413"
17296 .cindex "host" "for RFC 1413 calls"
17297 RFC 1413 identification calls are made to any client host which matches
17298 an item in the list.
17299 The default value specifies just this host, being any local interface
17300 for the system.
17301
17302 .option rfc1413_query_timeout main time 0s
17303 .cindex "RFC 1413" "query timeout"
17304 .cindex "timeout" "for RFC 1413 call"
17305 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17306 no RFC 1413 calls are ever made.
17307
17308
17309 .option sender_unqualified_hosts main "host list&!!" unset
17310 .cindex "unqualified addresses"
17311 .cindex "host" "unqualified addresses from"
17312 This option lists those hosts from which Exim is prepared to accept unqualified
17313 sender addresses. The addresses are made fully qualified by the addition of
17314 &%qualify_domain%&. This option also affects message header lines. Exim does
17315 not reject unqualified addresses in headers that contain sender addresses, but
17316 it qualifies them only if the message came from a host that matches
17317 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17318 using TCP/IP), and the &%-bnq%& option was not set.
17319
17320
17321 .option slow_lookup_log main integer 0
17322 .cindex "logging" "slow lookups"
17323 .cindex "dns" "logging slow lookups"
17324 This option controls logging of slow lookups.
17325 If the value is nonzero it is taken as a number of milliseconds
17326 and lookups taking longer than this are logged.
17327 Currently this applies only to DNS lookups.
17328
17329
17330
17331 .option smtp_accept_keepalive main boolean true
17332 .cindex "keepalive" "on incoming connection"
17333 This option controls the setting of the SO_KEEPALIVE option on incoming
17334 TCP/IP socket connections. When set, it causes the kernel to probe idle
17335 connections periodically, by sending packets with &"old"& sequence numbers. The
17336 other end of the connection should send an acknowledgment if the connection is
17337 still okay or a reset if the connection has been aborted. The reason for doing
17338 this is that it has the beneficial effect of freeing up certain types of
17339 connection that can get stuck when the remote host is disconnected without
17340 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17341 hours to detect unreachable hosts.
17342
17343
17344
17345 .option smtp_accept_max main integer 20
17346 .cindex "limit" "incoming SMTP connections"
17347 .cindex "SMTP" "incoming connection count"
17348 .cindex "inetd"
17349 This option specifies the maximum number of simultaneous incoming SMTP calls
17350 that Exim will accept. It applies only to the listening daemon; there is no
17351 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17352 value is set to zero, no limit is applied. However, it is required to be
17353 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17354 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17355
17356 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17357 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17358 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17359 and &%smtp_load_reserve%& are then checked before accepting the connection.
17360
17361
17362 .option smtp_accept_max_nonmail main integer 10
17363 .cindex "limit" "non-mail SMTP commands"
17364 .cindex "SMTP" "limiting non-mail commands"
17365 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17366 the connection if there are too many. This option defines &"too many"&. The
17367 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17368 client looping sending EHLO, for example. The check is applied only if the
17369 client host matches &%smtp_accept_max_nonmail_hosts%&.
17370
17371 When a new message is expected, one occurrence of RSET is not counted. This
17372 allows a client to send one RSET between messages (this is not necessary,
17373 but some clients do it). Exim also allows one uncounted occurrence of HELO
17374 or EHLO, and one occurrence of STARTTLS between messages. After
17375 starting up a TLS session, another EHLO is expected, and so it too is not
17376 counted. The first occurrence of AUTH in a connection, or immediately
17377 following STARTTLS is not counted. Otherwise, all commands other than
17378 MAIL, RCPT, DATA, and QUIT are counted.
17379
17380
17381 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17382 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17383 check by setting this option. The default value makes it apply to all hosts. By
17384 changing the value, you can exclude any badly-behaved hosts that you have to
17385 live with.
17386
17387
17388 . Allow this long option name to split; give it unsplit as a fifth argument
17389 . for the automatic .oindex that is generated by .option.
17390 . We insert " &~&~" which is both pretty nasty visually and results in
17391 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17392 . zero-width-space, which would be nicer visually and results in (at least)
17393 . html that Firefox will split on when it's forced to reflow (rather than
17394 . inserting a horizontal scrollbar).  However, the text is still not
17395 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17396 . the option name to split.
17397
17398 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17399          smtp_accept_max_per_connection
17400 .cindex "SMTP" "limiting incoming message count"
17401 .cindex "limit" "messages per SMTP connection"
17402 The value of this option limits the number of MAIL commands that Exim is
17403 prepared to accept over a single SMTP connection, whether or not each command
17404 results in the transfer of a message. After the limit is reached, a 421
17405 response is given to subsequent MAIL commands. This limit is a safety
17406 precaution against a client that goes mad (incidents of this type have been
17407 seen).
17408
17409
17410 .option smtp_accept_max_per_host main string&!! unset
17411 .cindex "limit" "SMTP connections from one host"
17412 .cindex "host" "limiting SMTP connections from"
17413 This option restricts the number of simultaneous IP connections from a single
17414 host (strictly, from a single IP address) to the Exim daemon. The option is
17415 expanded, to enable different limits to be applied to different hosts by
17416 reference to &$sender_host_address$&. Once the limit is reached, additional
17417 connection attempts from the same host are rejected with error code 421. This
17418 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17419 of zero imposes no limit. If this option is set greater than zero, it is
17420 required that &%smtp_accept_max%& be non-zero.
17421
17422 &*Warning*&: When setting this option you should not use any expansion
17423 constructions that take an appreciable amount of time. The expansion and test
17424 happen in the main daemon loop, in order to reject additional connections
17425 without forking additional processes (otherwise a denial-of-service attack
17426 could cause a vast number or processes to be created). While the daemon is
17427 doing this processing, it cannot accept any other incoming connections.
17428
17429
17430
17431 .option smtp_accept_queue main integer 0
17432 .cindex "SMTP" "incoming connection count"
17433 .cindex "queueing incoming messages"
17434 .cindex "message" "queueing by SMTP connection count"
17435 If the number of simultaneous incoming SMTP connections being handled via the
17436 listening daemon exceeds this value, messages received by SMTP are just placed
17437 in the queue; no delivery processes are started automatically. The count is
17438 fixed at the start of an SMTP connection. It cannot be updated in the
17439 subprocess that receives messages, and so the queueing or not queueing applies
17440 to all messages received in the same connection.
17441
17442 A value of zero implies no limit, and clearly any non-zero value is useful only
17443 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17444 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17445 various &%-od%&&'x'& command line options.
17446
17447
17448 . See the comment on smtp_accept_max_per_connection
17449
17450 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17451          smtp_accept_queue_per_connection
17452 .cindex "queueing incoming messages"
17453 .cindex "message" "queueing by message count"
17454 This option limits the number of delivery processes that Exim starts
17455 automatically when receiving messages via SMTP, whether via the daemon or by
17456 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17457 and the number of messages received in a single SMTP session exceeds this
17458 number, subsequent messages are placed in the queue, but no delivery processes
17459 are started. This helps to limit the number of Exim processes when a server
17460 restarts after downtime and there is a lot of mail waiting for it on other
17461 systems. On large systems, the default should probably be increased, and on
17462 dial-in client systems it should probably be set to zero (that is, disabled).
17463
17464
17465 .option smtp_accept_reserve main integer 0
17466 .cindex "SMTP" "incoming call count"
17467 .cindex "host" "reserved"
17468 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17469 number of SMTP connections that are reserved for connections from the hosts
17470 that are specified in &%smtp_reserve_hosts%&. The value set in
17471 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17472 restricted to this number of connections; the option specifies a minimum number
17473 of connection slots for them, not a maximum. It is a guarantee that this group
17474 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17475 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17476 individual host.
17477
17478 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17479 set to 5, once there are 45 active connections (from any hosts), new
17480 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17481 provided the other criteria for acceptance are met.
17482
17483
17484 .option smtp_active_hostname main string&!! unset
17485 .cindex "host" "name in SMTP responses"
17486 .cindex "SMTP" "host name in responses"
17487 .vindex "&$primary_hostname$&"
17488 This option is provided for multi-homed servers that want to masquerade as
17489 several different hosts. At the start of an incoming SMTP connection, its value
17490 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17491 responses. For example, it is used as domain name in the response to an
17492 incoming HELO or EHLO command.
17493
17494 .vindex "&$smtp_active_hostname$&"
17495 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17496 is saved with any messages that are received. It is therefore available for use
17497 in routers and transports when the message is later delivered.
17498
17499 If this option is unset, or if its expansion is forced to fail, or if the
17500 expansion results in an empty string, the value of &$primary_hostname$& is
17501 used. Other expansion failures cause a message to be written to the main and
17502 panic logs, and the SMTP command receives a temporary error. Typically, the
17503 value of &%smtp_active_hostname%& depends on the incoming interface address.
17504 For example:
17505 .code
17506 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17507   {cox.mydomain}{box.mydomain}}
17508 .endd
17509
17510 Although &$smtp_active_hostname$& is primarily concerned with incoming
17511 messages, it is also used as the default for HELO commands in callout
17512 verification if there is no remote transport from which to obtain a
17513 &%helo_data%& value.
17514
17515 .option smtp_banner main string&!! "see below"
17516 .cindex "SMTP" "welcome banner"
17517 .cindex "banner for SMTP"
17518 .cindex "welcome banner for SMTP"
17519 .cindex "customizing" "SMTP banner"
17520 This string, which is expanded every time it is used, is output as the initial
17521 positive response to an SMTP connection. The default setting is:
17522 .code
17523 smtp_banner = $smtp_active_hostname ESMTP Exim \
17524   $version_number $tod_full
17525 .endd
17526 Failure to expand the string causes a panic error. If you want to create a
17527 multiline response to the initial SMTP connection, use &"\n"& in the string at
17528 appropriate points, but not at the end. Note that the 220 code is not included
17529 in this string. Exim adds it automatically (several times in the case of a
17530 multiline response).
17531
17532
17533 .option smtp_check_spool_space main boolean true
17534 .cindex "checking disk space"
17535 .cindex "disk space, checking"
17536 .cindex "spool directory" "checking space"
17537 When this option is set, if an incoming SMTP session encounters the SIZE
17538 option on a MAIL command, it checks that there is enough space in the
17539 spool directory's partition to accept a message of that size, while still
17540 leaving free the amount specified by &%check_spool_space%& (even if that value
17541 is zero). If there isn't enough space, a temporary error code is returned.
17542
17543
17544 .option smtp_connect_backlog main integer 20
17545 .cindex "connection backlog"
17546 .cindex "SMTP" "connection backlog"
17547 .cindex "backlog of connections"
17548 This option specifies a maximum number of waiting SMTP connections. Exim passes
17549 this value to the TCP/IP system when it sets up its listener. Once this number
17550 of connections are waiting for the daemon's attention, subsequent connection
17551 attempts are refused at the TCP/IP level. At least, that is what the manuals
17552 say; in some circumstances such connection attempts have been observed to time
17553 out instead. For large systems it is probably a good idea to increase the
17554 value (to 50, say). It also gives some protection against denial-of-service
17555 attacks by SYN flooding.
17556
17557
17558 .option smtp_enforce_sync main boolean true
17559 .cindex "SMTP" "synchronization checking"
17560 .cindex "synchronization checking in SMTP"
17561 The SMTP protocol specification requires the client to wait for a response from
17562 the server at certain points in the dialogue. Without PIPELINING these
17563 synchronization points are after every command; with PIPELINING they are
17564 fewer, but they still exist.
17565
17566 Some spamming sites send out a complete set of SMTP commands without waiting
17567 for any response. Exim protects against this by rejecting a message if the
17568 client has sent further input when it should not have. The error response &"554
17569 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17570 for this error cannot be perfect because of transmission delays (unexpected
17571 input may be on its way but not yet received when Exim checks). However, it
17572 does detect many instances.
17573
17574 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17575 If you want to disable the check selectively (for example, only for certain
17576 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17577 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17578
17579
17580
17581 .option smtp_etrn_command main string&!! unset
17582 .cindex "ETRN" "command to be run"
17583 .cindex "ESMTP extensions" ETRN
17584 .vindex "&$domain$&"
17585 If this option is set, the given command is run whenever an SMTP ETRN
17586 command is received from a host that is permitted to issue such commands (see
17587 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17588 are independently expanded. The expansion variable &$domain$& is set to the
17589 argument of the ETRN command, and no syntax checking is done on it. For
17590 example:
17591 .code
17592 smtp_etrn_command = /etc/etrn_command $domain \
17593                     $sender_host_address
17594 .endd
17595 .new
17596 If the option is not set, the argument for the ETRN command must
17597 be a &'#'& followed by an address string.
17598 In this case an &'exim -R <string>'& command is used;
17599 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17600 .wen
17601
17602 A new process is created to run the command, but Exim does not wait for it to
17603 complete. Consequently, its status cannot be checked. If the command cannot be
17604 run, a line is written to the panic log, but the ETRN caller still receives
17605 a 250 success response. Exim is normally running under its own uid when
17606 receiving SMTP, so it is not possible for it to change the uid before running
17607 the command.
17608
17609
17610 .option smtp_etrn_serialize main boolean true
17611 .cindex "ETRN" "serializing"
17612 When this option is set, it prevents the simultaneous execution of more than
17613 one identical command as a result of ETRN in an SMTP connection. See
17614 section &<<SECTETRN>>& for details.
17615
17616
17617 .option smtp_load_reserve main fixed-point unset
17618 .cindex "load average"
17619 If the system load average ever gets higher than this, incoming SMTP calls are
17620 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17621 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17622 the load is over the limit. The option has no effect on ancient operating
17623 systems on which Exim cannot determine the load average. See also
17624 &%deliver_queue_load_max%& and &%queue_only_load%&.
17625
17626
17627
17628 .option smtp_max_synprot_errors main integer 3
17629 .cindex "SMTP" "limiting syntax and protocol errors"
17630 .cindex "limit" "SMTP syntax and protocol errors"
17631 Exim rejects SMTP commands that contain syntax or protocol errors. In
17632 particular, a syntactically invalid email address, as in this command:
17633 .code
17634 RCPT TO:<abc xyz@a.b.c>
17635 .endd
17636 causes immediate rejection of the command, before any other tests are done.
17637 (The ACL cannot be run if there is no valid address to set up for it.) An
17638 example of a protocol error is receiving RCPT before MAIL. If there are
17639 too many syntax or protocol errors in one SMTP session, the connection is
17640 dropped. The limit is set by this option.
17641
17642 .cindex "PIPELINING" "expected errors"
17643 When the PIPELINING extension to SMTP is in use, some protocol errors are
17644 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17645 Exim assumes that PIPELINING will be used if it advertises it (see
17646 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17647 not count towards the limit.
17648
17649
17650
17651 .option smtp_max_unknown_commands main integer 3
17652 .cindex "SMTP" "limiting unknown commands"
17653 .cindex "limit" "unknown SMTP commands"
17654 If there are too many unrecognized commands in an incoming SMTP session, an
17655 Exim server drops the connection. This is a defence against some kinds of abuse
17656 that subvert web
17657 clients
17658 into making connections to SMTP ports; in these circumstances, a number of
17659 non-SMTP command lines are sent first.
17660
17661
17662
17663 .option smtp_ratelimit_hosts main "host list&!!" unset
17664 .cindex "SMTP" "rate limiting"
17665 .cindex "limit" "rate of message arrival"
17666 .cindex "RCPT" "rate limiting"
17667 Some sites find it helpful to be able to limit the rate at which certain hosts
17668 can send them messages, and the rate at which an individual message can specify
17669 recipients.
17670
17671 Exim has two rate-limiting facilities. This section describes the older
17672 facility, which can limit rates within a single connection. The newer
17673 &%ratelimit%& ACL condition can limit rates across all connections. See section
17674 &<<SECTratelimiting>>& for details of the newer facility.
17675
17676 When a host matches &%smtp_ratelimit_hosts%&, the values of
17677 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17678 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17679 respectively. Each option, if set, must contain a set of four comma-separated
17680 values:
17681
17682 .ilist
17683 A threshold, before which there is no rate limiting.
17684 .next
17685 An initial time delay. Unlike other times in Exim, numbers with decimal
17686 fractional parts are allowed here.
17687 .next
17688 A factor by which to increase the delay each time.
17689 .next
17690 A maximum value for the delay. This should normally be less than 5 minutes,
17691 because after that time, the client is liable to timeout the SMTP command.
17692 .endlist
17693
17694 For example, these settings have been used successfully at the site which
17695 first suggested this feature, for controlling mail from their customers:
17696 .code
17697 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17698 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17699 .endd
17700 The first setting specifies delays that are applied to MAIL commands after
17701 two have been received over a single connection. The initial delay is 0.5
17702 seconds, increasing by a factor of 1.05 each time. The second setting applies
17703 delays to RCPT commands when more than four occur in a single message.
17704
17705
17706 .option smtp_ratelimit_mail main string unset
17707 See &%smtp_ratelimit_hosts%& above.
17708
17709
17710 .option smtp_ratelimit_rcpt main string unset
17711 See &%smtp_ratelimit_hosts%& above.
17712
17713
17714 .option smtp_receive_timeout main time&!! 5m
17715 .cindex "timeout" "for SMTP input"
17716 .cindex "SMTP" "input timeout"
17717 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17718 input, including batch SMTP. If a line of input (either an SMTP command or a
17719 data line) is not received within this time, the SMTP connection is dropped and
17720 the message is abandoned.
17721 A line is written to the log containing one of the following messages:
17722 .code
17723 SMTP command timeout on connection from...
17724 SMTP data timeout on connection from...
17725 .endd
17726 The former means that Exim was expecting to read an SMTP command; the latter
17727 means that it was in the DATA phase, reading the contents of a message.
17728
17729 If the first character of the option is a &"$"& the option is
17730 expanded before use and may depend on
17731 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17732
17733
17734 .oindex "&%-os%&"
17735 The value set by this option can be overridden by the
17736 &%-os%& command-line option. A setting of zero time disables the timeout, but
17737 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17738 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17739 timeout is controlled by &%receive_timeout%& and &%-or%&.
17740
17741
17742 .option smtp_reserve_hosts main "host list&!!" unset
17743 This option defines hosts for which SMTP connections are reserved; see
17744 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17745
17746
17747 .option smtp_return_error_details main boolean false
17748 .cindex "SMTP" "details policy failures"
17749 .cindex "policy control" "rejection, returning details"
17750 In the default state, Exim uses bland messages such as
17751 &"Administrative prohibition"& when it rejects SMTP commands for policy
17752 reasons. Many sysadmins like this because it gives away little information
17753 to spammers. However, some other sysadmins who are applying strict checking
17754 policies want to give out much fuller information about failures. Setting
17755 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17756 example, instead of &"Administrative prohibition"&, it might give:
17757 .code
17758 550-Rejected after DATA: '>' missing at end of address:
17759 550 failing address in "From" header is: <user@dom.ain
17760 .endd
17761
17762
17763 .option smtputf8_advertise_hosts main "host list&!!" *
17764 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17765 .cindex "ESMTP extensions" SMTPUTF8
17766 When Exim is built with support for internationalised mail names,
17767 the availability thereof is advertised in
17768 response to EHLO only to those client hosts that match this option. See
17769 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17770
17771
17772 .option spamd_address main string "127.0.0.1 783"
17773 This option is available when Exim is compiled with the content-scanning
17774 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17775 See section &<<SECTscanspamass>>& for more details.
17776
17777
17778
17779 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17780 This option is available when Exim is compiled with SPF support.
17781 See section &<<SECSPF>>& for more details.
17782
17783 .new
17784 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17785 This option is available when Exim is compiled with SPF support.  It
17786 allows the customisation of the SMTP comment that the SPF library
17787 generates.  You are strongly encouraged to link to your own explanative
17788 site. The template must not contain spaces. If you need spaces in the
17789 output, use the proper placeholder. If libspf2 can not parse the
17790 template, it uses a built-in default broken link. The following placeholders
17791 (along with Exim variables (but see below)) are allowed in the template:
17792 .ilist
17793 &*%_*&: A space.
17794 .next
17795 &*%{L}*&: Envelope sender's local part.
17796 .next
17797 &*%{S}*&: Envelope sender.
17798 .next
17799 &*%{O}*&: Envelope sender's domain.
17800 .next
17801 &*%{D}*&: Current(?) domain.
17802 .next
17803 &*%{I}*&: SMTP client Ip.
17804 .next
17805 &*%{C}*&: SMTP client pretty IP.
17806 .next
17807 &*%{T}*&: Epoch time (UTC).
17808 .next
17809 &*%{P}*&: SMTP client domain name.
17810 .next
17811 &*%{V}*&: IP version.
17812 .next
17813 &*%{H}*&: EHLO/HELO domain.
17814 .next
17815 &*%{R}*&: Receiving domain.
17816 .endlist
17817 The capitalized placeholders do proper URL encoding, if you use them
17818 lowercased, no encoding takes place.  This list was compiled from the
17819 libspf2 sources.
17820
17821 A note on using Exim variables: As
17822 currently the SPF library is initialized before the SMTP EHLO phase,
17823 the variables useful for expansion are quite limited.
17824 .wen
17825
17826
17827 .option split_spool_directory main boolean false
17828 .cindex "multiple spool directories"
17829 .cindex "spool directory" "split"
17830 .cindex "directories, multiple"
17831 If this option is set, it causes Exim to split its input directory into 62
17832 subdirectories, each with a single alphanumeric character as its name. The
17833 sixth character of the message id is used to allocate messages to
17834 subdirectories; this is the least significant base-62 digit of the time of
17835 arrival of the message.
17836
17837 Splitting up the spool in this way may provide better performance on systems
17838 where there are long mail queues, by reducing the number of files in any one
17839 directory. The msglog directory is also split up in a similar way to the input
17840 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17841 are still placed in the single directory &_msglog.OLD_&.
17842
17843 It is not necessary to take any special action for existing messages when
17844 changing &%split_spool_directory%&. Exim notices messages that are in the
17845 &"wrong"& place, and continues to process them. If the option is turned off
17846 after a period of being on, the subdirectories will eventually empty and be
17847 automatically deleted.
17848
17849 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17850 changes. Instead of creating a list of all messages in the queue, and then
17851 trying to deliver each one, in turn, it constructs a list of those in one
17852 sub-directory and tries to deliver them, before moving on to the next
17853 sub-directory. The sub-directories are processed in a random order. This
17854 spreads out the scanning of the input directories, and uses less memory. It is
17855 particularly beneficial when there are lots of messages in the queue. However,
17856 if &%queue_run_in_order%& is set, none of this new processing happens. The
17857 entire queue has to be scanned and sorted before any deliveries can start.
17858
17859
17860 .option spool_directory main string&!! "set at compile time"
17861 .cindex "spool directory" "path to"
17862 This defines the directory in which Exim keeps its spool, that is, the messages
17863 it is waiting to deliver. The default value is taken from the compile-time
17864 configuration setting, if there is one. If not, this option must be set. The
17865 string is expanded, so it can contain, for example, a reference to
17866 &$primary_hostname$&.
17867
17868 If the spool directory name is fixed on your installation, it is recommended
17869 that you set it at build time rather than from this option, particularly if the
17870 log files are being written to the spool directory (see &%log_file_path%&).
17871 Otherwise log files cannot be used for errors that are detected early on, such
17872 as failures in the configuration file.
17873
17874 By using this option to override the compiled-in path, it is possible to run
17875 tests of Exim without using the standard spool.
17876
17877 .option spool_wireformat main boolean false
17878 .cindex "spool directory" "file formats"
17879 If this option is set, Exim may for some messages use an alternative format
17880 for data-files in the spool which matches the wire format.
17881 Doing this permits more efficient message reception and transmission.
17882 Currently it is only done for messages received using the ESMTP CHUNKING
17883 option.
17884
17885 The following variables will not have useful values:
17886 .code
17887 $max_received_linelength
17888 $body_linecount
17889 $body_zerocount
17890 .endd
17891
17892 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17893 and any external programs which are passed a reference to a message data file
17894 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17895 will need to be aware of the different formats potentially available.
17896
17897 Using any of the ACL conditions noted will negate the reception benefit
17898 (as a Unix-mbox-format file is constructed for them).
17899 The transmission benefit is maintained.
17900
17901 .option sqlite_lock_timeout main time 5s
17902 .cindex "sqlite lookup type" "lock timeout"
17903 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17904 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17905
17906 .option strict_acl_vars main boolean false
17907 .cindex "&ACL;" "variables, handling unset"
17908 This option controls what happens if a syntactically valid but undefined ACL
17909 variable is referenced. If it is false (the default), an empty string
17910 is substituted; if it is true, an error is generated. See section
17911 &<<SECTaclvariables>>& for details of ACL variables.
17912
17913 .option strip_excess_angle_brackets main boolean false
17914 .cindex "angle brackets, excess"
17915 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17916 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17917 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17918 passed on to another MTA, the excess angle brackets are not passed on. If this
17919 option is not set, multiple pairs of angle brackets cause a syntax error.
17920
17921
17922 .option strip_trailing_dot main boolean false
17923 .cindex "trailing dot on domain"
17924 .cindex "dot" "trailing on domain"
17925 If this option is set, a trailing dot at the end of a domain in an address is
17926 ignored. If this is in the envelope and the message is passed on to another
17927 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17928 domain causes a syntax error.
17929 However, addresses in header lines are checked only when an ACL requests header
17930 syntax checking.
17931
17932
17933 .option syslog_duplication main boolean true
17934 .cindex "syslog" "duplicate log lines; suppressing"
17935 When Exim is logging to syslog, it writes the log lines for its three
17936 separate logs at different syslog priorities so that they can in principle
17937 be separated on the logging hosts. Some installations do not require this
17938 separation, and in those cases, the duplication of certain log lines is a
17939 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17940 particular log line is written to syslog. For lines that normally go to
17941 both the main log and the reject log, the reject log version (possibly
17942 containing message header lines) is written, at LOG_NOTICE priority.
17943 Lines that normally go to both the main and the panic log are written at
17944 the LOG_ALERT priority.
17945
17946
17947 .option syslog_facility main string unset
17948 .cindex "syslog" "facility; setting"
17949 This option sets the syslog &"facility"& name, used when Exim is logging to
17950 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17951 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17952 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17953 details of Exim's logging.
17954
17955
17956 .option syslog_pid main boolean true
17957 .cindex "syslog" "pid"
17958 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17959 omitted when these lines are sent to syslog. (Syslog normally prefixes
17960 the log lines with the PID of the logging process automatically.) You need
17961 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17962 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17963
17964
17965
17966 .option syslog_processname main string &`exim`&
17967 .cindex "syslog" "process name; setting"
17968 This option sets the syslog &"ident"& name, used when Exim is logging to
17969 syslog. The value must be no longer than 32 characters. See chapter
17970 &<<CHAPlog>>& for details of Exim's logging.
17971
17972
17973
17974 .option syslog_timestamp main boolean true
17975 .cindex "syslog" "timestamps"
17976 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17977 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17978 details of Exim's logging.
17979
17980
17981 .option system_filter main string&!! unset
17982 .cindex "filter" "system filter"
17983 .cindex "system filter" "specifying"
17984 .cindex "Sieve filter" "not available for system filter"
17985 This option specifies an Exim filter file that is applied to all messages at
17986 the start of each delivery attempt, before any routing is done. System filters
17987 must be Exim filters; they cannot be Sieve filters. If the system filter
17988 generates any deliveries to files or pipes, or any new mail messages, the
17989 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17990 which transports are to be used. Details of this facility are given in chapter
17991 &<<CHAPsystemfilter>>&.
17992 A forced expansion failure results in no filter operation.
17993
17994
17995 .option system_filter_directory_transport main string&!! unset
17996 .vindex "&$address_file$&"
17997 This sets the name of the transport driver that is to be used when the
17998 &%save%& command in a system message filter specifies a path ending in &"/"&,
17999 implying delivery of each message into a separate file in some directory.
18000 During the delivery, the variable &$address_file$& contains the path name.
18001
18002
18003 .option system_filter_file_transport main string&!! unset
18004 .cindex "file" "transport for system filter"
18005 This sets the name of the transport driver that is to be used when the &%save%&
18006 command in a system message filter specifies a path not ending in &"/"&. During
18007 the delivery, the variable &$address_file$& contains the path name.
18008
18009 .option system_filter_group main string unset
18010 .cindex "gid (group id)" "system filter"
18011 This option is used only when &%system_filter_user%& is also set. It sets the
18012 gid under which the system filter is run, overriding any gid that is associated
18013 with the user. The value may be numerical or symbolic.
18014
18015 .option system_filter_pipe_transport main string&!! unset
18016 .cindex "&(pipe)& transport" "for system filter"
18017 .vindex "&$address_pipe$&"
18018 This specifies the transport driver that is to be used when a &%pipe%& command
18019 is used in a system filter. During the delivery, the variable &$address_pipe$&
18020 contains the pipe command.
18021
18022
18023 .option system_filter_reply_transport main string&!! unset
18024 .cindex "&(autoreply)& transport" "for system filter"
18025 This specifies the transport driver that is to be used when a &%mail%& command
18026 is used in a system filter.
18027
18028
18029 .option system_filter_user main string unset
18030 .cindex "uid (user id)" "system filter"
18031 If this option is set to root, the system filter is run in the main Exim
18032 delivery process, as root.  Otherwise, the system filter runs in a separate
18033 process, as the given user, defaulting to the Exim run-time user.
18034 Unless the string consists entirely of digits, it
18035 is looked up in the password data. Failure to find the named user causes a
18036 configuration error. The gid is either taken from the password data, or
18037 specified by &%system_filter_group%&. When the uid is specified numerically,
18038 &%system_filter_group%& is required to be set.
18039
18040 If the system filter generates any pipe, file, or reply deliveries, the uid
18041 under which the filter is run is used when transporting them, unless a
18042 transport option overrides.
18043
18044
18045 .option tcp_nodelay main boolean true
18046 .cindex "daemon" "TCP_NODELAY on sockets"
18047 .cindex "Nagle algorithm"
18048 .cindex "TCP_NODELAY on listening sockets"
18049 If this option is set false, it stops the Exim daemon setting the
18050 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18051 turns off the &"Nagle algorithm"&, which is a way of improving network
18052 performance in interactive (character-by-character) situations. Turning it off
18053 should improve Exim's performance a bit, so that is what happens by default.
18054 However, it appears that some broken clients cannot cope, and time out. Hence
18055 this option. It affects only those sockets that are set up for listening by the
18056 daemon. Sockets created by the smtp transport for delivering mail always set
18057 TCP_NODELAY.
18058
18059
18060 .option timeout_frozen_after main time 0s
18061 .cindex "frozen messages" "timing out"
18062 .cindex "timeout" "frozen messages"
18063 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18064 message of any kind that has been in the queue for longer than the given time
18065 is automatically cancelled at the next queue run. If the frozen message is a
18066 bounce message, it is just discarded; otherwise, a bounce is sent to the
18067 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18068 If you want to timeout frozen bounce messages earlier than other kinds of
18069 frozen message, see &%ignore_bounce_errors_after%&.
18070
18071 &*Note:*& the default value of zero means no timeouts; with this setting,
18072 frozen messages remain in the queue forever (except for any frozen bounce
18073 messages that are released by &%ignore_bounce_errors_after%&).
18074
18075
18076 .option timezone main string unset
18077 .cindex "timezone, setting"
18078 .cindex "environment" "values from"
18079 The value of &%timezone%& is used to set the environment variable TZ while
18080 running Exim (if it is different on entry). This ensures that all timestamps
18081 created by Exim are in the required timezone. If you want all your timestamps
18082 to be in UTC (aka GMT) you should set
18083 .code
18084 timezone = UTC
18085 .endd
18086 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18087 or, if that is not set, from the value of the TZ environment variable when Exim
18088 is built. If &%timezone%& is set to the empty string, either at build or run
18089 time, any existing TZ variable is removed from the environment when Exim
18090 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18091 unfortunately not all, operating systems.
18092
18093
18094 .option tls_advertise_hosts main "host list&!!" *
18095 .cindex "TLS" "advertising"
18096 .cindex "encryption" "on SMTP connection"
18097 .cindex "SMTP" "encrypted connection"
18098 .cindex "ESMTP extensions" STARTTLS
18099 When Exim is built with support for TLS encrypted connections, the availability
18100 of the STARTTLS command to set up an encrypted session is advertised in
18101 response to EHLO only to those client hosts that match this option. See
18102 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18103 Note that the default value requires that a certificate be supplied
18104 using the &%tls_certificate%& option.  If TLS support for incoming connections
18105 is not required the &%tls_advertise_hosts%& option should be set empty.
18106
18107
18108 .option tls_certificate main string list&!! unset
18109 .cindex "TLS" "server certificate; location of"
18110 .cindex "certificate" "server, location of"
18111 The value of this option is expanded, and must then be a list of absolute paths to
18112 files which contain the server's certificates (in PEM format).
18113 Commonly only one file is needed.
18114 The server's private key is also
18115 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18116 &<<CHAPTLS>>& for further details.
18117
18118 &*Note*&: The certificates defined by this option are used only when Exim is
18119 receiving incoming messages as a server. If you want to supply certificates for
18120 use when sending messages as a client, you must set the &%tls_certificate%&
18121 option in the relevant &(smtp)& transport.
18122
18123 &*Note*&: If you use filenames based on IP addresses, change the list
18124 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18125
18126 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18127 when a list of more than one
18128 file is used, the &$tls_in_ourcert$& variable is unreliable.
18129 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18130
18131 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18132 if the OpenSSL build supports TLS extensions and the TLS client sends the
18133 Server Name Indication extension, then this option and others documented in
18134 &<<SECTtlssni>>& will be re-expanded.
18135
18136 If this option is unset or empty a fresh self-signed certificate will be
18137 generated for every connection.
18138
18139 .option tls_crl main string&!! unset
18140 .cindex "TLS" "server certificate revocation list"
18141 .cindex "certificate" "revocation list for server"
18142 This option specifies a certificate revocation list. The expanded value must
18143 be the name of a file that contains CRLs in PEM format.
18144
18145 Under OpenSSL the option can specify a directory with CRL files.
18146
18147 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18148 for each signing element of the certificate chain (i.e. all but the leaf).
18149 For the file variant this can be multiple PEM blocks in the one file.
18150
18151 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18152
18153
18154 .option tls_dh_max_bits main integer 2236
18155 .cindex "TLS" "D-H bit count"
18156 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18157 the chosen TLS library.  That value might prove to be too high for
18158 interoperability.  This option provides a maximum clamp on the value
18159 suggested, trading off security for interoperability.
18160
18161 The value must be at least 1024.
18162
18163 The value 2236 was chosen because, at time of adding the option, it was the
18164 hard-coded maximum value supported by the NSS cryptographic library, as used
18165 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18166
18167 If you prefer more security and are willing to break some clients, raise this
18168 number.
18169
18170 Note that the value passed to GnuTLS for *generating* a new prime may be a
18171 little less than this figure, because GnuTLS is inexact and may produce a
18172 larger prime than requested.
18173
18174
18175 .option tls_dhparam main string&!! unset
18176 .cindex "TLS" "D-H parameters for server"
18177 The value of this option is expanded and indicates the source of DH parameters
18178 to be used by Exim.
18179
18180 This option is ignored for GnuTLS version 3.6.0 and later.
18181 The library manages parameter negotiation internally.
18182
18183 &*Note: The Exim Maintainers strongly recommend,
18184 for other TLS library versions,
18185 using a filename with site-generated
18186 local DH parameters*&, which has been supported across all versions of Exim.  The
18187 other specific constants available are a fallback so that even when
18188 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18189
18190 If &%tls_dhparam%& is a filename starting with a &`/`&,
18191 then it names a file from which DH
18192 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18193 PKCS#3 representation of the DH prime.  If the file does not exist, for
18194 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18195 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18196 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18197 and treated as though the &%tls_dhparam%& were set to "none".
18198
18199 If this option expands to the string "none", then no DH parameters will be
18200 loaded by Exim.
18201
18202 If this option expands to the string "historic" and Exim is using GnuTLS, then
18203 Exim will attempt to load a file from inside the spool directory.  If the file
18204 does not exist, Exim will attempt to create it.
18205 See section &<<SECTgnutlsparam>>& for further details.
18206
18207 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18208 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18209
18210 In older versions of Exim the default was the 2048 bit prime described in section
18211 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18212 in IKE is assigned number 23.
18213
18214 Otherwise, the option must expand to the name used by Exim for any of a number
18215 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18216 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18217 the number used by IKE, or "default" which corresponds to
18218 &`exim.dev.20160529.3`&.
18219
18220 The available standard primes are:
18221 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18222 &`ike1`&, &`ike2`&, &`ike5`&,
18223 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18224 &`ike22`&, &`ike23`& and &`ike24`&.
18225
18226 The available additional primes are:
18227 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18228
18229 Some of these will be too small to be accepted by clients.
18230 Some may be too large to be accepted by clients.
18231 The open cryptographic community has suspicions about the integrity of some
18232 of the later IKE values, which led into RFC7919 providing new fixed constants
18233 (the "ffdhe" identifiers).
18234
18235 At this point, all of the "ike" values should be considered obsolete;
18236 they're still in Exim to avoid breaking unusual configurations, but are
18237 candidates for removal the next time we have backwards-incompatible changes.
18238
18239 The TLS protocol does not negotiate an acceptable size for this; clients tend
18240 to hard-drop connections if what is offered by the server is unacceptable,
18241 whether too large or too small, and there's no provision for the client to
18242 tell the server what these constraints are.  Thus, as a server operator, you
18243 need to make an educated guess as to what is most likely to work for your
18244 userbase.
18245
18246 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18247 is most likely to maximise interoperability.  The upper bound comes from
18248 applications using the Mozilla Network Security Services (NSS) library, which
18249 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18250 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18251 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18252 acceptable bound from 1024 to 2048.
18253
18254
18255 .option tls_eccurve main string&!! &`auto`&
18256 .cindex TLS "EC cryptography"
18257 This option selects a EC curve for use by Exim when used with OpenSSL.
18258 It has no effect when Exim is used with GnuTLS.
18259
18260 After expansion it must contain a valid EC curve parameter, such as
18261 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18262 for valid selections.
18263
18264 For OpenSSL versions before (and not including) 1.0.2, the string
18265 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18266 &`auto`& tells the library to choose.
18267
18268 If the option expands to an empty string, no EC curves will be enabled.
18269
18270
18271 .option tls_ocsp_file main string&!! unset
18272 .cindex TLS "certificate status"
18273 .cindex TLS "OCSP proof file"
18274 This option
18275 must if set expand to the absolute path to a file which contains a current
18276 status proof for the server's certificate, as obtained from the
18277 Certificate Authority.
18278
18279 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18280 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18281
18282 For OpenSSL 1.1.0 or later, and
18283 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18284 of files, to match a list given for the &%tls_certificate%& option.
18285 The ordering of the two lists must match.
18286 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18287
18288 The file(s) should be in DER format,
18289 except for GnuTLS 3.6.3 or later
18290 or for OpenSSL,
18291 when an optional filetype prefix can be used.
18292 The prefix must be one of "DER" or "PEM", followed by
18293 a single space.  If one is used it sets the format for subsequent
18294 files in the list; the initial format is DER.
18295 If multiple proofs are wanted, for multiple chain elements
18296 (this only works under TLS1.3)
18297 they must be coded as a combined OCSP response.
18298
18299 Although GnuTLS will accept PEM files with multiple separate
18300 PEM blobs (ie. separate OCSP responses), it sends them in the
18301 TLS Certificate record interleaved with the certificates of the chain;
18302 although a GnuTLS client is happy with that, an OpenSSL client is not.
18303
18304 .option tls_on_connect_ports main "string list" unset
18305 .cindex SSMTP
18306 .cindex SMTPS
18307 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18308 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18309 set up without waiting for the client to issue a STARTTLS command. For
18310 further details, see section &<<SECTsupobssmt>>&.
18311
18312
18313
18314 .option tls_privatekey main string list&!! unset
18315 .cindex "TLS" "server private key; location of"
18316 The value of this option is expanded, and must then be a list of absolute paths to
18317 files which contains the server's private keys.
18318 If this option is unset, or if
18319 the expansion is forced to fail, or the result is an empty string, the private
18320 key is assumed to be in the same file as the server's certificates. See chapter
18321 &<<CHAPTLS>>& for further details.
18322
18323 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18324
18325
18326 .option tls_remember_esmtp main boolean false
18327 .cindex "TLS" "esmtp state; remembering"
18328 .cindex "TLS" "broken clients"
18329 If this option is set true, Exim violates the RFCs by remembering that it is in
18330 &"esmtp"& state after successfully negotiating a TLS session. This provides
18331 support for broken clients that fail to send a new EHLO after starting a
18332 TLS session.
18333
18334
18335 .option tls_require_ciphers main string&!! unset
18336 .cindex "TLS" "requiring specific ciphers"
18337 .cindex "cipher" "requiring specific"
18338 This option controls which ciphers can be used for incoming TLS connections.
18339 The &(smtp)& transport has an option of the same name for controlling outgoing
18340 connections. This option is expanded for each connection, so can be varied for
18341 different clients if required. The value of this option must be a list of
18342 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18343 in somewhat different ways. If GnuTLS is being used, the client controls the
18344 preference order of the available ciphers. Details are given in sections
18345 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18346
18347
18348 .option tls_try_verify_hosts main "host list&!!" unset
18349 .cindex "TLS" "client certificate verification"
18350 .cindex "certificate" "verification of client"
18351 See &%tls_verify_hosts%& below.
18352
18353
18354 .option tls_verify_certificates main string&!! system
18355 .cindex "TLS" "client certificate verification"
18356 .cindex "certificate" "verification of client"
18357 The value of this option is expanded, and must then be either the
18358 word "system"
18359 or the absolute path to
18360 a file or directory containing permitted certificates for clients that
18361 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18362
18363 The "system" value for the option will use a
18364 system default location compiled into the SSL library.
18365 This is not available for GnuTLS versions preceding 3.0.20,
18366 and will be taken as empty; an explicit location
18367 must be specified.
18368
18369 The use of a directory for the option value is not available for GnuTLS versions
18370 preceding 3.3.6 and a single file must be used.
18371
18372 With OpenSSL the certificates specified
18373 explicitly
18374 either by file or directory
18375 are added to those given by the system default location.
18376
18377 These certificates should be for the certificate authorities trusted, rather
18378 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18379 the value is a file then the certificates are sent by Exim as a server to
18380 connecting clients, defining the list of accepted certificate authorities.
18381 Thus the values defined should be considered public data.  To avoid this,
18382 use the explicit directory version.
18383
18384 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18385
18386 A forced expansion failure or setting to an empty string is equivalent to
18387 being unset.
18388
18389
18390 .option tls_verify_hosts main "host list&!!" unset
18391 .cindex "TLS" "client certificate verification"
18392 .cindex "certificate" "verification of client"
18393 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18394 certificates from clients. The expected certificates are defined by
18395 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18396 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18397 &%tls_verify_certificates%& is not set.
18398
18399 Any client that matches &%tls_verify_hosts%& is constrained by
18400 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18401 present one of the listed certificates. If it does not, the connection is
18402 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18403 the host to use TLS. It can still send SMTP commands through unencrypted
18404 connections. Forcing a client to use TLS has to be done separately using an
18405 ACL to reject inappropriate commands when the connection is not encrypted.
18406
18407 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18408 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18409 certificate and checks it against &%tls_verify_certificates%&, but does not
18410 abort the connection if there is no certificate or if it does not match. This
18411 state can be detected in an ACL, which makes it possible to implement policies
18412 such as &"accept for relay only if a verified certificate has been received,
18413 but accept for local delivery if encrypted, even without a verified
18414 certificate"&.
18415
18416 Client hosts that match neither of these lists are not asked to present
18417 certificates.
18418
18419
18420 .option trusted_groups main "string list&!!" unset
18421 .cindex "trusted groups"
18422 .cindex "groups" "trusted"
18423 This option is expanded just once, at the start of Exim's processing. If this
18424 option is set, any process that is running in one of the listed groups, or
18425 which has one of them as a supplementary group, is trusted. The groups can be
18426 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18427 details of what trusted callers are permitted to do. If neither
18428 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18429 are trusted.
18430
18431 .option trusted_users main "string list&!!" unset
18432 .cindex "trusted users"
18433 .cindex "user" "trusted"
18434 This option is expanded just once, at the start of Exim's processing. If this
18435 option is set, any process that is running as one of the listed users is
18436 trusted. The users can be specified numerically or by name. See section
18437 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18438 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18439 Exim user are trusted.
18440
18441 .option unknown_login main string&!! unset
18442 .cindex "uid (user id)" "unknown caller"
18443 .vindex "&$caller_uid$&"
18444 This is a specialized feature for use in unusual configurations. By default, if
18445 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18446 gives up. The &%unknown_login%& option can be used to set a login name to be
18447 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18448 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18449 is used for the user's real name (gecos field), unless this has been set by the
18450 &%-F%& option.
18451
18452 .option unknown_username main string unset
18453 See &%unknown_login%&.
18454
18455 .option untrusted_set_sender main "address list&!!" unset
18456 .cindex "trusted users"
18457 .cindex "sender" "setting by untrusted user"
18458 .cindex "untrusted user setting sender"
18459 .cindex "user" "untrusted setting sender"
18460 .cindex "envelope from"
18461 .cindex "envelope sender"
18462 When an untrusted user submits a message to Exim using the standard input, Exim
18463 normally creates an envelope sender address from the user's login and the
18464 default qualification domain. Data from the &%-f%& option (for setting envelope
18465 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18466 is used) is ignored.
18467
18468 However, untrusted users are permitted to set an empty envelope sender address,
18469 to declare that a message should never generate any bounces. For example:
18470 .code
18471 exim -f '<>' user@domain.example
18472 .endd
18473 .vindex "&$sender_ident$&"
18474 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18475 other envelope sender addresses in a controlled way. When it is set, untrusted
18476 users are allowed to set envelope sender addresses that match any of the
18477 patterns in the list. Like all address lists, the string is expanded. The
18478 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18479 users to setting senders that start with their login ids
18480 followed by a hyphen
18481 by a setting like this:
18482 .code
18483 untrusted_set_sender = ^$sender_ident-
18484 .endd
18485 If you want to allow untrusted users to set envelope sender addresses without
18486 restriction, you can use
18487 .code
18488 untrusted_set_sender = *
18489 .endd
18490 The &%untrusted_set_sender%& option applies to all forms of local input, but
18491 only to the setting of the envelope sender. It does not permit untrusted users
18492 to use the other options which trusted user can use to override message
18493 parameters. Furthermore, it does not stop Exim from removing an existing
18494 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18495 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18496 overriding these actions. The handling of the &'Sender:'& header is also
18497 described in section &<<SECTthesenhea>>&.
18498
18499 The log line for a message's arrival shows the envelope sender following
18500 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18501 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18502 envelope sender address, the user's login is shown in parentheses after the
18503 sender address.
18504
18505
18506 .option uucp_from_pattern main string "see below"
18507 .cindex "&""From""& line"
18508 .cindex "UUCP" "&""From""& line"
18509 Some applications that pass messages to an MTA via a command line interface use
18510 an initial line starting with &"From&~"& to pass the envelope sender. In
18511 particular, this is used by UUCP software. Exim recognizes such a line by means
18512 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18513 matches, the sender address is constructed by expanding the contents of
18514 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18515 default pattern recognizes lines in the following two forms:
18516 .code
18517 From ph10 Fri Jan  5 12:35 GMT 1996
18518 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18519 .endd
18520 The pattern can be seen by running
18521 .code
18522 exim -bP uucp_from_pattern
18523 .endd
18524 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18525 year in the second case. The first word after &"From&~"& is matched in the
18526 regular expression by a parenthesized subpattern. The default value for
18527 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18528 (&"ph10"& in the example above) as the message's sender. See also
18529 &%ignore_fromline_hosts%&.
18530
18531
18532 .option uucp_from_sender main string&!! &`$1`&
18533 See &%uucp_from_pattern%& above.
18534
18535
18536 .option warn_message_file main string&!! unset
18537 .cindex "warning of delay" "customizing the message"
18538 .cindex "customizing" "warning message"
18539 This option defines a template file containing paragraphs of text to be used
18540 for constructing the warning message which is sent by Exim when a message has
18541 been in the queue for a specified amount of time, as specified by
18542 &%delay_warning%&. Details of the file's contents are given in chapter
18543 &<<CHAPemsgcust>>&.
18544 .new
18545 .cindex warn_message_file "tainted data"
18546 The option is expanded to give the file path, which must be
18547 absolute and untainted.
18548 .wen
18549 See also &%bounce_message_file%&.
18550
18551
18552 .option write_rejectlog main boolean true
18553 .cindex "reject log" "disabling"
18554 If this option is set false, Exim no longer writes anything to the reject log.
18555 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18556 .ecindex IIDconfima
18557 .ecindex IIDmaiconf
18558
18559
18560
18561
18562 . ////////////////////////////////////////////////////////////////////////////
18563 . ////////////////////////////////////////////////////////////////////////////
18564
18565 .chapter "Generic options for routers" "CHAProutergeneric"
18566 .scindex IIDgenoprou1 "options" "generic; for routers"
18567 .scindex IIDgenoprou2 "generic options" "router"
18568 This chapter describes the generic options that apply to all routers.
18569 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18570
18571 For a general description of how a router operates, see sections
18572 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18573 which the preconditions are tested. The order of expansion of the options that
18574 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18575 &%headers_remove%&, &%transport%&.
18576
18577
18578
18579 .option address_data routers string&!! unset
18580 .cindex "router" "data attached to address"
18581 The string is expanded just before the router is run, that is, after all the
18582 precondition tests have succeeded. If the expansion is forced to fail, the
18583 router declines, the value of &%address_data%& remains unchanged, and the
18584 &%more%& option controls what happens next. Other expansion failures cause
18585 delivery of the address to be deferred.
18586
18587 .vindex "&$address_data$&"
18588 When the expansion succeeds, the value is retained with the address, and can be
18589 accessed using the variable &$address_data$& in the current router, subsequent
18590 routers, and the eventual transport.
18591
18592 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18593 that runs a user's filter file, the contents of &$address_data$& are accessible
18594 in the filter. This is not normally a problem, because such data is usually
18595 either not confidential or it &"belongs"& to the current user, but if you do
18596 put confidential data into &$address_data$& you need to remember this point.
18597
18598 Even if the router declines or passes, the value of &$address_data$& remains
18599 with the address, though it can be changed by another &%address_data%& setting
18600 on a subsequent router. If a router generates child addresses, the value of
18601 &$address_data$& propagates to them. This also applies to the special kind of
18602 &"child"& that is generated by a router with the &%unseen%& option.
18603
18604 The idea of &%address_data%& is that you can use it to look up a lot of data
18605 for the address once, and then pick out parts of the data later. For example,
18606 you could use a single LDAP lookup to return a string of the form
18607 .code
18608 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18609 .endd
18610 In the transport you could pick out the mailbox by a setting such as
18611 .code
18612 file = ${extract{mailbox}{$address_data}}
18613 .endd
18614 This makes the configuration file less messy, and also reduces the number of
18615 lookups (though Exim does cache lookups).
18616
18617 See also the &%set%& option below.
18618
18619 .vindex "&$sender_address_data$&"
18620 .vindex "&$address_data$&"
18621 The &%address_data%& facility is also useful as a means of passing information
18622 from one router to another, and from a router to a transport. In addition, if
18623 &$address_data$& is set by a router when verifying a recipient address from an
18624 ACL, it remains available for use in the rest of the ACL statement. After
18625 verifying a sender, the value is transferred to &$sender_address_data$&.
18626
18627
18628
18629 .option address_test routers&!? boolean true
18630 .oindex "&%-bt%&"
18631 .cindex "router" "skipping when address testing"
18632 If this option is set false, the router is skipped when routing is being tested
18633 by means of the &%-bt%& command line option. This can be a convenience when
18634 your first router sends messages to an external scanner, because it saves you
18635 having to set the &"already scanned"& indicator when testing real address
18636 routing.
18637
18638
18639
18640 .option cannot_route_message routers string&!! unset
18641 .cindex "router" "customizing &""cannot route""& message"
18642 .cindex "customizing" "&""cannot route""& message"
18643 This option specifies a text message that is used when an address cannot be
18644 routed because Exim has run out of routers. The default message is
18645 &"Unrouteable address"&. This option is useful only on routers that have
18646 &%more%& set false, or on the very last router in a configuration, because the
18647 value that is used is taken from the last router that is considered. This
18648 includes a router that is skipped because its preconditions are not met, as
18649 well as a router that declines. For example, using the default configuration,
18650 you could put:
18651 .code
18652 cannot_route_message = Remote domain not found in DNS
18653 .endd
18654 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18655 and
18656 .code
18657 cannot_route_message = Unknown local user
18658 .endd
18659 on the final router that checks for local users. If string expansion fails for
18660 this option, the default message is used. Unless the expansion failure was
18661 explicitly forced, a message about the failure is written to the main and panic
18662 logs, in addition to the normal message about the routing failure.
18663
18664
18665 .option caseful_local_part routers boolean false
18666 .cindex "case of local parts"
18667 .cindex "router" "case of local parts"
18668 By default, routers handle the local parts of addresses in a case-insensitive
18669 manner, though the actual case is preserved for transmission with the message.
18670 If you want the case of letters to be significant in a router, you must set
18671 this option true. For individual router options that contain address or local
18672 part lists (for example, &%local_parts%&), case-sensitive matching can be
18673 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18674 more details.
18675
18676 .vindex "&$local_part$&"
18677 .vindex "&$original_local_part$&"
18678 .vindex "&$parent_local_part$&"
18679 The value of the &$local_part$& variable is forced to lower case while a
18680 router is running unless &%caseful_local_part%& is set. When a router assigns
18681 an address to a transport, the value of &$local_part$& when the transport runs
18682 is the same as it was in the router. Similarly, when a router generates child
18683 addresses by aliasing or forwarding, the values of &$original_local_part$&
18684 and &$parent_local_part$& are those that were used by the redirecting router.
18685
18686 This option applies to the processing of an address by a router. When a
18687 recipient address is being processed in an ACL, there is a separate &%control%&
18688 modifier that can be used to specify case-sensitive processing within the ACL
18689 (see section &<<SECTcontrols>>&).
18690
18691
18692
18693 .option check_local_user routers&!? boolean false
18694 .cindex "local user, checking in router"
18695 .cindex "router" "checking for local user"
18696 .cindex "&_/etc/passwd_&"
18697 .vindex "&$home$&"
18698 When this option is true, Exim checks that the local part of the recipient
18699 address (with affixes removed if relevant) is the name of an account on the
18700 local system. The check is done by calling the &[getpwnam()]& function rather
18701 than trying to read &_/etc/passwd_& directly. This means that other methods of
18702 holding password data (such as NIS) are supported. If the local part is a local
18703 user, &$home$& is set from the password data, and can be tested in other
18704 preconditions that are evaluated after this one (the order of evaluation is
18705 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18706 overridden by &%router_home_directory%&. If the local part is not a local user,
18707 the router is skipped.
18708
18709 If you want to check that the local part is either the name of a local user
18710 or matches something else, you cannot combine &%check_local_user%& with a
18711 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18712 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18713 setting to achieve this. For example:
18714 .code
18715 local_parts = passwd;$local_part : lsearch;/etc/other/users
18716 .endd
18717 Note, however, that the side effects of &%check_local_user%& (such as setting
18718 up a home directory) do not occur when a &(passwd)& lookup is used in a
18719 &%local_parts%& (or any other) precondition.
18720
18721
18722
18723 .option condition routers&!? string&!! unset
18724 .cindex "router" "customized precondition"
18725 This option specifies a general precondition test that has to succeed for the
18726 router to be called. The &%condition%& option is the last precondition to be
18727 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18728 result is a forced failure, or an empty string, or one of the strings &"0"& or
18729 &"no"& or &"false"& (checked without regard to the case of the letters), the
18730 router is skipped, and the address is offered to the next one.
18731
18732 If the result is any other value, the router is run (as this is the last
18733 precondition to be evaluated, all the other preconditions must be true).
18734
18735 This option is unusual in that multiple &%condition%& options may be present.
18736 All &%condition%& options must succeed.
18737
18738 The &%condition%& option provides a means of applying custom conditions to the
18739 running of routers. Note that in the case of a simple conditional expansion,
18740 the default expansion values are exactly what is wanted. For example:
18741 .code
18742 condition = ${if >{$message_age}{600}}
18743 .endd
18744 Because of the default behaviour of the string expansion, this is equivalent to
18745 .code
18746 condition = ${if >{$message_age}{600}{true}{}}
18747 .endd
18748
18749 A multiple condition example, which succeeds:
18750 .code
18751 condition = ${if >{$message_age}{600}}
18752 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18753 condition = foobar
18754 .endd
18755
18756 If the expansion fails (other than forced failure) delivery is deferred. Some
18757 of the other precondition options are common special cases that could in fact
18758 be specified using &%condition%&.
18759
18760 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18761 are far older, and use one set of semantics.  ACLs are newer and when
18762 they were created, the ACL &%condition%& process was given far stricter
18763 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18764 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18765 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18766 Router rules processing behavior.
18767
18768 This is best illustrated in an example:
18769 .code
18770 # If used in an ACL condition will fail with a syntax error, but
18771 # in a router condition any extra characters are treated as a string
18772
18773 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18774 true {yes} {no}}
18775
18776 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18777  {yes} {no}}
18778 .endd
18779 In each example above, the &%if%& statement actually ends after
18780 &"{google.com}}"&.  Since no true or false braces were defined, the
18781 default &%if%& behavior is to return a boolean true or a null answer
18782 (which evaluates to false). The rest of the line is then treated as a
18783 string. So the first example resulted in the boolean answer &"true"&
18784 with the string &" {yes} {no}}"& appended to it. The second example
18785 resulted in the null output (indicating false) with the string
18786 &" {yes} {no}}"& appended to it.
18787
18788 In fact you can put excess forward braces in too.  In the router
18789 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18790 mean something, like after a &"$"& or when required as part of a
18791 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18792 string characters.
18793
18794 Thus, in a Router, the above expansion strings will both always evaluate
18795 true, as the result of expansion is a non-empty string which doesn't
18796 match an explicit false value.  This can be tricky to debug.  By
18797 contrast, in an ACL either of those strings will always result in an
18798 expansion error because the result doesn't look sufficiently boolean.
18799
18800
18801 .option debug_print routers string&!! unset
18802 .cindex "testing" "variables in drivers"
18803 If this option is set and debugging is enabled (see the &%-d%& command line
18804 option) or in address-testing mode (see the &%-bt%& command line option),
18805 the string is expanded and included in the debugging output.
18806 If expansion of the string fails, the error message is written to the debugging
18807 output, and Exim carries on processing.
18808 This option is provided to help with checking out the values of variables and
18809 so on when debugging router configurations. For example, if a &%condition%&
18810 option appears not to be working, &%debug_print%& can be used to output the
18811 variables it references. The output happens after checks for &%domains%&,
18812 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18813 are tested. A newline is added to the text if it does not end with one.
18814 The variable &$router_name$& contains the name of the router.
18815
18816
18817
18818 .option disable_logging routers boolean false
18819 If this option is set true, nothing is logged for any routing errors
18820 or for any deliveries caused by this router. You should not set this option
18821 unless you really, really know what you are doing. See also the generic
18822 transport option of the same name.
18823
18824 .option dnssec_request_domains routers "domain list&!!" *
18825 .cindex "MX record" "security"
18826 .cindex "DNSSEC" "MX lookup"
18827 .cindex "security" "MX lookup"
18828 .cindex "DNS" "DNSSEC"
18829 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18830 the dnssec request bit set.
18831 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18832
18833 .option dnssec_require_domains routers "domain list&!!" unset
18834 .cindex "MX record" "security"
18835 .cindex "DNSSEC" "MX lookup"
18836 .cindex "security" "MX lookup"
18837 .cindex "DNS" "DNSSEC"
18838 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18839 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18840 (AD bit) set will be ignored and logged as a host-lookup failure.
18841 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18842
18843
18844 .option domains routers&!? "domain list&!!" unset
18845 .cindex "router" "restricting to specific domains"
18846 .vindex "&$domain_data$&"
18847 If this option is set, the router is skipped unless the current domain matches
18848 the list. If the match is achieved by means of a file lookup, the data that the
18849 lookup returned for the domain is placed in &$domain_data$& for use in string
18850 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18851 a list of the order in which preconditions are evaluated.
18852
18853
18854
18855 .option driver routers string unset
18856 This option must always be set. It specifies which of the available routers is
18857 to be used.
18858
18859
18860 .option dsn_lasthop routers boolean false
18861 .cindex "DSN" "success"
18862 .cindex "Delivery Status Notification" "success"
18863 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18864 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18865 instead send a success DSN as if the next hop does not support DSN.
18866 Not effective on redirect routers.
18867
18868
18869
18870 .option errors_to routers string&!! unset
18871 .cindex "envelope from"
18872 .cindex "envelope sender"
18873 .cindex "router" "changing address for errors"
18874 If a router successfully handles an address, it may assign the address to a
18875 transport for delivery or it may generate child addresses. In both cases, if
18876 there is a delivery problem during later processing, the resulting bounce
18877 message is sent to the address that results from expanding this string,
18878 provided that the address verifies successfully. The &%errors_to%& option is
18879 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18880
18881 The &%errors_to%& setting associated with an address can be overridden if it
18882 subsequently passes through other routers that have their own &%errors_to%&
18883 settings, or if the message is delivered by a transport with a &%return_path%&
18884 setting.
18885
18886 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18887 the expansion fails to verify, the errors address associated with the incoming
18888 address is used. At top level, this is the envelope sender. A non-forced
18889 expansion failure causes delivery to be deferred.
18890
18891 If an address for which &%errors_to%& has been set ends up being delivered over
18892 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18893 any bounces that are generated by other MTAs on the delivery route are also
18894 sent there. You can set &%errors_to%& to the empty string by either of these
18895 settings:
18896 .code
18897 errors_to =
18898 errors_to = ""
18899 .endd
18900 An expansion item that yields an empty string has the same effect. If you do
18901 this, a locally detected delivery error for addresses processed by this router
18902 no longer gives rise to a bounce message; the error is discarded. If the
18903 address is delivered to a remote host, the return path is set to &`<>`&, unless
18904 overridden by the &%return_path%& option on the transport.
18905
18906 .vindex "&$address_data$&"
18907 If for some reason you want to discard local errors, but use a non-empty
18908 MAIL command for remote delivery, you can preserve the original return
18909 path in &$address_data$& in the router, and reinstate it in the transport by
18910 setting &%return_path%&.
18911
18912 The most common use of &%errors_to%& is to direct mailing list bounces to the
18913 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18914 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18915
18916
18917
18918 .option expn routers&!? boolean true
18919 .cindex "address" "testing"
18920 .cindex "testing" "addresses"
18921 .cindex "EXPN" "router skipping"
18922 .cindex "router" "skipping for EXPN"
18923 If this option is turned off, the router is skipped when testing an address
18924 as a result of processing an SMTP EXPN command. You might, for example,
18925 want to turn it off on a router for users' &_.forward_& files, while leaving it
18926 on for the system alias file.
18927 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18928 are evaluated.
18929
18930 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18931 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18932 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18933
18934
18935
18936 .option fail_verify routers boolean false
18937 .cindex "router" "forcing verification failure"
18938 Setting this option has the effect of setting both &%fail_verify_sender%& and
18939 &%fail_verify_recipient%& to the same value.
18940
18941
18942
18943 .option fail_verify_recipient routers boolean false
18944 If this option is true and an address is accepted by this router when
18945 verifying a recipient, verification fails.
18946
18947
18948
18949 .option fail_verify_sender routers boolean false
18950 If this option is true and an address is accepted by this router when
18951 verifying a sender, verification fails.
18952
18953
18954
18955 .option fallback_hosts routers "string list" unset
18956 .cindex "router" "fallback hosts"
18957 .cindex "fallback" "hosts specified on router"
18958 String expansion is not applied to this option. The argument must be a
18959 colon-separated list of host names or IP addresses. The list separator can be
18960 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18961 each name or address. In fact, the format of each item is exactly the same as
18962 defined for the list of hosts in a &(manualroute)& router (see section
18963 &<<SECTformatonehostitem>>&).
18964
18965 If a router queues an address for a remote transport, this host list is
18966 associated with the address, and used instead of the transport's fallback host
18967 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18968 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18969 transport for further details.
18970
18971
18972 .option group routers string&!! "see below"
18973 .cindex "gid (group id)" "local delivery"
18974 .cindex "local transports" "uid and gid"
18975 .cindex "transport" "local"
18976 .cindex "router" "setting group"
18977 When a router queues an address for a transport, and the transport does not
18978 specify a group, the group given here is used when running the delivery
18979 process.
18980 The group may be specified numerically or by name. If expansion fails, the
18981 error is logged and delivery is deferred.
18982 The default is unset, unless &%check_local_user%& is set, when the default
18983 is taken from the password information. See also &%initgroups%& and &%user%&
18984 and the discussion in chapter &<<CHAPenvironment>>&.
18985
18986
18987
18988 .option headers_add routers list&!! unset
18989 .cindex "header lines" "adding"
18990 .cindex "router" "adding header lines"
18991 This option specifies a list of text headers,
18992 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18993 that is associated with any addresses that are accepted by the router.
18994 Each item is separately expanded, at routing time.  However, this
18995 option has no effect when an address is just being verified. The way in which
18996 the text is used to add header lines at transport time is described in section
18997 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18998 message is in the process of being transported. This means that references to
18999 header lines in string expansions in the transport's configuration do not
19000 &"see"& the added header lines.
19001
19002 The &%headers_add%& option is expanded after &%errors_to%&, but before
19003 &%headers_remove%& and &%transport%&. If an item is empty, or if
19004 an item expansion is forced to fail, the item has no effect. Other expansion
19005 failures are treated as configuration errors.
19006
19007 Unlike most options, &%headers_add%& can be specified multiple times
19008 for a router; all listed headers are added.
19009
19010 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19011 router that has the &%one_time%& option set.
19012
19013 .cindex "duplicate addresses"
19014 .oindex "&%unseen%&"
19015 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19016 additions are deleted when the address is passed on to subsequent routers.
19017 For a &%redirect%& router, if a generated address is the same as the incoming
19018 address, this can lead to duplicate addresses with different header
19019 modifications. Exim does not do duplicate deliveries (except, in certain
19020 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19021 which of the duplicates is discarded, so this ambiguous situation should be
19022 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19023
19024
19025
19026 .option headers_remove routers list&!! unset
19027 .cindex "header lines" "removing"
19028 .cindex "router" "removing header lines"
19029 This option specifies a list of text headers,
19030 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19031 that is associated with any addresses that are accepted by the router.
19032 However, the option has no effect when an address is just being verified.
19033 Each list item is separately expanded, at transport time.
19034 .new
19035 If an item ends in *, it will match any header with the given prefix.
19036 .wen
19037 The way in which
19038 the text is used to remove header lines at transport time is described in
19039 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19040 the message is in the process of being transported. This means that references
19041 to header lines in string expansions in the transport's configuration still
19042 &"see"& the original header lines.
19043
19044 The &%headers_remove%& option is handled after &%errors_to%& and
19045 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19046 the item has no effect. Other expansion failures are treated as configuration
19047 errors.
19048
19049 Unlike most options, &%headers_remove%& can be specified multiple times
19050 for a router; all listed headers are removed.
19051
19052 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19053 router that has the &%one_time%& option set.
19054
19055 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19056 removal requests are deleted when the address is passed on to subsequent
19057 routers, and this can lead to problems with duplicates -- see the similar
19058 warning for &%headers_add%& above.
19059
19060 &*Warning 3*&: Because of the separate expansion of the list items,
19061 items that contain a list separator must have it doubled.
19062 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19063
19064
19065
19066 .option ignore_target_hosts routers "host list&!!" unset
19067 .cindex "IP address" "discarding"
19068 .cindex "router" "discarding IP addresses"
19069 Although this option is a host list, it should normally contain IP address
19070 entries rather than names. If any host that is looked up by the router has an
19071 IP address that matches an item in this list, Exim behaves as if that IP
19072 address did not exist. This option allows you to cope with rogue DNS entries
19073 like
19074 .code
19075 remote.domain.example.  A  127.0.0.1
19076 .endd
19077 by setting
19078 .code
19079 ignore_target_hosts = 127.0.0.1
19080 .endd
19081 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19082 discarded in this way, the router declines. In a conventional configuration, an
19083 attempt to mail to such a domain would normally provoke the &"unrouteable
19084 domain"& error, and an attempt to verify an address in the domain would fail.
19085 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19086 router declines if presented with one of the listed addresses.
19087
19088 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19089 means of the first or the second of the following settings, respectively:
19090 .code
19091 ignore_target_hosts = 0.0.0.0/0
19092 ignore_target_hosts = <; 0::0/0
19093 .endd
19094 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19095 in the second line matches all IPv6 addresses.
19096
19097 This option may also be useful for ignoring link-local and site-local IPv6
19098 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19099 is expanded before use as a list, it is possible to make it dependent on the
19100 domain that is being routed.
19101
19102 .vindex "&$host_address$&"
19103 During its expansion, &$host_address$& is set to the IP address that is being
19104 checked.
19105
19106 .option initgroups routers boolean false
19107 .cindex "additional groups"
19108 .cindex "groups" "additional"
19109 .cindex "local transports" "uid and gid"
19110 .cindex "transport" "local"
19111 If the router queues an address for a transport, and this option is true, and
19112 the uid supplied by the router is not overridden by the transport, the
19113 &[initgroups()]& function is called when running the transport to ensure that
19114 any additional groups associated with the uid are set up. See also &%group%&
19115 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19116
19117
19118
19119 .option local_part_prefix routers&!? "string list" unset
19120 .cindex affix "router precondition"
19121 .cindex "router" "prefix for local part"
19122 .cindex "prefix" "for local part, used in router"
19123 If this option is set, the router is skipped unless the local part starts with
19124 one of the given strings, or &%local_part_prefix_optional%& is true. See
19125 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19126 evaluated.
19127
19128 The list is scanned from left to right, and the first prefix that matches is
19129 used. A limited form of wildcard is available; if the prefix begins with an
19130 asterisk, it matches the longest possible sequence of arbitrary characters at
19131 the start of the local part. An asterisk should therefore always be followed by
19132 some character that does not occur in normal local parts.
19133 .cindex "multiple mailboxes"
19134 .cindex "mailbox" "multiple"
19135 Wildcarding can be used to set up multiple user mailboxes, as described in
19136 section &<<SECTmulbox>>&.
19137
19138 .vindex "&$local_part$&"
19139 .vindex "&$local_part_prefix$&"
19140 During the testing of the &%local_parts%& option, and while the router is
19141 running, the prefix is removed from the local part, and is available in the
19142 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19143 the router accepts the address, this remains true during subsequent delivery by
19144 a transport. In particular, the local part that is transmitted in the RCPT
19145 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19146 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19147 the relevant transport.
19148
19149 .new
19150 .vindex &$local_part_prefix_v$&
19151 If wildcarding (above) was used then the part of the prefix matching the
19152 wildcard is available in &$local_part_prefix_v$&.
19153 .wen
19154
19155 When an address is being verified, &%local_part_prefix%& affects only the
19156 behaviour of the router. If the callout feature of verification is in use, this
19157 means that the full address, including the prefix, will be used during the
19158 callout.
19159
19160 The prefix facility is commonly used to handle local parts of the form
19161 &%owner-something%&. Another common use is to support local parts of the form
19162 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19163 to tell a user their forwarding is broken &-- by placing a router like this one
19164 immediately before the router that handles &_.forward_& files:
19165 .code
19166 real_localuser:
19167   driver = accept
19168   local_part_prefix = real-
19169   check_local_user
19170   transport = local_delivery
19171 .endd
19172 For security, it would probably be a good idea to restrict the use of this
19173 router to locally-generated messages, using a condition such as this:
19174 .code
19175   condition = ${if match {$sender_host_address}\
19176                          {\N^(|127\.0\.0\.1)$\N}}
19177 .endd
19178
19179 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19180 both conditions must be met if not optional. Care must be taken if wildcards
19181 are used in both a prefix and a suffix on the same router. Different
19182 separator characters must be used to avoid ambiguity.
19183
19184
19185 .option local_part_prefix_optional routers boolean false
19186 See &%local_part_prefix%& above.
19187
19188
19189
19190 .option local_part_suffix routers&!? "string list" unset
19191 .cindex "router" "suffix for local part"
19192 .cindex "suffix for local part" "used in router"
19193 This option operates in the same way as &%local_part_prefix%&, except that the
19194 local part must end (rather than start) with the given string, the
19195 &%local_part_suffix_optional%& option determines whether the suffix is
19196 mandatory, and the wildcard * character, if present, must be the last
19197 character of the suffix. This option facility is commonly used to handle local
19198 parts of the form &%something-request%& and multiple user mailboxes of the form
19199 &%username-foo%&.
19200
19201
19202 .option local_part_suffix_optional routers boolean false
19203 See &%local_part_suffix%& above.
19204
19205
19206
19207 .option local_parts routers&!? "local part list&!!" unset
19208 .cindex "router" "restricting to specific local parts"
19209 .cindex "local part" "checking in router"
19210 The router is run only if the local part of the address matches the list.
19211 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19212 are evaluated, and
19213 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19214 string is expanded, it is possible to make it depend on the domain, for
19215 example:
19216 .code
19217 local_parts = dbm;/usr/local/specials/$domain
19218 .endd
19219 .vindex "&$local_part_data$&"
19220 If the match is achieved by a lookup, the data that the lookup returned
19221 for the local part is placed in the variable &$local_part_data$& for use in
19222 expansions of the router's private options. You might use this option, for
19223 example, if you have a large number of local virtual domains, and you want to
19224 send all postmaster mail to the same place without having to set up an alias in
19225 each virtual domain:
19226 .code
19227 postmaster:
19228   driver = redirect
19229   local_parts = postmaster
19230   data = postmaster@real.domain.example
19231 .endd
19232
19233
19234 .option log_as_local routers boolean "see below"
19235 .cindex "log" "delivery line"
19236 .cindex "delivery" "log line format"
19237 Exim has two logging styles for delivery, the idea being to make local
19238 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19239 recipient address is given just as the local part, without a domain. The use of
19240 this style is controlled by this option. It defaults to true for the &(accept)&
19241 router, and false for all the others. This option applies only when a
19242 router assigns an address to a transport. It has no effect on routers that
19243 redirect addresses.
19244
19245
19246
19247 .option more routers boolean&!! true
19248 The result of string expansion for this option must be a valid boolean value,
19249 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19250 result causes an error, and delivery is deferred. If the expansion is forced to
19251 fail, the default value for the option (true) is used. Other failures cause
19252 delivery to be deferred.
19253
19254 If this option is set false, and the router declines to handle the address, no
19255 further routers are tried, routing fails, and the address is bounced.
19256 .oindex "&%self%&"
19257 However, if the router explicitly passes an address to the following router by
19258 means of the setting
19259 .code
19260 self = pass
19261 .endd
19262 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19263 does not affect the behaviour if one of the precondition tests fails. In that
19264 case, the address is always passed to the next router.
19265
19266 Note that &%address_data%& is not considered to be a precondition. If its
19267 expansion is forced to fail, the router declines, and the value of &%more%&
19268 controls what happens next.
19269
19270
19271 .option pass_on_timeout routers boolean false
19272 .cindex "timeout" "of router"
19273 .cindex "router" "timeout"
19274 If a router times out during a host lookup, it normally causes deferral of the
19275 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19276 router, overriding &%no_more%&. This may be helpful for systems that are
19277 intermittently connected to the Internet, or those that want to pass to a smart
19278 host any messages that cannot immediately be delivered.
19279
19280 There are occasional other temporary errors that can occur while doing DNS
19281 lookups. They are treated in the same way as a timeout, and this option
19282 applies to all of them.
19283
19284
19285
19286 .option pass_router routers string unset
19287 .cindex "router" "go to after &""pass""&"
19288 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19289 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19290 routing to continue, and overriding a false setting of &%more%&. When one of
19291 these routers returns &"pass"&, the address is normally handed on to the next
19292 router in sequence. This can be changed by setting &%pass_router%& to the name
19293 of another router. However (unlike &%redirect_router%&) the named router must
19294 be below the current router, to avoid loops. Note that this option applies only
19295 to the special case of &"pass"&. It does not apply when a router returns
19296 &"decline"& because it cannot handle an address.
19297
19298
19299
19300 .option redirect_router routers string unset
19301 .cindex "router" "start at after redirection"
19302 Sometimes an administrator knows that it is pointless to reprocess addresses
19303 generated from alias or forward files with the same router again. For
19304 example, if an alias file translates real names into login ids there is no
19305 point searching the alias file a second time, especially if it is a large file.
19306
19307 The &%redirect_router%& option can be set to the name of any router instance.
19308 It causes the routing of any generated addresses to start at the named router
19309 instead of at the first router. This option has no effect if the router in
19310 which it is set does not generate new addresses.
19311
19312
19313
19314 .option require_files routers&!? "string list&!!" unset
19315 .cindex "file" "requiring for router"
19316 .cindex "router" "requiring file existence"
19317 This option provides a general mechanism for predicating the running of a
19318 router on the existence or non-existence of certain files or directories.
19319 Before running a router, as one of its precondition tests, Exim works its way
19320 through the &%require_files%& list, expanding each item separately.
19321
19322 Because the list is split before expansion, any colons in expansion items must
19323 be doubled, or the facility for using a different list separator must be used
19324 (&<<SECTlistsepchange>>&).
19325 If any expansion is forced to fail, the item is ignored. Other expansion
19326 failures cause routing of the address to be deferred.
19327
19328 If any expanded string is empty, it is ignored. Otherwise, except as described
19329 below, each string must be a fully qualified file path, optionally preceded by
19330 &"!"&. The paths are passed to the &[stat()]& function to test for the
19331 existence of the files or directories. The router is skipped if any paths not
19332 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19333
19334 .cindex "NFS"
19335 If &[stat()]& cannot determine whether a file exists or not, delivery of
19336 the message is deferred. This can happen when NFS-mounted filesystems are
19337 unavailable.
19338
19339 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19340 options, so you cannot use it to check for the existence of a file in which to
19341 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19342 full list of the order in which preconditions are evaluated.) However, as
19343 these options are all expanded, you can use the &%exists%& expansion condition
19344 to make such tests. The &%require_files%& option is intended for checking files
19345 that the router may be going to use internally, or which are needed by a
19346 transport (e.g., &_.procmailrc_&).
19347
19348 During delivery, the &[stat()]& function is run as root, but there is a
19349 facility for some checking of the accessibility of a file by another user.
19350 This is not a proper permissions check, but just a &"rough"& check that
19351 operates as follows:
19352
19353 If an item in a &%require_files%& list does not contain any forward slash
19354 characters, it is taken to be the user (and optional group, separated by a
19355 comma) to be checked for subsequent files in the list. If no group is specified
19356 but the user is specified symbolically, the gid associated with the uid is
19357 used. For example:
19358 .code
19359 require_files = mail:/some/file
19360 require_files = $local_part_data:$home/.procmailrc
19361 .endd
19362 If a user or group name in a &%require_files%& list does not exist, the
19363 &%require_files%& condition fails.
19364
19365 Exim performs the check by scanning along the components of the file path, and
19366 checking the access for the given uid and gid. It checks for &"x"& access on
19367 directories, and &"r"& access on the final file. Note that this means that file
19368 access control lists, if the operating system has them, are ignored.
19369
19370 &*Warning 1*&: When the router is being run to verify addresses for an
19371 incoming SMTP message, Exim is not running as root, but under its own uid. This
19372 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19373 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19374 user is not permitted to read one of the directories on the file's path.
19375
19376 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19377 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19378 without root access. In this case, if a check for access by a particular user
19379 is requested, Exim creates a subprocess that runs as that user, and tries the
19380 check again in that process.
19381
19382 The default action for handling an unresolved EACCES is to consider it to
19383 be caused by a configuration error, and routing is deferred because the
19384 existence or non-existence of the file cannot be determined. However, in some
19385 circumstances it may be desirable to treat this condition as if the file did
19386 not exist. If the filename (or the exclamation mark that precedes the filename
19387 for non-existence) is preceded by a plus sign, the EACCES error is treated
19388 as if the file did not exist. For example:
19389 .code
19390 require_files = +/some/file
19391 .endd
19392 If the router is not an essential part of verification (for example, it
19393 handles users' &_.forward_& files), another solution is to set the &%verify%&
19394 option false so that the router is skipped when verifying.
19395
19396
19397
19398 .option retry_use_local_part routers boolean "see below"
19399 .cindex "hints database" "retry keys"
19400 .cindex "local part" "in retry keys"
19401 When a delivery suffers a temporary routing failure, a retry record is created
19402 in Exim's hints database. For addresses whose routing depends only on the
19403 domain, the key for the retry record should not involve the local part, but for
19404 other addresses, both the domain and the local part should be included.
19405 Usually, remote routing is of the former kind, and local routing is of the
19406 latter kind.
19407
19408 This option controls whether the local part is used to form the key for retry
19409 hints for addresses that suffer temporary errors while being handled by this
19410 router. The default value is true for any router that has any of
19411 &%check_local_user%&,
19412 &%local_parts%&,
19413 &%condition%&,
19414 &%local_part_prefix%&,
19415 &%local_part_suffix%&,
19416 &%senders%& or
19417 &%require_files%&
19418 set, and false otherwise. Note that this option does not apply to hints keys
19419 for transport delays; they are controlled by a generic transport option of the
19420 same name.
19421
19422 Failing to set this option when it is needed
19423 (because a remote router handles only some of the local-parts for a domain)
19424 can result in incorrect error messages being generated.
19425
19426 The setting of &%retry_use_local_part%& applies only to the router on which it
19427 appears. If the router generates child addresses, they are routed
19428 independently; this setting does not become attached to them.
19429
19430
19431
19432 .option router_home_directory routers string&!! unset
19433 .cindex "router" "home directory for"
19434 .cindex "home directory" "for router"
19435 .vindex "&$home$&"
19436 This option sets a home directory for use while the router is running. (Compare
19437 &%transport_home_directory%&, which sets a home directory for later
19438 transporting.) In particular, if used on a &(redirect)& router, this option
19439 sets a value for &$home$& while a filter is running. The value is expanded;
19440 forced expansion failure causes the option to be ignored &-- other failures
19441 cause the router to defer.
19442
19443 Expansion of &%router_home_directory%& happens immediately after the
19444 &%check_local_user%& test (if configured), before any further expansions take
19445 place.
19446 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19447 are evaluated.)
19448 While the router is running, &%router_home_directory%& overrides the value of
19449 &$home$& that came from &%check_local_user%&.
19450
19451 When a router accepts an address and assigns it to a local transport (including
19452 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19453 delivery), the home directory setting for the transport is taken from the first
19454 of these values that is set:
19455
19456 .ilist
19457 The &%home_directory%& option on the transport;
19458 .next
19459 The &%transport_home_directory%& option on the router;
19460 .next
19461 The password data if &%check_local_user%& is set on the router;
19462 .next
19463 The &%router_home_directory%& option on the router.
19464 .endlist
19465
19466 In other words, &%router_home_directory%& overrides the password data for the
19467 router, but not for the transport.
19468
19469
19470
19471 .option self routers string freeze
19472 .cindex "MX record" "pointing to local host"
19473 .cindex "local host" "MX pointing to"
19474 This option applies to those routers that use a recipient address to find a
19475 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19476 and &(manualroute)& routers.
19477 Certain configurations of the &(queryprogram)& router can also specify a list
19478 of remote hosts.
19479 Usually such routers are configured to send the message to a remote host via an
19480 &(smtp)& transport. The &%self%& option specifies what happens when the first
19481 host on the list turns out to be the local host.
19482 The way in which Exim checks for the local host is described in section
19483 &<<SECTreclocipadd>>&.
19484
19485 Normally this situation indicates either an error in Exim's configuration (for
19486 example, the router should be configured not to process this domain), or an
19487 error in the DNS (for example, the MX should not point to this host). For this
19488 reason, the default action is to log the incident, defer the address, and
19489 freeze the message. The following alternatives are provided for use in special
19490 cases:
19491
19492 .vlist
19493 .vitem &%defer%&
19494 Delivery of the message is tried again later, but the message is not frozen.
19495
19496 .vitem "&%reroute%&: <&'domain'&>"
19497 The domain is changed to the given domain, and the address is passed back to
19498 be reprocessed by the routers. No rewriting of headers takes place. This
19499 behaviour is essentially a redirection.
19500
19501 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19502 The domain is changed to the given domain, and the address is passed back to be
19503 reprocessed by the routers. Any headers that contain the original domain are
19504 rewritten.
19505
19506 .vitem &%pass%&
19507 .oindex "&%more%&"
19508 .vindex "&$self_hostname$&"
19509 The router passes the address to the next router, or to the router named in the
19510 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19511 subsequent routing and delivery, the variable &$self_hostname$& contains the
19512 name of the local host that the router encountered. This can be used to
19513 distinguish between different cases for hosts with multiple names. The
19514 combination
19515 .code
19516 self = pass
19517 no_more
19518 .endd
19519 ensures that only those addresses that routed to the local host are passed on.
19520 Without &%no_more%&, addresses that were declined for other reasons would also
19521 be passed to the next router.
19522
19523 .vitem &%fail%&
19524 Delivery fails and an error report is generated.
19525
19526 .vitem &%send%&
19527 .cindex "local host" "sending to"
19528 The anomaly is ignored and the address is queued for the transport. This
19529 setting should be used with extreme caution. For an &(smtp)& transport, it
19530 makes sense only in cases where the program that is listening on the SMTP port
19531 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19532 different configuration file that handles the domain in another way.
19533 .endlist
19534
19535
19536
19537 .option senders routers&!? "address list&!!" unset
19538 .cindex "router" "checking senders"
19539 If this option is set, the router is skipped unless the message's sender
19540 address matches something on the list.
19541 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19542 are evaluated.
19543
19544 There are issues concerning verification when the running of routers is
19545 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19546 setting, it sets the sender to the null string. When using the &%-bt%& option
19547 to check a configuration file, it is necessary also to use the &%-f%& option to
19548 set an appropriate sender. For incoming mail, the sender is unset when
19549 verifying the sender, but is available when verifying any recipients. If the
19550 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19551 matters.
19552
19553
19554 .option set routers "string list" unset
19555 .cindex router variables
19556 This option may be used multiple times on a router;
19557 because of this the list aspect is mostly irrelevant.
19558 The list separator is a semicolon but can be changed in the
19559 usual way.
19560
19561 Each list-element given must be of the form &"name = value"&
19562 and the names used must start with the string &"r_"&.
19563 Values containing a list-separator should have them doubled.
19564 When a router runs, the strings are evaluated in order,
19565 to create variables which are added to the set associated with
19566 the address.
19567 The variable is set with the expansion of the value.
19568 The variables can be used by the router options
19569 (not including any preconditions)
19570 and by the transport.
19571 Later definitions of a given named variable will override former ones.
19572 Variable use is via the usual &$r_...$& syntax.
19573
19574 This is similar to the &%address_data%& option, except that
19575 many independent variables can be used, with choice of naming.
19576
19577
19578 .option translate_ip_address routers string&!! unset
19579 .cindex "IP address" "translating"
19580 .cindex "packet radio"
19581 .cindex "router" "IP address translation"
19582 There exist some rare networking situations (for example, packet radio) where
19583 it is helpful to be able to translate IP addresses generated by normal routing
19584 mechanisms into other IP addresses, thus performing a kind of manual IP
19585 routing. This should be done only if the normal IP routing of the TCP/IP stack
19586 is inadequate or broken. Because this is an extremely uncommon requirement, the
19587 code to support this option is not included in the Exim binary unless
19588 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19589
19590 .vindex "&$host_address$&"
19591 The &%translate_ip_address%& string is expanded for every IP address generated
19592 by the router, with the generated address set in &$host_address$&. If the
19593 expansion is forced to fail, no action is taken.
19594 For any other expansion error, delivery of the message is deferred.
19595 If the result of the expansion is an IP address, that replaces the original
19596 address; otherwise the result is assumed to be a host name &-- this is looked
19597 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19598 produce one or more replacement IP addresses. For example, to subvert all IP
19599 addresses in some specific networks, this could be added to a router:
19600 .code
19601 translate_ip_address = \
19602   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19603     {$value}fail}}
19604 .endd
19605 The file would contain lines like
19606 .code
19607 10.2.3.128/26    some.host
19608 10.8.4.34/26     10.44.8.15
19609 .endd
19610 You should not make use of this facility unless you really understand what you
19611 are doing.
19612
19613
19614
19615 .option transport routers string&!! unset
19616 This option specifies the transport to be used when a router accepts an address
19617 and sets it up for delivery. A transport is never needed if a router is used
19618 only for verification. The value of the option is expanded at routing time,
19619 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19620 and result must be the name of one of the configured transports. If it is not,
19621 delivery is deferred.
19622
19623 The &%transport%& option is not used by the &(redirect)& router, but it does
19624 have some private options that set up transports for pipe and file deliveries
19625 (see chapter &<<CHAPredirect>>&).
19626
19627
19628
19629 .option transport_current_directory routers string&!! unset
19630 .cindex "current directory for local transport"
19631 This option associates a current directory with any address that is routed
19632 to a local transport. This can happen either because a transport is
19633 explicitly configured for the router, or because it generates a delivery to a
19634 file or a pipe. During the delivery process (that is, at transport time), this
19635 option string is expanded and is set as the current directory, unless
19636 overridden by a setting on the transport.
19637 If the expansion fails for any reason, including forced failure, an error is
19638 logged, and delivery is deferred.
19639 See chapter &<<CHAPenvironment>>& for details of the local delivery
19640 environment.
19641
19642
19643
19644
19645 .option transport_home_directory routers string&!! "see below"
19646 .cindex "home directory" "for local transport"
19647 This option associates a home directory with any address that is routed to a
19648 local transport. This can happen either because a transport is explicitly
19649 configured for the router, or because it generates a delivery to a file or a
19650 pipe. During the delivery process (that is, at transport time), the option
19651 string is expanded and is set as the home directory, unless overridden by a
19652 setting of &%home_directory%& on the transport.
19653 If the expansion fails for any reason, including forced failure, an error is
19654 logged, and delivery is deferred.
19655
19656 If the transport does not specify a home directory, and
19657 &%transport_home_directory%& is not set for the router, the home directory for
19658 the transport is taken from the password data if &%check_local_user%& is set for
19659 the router. Otherwise it is taken from &%router_home_directory%& if that option
19660 is set; if not, no home directory is set for the transport.
19661
19662 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19663 environment.
19664
19665
19666
19667
19668 .option unseen routers boolean&!! false
19669 .cindex "router" "carrying on after success"
19670 The result of string expansion for this option must be a valid boolean value,
19671 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19672 result causes an error, and delivery is deferred. If the expansion is forced to
19673 fail, the default value for the option (false) is used. Other failures cause
19674 delivery to be deferred.
19675
19676 When this option is set true, routing does not cease if the router accepts the
19677 address. Instead, a copy of the incoming address is passed to the next router,
19678 overriding a false setting of &%more%&. There is little point in setting
19679 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19680 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19681 sometimes true and sometimes false).
19682
19683 .cindex "copy of message (&%unseen%& option)"
19684 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19685 qualifier in filter files. It can be used to cause copies of messages to be
19686 delivered to some other destination, while also carrying out a normal delivery.
19687 In effect, the current address is made into a &"parent"& that has two children
19688 &-- one that is delivered as specified by this router, and a clone that goes on
19689 to be routed further. For this reason, &%unseen%& may not be combined with the
19690 &%one_time%& option in a &(redirect)& router.
19691
19692 &*Warning*&: Header lines added to the address (or specified for removal) by
19693 this router or by previous routers affect the &"unseen"& copy of the message
19694 only. The clone that continues to be processed by further routers starts with
19695 no added headers and none specified for removal. For a &%redirect%& router, if
19696 a generated address is the same as the incoming address, this can lead to
19697 duplicate addresses with different header modifications. Exim does not do
19698 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19699 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19700 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19701 &%redirect%& router may be of help.
19702
19703 Unlike the handling of header modifications, any data that was set by the
19704 &%address_data%& option in the current or previous routers &'is'& passed on to
19705 subsequent routers.
19706
19707
19708 .option user routers string&!! "see below"
19709 .cindex "uid (user id)" "local delivery"
19710 .cindex "local transports" "uid and gid"
19711 .cindex "transport" "local"
19712 .cindex "router" "user for filter processing"
19713 .cindex "filter" "user for processing"
19714 When a router queues an address for a transport, and the transport does not
19715 specify a user, the user given here is used when running the delivery process.
19716 The user may be specified numerically or by name. If expansion fails, the
19717 error is logged and delivery is deferred.
19718 This user is also used by the &(redirect)& router when running a filter file.
19719 The default is unset, except when &%check_local_user%& is set. In this case,
19720 the default is taken from the password information. If the user is specified as
19721 a name, and &%group%& is not set, the group associated with the user is used.
19722 See also &%initgroups%& and &%group%& and the discussion in chapter
19723 &<<CHAPenvironment>>&.
19724
19725
19726
19727 .option verify routers&!? boolean true
19728 Setting this option has the effect of setting &%verify_sender%& and
19729 &%verify_recipient%& to the same value.
19730
19731
19732 .option verify_only routers&!? boolean false
19733 .cindex "EXPN" "with &%verify_only%&"
19734 .oindex "&%-bv%&"
19735 .cindex "router" "used only when verifying"
19736 If this option is set, the router is used only when verifying an address,
19737 delivering in cutthrough mode or
19738 testing with the &%-bv%& option, not when actually doing a delivery, testing
19739 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19740 restricted to verifying only senders or recipients by means of
19741 &%verify_sender%& and &%verify_recipient%&.
19742
19743 &*Warning*&: When the router is being run to verify addresses for an incoming
19744 SMTP message, Exim is not running as root, but under its own uid. If the router
19745 accesses any files, you need to make sure that they are accessible to the Exim
19746 user or group.
19747
19748
19749 .option verify_recipient routers&!? boolean true
19750 If this option is false, the router is skipped when verifying recipient
19751 addresses,
19752 delivering in cutthrough mode
19753 or testing recipient verification using &%-bv%&.
19754 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19755 are evaluated.
19756 See also the &$verify_mode$& variable.
19757
19758
19759 .option verify_sender routers&!? boolean true
19760 If this option is false, the router is skipped when verifying sender addresses
19761 or testing sender verification using &%-bvs%&.
19762 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19763 are evaluated.
19764 See also the &$verify_mode$& variable.
19765 .ecindex IIDgenoprou1
19766 .ecindex IIDgenoprou2
19767
19768
19769
19770
19771
19772
19773 . ////////////////////////////////////////////////////////////////////////////
19774 . ////////////////////////////////////////////////////////////////////////////
19775
19776 .chapter "The accept router" "CHID4"
19777 .cindex "&(accept)& router"
19778 .cindex "routers" "&(accept)&"
19779 The &(accept)& router has no private options of its own. Unless it is being
19780 used purely for verification (see &%verify_only%&) a transport is required to
19781 be defined by the generic &%transport%& option. If the preconditions that are
19782 specified by generic options are met, the router accepts the address and queues
19783 it for the given transport. The most common use of this router is for setting
19784 up deliveries to local mailboxes. For example:
19785 .code
19786 localusers:
19787   driver = accept
19788   domains = mydomain.example
19789   check_local_user
19790   transport = local_delivery
19791 .endd
19792 The &%domains%& condition in this example checks the domain of the address, and
19793 &%check_local_user%& checks that the local part is the login of a local user.
19794 When both preconditions are met, the &(accept)& router runs, and queues the
19795 address for the &(local_delivery)& transport.
19796
19797
19798
19799
19800
19801
19802 . ////////////////////////////////////////////////////////////////////////////
19803 . ////////////////////////////////////////////////////////////////////////////
19804
19805 .chapter "The dnslookup router" "CHAPdnslookup"
19806 .scindex IIDdnsrou1 "&(dnslookup)& router"
19807 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19808 The &(dnslookup)& router looks up the hosts that handle mail for the
19809 recipient's domain in the DNS. A transport must always be set for this router,
19810 unless &%verify_only%& is set.
19811
19812 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19813 SRV records. If none are found, or if SRV support is not configured,
19814 MX records are looked up. If no MX records exist, address records are sought.
19815 However, &%mx_domains%& can be set to disable the direct use of address
19816 records.
19817
19818 MX records of equal priority are sorted by Exim into a random order. Exim then
19819 looks for address records for the host names obtained from MX or SRV records.
19820 When a host has more than one IP address, they are sorted into a random order,
19821 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19822 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19823 generic option, the router declines.
19824
19825 Unless they have the highest priority (lowest MX value), MX records that point
19826 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19827 are discarded, together with any other MX records of equal or lower priority.
19828
19829 .cindex "MX record" "pointing to local host"
19830 .cindex "local host" "MX pointing to"
19831 .oindex "&%self%&" "in &(dnslookup)& router"
19832 If the host pointed to by the highest priority MX record, or looked up as an
19833 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19834 happens is controlled by the generic &%self%& option.
19835
19836
19837 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19838 There have been problems with DNS servers when SRV records are looked up.
19839 Some misbehaving servers return a DNS error or timeout when a non-existent
19840 SRV record is sought. Similar problems have in the past been reported for
19841 MX records. The global &%dns_again_means_nonexist%& option can help with this
19842 problem, but it is heavy-handed because it is a global option.
19843
19844 For this reason, there are two options, &%srv_fail_domains%& and
19845 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19846 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19847 an attempt to look up an SRV or MX record causes one of these results, and the
19848 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19849 such record"&. In the case of an SRV lookup, this means that the router
19850 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19851 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19852 case routing fails.
19853
19854
19855 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19856 .cindex "&(dnslookup)& router" "declines"
19857 There are a few cases where a &(dnslookup)& router will decline to accept
19858 an address; if such a router is expected to handle "all remaining non-local
19859 domains", then it is important to set &%no_more%&.
19860
19861 The router will defer rather than decline if the domain
19862 is found in the &%fail_defer_domains%& router option.
19863
19864 Reasons for a &(dnslookup)& router to decline currently include:
19865 .ilist
19866 The domain does not exist in DNS
19867 .next
19868 The domain exists but the MX record's host part is just "."; this is a common
19869 convention (borrowed from SRV) used to indicate that there is no such service
19870 for this domain and to not fall back to trying A/AAAA records.
19871 .next
19872 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19873 .next
19874 MX record points to a non-existent host.
19875 .next
19876 MX record points to an IP address and the main section option
19877 &%allow_mx_to_ip%& is not set.
19878 .next
19879 MX records exist and point to valid hosts, but all hosts resolve only to
19880 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19881 .next
19882 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19883 &%dns_check_names_pattern%& for handling one variant of this)
19884 .next
19885 &%check_secondary_mx%& is set on this router but the local host can
19886 not be found in the MX records (see below)
19887 .endlist
19888
19889
19890
19891
19892 .section "Private options for dnslookup" "SECID118"
19893 .cindex "options" "&(dnslookup)& router"
19894 The private options for the &(dnslookup)& router are as follows:
19895
19896 .option check_secondary_mx dnslookup boolean false
19897 .cindex "MX record" "checking for secondary"
19898 If this option is set, the router declines unless the local host is found in
19899 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19900 process domains for which the local host is a secondary mail exchanger
19901 differently to other domains. The way in which Exim decides whether a host is
19902 the local host is described in section &<<SECTreclocipadd>>&.
19903
19904
19905 .option check_srv dnslookup string&!! unset
19906 .cindex "SRV record" "enabling use of"
19907 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19908 addition to MX and address records. The support is disabled by default. To
19909 enable SRV support, set the &%check_srv%& option to the name of the service
19910 required. For example,
19911 .code
19912 check_srv = smtp
19913 .endd
19914 looks for SRV records that refer to the normal smtp service. The option is
19915 expanded, so the service name can vary from message to message or address
19916 to address. This might be helpful if SRV records are being used for a
19917 submission service. If the expansion is forced to fail, the &%check_srv%&
19918 option is ignored, and the router proceeds to look for MX records in the
19919 normal way.
19920
19921 When the expansion succeeds, the router searches first for SRV records for
19922 the given service (it assumes TCP protocol). A single SRV record with a
19923 host name that consists of just a single dot indicates &"no such service for
19924 this domain"&; if this is encountered, the router declines. If other kinds of
19925 SRV record are found, they are used to construct a host list for delivery
19926 according to the rules of RFC 2782. MX records are not sought in this case.
19927
19928 When no SRV records are found, MX records (and address records) are sought in
19929 the traditional way. In other words, SRV records take precedence over MX
19930 records, just as MX records take precedence over address records. Note that
19931 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19932 defined it. It is apparently believed that MX records are sufficient for email
19933 and that SRV records should not be used for this purpose. However, SRV records
19934 have an additional &"weight"& feature which some people might find useful when
19935 trying to split an SMTP load between hosts of different power.
19936
19937 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19938 when there is a DNS lookup error.
19939
19940
19941
19942
19943 .option fail_defer_domains dnslookup "domain list&!!" unset
19944 .cindex "MX record" "not found"
19945 DNS lookups for domains matching &%fail_defer_domains%&
19946 which find no matching record will cause the router to defer
19947 rather than the default behaviour of decline.
19948 This maybe be useful for queueing messages for a newly created
19949 domain while the DNS configuration is not ready.
19950 However, it will result in any message with mistyped domains
19951 also being queued.
19952
19953
19954 .option ipv4_only "string&!!" unset
19955 .cindex IPv6 disabling
19956 .cindex DNS "IPv6 disabling"
19957 The string is expanded, and if the result is anything but a forced failure,
19958 or an empty string, or one of the strings “0” or “no” or “false”
19959 (checked without regard to the case of the letters),
19960 only A records are used.
19961
19962 .option ipv4_prefer "string&!!" unset
19963 .cindex IPv4 preference
19964 .cindex DNS "IPv4 preference"
19965 The string is expanded, and if the result is anything but a forced failure,
19966 or an empty string, or one of the strings “0” or “no” or “false”
19967 (checked without regard to the case of the letters),
19968 A records are sorted before AAAA records (inverting the default).
19969
19970 .option mx_domains dnslookup "domain list&!!" unset
19971 .cindex "MX record" "required to exist"
19972 .cindex "SRV record" "required to exist"
19973 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19974 record in order to be recognized. (The name of this option could be improved.)
19975 For example, if all the mail hosts in &'fict.example'& are known to have MX
19976 records, except for those in &'discworld.fict.example'&, you could use this
19977 setting:
19978 .code
19979 mx_domains = ! *.discworld.fict.example : *.fict.example
19980 .endd
19981 This specifies that messages addressed to a domain that matches the list but
19982 has no MX record should be bounced immediately instead of being routed using
19983 the address record.
19984
19985
19986 .option mx_fail_domains dnslookup "domain list&!!" unset
19987 If the DNS lookup for MX records for one of the domains in this list causes a
19988 DNS lookup error, Exim behaves as if no MX records were found. See section
19989 &<<SECTprowitdnsloo>>& for more discussion.
19990
19991
19992
19993
19994 .option qualify_single dnslookup boolean true
19995 .cindex "DNS" "resolver options"
19996 .cindex "DNS" "qualifying single-component names"
19997 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19998 lookups. Typically, but not standardly, this causes the resolver to qualify
19999 single-component names with the default domain. For example, on a machine
20000 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20001 &'thesaurus.ref.example'& inside the resolver. For details of what your
20002 resolver actually does, consult your man pages for &'resolver'& and
20003 &'resolv.conf'&.
20004
20005
20006
20007 .option rewrite_headers dnslookup boolean true
20008 .cindex "rewriting" "header lines"
20009 .cindex "header lines" "rewriting"
20010 If the domain name in the address that is being processed is not fully
20011 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20012 an address is specified as &'dormouse@teaparty'&, the domain might be
20013 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20014 occur as a result of setting the &%widen_domains%& option. If
20015 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20016 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20017 header lines of the message are rewritten with the full domain name.
20018
20019 This option should be turned off only when it is known that no message is
20020 ever going to be sent outside an environment where the abbreviation makes
20021 sense.
20022
20023 When an MX record is looked up in the DNS and matches a wildcard record, name
20024 servers normally return a record containing the name that has been looked up,
20025 making it impossible to detect whether a wildcard was present or not. However,
20026 some name servers have recently been seen to return the wildcard entry. If the
20027 name returned by a DNS lookup begins with an asterisk, it is not used for
20028 header rewriting.
20029
20030
20031 .option same_domain_copy_routing dnslookup boolean false
20032 .cindex "address" "copying routing"
20033 Addresses with the same domain are normally routed by the &(dnslookup)& router
20034 to the same list of hosts. However, this cannot be presumed, because the router
20035 options and preconditions may refer to the local part of the address. By
20036 default, therefore, Exim routes each address in a message independently. DNS
20037 servers run caches, so repeated DNS lookups are not normally expensive, and in
20038 any case, personal messages rarely have more than a few recipients.
20039
20040 If you are running mailing lists with large numbers of subscribers at the same
20041 domain, and you are using a &(dnslookup)& router which is independent of the
20042 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20043 lookups for identical domains in one message. In this case, when &(dnslookup)&
20044 routes an address to a remote transport, any other unrouted addresses in the
20045 message that have the same domain are automatically given the same routing
20046 without processing them independently,
20047 provided the following conditions are met:
20048
20049 .ilist
20050 No router that processed the address specified &%headers_add%& or
20051 &%headers_remove%&.
20052 .next
20053 The router did not change the address in any way, for example, by &"widening"&
20054 the domain.
20055 .endlist
20056
20057
20058
20059
20060 .option search_parents dnslookup boolean false
20061 .cindex "DNS" "resolver options"
20062 When this option is true, the resolver option RES_DNSRCH is set for DNS
20063 lookups. This is different from the &%qualify_single%& option in that it
20064 applies to domains containing dots. Typically, but not standardly, it causes
20065 the resolver to search for the name in the current domain and in parent
20066 domains. For example, on a machine in the &'fict.example'& domain, if looking
20067 up &'teaparty.wonderland'& failed, the resolver would try
20068 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20069 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20070
20071 Setting this option true can cause problems in domains that have a wildcard MX
20072 record, because any domain that does not have its own MX record matches the
20073 local wildcard.
20074
20075
20076
20077 .option srv_fail_domains dnslookup "domain list&!!" unset
20078 If the DNS lookup for SRV records for one of the domains in this list causes a
20079 DNS lookup error, Exim behaves as if no SRV records were found. See section
20080 &<<SECTprowitdnsloo>>& for more discussion.
20081
20082
20083
20084
20085 .option widen_domains dnslookup "string list" unset
20086 .cindex "domain" "partial; widening"
20087 If a DNS lookup fails and this option is set, each of its strings in turn is
20088 added onto the end of the domain, and the lookup is tried again. For example,
20089 if
20090 .code
20091 widen_domains = fict.example:ref.example
20092 .endd
20093 is set and a lookup of &'klingon.dictionary'& fails,
20094 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20095 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20096 and &%search_parents%& options can cause some widening to be undertaken inside
20097 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20098 when verifying, unless &%rewrite_headers%& is false (not the default).
20099
20100
20101 .section "Effect of qualify_single and search_parents" "SECID119"
20102 When a domain from an envelope recipient is changed by the resolver as a result
20103 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20104 corresponding address in the message's header lines unless &%rewrite_headers%&
20105 is set false. Exim then re-routes the address, using the full domain.
20106
20107 These two options affect only the DNS lookup that takes place inside the router
20108 for the domain of the address that is being routed. They do not affect lookups
20109 such as that implied by
20110 .code
20111 domains = @mx_any
20112 .endd
20113 that may happen while processing a router precondition before the router is
20114 entered. No widening ever takes place for these lookups.
20115 .ecindex IIDdnsrou1
20116 .ecindex IIDdnsrou2
20117
20118
20119
20120
20121
20122
20123
20124
20125
20126 . ////////////////////////////////////////////////////////////////////////////
20127 . ////////////////////////////////////////////////////////////////////////////
20128
20129 .chapter "The ipliteral router" "CHID5"
20130 .cindex "&(ipliteral)& router"
20131 .cindex "domain literal" "routing"
20132 .cindex "routers" "&(ipliteral)&"
20133 This router has no private options. Unless it is being used purely for
20134 verification (see &%verify_only%&) a transport is required to be defined by the
20135 generic &%transport%& option. The router accepts the address if its domain part
20136 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20137 router handles the address
20138 .code
20139 root@[192.168.1.1]
20140 .endd
20141 by setting up delivery to the host with that IP address. IPv4 domain literals
20142 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20143 are similar, but the address is preceded by &`ipv6:`&. For example:
20144 .code
20145 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20146 .endd
20147 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20148 grounds that sooner or later somebody will try it.
20149
20150 .oindex "&%self%&" "in &(ipliteral)& router"
20151 If the IP address matches something in &%ignore_target_hosts%&, the router
20152 declines. If an IP literal turns out to refer to the local host, the generic
20153 &%self%& option determines what happens.
20154
20155 The RFCs require support for domain literals; however, their use is
20156 controversial in today's Internet. If you want to use this router, you must
20157 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20158 Exim will not recognize the domain literal syntax in addresses.
20159
20160
20161
20162 . ////////////////////////////////////////////////////////////////////////////
20163 . ////////////////////////////////////////////////////////////////////////////
20164
20165 .chapter "The iplookup router" "CHID6"
20166 .cindex "&(iplookup)& router"
20167 .cindex "routers" "&(iplookup)&"
20168 The &(iplookup)& router was written to fulfil a specific requirement in
20169 Cambridge University (which in fact no longer exists). For this reason, it is
20170 not included in the binary of Exim by default. If you want to include it, you
20171 must set
20172 .code
20173 ROUTER_IPLOOKUP=yes
20174 .endd
20175 in your &_Local/Makefile_& configuration file.
20176
20177 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20178 connection to one or more specific hosts. The host can then return the same or
20179 a different address &-- in effect rewriting the recipient address in the
20180 message's envelope. The new address is then passed on to subsequent routers. If
20181 this process fails, the address can be passed on to other routers, or delivery
20182 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20183 must not be specified for it.
20184
20185 .cindex "options" "&(iplookup)& router"
20186 .option hosts iplookup string unset
20187 This option must be supplied. Its value is a colon-separated list of host
20188 names. The hosts are looked up using &[gethostbyname()]&
20189 (or &[getipnodebyname()]& when available)
20190 and are tried in order until one responds to the query. If none respond, what
20191 happens is controlled by &%optional%&.
20192
20193
20194 .option optional iplookup boolean false
20195 If &%optional%& is true, if no response is obtained from any host, the address
20196 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20197 delivery to the address is deferred.
20198
20199
20200 .option port iplookup integer 0
20201 .cindex "port" "&(iplookup)& router"
20202 This option must be supplied. It specifies the port number for the TCP or UDP
20203 call.
20204
20205
20206 .option protocol iplookup string udp
20207 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20208 protocols is to be used.
20209
20210
20211 .option query iplookup string&!! "see below"
20212 This defines the content of the query that is sent to the remote hosts. The
20213 default value is:
20214 .code
20215 $local_part@$domain $local_part@$domain
20216 .endd
20217 The repetition serves as a way of checking that a response is to the correct
20218 query in the default case (see &%response_pattern%& below).
20219
20220
20221 .option reroute iplookup string&!! unset
20222 If this option is not set, the rerouted address is precisely the byte string
20223 returned by the remote host, up to the first white space, if any. If set, the
20224 string is expanded to form the rerouted address. It can include parts matched
20225 in the response by &%response_pattern%& by means of numeric variables such as
20226 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20227 whether or not a pattern is in use. In all cases, the rerouted address must end
20228 up in the form &'local_part@domain'&.
20229
20230
20231 .option response_pattern iplookup string unset
20232 This option can be set to a regular expression that is applied to the string
20233 returned from the remote host. If the pattern does not match the response, the
20234 router declines. If &%response_pattern%& is not set, no checking of the
20235 response is done, unless the query was defaulted, in which case there is a
20236 check that the text returned after the first white space is the original
20237 address. This checks that the answer that has been received is in response to
20238 the correct question. For example, if the response is just a new domain, the
20239 following could be used:
20240 .code
20241 response_pattern = ^([^@]+)$
20242 reroute = $local_part@$1
20243 .endd
20244
20245 .option timeout iplookup time 5s
20246 This specifies the amount of time to wait for a response from the remote
20247 machine. The same timeout is used for the &[connect()]& function for a TCP
20248 call. It does not apply to UDP.
20249
20250
20251
20252
20253 . ////////////////////////////////////////////////////////////////////////////
20254 . ////////////////////////////////////////////////////////////////////////////
20255
20256 .chapter "The manualroute router" "CHID7"
20257 .scindex IIDmanrou1 "&(manualroute)& router"
20258 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20259 .cindex "domain" "manually routing"
20260 The &(manualroute)& router is so-called because it provides a way of manually
20261 routing an address according to its domain. It is mainly used when you want to
20262 route addresses to remote hosts according to your own rules, bypassing the
20263 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20264 route to local transports, a facility that may be useful if you want to save
20265 messages for dial-in hosts in local files.
20266
20267 The &(manualroute)& router compares a list of domain patterns with the domain
20268 it is trying to route. If there is no match, the router declines. Each pattern
20269 has associated with it a list of hosts and some other optional data, which may
20270 include a transport. The combination of a pattern and its data is called a
20271 &"routing rule"&. For patterns that do not have an associated transport, the
20272 generic &%transport%& option must specify a transport, unless the router is
20273 being used purely for verification (see &%verify_only%&).
20274
20275 .vindex "&$host$&"
20276 In the case of verification, matching the domain pattern is sufficient for the
20277 router to accept the address. When actually routing an address for delivery,
20278 an address that matches a domain pattern is queued for the associated
20279 transport. If the transport is not a local one, a host list must be associated
20280 with the pattern; IP addresses are looked up for the hosts, and these are
20281 passed to the transport along with the mail address. For local transports, a
20282 host list is optional. If it is present, it is passed in &$host$& as a single
20283 text string.
20284
20285 The list of routing rules can be provided as an inline string in
20286 &%route_list%&, or the data can be obtained by looking up the domain in a file
20287 or database by setting &%route_data%&. Only one of these settings may appear in
20288 any one instance of &(manualroute)&. The format of routing rules is described
20289 below, following the list of private options.
20290
20291
20292 .section "Private options for manualroute" "SECTprioptman"
20293
20294 .cindex "options" "&(manualroute)& router"
20295 The private options for the &(manualroute)& router are as follows:
20296
20297 .option host_all_ignored manualroute string defer
20298 See &%host_find_failed%&.
20299
20300 .option host_find_failed manualroute string freeze
20301 This option controls what happens when &(manualroute)& tries to find an IP
20302 address for a host, and the host does not exist. The option can be set to one
20303 of the following values:
20304 .code
20305 decline
20306 defer
20307 fail
20308 freeze
20309 ignore
20310 pass
20311 .endd
20312 The default (&"freeze"&) assumes that this state is a serious configuration
20313 error. The difference between &"pass"& and &"decline"& is that the former
20314 forces the address to be passed to the next router (or the router defined by
20315 &%pass_router%&),
20316 .oindex "&%more%&"
20317 overriding &%no_more%&, whereas the latter passes the address to the next
20318 router only if &%more%& is true.
20319
20320 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20321 cannot be found. If all the hosts in the list are ignored, the behaviour is
20322 controlled by the &%host_all_ignored%& option. This takes the same values
20323 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20324
20325 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20326 state; if a host lookup gets a temporary error, delivery is deferred unless the
20327 generic &%pass_on_timeout%& option is set.
20328
20329
20330 .option hosts_randomize manualroute boolean false
20331 .cindex "randomized host list"
20332 .cindex "host" "list of; randomized"
20333 If this option is set, the order of the items in a host list in a routing rule
20334 is randomized each time the list is used, unless an option in the routing rule
20335 overrides (see below). Randomizing the order of a host list can be used to do
20336 crude load sharing. However, if more than one mail address is routed by the
20337 same router to the same host list, the host lists are considered to be the same
20338 (even though they may be randomized into different orders) for the purpose of
20339 deciding whether to batch the deliveries into a single SMTP transaction.
20340
20341 When &%hosts_randomize%& is true, a host list may be split
20342 into groups whose order is separately randomized. This makes it possible to
20343 set up MX-like behaviour. The boundaries between groups are indicated by an
20344 item that is just &`+`& in the host list. For example:
20345 .code
20346 route_list = * host1:host2:host3:+:host4:host5
20347 .endd
20348 The order of the first three hosts and the order of the last two hosts is
20349 randomized for each use, but the first three always end up before the last two.
20350 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20351 randomized host list is passed to an &(smtp)& transport that also has
20352 &%hosts_randomize set%&, the list is not re-randomized.
20353
20354
20355 .option route_data manualroute string&!! unset
20356 If this option is set, it must expand to yield the data part of a routing rule.
20357 Typically, the expansion string includes a lookup based on the domain. For
20358 example:
20359 .code
20360 route_data = ${lookup{$domain}dbm{/etc/routes}}
20361 .endd
20362 If the expansion is forced to fail, or the result is an empty string, the
20363 router declines. Other kinds of expansion failure cause delivery to be
20364 deferred.
20365
20366
20367 .option route_list manualroute "string list" unset
20368 This string is a list of routing rules, in the form defined below. Note that,
20369 unlike most string lists, the items are separated by semicolons. This is so
20370 that they may contain colon-separated host lists.
20371
20372
20373 .option same_domain_copy_routing manualroute boolean false
20374 .cindex "address" "copying routing"
20375 Addresses with the same domain are normally routed by the &(manualroute)&
20376 router to the same list of hosts. However, this cannot be presumed, because the
20377 router options and preconditions may refer to the local part of the address. By
20378 default, therefore, Exim routes each address in a message independently. DNS
20379 servers run caches, so repeated DNS lookups are not normally expensive, and in
20380 any case, personal messages rarely have more than a few recipients.
20381
20382 If you are running mailing lists with large numbers of subscribers at the same
20383 domain, and you are using a &(manualroute)& router which is independent of the
20384 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20385 lookups for identical domains in one message. In this case, when
20386 &(manualroute)& routes an address to a remote transport, any other unrouted
20387 addresses in the message that have the same domain are automatically given the
20388 same routing without processing them independently. However, this is only done
20389 if &%headers_add%& and &%headers_remove%& are unset.
20390
20391
20392
20393
20394 .section "Routing rules in route_list" "SECID120"
20395 The value of &%route_list%& is a string consisting of a sequence of routing
20396 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20397 entered as two semicolons. Alternatively, the list separator can be changed as
20398 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20399 Empty rules are ignored. The format of each rule is
20400 .display
20401 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20402 .endd
20403 The following example contains two rules, each with a simple domain pattern and
20404 no options:
20405 .code
20406 route_list = \
20407   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20408   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20409 .endd
20410 The three parts of a rule are separated by white space. The pattern and the
20411 list of hosts can be enclosed in quotes if necessary, and if they are, the
20412 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20413 single domain pattern, which is the only mandatory item in the rule. The
20414 pattern is in the same format as one item in a domain list (see section
20415 &<<SECTdomainlist>>&),
20416 except that it may not be the name of an interpolated file.
20417 That is, it may be wildcarded, or a regular expression, or a file or database
20418 lookup (with semicolons doubled, because of the use of semicolon as a separator
20419 in a &%route_list%&).
20420
20421 The rules in &%route_list%& are searched in order until one of the patterns
20422 matches the domain that is being routed. The list of hosts and then options are
20423 then used as described below. If there is no match, the router declines. When
20424 &%route_list%& is set, &%route_data%& must not be set.
20425
20426
20427
20428 .section "Routing rules in route_data" "SECID121"
20429 The use of &%route_list%& is convenient when there are only a small number of
20430 routing rules. For larger numbers, it is easier to use a file or database to
20431 hold the routing information, and use the &%route_data%& option instead.
20432 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20433 Most commonly, &%route_data%& is set as a string that contains an
20434 expansion lookup. For example, suppose we place two routing rules in a file
20435 like this:
20436 .code
20437 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20438 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20439 .endd
20440 This data can be accessed by setting
20441 .code
20442 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20443 .endd
20444 Failure of the lookup results in an empty string, causing the router to
20445 decline. However, you do not have to use a lookup in &%route_data%&. The only
20446 requirement is that the result of expanding the string is a list of hosts,
20447 possibly followed by options, separated by white space. The list of hosts must
20448 be enclosed in quotes if it contains white space.
20449
20450
20451
20452
20453 .section "Format of the list of hosts" "SECID122"
20454 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20455 always separately expanded before use. If the expansion fails, the router
20456 declines. The result of the expansion must be a colon-separated list of names
20457 and/or IP addresses, optionally also including ports.
20458 If the list is written with spaces, it must be protected with quotes.
20459 The format of each item
20460 in the list is described in the next section. The list separator can be changed
20461 as described in section &<<SECTlistsepchange>>&.
20462
20463 If the list of hosts was obtained from a &%route_list%& item, the following
20464 variables are set during its expansion:
20465
20466 .ilist
20467 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20468 If the domain was matched against a regular expression, the numeric variables
20469 &$1$&, &$2$&, etc. may be set. For example:
20470 .code
20471 route_list = ^domain(\d+)   host-$1.text.example
20472 .endd
20473 .next
20474 &$0$& is always set to the entire domain.
20475 .next
20476 &$1$& is also set when partial matching is done in a file lookup.
20477
20478 .next
20479 .vindex "&$value$&"
20480 If the pattern that matched the domain was a lookup item, the data that was
20481 looked up is available in the expansion variable &$value$&. For example:
20482 .code
20483 route_list = lsearch;;/some/file.routes  $value
20484 .endd
20485 .endlist
20486
20487 Note the doubling of the semicolon in the pattern that is necessary because
20488 semicolon is the default route list separator.
20489
20490
20491
20492 .section "Format of one host item" "SECTformatonehostitem"
20493 Each item in the list of hosts can be either a host name or an IP address,
20494 optionally with an attached port number, or it can be a single "+"
20495 (see &%hosts_randomize%&).
20496 When no port is given, an IP address
20497 is not enclosed in brackets. When a port is specified, it overrides the port
20498 specification on the transport. The port is separated from the name or address
20499 by a colon. This leads to some complications:
20500
20501 .ilist
20502 Because colon is the default separator for the list of hosts, either
20503 the colon that specifies a port must be doubled, or the list separator must
20504 be changed. The following two examples have the same effect:
20505 .code
20506 route_list = * "host1.tld::1225 : host2.tld::1226"
20507 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20508 .endd
20509 .next
20510 When IPv6 addresses are involved, it gets worse, because they contain
20511 colons of their own. To make this case easier, it is permitted to
20512 enclose an IP address (either v4 or v6) in square brackets if a port
20513 number follows. For example:
20514 .code
20515 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20516 .endd
20517 .endlist
20518
20519 .section "How the list of hosts is used" "SECThostshowused"
20520 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20521 the hosts is tried, in the order specified, when carrying out the SMTP
20522 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20523 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20524 transport.
20525
20526 Hosts may be listed by name or by IP address. An unadorned name in the list of
20527 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20528 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20529 records in the DNS. For example:
20530 .code
20531 route_list = *  x.y.z:p.q.r/MX:e.f.g
20532 .endd
20533 If this feature is used with a port specifier, the port must come last. For
20534 example:
20535 .code
20536 route_list = *  dom1.tld/mx::1225
20537 .endd
20538 If the &%hosts_randomize%& option is set, the order of the items in the list is
20539 randomized before any lookups are done. Exim then scans the list; for any name
20540 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20541 be an interface on the local host and the item is not the first in the list,
20542 Exim discards it and any subsequent items. If it is the first item, what
20543 happens is controlled by the
20544 .oindex "&%self%&" "in &(manualroute)& router"
20545 &%self%& option of the router.
20546
20547 A name on the list that is followed by &`/MX`& is replaced with the list of
20548 hosts obtained by looking up MX records for the name. This is always a DNS
20549 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20550 below) are not relevant here. The order of these hosts is determined by the
20551 preference values in the MX records, according to the usual rules. Because
20552 randomizing happens before the MX lookup, it does not affect the order that is
20553 defined by MX preferences.
20554
20555 If the local host is present in the sublist obtained from MX records, but is
20556 not the most preferred host in that list, it and any equally or less
20557 preferred hosts are removed before the sublist is inserted into the main list.
20558
20559 If the local host is the most preferred host in the MX list, what happens
20560 depends on where in the original list of hosts the &`/MX`& item appears. If it
20561 is not the first item (that is, there are previous hosts in the main list),
20562 Exim discards this name and any subsequent items in the main list.
20563
20564 If the MX item is first in the list of hosts, and the local host is the
20565 most preferred host, what happens is controlled by the &%self%& option of the
20566 router.
20567
20568 DNS failures when lookup up the MX records are treated in the same way as DNS
20569 failures when looking up IP addresses: &%pass_on_timeout%& and
20570 &%host_find_failed%& are used when relevant.
20571
20572 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20573 whether obtained from an MX lookup or not.
20574
20575
20576
20577 .section "How the options are used" "SECThowoptused"
20578 The options are a sequence of words, space-separated.
20579 One of the words can be the name of a transport; this overrides the
20580 &%transport%& option on the router for this particular routing rule only. The
20581 other words (if present) control randomization of the list of hosts on a
20582 per-rule basis, and how the IP addresses of the hosts are to be found when
20583 routing to a remote transport. These options are as follows:
20584
20585 .ilist
20586 &%randomize%&: randomize the order of the hosts in this list, overriding the
20587 setting of &%hosts_randomize%& for this routing rule only.
20588 .next
20589 &%no_randomize%&: do not randomize the order of the hosts in this list,
20590 overriding the setting of &%hosts_randomize%& for this routing rule only.
20591 .next
20592 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20593 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20594 also look in &_/etc/hosts_& or other sources of information.
20595 .next
20596 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20597 no address records are found. If there is a temporary DNS error (such as a
20598 timeout), delivery is deferred.
20599 .next
20600 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20601 .next
20602 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20603 .endlist
20604
20605 For example:
20606 .code
20607 route_list = domain1  host1:host2:host3  randomize bydns;\
20608              domain2  host4:host5
20609 .endd
20610 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20611 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20612 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20613 or &[gethostbyname()]&, and the result of the lookup is the result of that
20614 call.
20615
20616 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20617 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20618 instead of TRY_AGAIN. That is why the default action is to try a DNS
20619 lookup first. Only if that gives a definite &"no such host"& is the local
20620 function called.
20621
20622 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20623 inadvertent constraint that a transport name as an option had to be the last
20624 option specified.
20625
20626
20627
20628 If no IP address for a host can be found, what happens is controlled by the
20629 &%host_find_failed%& option.
20630
20631 .vindex "&$host$&"
20632 When an address is routed to a local transport, IP addresses are not looked up.
20633 The host list is passed to the transport in the &$host$& variable.
20634
20635
20636
20637 .section "Manualroute examples" "SECID123"
20638 In some of the examples that follow, the presence of the &%remote_smtp%&
20639 transport, as defined in the default configuration file, is assumed:
20640
20641 .ilist
20642 .cindex "smart host" "example router"
20643 The &(manualroute)& router can be used to forward all external mail to a
20644 &'smart host'&. If you have set up, in the main part of the configuration, a
20645 named domain list that contains your local domains, for example:
20646 .code
20647 domainlist local_domains = my.domain.example
20648 .endd
20649 You can arrange for all other domains to be routed to a smart host by making
20650 your first router something like this:
20651 .code
20652 smart_route:
20653   driver = manualroute
20654   domains = !+local_domains
20655   transport = remote_smtp
20656   route_list = * smarthost.ref.example
20657 .endd
20658 This causes all non-local addresses to be sent to the single host
20659 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20660 they are tried in order
20661 (but you can use &%hosts_randomize%& to vary the order each time).
20662 Another way of configuring the same thing is this:
20663 .code
20664 smart_route:
20665   driver = manualroute
20666   transport = remote_smtp
20667   route_list = !+local_domains  smarthost.ref.example
20668 .endd
20669 There is no difference in behaviour between these two routers as they stand.
20670 However, they behave differently if &%no_more%& is added to them. In the first
20671 example, the router is skipped if the domain does not match the &%domains%&
20672 precondition; the following router is always tried. If the router runs, it
20673 always matches the domain and so can never decline. Therefore, &%no_more%&
20674 would have no effect. In the second case, the router is never skipped; it
20675 always runs. However, if it doesn't match the domain, it declines. In this case
20676 &%no_more%& would prevent subsequent routers from running.
20677
20678 .next
20679 .cindex "mail hub example"
20680 A &'mail hub'& is a host which receives mail for a number of domains via MX
20681 records in the DNS and delivers it via its own private routing mechanism. Often
20682 the final destinations are behind a firewall, with the mail hub being the one
20683 machine that can connect to machines both inside and outside the firewall. The
20684 &(manualroute)& router is usually used on a mail hub to route incoming messages
20685 to the correct hosts. For a small number of domains, the routing can be inline,
20686 using the &%route_list%& option, but for a larger number a file or database
20687 lookup is easier to manage.
20688
20689 If the domain names are in fact the names of the machines to which the mail is
20690 to be sent by the mail hub, the configuration can be quite simple. For
20691 example:
20692 .code
20693 hub_route:
20694   driver = manualroute
20695   transport = remote_smtp
20696   route_list = *.rhodes.tvs.example  $domain
20697 .endd
20698 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20699 whose names are the same as the mail domains. A similar approach can be taken
20700 if the host name can be obtained from the domain name by a string manipulation
20701 that the expansion facilities can handle. Otherwise, a lookup based on the
20702 domain can be used to find the host:
20703 .code
20704 through_firewall:
20705   driver = manualroute
20706   transport = remote_smtp
20707   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20708 .endd
20709 The result of the lookup must be the name or IP address of the host (or
20710 hosts) to which the address is to be routed. If the lookup fails, the route
20711 data is empty, causing the router to decline. The address then passes to the
20712 next router.
20713
20714 .next
20715 .cindex "batched SMTP output example"
20716 .cindex "SMTP" "batched outgoing; example"
20717 You can use &(manualroute)& to deliver messages to pipes or files in batched
20718 SMTP format for onward transportation by some other means. This is one way of
20719 storing mail for a dial-up host when it is not connected. The route list entry
20720 can be as simple as a single domain name in a configuration like this:
20721 .code
20722 save_in_file:
20723   driver = manualroute
20724   transport = batchsmtp_appendfile
20725   route_list = saved.domain.example
20726 .endd
20727 though often a pattern is used to pick up more than one domain. If there are
20728 several domains or groups of domains with different transport requirements,
20729 different transports can be listed in the routing information:
20730 .code
20731 save_in_file:
20732   driver = manualroute
20733   route_list = \
20734     *.saved.domain1.example  $domain  batch_appendfile; \
20735     *.saved.domain2.example  \
20736       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20737       batch_pipe
20738 .endd
20739 .vindex "&$domain$&"
20740 .vindex "&$host$&"
20741 The first of these just passes the domain in the &$host$& variable, which
20742 doesn't achieve much (since it is also in &$domain$&), but the second does a
20743 file lookup to find a value to pass, causing the router to decline to handle
20744 the address if the lookup fails.
20745
20746 .next
20747 .cindex "UUCP" "example of router for"
20748 Routing mail directly to UUCP software is a specific case of the use of
20749 &(manualroute)& in a gateway to another mail environment. This is an example of
20750 one way it can be done:
20751 .code
20752 # Transport
20753 uucp:
20754   driver = pipe
20755   user = nobody
20756   command = /usr/local/bin/uux -r - \
20757     ${substr_-5:$host}!rmail ${local_part}
20758   return_fail_output = true
20759
20760 # Router
20761 uucphost:
20762   transport = uucp
20763   driver = manualroute
20764   route_data = \
20765     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20766 .endd
20767 The file &_/usr/local/exim/uucphosts_& contains entries like
20768 .code
20769 darksite.ethereal.example:           darksite.UUCP
20770 .endd
20771 It can be set up more simply without adding and removing &".UUCP"& but this way
20772 makes clear the distinction between the domain name
20773 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20774 .endlist
20775 .ecindex IIDmanrou1
20776 .ecindex IIDmanrou2
20777
20778
20779
20780
20781
20782
20783
20784
20785 . ////////////////////////////////////////////////////////////////////////////
20786 . ////////////////////////////////////////////////////////////////////////////
20787
20788 .chapter "The queryprogram router" "CHAPdriverlast"
20789 .scindex IIDquerou1 "&(queryprogram)& router"
20790 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20791 .cindex "routing" "by external program"
20792 The &(queryprogram)& router routes an address by running an external command
20793 and acting on its output. This is an expensive way to route, and is intended
20794 mainly for use in lightly-loaded systems, or for performing experiments.
20795 However, if it is possible to use the precondition options (&%domains%&,
20796 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20797 be used in special cases, even on a busy host. There are the following private
20798 options:
20799 .cindex "options" "&(queryprogram)& router"
20800
20801 .option command queryprogram string&!! unset
20802 This option must be set. It specifies the command that is to be run. The
20803 command is split up into a command name and arguments, and then each is
20804 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20805 &<<CHAPpipetransport>>&).
20806
20807
20808 .option command_group queryprogram string unset
20809 .cindex "gid (group id)" "in &(queryprogram)& router"
20810 This option specifies a gid to be set when running the command while routing an
20811 address for deliver. It must be set if &%command_user%& specifies a numerical
20812 uid. If it begins with a digit, it is interpreted as the numerical value of the
20813 gid. Otherwise it is looked up using &[getgrnam()]&.
20814
20815
20816 .option command_user queryprogram string unset
20817 .cindex "uid (user id)" "for &(queryprogram)&"
20818 This option must be set. It specifies the uid which is set when running the
20819 command while routing an address for delivery. If the value begins with a digit,
20820 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20821 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20822 not set, a value for the gid also.
20823
20824 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20825 root, which it does during a normal delivery in a conventional configuration.
20826 However, when an address is being verified during message reception, Exim is
20827 usually running as the Exim user, not as root. If the &(queryprogram)& router
20828 is called from a non-root process, Exim cannot change uid or gid before running
20829 the command. In this circumstance the command runs under the current uid and
20830 gid.
20831
20832
20833 .option current_directory queryprogram string /
20834 This option specifies an absolute path which is made the current directory
20835 before running the command.
20836
20837
20838 .option timeout queryprogram time 1h
20839 If the command does not complete within the timeout period, its process group
20840 is killed and the message is frozen. A value of zero time specifies no
20841 timeout.
20842
20843
20844 The standard output of the command is connected to a pipe, which is read when
20845 the command terminates. It should consist of a single line of output,
20846 containing up to five fields, separated by white space. The maximum length of
20847 the line is 1023 characters. Longer lines are silently truncated. The first
20848 field is one of the following words (case-insensitive):
20849
20850 .ilist
20851 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20852 below).
20853 .next
20854 &'Decline'&: the router declines; pass the address to the next router, unless
20855 &%no_more%& is set.
20856 .next
20857 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20858 subsequent text on the line is an error message. If the router is run as part
20859 of address verification during an incoming SMTP message, the message is
20860 included in the SMTP response.
20861 .next
20862 &'Defer'&: routing could not be completed at this time; try again later. Any
20863 subsequent text on the line is an error message which is logged. It is not
20864 included in any SMTP response.
20865 .next
20866 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20867 .next
20868 &'Pass'&: pass the address to the next router (or the router specified by
20869 &%pass_router%&), overriding &%no_more%&.
20870 .next
20871 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20872 new addresses, which are routed independently, starting with the first router,
20873 or the router specified by &%redirect_router%&, if set.
20874 .endlist
20875
20876 When the first word is &'accept'&, the remainder of the line consists of a
20877 number of keyed data values, as follows (split into two lines here, to fit on
20878 the page):
20879 .code
20880 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20881 LOOKUP=byname|bydns DATA=<text>
20882 .endd
20883 The data items can be given in any order, and all are optional. If no transport
20884 is included, the transport specified by the generic &%transport%& option is
20885 used. The list of hosts and the lookup type are needed only if the transport is
20886 an &(smtp)& transport that does not itself supply a list of hosts.
20887
20888 The format of the list of hosts is the same as for the &(manualroute)& router.
20889 As well as host names and IP addresses with optional port numbers, as described
20890 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20891 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20892 (see section &<<SECThostshowused>>&).
20893
20894 If the lookup type is not specified, Exim behaves as follows when trying to
20895 find an IP address for each host: First, a DNS lookup is done. If this yields
20896 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20897 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20898 result of the lookup is the result of that call.
20899
20900 .vindex "&$address_data$&"
20901 If the DATA field is set, its value is placed in the &$address_data$&
20902 variable. For example, this return line
20903 .code
20904 accept hosts=x1.y.example:x2.y.example data="rule1"
20905 .endd
20906 routes the address to the default transport, passing a list of two hosts. When
20907 the transport runs, the string &"rule1"& is in &$address_data$&.
20908 .ecindex IIDquerou1
20909 .ecindex IIDquerou2
20910
20911
20912
20913
20914 . ////////////////////////////////////////////////////////////////////////////
20915 . ////////////////////////////////////////////////////////////////////////////
20916
20917 .chapter "The redirect router" "CHAPredirect"
20918 .scindex IIDredrou1 "&(redirect)& router"
20919 .scindex IIDredrou2 "routers" "&(redirect)&"
20920 .cindex "alias file" "in a &(redirect)& router"
20921 .cindex "address redirection" "&(redirect)& router"
20922 The &(redirect)& router handles several kinds of address redirection. Its most
20923 common uses are for resolving local part aliases from a central alias file
20924 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20925 files, but it has many other potential uses. The incoming address can be
20926 redirected in several different ways:
20927
20928 .ilist
20929 It can be replaced by one or more new addresses which are themselves routed
20930 independently.
20931 .next
20932 It can be routed to be delivered to a given file or directory.
20933 .next
20934 It can be routed to be delivered to a specified pipe command.
20935 .next
20936 It can cause an automatic reply to be generated.
20937 .next
20938 It can be forced to fail, optionally with a custom error message.
20939 .next
20940 It can be temporarily deferred, optionally with a custom message.
20941 .next
20942 It can be discarded.
20943 .endlist
20944
20945 The generic &%transport%& option must not be set for &(redirect)& routers.
20946 However, there are some private options which define transports for delivery to
20947 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20948 &%pipe_transport%& and &%reply_transport%& descriptions below.
20949
20950 If success DSNs have been requested
20951 .cindex "DSN" "success"
20952 .cindex "Delivery Status Notification" "success"
20953 redirection triggers one and the DSN options are not passed any further.
20954
20955
20956
20957 .section "Redirection data" "SECID124"
20958 The router operates by interpreting a text string which it obtains either by
20959 expanding the contents of the &%data%& option, or by reading the entire
20960 contents of a file whose name is given in the &%file%& option. These two
20961 options are mutually exclusive. The first is commonly used for handling system
20962 aliases, in a configuration like this:
20963 .code
20964 system_aliases:
20965   driver = redirect
20966   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20967 .endd
20968 If the lookup fails, the expanded string in this example is empty. When the
20969 expansion of &%data%& results in an empty string, the router declines. A forced
20970 expansion failure also causes the router to decline; other expansion failures
20971 cause delivery to be deferred.
20972
20973 A configuration using &%file%& is commonly used for handling users'
20974 &_.forward_& files, like this:
20975 .code
20976 userforward:
20977   driver = redirect
20978   check_local_user
20979   file = $home/.forward
20980   no_verify
20981 .endd
20982 If the file does not exist, or causes no action to be taken (for example, it is
20983 empty or consists only of comments), the router declines. &*Warning*&: This
20984 is not the case when the file contains syntactically valid items that happen to
20985 yield empty addresses, for example, items containing only RFC 2822 address
20986 comments.
20987
20988 .new
20989 .cindex "tainted data" "in filenames"
20990 .cindex redirect "tainted data"
20991 Tainted data may not be used for a filename.
20992
20993 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20994 directly for redirection,
20995 as they are provided by a potential attacker.
20996 In the examples above, &$local_part$& is used for looking up data held locally
20997 on the system, and not used directly (the second example derives &$home$& via
20998 the passsword file or database, using &$local_part$&).
20999 .wen
21000
21001
21002
21003 .section "Forward files and address verification" "SECID125"
21004 .cindex "address redirection" "while verifying"
21005 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21006 &_.forward_& files, as in the example above. There are two reasons for this:
21007
21008 .ilist
21009 When Exim is receiving an incoming SMTP message from a remote host, it is
21010 running under the Exim uid, not as root. Exim is unable to change uid to read
21011 the file as the user, and it may not be able to read it as the Exim user. So in
21012 practice the router may not be able to operate.
21013 .next
21014 However, even when the router can operate, the existence of a &_.forward_& file
21015 is unimportant when verifying an address. What should be checked is whether the
21016 local part is a valid user name or not. Cutting out the redirection processing
21017 saves some resources.
21018 .endlist
21019
21020
21021
21022
21023
21024
21025 .section "Interpreting redirection data" "SECID126"
21026 .cindex "Sieve filter" "specifying in redirection data"
21027 .cindex "filter" "specifying in redirection data"
21028 The contents of the data string, whether obtained from &%data%& or &%file%&,
21029 can be interpreted in two different ways:
21030
21031 .ilist
21032 If the &%allow_filter%& option is set true, and the data begins with the text
21033 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21034 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21035 respectively. Details of the syntax and semantics of filter files are described
21036 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21037 document is intended for use by end users.
21038 .next
21039 Otherwise, the data must be a comma-separated list of redirection items, as
21040 described in the next section.
21041 .endlist
21042
21043 When a message is redirected to a file (a &"mail folder"&), the filename given
21044 in a non-filter redirection list must always be an absolute path. A filter may
21045 generate a relative path &-- how this is handled depends on the transport's
21046 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21047 for the &(appendfile)& transport.
21048
21049
21050
21051 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21052 .cindex "address redirection" "non-filter list items"
21053 When the redirection data is not an Exim or Sieve filter, for example, if it
21054 comes from a conventional alias or forward file, it consists of a list of
21055 addresses, filenames, pipe commands, or certain special items (see section
21056 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21057 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21058 depending on their default values. The items in the list are separated by
21059 commas or newlines.
21060 If a comma is required in an item, the entire item must be enclosed in double
21061 quotes.
21062
21063 Lines starting with a # character are comments, and are ignored, and # may
21064 also appear following a comma, in which case everything between the # and the
21065 next newline character is ignored.
21066
21067 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21068 double quotes are retained because some forms of mail address require their use
21069 (but never to enclose the entire address). In the following description,
21070 &"item"& refers to what remains after any surrounding double quotes have been
21071 removed.
21072
21073 .vindex "&$local_part$&"
21074 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21075 and the expansion contains a reference to &$local_part$&, you should make use
21076 of the &%quote_local_part%& expansion operator, in case the local part contains
21077 special characters. For example, to redirect all mail for the domain
21078 &'obsolete.example'&, retaining the existing local part, you could use this
21079 setting:
21080 .code
21081 data = ${quote_local_part:$local_part}@newdomain.example
21082 .endd
21083
21084
21085 .section "Redirecting to a local mailbox" "SECTredlocmai"
21086 .cindex "routing" "loops in"
21087 .cindex "loop" "while routing, avoidance of"
21088 .cindex "address redirection" "to local mailbox"
21089 A redirection item may safely be the same as the address currently under
21090 consideration. This does not cause a routing loop, because a router is
21091 automatically skipped if any ancestor of the address that is being processed
21092 is the same as the current address and was processed by the current router.
21093 Such an address is therefore passed to the following routers, so it is handled
21094 as if there were no redirection. When making this loop-avoidance test, the
21095 complete local part, including any prefix or suffix, is used.
21096
21097 .cindex "address redirection" "local part without domain"
21098 Specifying the same local part without a domain is a common usage in personal
21099 filter files when the user wants to have messages delivered to the local
21100 mailbox and also forwarded elsewhere. For example, the user whose login is
21101 &'cleo'& might have a &_.forward_& file containing this:
21102 .code
21103 cleo, cleopatra@egypt.example
21104 .endd
21105 .cindex "backslash in alias file"
21106 .cindex "alias file" "backslash in"
21107 For compatibility with other MTAs, such unqualified local parts may be
21108 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21109 it does make a difference if more than one domain is being handled
21110 synonymously.
21111
21112 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21113 2822 address that does not include a domain, the item is qualified using the
21114 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21115 addresses are qualified using the value in &%qualify_recipient%&, but you can
21116 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21117
21118 Care must be taken if there are alias names for local users.
21119 Consider an MTA handling a single local domain where the system alias file
21120 contains:
21121 .code
21122 Sam.Reman: spqr
21123 .endd
21124 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21125 messages in the local mailbox, and also forward copies elsewhere. He creates
21126 this forward file:
21127 .code
21128 Sam.Reman, spqr@reme.elsewhere.example
21129 .endd
21130 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21131 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21132 second time round, because it has previously routed it,
21133 and the following routers presumably cannot handle the alias. The forward file
21134 should really contain
21135 .code
21136 spqr, spqr@reme.elsewhere.example
21137 .endd
21138 but because this is such a common error, the &%check_ancestor%& option (see
21139 below) exists to provide a way to get round it. This is normally set on a
21140 &(redirect)& router that is handling users' &_.forward_& files.
21141
21142
21143
21144 .section "Special items in redirection lists" "SECTspecitredli"
21145 In addition to addresses, the following types of item may appear in redirection
21146 lists (that is, in non-filter redirection data):
21147
21148 .ilist
21149 .cindex "pipe" "in redirection list"
21150 .cindex "address redirection" "to pipe"
21151 An item is treated as a pipe command if it begins with &"|"& and does not parse
21152 as a valid RFC 2822 address that includes a domain. A transport for running the
21153 command must be specified by the &%pipe_transport%& option.
21154 Normally, either the router or the transport specifies a user and a group under
21155 which to run the delivery. The default is to use the Exim user and group.
21156
21157 Single or double quotes can be used for enclosing the individual arguments of
21158 the pipe command; no interpretation of escapes is done for single quotes. If
21159 the command contains a comma character, it is necessary to put the whole item
21160 in double quotes, for example:
21161 .code
21162 "|/some/command ready,steady,go"
21163 .endd
21164 since items in redirection lists are terminated by commas. Do not, however,
21165 quote just the command. An item such as
21166 .code
21167 |"/some/command ready,steady,go"
21168 .endd
21169 is interpreted as a pipe with a rather strange command name, and no arguments.
21170
21171 Note that the above example assumes that the text comes from a lookup source
21172 of some sort, so that the quotes are part of the data.  If composing a
21173 redirect router with a &%data%& option directly specifying this command, the
21174 quotes will be used by the configuration parser to define the extent of one
21175 string, but will not be passed down into the redirect router itself.  There
21176 are two main approaches to get around this: escape quotes to be part of the
21177 data itself, or avoid using this mechanism and instead create a custom
21178 transport with the &%command%& option set and reference that transport from
21179 an &%accept%& router.
21180
21181 .next
21182 .cindex "file" "in redirection list"
21183 .cindex "address redirection" "to file"
21184 An item is interpreted as a path name if it begins with &"/"& and does not
21185 parse as a valid RFC 2822 address that includes a domain. For example,
21186 .code
21187 /home/world/minbari
21188 .endd
21189 is treated as a filename, but
21190 .code
21191 /s=molari/o=babylon/@x400gate.way
21192 .endd
21193 is treated as an address. For a filename, a transport must be specified using
21194 the &%file_transport%& option. However, if the generated path name ends with a
21195 forward slash character, it is interpreted as a directory name rather than a
21196 filename, and &%directory_transport%& is used instead.
21197
21198 Normally, either the router or the transport specifies a user and a group under
21199 which to run the delivery. The default is to use the Exim user and group.
21200
21201 .cindex "&_/dev/null_&"
21202 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21203 bypassed at a high level, and the log entry shows &"**bypassed**"&
21204 instead of a transport name. In this case the user and group are not used.
21205
21206 .next
21207 .cindex "included address list"
21208 .cindex "address redirection" "included external list"
21209 If an item is of the form
21210 .code
21211 :include:<path name>
21212 .endd
21213 a list of further items is taken from the given file and included at that
21214 point. &*Note*&: Such a file can not be a filter file; it is just an
21215 out-of-line addition to the list. The items in the included list are separated
21216 by commas or newlines and are not subject to expansion. If this is the first
21217 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21218 the alias name. This example is incorrect:
21219 .code
21220 list1    :include:/opt/lists/list1
21221 .endd
21222 It must be given as
21223 .code
21224 list1:   :include:/opt/lists/list1
21225 .endd
21226 .new
21227 .cindex "tainted data" "in filenames"
21228 .cindex redirect "tainted data"
21229 Tainted data may not be used for a filename.
21230 .wen
21231 .next
21232 .cindex "address redirection" "to black hole"
21233 .cindex "delivery" "discard"
21234 .cindex "delivery" "blackhole"
21235 .cindex "black hole"
21236 .cindex "abandoning mail"
21237 Sometimes you want to throw away mail to a particular local part.  Making the
21238 &%data%& option expand to an empty string does not work, because that causes
21239 the router to decline. Instead, the alias item
21240 .code
21241 :blackhole:
21242 .endd
21243 can be used. It does what its name implies. No delivery is
21244 done, and no error message is generated. This has the same effect as specifying
21245 &_/dev/null_& as a destination, but it can be independently disabled.
21246
21247 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21248 delivery is done for the original local part, even if other redirection items
21249 are present. If you are generating a multi-item list (for example, by reading a
21250 database) and need the ability to provide a no-op item, you must use
21251 &_/dev/null_&.
21252
21253 .next
21254 .cindex "delivery" "forcing failure"
21255 .cindex "delivery" "forcing deferral"
21256 .cindex "failing delivery" "forcing"
21257 .cindex "deferred delivery, forcing"
21258 .cindex "customizing" "failure message"
21259 An attempt to deliver a particular address can be deferred or forced to fail by
21260 redirection items of the form
21261 .code
21262 :defer:
21263 :fail:
21264 .endd
21265 respectively. When a redirection list contains such an item, it applies
21266 to the entire redirection; any other items in the list are ignored. Any
21267 text following &':fail:'& or &':defer:'& is placed in the error text
21268 associated with the failure. For example, an alias file might contain:
21269 .code
21270 X.Employee:  :fail: Gone away, no forwarding address
21271 .endd
21272 In the case of an address that is being verified from an ACL or as the subject
21273 of a
21274 .cindex "VRFY" "error text, display of"
21275 VRFY command, the text is included in the SMTP error response by
21276 default.
21277 .cindex "EXPN" "error text, display of"
21278 The text is not included in the response to an EXPN command. In non-SMTP cases
21279 the text is included in the error message that Exim generates.
21280
21281 .cindex "SMTP" "error codes"
21282 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21283 &':fail:'&. However, if the message starts with three digits followed by a
21284 space, optionally followed by an extended code of the form &'n.n.n'&, also
21285 followed by a space, and the very first digit is the same as the default error
21286 code, the code from the message is used instead. If the very first digit is
21287 incorrect, a panic error is logged, and the default code is used. You can
21288 suppress the use of the supplied code in a redirect router by setting the
21289 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21290 ignored.
21291
21292 .vindex "&$acl_verify_message$&"
21293 In an ACL, an explicitly provided message overrides the default, but the
21294 default message is available in the variable &$acl_verify_message$& and can
21295 therefore be included in a custom message if this is desired.
21296
21297 Normally the error text is the rest of the redirection list &-- a comma does
21298 not terminate it &-- but a newline does act as a terminator. Newlines are not
21299 normally present in alias expansions. In &(lsearch)& lookups they are removed
21300 as part of the continuation process, but they may exist in other kinds of
21301 lookup and in &':include:'& files.
21302
21303 During routing for message delivery (as opposed to verification), a redirection
21304 containing &':fail:'& causes an immediate failure of the incoming address,
21305 whereas &':defer:'& causes the message to remain in the queue so that a
21306 subsequent delivery attempt can happen at a later time. If an address is
21307 deferred for too long, it will ultimately fail, because the normal retry
21308 rules still apply.
21309
21310 .next
21311 .cindex "alias file" "exception to default"
21312 Sometimes it is useful to use a single-key search type with a default (see
21313 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21314 for exceptions to the default. These can be handled by aliasing them to
21315 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21316 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21317 results in an empty redirection list has the same effect.
21318 .endlist
21319
21320
21321 .section "Duplicate addresses" "SECTdupaddr"
21322 .cindex "duplicate addresses"
21323 .cindex "address duplicate, discarding"
21324 .cindex "pipe" "duplicated"
21325 Exim removes duplicate addresses from the list to which it is delivering, so as
21326 to deliver just one copy to each address. This does not apply to deliveries
21327 routed to pipes by different immediate parent addresses, but an indirect
21328 aliasing scheme of the type
21329 .code
21330 pipe:       |/some/command $local_part
21331 localpart1: pipe
21332 localpart2: pipe
21333 .endd
21334 does not work with a message that is addressed to both local parts, because
21335 when the second is aliased to the intermediate local part &"pipe"& it gets
21336 discarded as being the same as a previously handled address. However, a scheme
21337 such as
21338 .code
21339 localpart1: |/some/command $local_part
21340 localpart2: |/some/command $local_part
21341 .endd
21342 does result in two different pipe deliveries, because the immediate parents of
21343 the pipes are distinct.
21344
21345
21346
21347 .section "Repeated redirection expansion" "SECID128"
21348 .cindex "repeated redirection expansion"
21349 .cindex "address redirection" "repeated for each delivery attempt"
21350 When a message cannot be delivered to all of its recipients immediately,
21351 leading to two or more delivery attempts, redirection expansion is carried out
21352 afresh each time for those addresses whose children were not all previously
21353 delivered. If redirection is being used as a mailing list, this can lead to new
21354 members of the list receiving copies of old messages. The &%one_time%& option
21355 can be used to avoid this.
21356
21357
21358 .section "Errors in redirection lists" "SECID129"
21359 .cindex "address redirection" "errors"
21360 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21361 error is skipped, and an entry is written to the main log. This may be useful
21362 for mailing lists that are automatically managed. Otherwise, if an error is
21363 detected while generating the list of new addresses, the original address is
21364 deferred. See also &%syntax_errors_to%&.
21365
21366
21367
21368 .section "Private options for the redirect router" "SECID130"
21369
21370 .cindex "options" "&(redirect)& router"
21371 The private options for the &(redirect)& router are as follows:
21372
21373
21374 .option allow_defer redirect boolean false
21375 Setting this option allows the use of &':defer:'& in non-filter redirection
21376 data, or the &%defer%& command in an Exim filter file.
21377
21378
21379 .option allow_fail redirect boolean false
21380 .cindex "failing delivery" "from filter"
21381 If this option is true, the &':fail:'& item can be used in a redirection list,
21382 and the &%fail%& command may be used in an Exim filter file.
21383
21384
21385 .option allow_filter redirect boolean false
21386 .cindex "filter" "enabling use of"
21387 .cindex "Sieve filter" "enabling use of"
21388 Setting this option allows Exim to interpret redirection data that starts with
21389 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21390 are some features of Exim filter files that some administrators may wish to
21391 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21392
21393 It is also possible to lock out Exim filters or Sieve filters while allowing
21394 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21395
21396
21397 The filter is run using the uid and gid set by the generic &%user%& and
21398 &%group%& options. These take their defaults from the password data if
21399 &%check_local_user%& is set, so in the normal case of users' personal filter
21400 files, the filter is run as the relevant user. When &%allow_filter%& is set
21401 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21402
21403
21404
21405 .option allow_freeze redirect boolean false
21406 .cindex "freezing messages" "allowing in filter"
21407 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21408 This command is more normally encountered in system filters, and is disabled by
21409 default for redirection filters because it isn't something you usually want to
21410 let ordinary users do.
21411
21412
21413
21414 .option check_ancestor redirect boolean false
21415 This option is concerned with handling generated addresses that are the same
21416 as some address in the list of redirection ancestors of the current address.
21417 Although it is turned off by default in the code, it is set in the default
21418 configuration file for handling users' &_.forward_& files. It is recommended
21419 for this use of the &(redirect)& router.
21420
21421 When &%check_ancestor%& is set, if a generated address (including the domain)
21422 is the same as any ancestor of the current address, it is replaced by a copy of
21423 the current address. This helps in the case where local part A is aliased to B,
21424 and B has a &_.forward_& file pointing back to A. For example, within a single
21425 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21426 &_&~jb/.forward_& contains:
21427 .code
21428 \Joe.Bloggs, <other item(s)>
21429 .endd
21430 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21431 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21432 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21433 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21434 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21435 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21436 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21437 original address. See also the &%repeat_use%& option below.
21438
21439
21440 .option check_group redirect boolean "see below"
21441 When the &%file%& option is used, the group owner of the file is checked only
21442 when this option is set. The permitted groups are those listed in the
21443 &%owngroups%& option, together with the user's default group if
21444 &%check_local_user%& is set. If the file has the wrong group, routing is
21445 deferred. The default setting for this option is true if &%check_local_user%&
21446 is set and the &%modemask%& option permits the group write bit, or if the
21447 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21448
21449
21450
21451 .option check_owner redirect boolean "see below"
21452 When the &%file%& option is used, the owner of the file is checked only when
21453 this option is set. If &%check_local_user%& is set, the local user is
21454 permitted; otherwise the owner must be one of those listed in the &%owners%&
21455 option. The default value for this option is true if &%check_local_user%& or
21456 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21457
21458
21459 .option data redirect string&!! unset
21460 This option is mutually exclusive with &%file%&. One or other of them must be
21461 set, but not both. The contents of &%data%& are expanded, and then used as the
21462 list of forwarding items, or as a set of filtering instructions. If the
21463 expansion is forced to fail, or the result is an empty string or a string that
21464 has no effect (consists entirely of comments), the router declines.
21465
21466 When filtering instructions are used, the string must begin with &"#Exim
21467 filter"&, and all comments in the string, including this initial one, must be
21468 terminated with newline characters. For example:
21469 .code
21470 data = #Exim filter\n\
21471        if $h_to: contains Exim then save $home/mail/exim endif
21472 .endd
21473 If you are reading the data from a database where newlines cannot be included,
21474 you can use the &${sg}$& expansion item to turn the escape string of your
21475 choice into a newline.
21476
21477
21478 .option directory_transport redirect string&!! unset
21479 A &(redirect)& router sets up a direct delivery to a directory when a path name
21480 ending with a slash is specified as a new &"address"&. The transport used is
21481 specified by this option, which, after expansion, must be the name of a
21482 configured transport. This should normally be an &(appendfile)& transport.
21483
21484
21485 .option file redirect string&!! unset
21486 This option specifies the name of a file that contains the redirection data. It
21487 is mutually exclusive with the &%data%& option. The string is expanded before
21488 use; if the expansion is forced to fail, the router declines. Other expansion
21489 failures cause delivery to be deferred. The result of a successful expansion
21490 must be an absolute path. The entire file is read and used as the redirection
21491 data. If the data is an empty string or a string that has no effect (consists
21492 entirely of comments), the router declines.
21493
21494 .cindex "NFS" "checking for file existence"
21495 If the attempt to open the file fails with a &"does not exist"& error, Exim
21496 runs a check on the containing directory,
21497 unless &%ignore_enotdir%& is true (see below).
21498 If the directory does not appear to exist, delivery is deferred. This can
21499 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21500 is a mount problem. If the containing directory does exist, but the file does
21501 not, the router declines.
21502
21503
21504 .option file_transport redirect string&!! unset
21505 .vindex "&$address_file$&"
21506 A &(redirect)& router sets up a direct delivery to a file when a path name not
21507 ending in a slash is specified as a new &"address"&. The transport used is
21508 specified by this option, which, after expansion, must be the name of a
21509 configured transport. This should normally be an &(appendfile)& transport. When
21510 it is running, the filename is in &$address_file$&.
21511
21512
21513 .option filter_prepend_home redirect boolean true
21514 When this option is true, if a &(save)& command in an Exim filter specifies a
21515 relative path, and &$home$& is defined, it is automatically prepended to the
21516 relative path. If this option is set false, this action does not happen. The
21517 relative path is then passed to the transport unmodified.
21518
21519
21520 .option forbid_blackhole redirect boolean false
21521 .cindex "restricting access to features"
21522 .cindex "filter" "locking out certain features"
21523 If this option is true, the &':blackhole:'& item may not appear in a
21524 redirection list.
21525
21526
21527 .option forbid_exim_filter redirect boolean false
21528 .cindex "restricting access to features"
21529 .cindex "filter" "locking out certain features"
21530 If this option is set true, only Sieve filters are permitted when
21531 &%allow_filter%& is true.
21532
21533
21534
21535
21536 .option forbid_file redirect boolean false
21537 .cindex "restricting access to features"
21538 .cindex "delivery" "to file; forbidding"
21539 .cindex "filter" "locking out certain features"
21540 .cindex "Sieve filter" "forbidding delivery to a file"
21541 .cindex "Sieve filter" "&""keep""& facility; disabling"
21542 If this option is true, this router may not generate a new address that
21543 specifies delivery to a local file or directory, either from a filter or from a
21544 conventional forward file. This option is forced to be true if &%one_time%& is
21545 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21546 locks out the Sieve's &"keep"& facility.
21547
21548
21549 .option forbid_filter_dlfunc redirect boolean false
21550 .cindex "restricting access to features"
21551 .cindex "filter" "locking out certain features"
21552 If this option is true, string expansions in Exim filters are not allowed to
21553 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21554 functions.
21555
21556 .option forbid_filter_existstest redirect boolean false
21557 .cindex "restricting access to features"
21558 .cindex "filter" "locking out certain features"
21559 .cindex "expansion" "statting a file"
21560 If this option is true, string expansions in Exim filters are not allowed to
21561 make use of the &%exists%& condition or the &%stat%& expansion item.
21562
21563 .option forbid_filter_logwrite redirect boolean false
21564 .cindex "restricting access to features"
21565 .cindex "filter" "locking out certain features"
21566 If this option is true, use of the logging facility in Exim filters is not
21567 permitted. Logging is in any case available only if the filter is being run
21568 under some unprivileged uid (which is normally the case for ordinary users'
21569 &_.forward_& files).
21570
21571
21572 .option forbid_filter_lookup redirect boolean false
21573 .cindex "restricting access to features"
21574 .cindex "filter" "locking out certain features"
21575 If this option is true, string expansions in Exim filter files are not allowed
21576 to make use of &%lookup%& items.
21577
21578
21579 .option forbid_filter_perl redirect boolean false
21580 .cindex "restricting access to features"
21581 .cindex "filter" "locking out certain features"
21582 This option has an effect only if Exim is built with embedded Perl support. If
21583 it is true, string expansions in Exim filter files are not allowed to make use
21584 of the embedded Perl support.
21585
21586
21587 .option forbid_filter_readfile redirect boolean false
21588 .cindex "restricting access to features"
21589 .cindex "filter" "locking out certain features"
21590 If this option is true, string expansions in Exim filter files are not allowed
21591 to make use of &%readfile%& items.
21592
21593
21594 .option forbid_filter_readsocket redirect boolean false
21595 .cindex "restricting access to features"
21596 .cindex "filter" "locking out certain features"
21597 If this option is true, string expansions in Exim filter files are not allowed
21598 to make use of &%readsocket%& items.
21599
21600
21601 .option forbid_filter_reply redirect boolean false
21602 .cindex "restricting access to features"
21603 .cindex "filter" "locking out certain features"
21604 If this option is true, this router may not generate an automatic reply
21605 message. Automatic replies can be generated only from Exim or Sieve filter
21606 files, not from traditional forward files. This option is forced to be true if
21607 &%one_time%& is set.
21608
21609
21610 .option forbid_filter_run redirect boolean false
21611 .cindex "restricting access to features"
21612 .cindex "filter" "locking out certain features"
21613 If this option is true, string expansions in Exim filter files are not allowed
21614 to make use of &%run%& items.
21615
21616
21617 .option forbid_include redirect boolean false
21618 .cindex "restricting access to features"
21619 .cindex "filter" "locking out certain features"
21620 If this option is true, items of the form
21621 .code
21622 :include:<path name>
21623 .endd
21624 are not permitted in non-filter redirection lists.
21625
21626
21627 .option forbid_pipe redirect boolean false
21628 .cindex "restricting access to features"
21629 .cindex "filter" "locking out certain features"
21630 .cindex "delivery" "to pipe; forbidding"
21631 If this option is true, this router may not generate a new address which
21632 specifies delivery to a pipe, either from an Exim filter or from a conventional
21633 forward file. This option is forced to be true if &%one_time%& is set.
21634
21635
21636 .option forbid_sieve_filter redirect boolean false
21637 .cindex "restricting access to features"
21638 .cindex "filter" "locking out certain features"
21639 If this option is set true, only Exim filters are permitted when
21640 &%allow_filter%& is true.
21641
21642
21643 .cindex "SMTP" "error codes"
21644 .option forbid_smtp_code redirect boolean false
21645 If this option is set true, any SMTP error codes that are present at the start
21646 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21647 the default codes (451 and 550, respectively) are always used.
21648
21649
21650
21651
21652 .option hide_child_in_errmsg redirect boolean false
21653 .cindex "bounce message" "redirection details; suppressing"
21654 If this option is true, it prevents Exim from quoting a child address if it
21655 generates a bounce or delay message for it. Instead it says &"an address
21656 generated from <&'the top level address'&>"&. Of course, this applies only to
21657 bounces generated locally. If a message is forwarded to another host, &'its'&
21658 bounce may well quote the generated address.
21659
21660
21661 .option ignore_eacces redirect boolean false
21662 .cindex "EACCES"
21663 If this option is set and an attempt to open a redirection file yields the
21664 EACCES error (permission denied), the &(redirect)& router behaves as if the
21665 file did not exist.
21666
21667
21668 .option ignore_enotdir redirect boolean false
21669 .cindex "ENOTDIR"
21670 If this option is set and an attempt to open a redirection file yields the
21671 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21672 router behaves as if the file did not exist.
21673
21674 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21675 router that has the &%file%& option set discovers that the file does not exist
21676 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21677 against unmounted NFS directories. If the parent can not be statted, delivery
21678 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21679 is set, because that option tells Exim to ignore &"something on the path is not
21680 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21681 that some operating systems give ENOENT where others give ENOTDIR.
21682
21683
21684
21685 .option include_directory redirect string unset
21686 If this option is set, the path names of any &':include:'& items in a
21687 redirection list must start with this directory.
21688
21689
21690 .option modemask redirect "octal integer" 022
21691 This specifies mode bits which must not be set for a file specified by the
21692 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21693
21694
21695 .option one_time redirect boolean false
21696 .cindex "one-time aliasing/forwarding expansion"
21697 .cindex "alias file" "one-time expansion"
21698 .cindex "forward file" "one-time expansion"
21699 .cindex "mailing lists" "one-time expansion"
21700 .cindex "address redirection" "one-time expansion"
21701 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21702 files each time it tries to deliver a message causes a problem when one or more
21703 of the generated addresses fails be delivered at the first attempt. The problem
21704 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21705 but of what happens when the redirection list changes during the time that the
21706 message is on Exim's queue. This is particularly true in the case of mailing
21707 lists, where new subscribers might receive copies of messages that were posted
21708 before they subscribed.
21709
21710 If &%one_time%& is set and any addresses generated by the router fail to
21711 deliver at the first attempt, the failing addresses are added to the message as
21712 &"top level"& addresses, and the parent address that generated them is marked
21713 &"delivered"&. Thus, redirection does not happen again at the next delivery
21714 attempt.
21715
21716 &*Warning 1*&: Any header line addition or removal that is specified by this
21717 router would be lost if delivery did not succeed at the first attempt. For this
21718 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21719 permitted when &%one_time%& is set.
21720
21721 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21722 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21723 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21724
21725 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21726 &%one_time%&.
21727
21728 The original top-level address is remembered with each of the generated
21729 addresses, and is output in any log messages. However, any intermediate parent
21730 addresses are not recorded. This makes a difference to the log only if
21731 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21732 typically be used for mailing lists, where there is normally just one level of
21733 expansion.
21734
21735
21736 .option owners redirect "string list" unset
21737 .cindex "ownership" "alias file"
21738 .cindex "ownership" "forward file"
21739 .cindex "alias file" "ownership"
21740 .cindex "forward file" "ownership"
21741 This specifies a list of permitted owners for the file specified by &%file%&.
21742 This list is in addition to the local user when &%check_local_user%& is set.
21743 See &%check_owner%& above.
21744
21745
21746 .option owngroups redirect "string list" unset
21747 This specifies a list of permitted groups for the file specified by &%file%&.
21748 The list is in addition to the local user's primary group when
21749 &%check_local_user%& is set. See &%check_group%& above.
21750
21751
21752 .option pipe_transport redirect string&!! unset
21753 .vindex "&$address_pipe$&"
21754 A &(redirect)& router sets up a direct delivery to a pipe when a string
21755 starting with a vertical bar character is specified as a new &"address"&. The
21756 transport used is specified by this option, which, after expansion, must be the
21757 name of a configured transport. This should normally be a &(pipe)& transport.
21758 When the transport is run, the pipe command is in &$address_pipe$&.
21759
21760
21761 .option qualify_domain redirect string&!! unset
21762 .vindex "&$qualify_recipient$&"
21763 If this option is set, and an unqualified address (one without a domain) is
21764 generated, and that address would normally be qualified by the global setting
21765 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21766 expanding this string. If the expansion fails, the router declines. If you want
21767 to revert to the default, you can have the expansion generate
21768 &$qualify_recipient$&.
21769
21770 This option applies to all unqualified addresses generated by Exim filters,
21771 but for traditional &_.forward_& files, it applies only to addresses that are
21772 not preceded by a backslash. Sieve filters cannot generate unqualified
21773 addresses.
21774
21775 .option qualify_preserve_domain redirect boolean false
21776 .cindex "domain" "in redirection; preserving"
21777 .cindex "preserving domain in redirection"
21778 .cindex "address redirection" "domain; preserving"
21779 If this option is set, the router's local &%qualify_domain%& option must not be
21780 set (a configuration error occurs if it is). If an unqualified address (one
21781 without a domain) is generated, it is qualified with the domain of the parent
21782 address (the immediately preceding ancestor) instead of the global
21783 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21784 this applies whether or not the address is preceded by a backslash.
21785
21786
21787 .option repeat_use redirect boolean true
21788 If this option is set false, the router is skipped for a child address that has
21789 any ancestor that was routed by this router. This test happens before any of
21790 the other preconditions are tested. Exim's default anti-looping rules skip
21791 only when the ancestor is the same as the current address. See also
21792 &%check_ancestor%& above and the generic &%redirect_router%& option.
21793
21794
21795 .option reply_transport redirect string&!! unset
21796 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21797 &%vacation%& command is used in a filter file. The transport used is specified
21798 by this option, which, after expansion, must be the name of a configured
21799 transport. This should normally be an &(autoreply)& transport. Other transports
21800 are unlikely to do anything sensible or useful.
21801
21802
21803 .option rewrite redirect boolean true
21804 .cindex "address redirection" "disabling rewriting"
21805 If this option is set false, addresses generated by the router are not
21806 subject to address rewriting. Otherwise, they are treated like new addresses
21807 and are rewritten according to the global rewriting rules.
21808
21809
21810 .option sieve_subaddress redirect string&!! unset
21811 The value of this option is passed to a Sieve filter to specify the
21812 :subaddress part of an address.
21813
21814 .option sieve_useraddress redirect string&!! unset
21815 The value of this option is passed to a Sieve filter to specify the :user part
21816 of an address. However, if it is unset, the entire original local part
21817 (including any prefix or suffix) is used for :user.
21818
21819
21820 .option sieve_vacation_directory redirect string&!! unset
21821 .cindex "Sieve filter" "vacation directory"
21822 To enable the &"vacation"& extension for Sieve filters, you must set
21823 &%sieve_vacation_directory%& to the directory where vacation databases are held
21824 (do not put anything else in that directory), and ensure that the
21825 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21826 needs their own directory; Exim will create it if necessary.
21827
21828
21829
21830 .option skip_syntax_errors redirect boolean false
21831 .cindex "forward file" "broken"
21832 .cindex "address redirection" "broken files"
21833 .cindex "alias file" "broken"
21834 .cindex "broken alias or forward files"
21835 .cindex "ignoring faulty addresses"
21836 .cindex "skipping faulty addresses"
21837 .cindex "error" "skipping bad syntax"
21838 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21839 non-filter redirection data are skipped, and each failing address is logged. If
21840 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21841 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21842 are expanded and placed at the head of the error message generated by
21843 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21844 be the same address as the generic &%errors_to%& option. The
21845 &%skip_syntax_errors%& option is often used when handling mailing lists.
21846
21847 If all the addresses in a redirection list are skipped because of syntax
21848 errors, the router declines to handle the original address, and it is passed to
21849 the following routers.
21850
21851 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21852 error in the filter causes filtering to be abandoned without any action being
21853 taken. The incident is logged, and the router declines to handle the address,
21854 so it is passed to the following routers.
21855
21856 .cindex "Sieve filter" "syntax errors in"
21857 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21858 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21859 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21860
21861 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21862 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21863 option, used with an address that does not get redirected, can be used to
21864 notify users of these errors, by means of a router like this:
21865 .code
21866 userforward:
21867   driver = redirect
21868   allow_filter
21869   check_local_user
21870   file = $home/.forward
21871   file_transport = address_file
21872   pipe_transport = address_pipe
21873   reply_transport = address_reply
21874   no_verify
21875   skip_syntax_errors
21876   syntax_errors_to = real-$local_part@$domain
21877   syntax_errors_text = \
21878    This is an automatically generated message. An error has\n\
21879    been found in your .forward file. Details of the error are\n\
21880    reported below. While this error persists, you will receive\n\
21881    a copy of this message for every message that is addressed\n\
21882    to you. If your .forward file is a filter file, or if it is\n\
21883    a non-filter file containing no valid forwarding addresses,\n\
21884    a copy of each incoming message will be put in your normal\n\
21885    mailbox. If a non-filter file contains at least one valid\n\
21886    forwarding address, forwarding to the valid addresses will\n\
21887    happen, and those will be the only deliveries that occur.
21888 .endd
21889 You also need a router to ensure that local addresses that are prefixed by
21890 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21891 put this immediately before the &(userforward)& router:
21892 .code
21893 real_localuser:
21894   driver = accept
21895   check_local_user
21896   local_part_prefix = real-
21897   transport = local_delivery
21898 .endd
21899 For security, it would probably be a good idea to restrict the use of this
21900 router to locally-generated messages, using a condition such as this:
21901 .code
21902   condition = ${if match {$sender_host_address}\
21903                          {\N^(|127\.0\.0\.1)$\N}}
21904 .endd
21905
21906
21907 .option syntax_errors_text redirect string&!! unset
21908 See &%skip_syntax_errors%& above.
21909
21910
21911 .option syntax_errors_to redirect string unset
21912 See &%skip_syntax_errors%& above.
21913 .ecindex IIDredrou1
21914 .ecindex IIDredrou2
21915
21916
21917
21918
21919
21920
21921 . ////////////////////////////////////////////////////////////////////////////
21922 . ////////////////////////////////////////////////////////////////////////////
21923
21924 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21925          "Environment for local transports"
21926 .scindex IIDenvlotra1 "local transports" "environment for"
21927 .scindex IIDenvlotra2 "environment" "local transports"
21928 .scindex IIDenvlotra3 "transport" "local; environment for"
21929 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21930 transport can be thought of as similar to a pipe.) Exim always runs transports
21931 in subprocesses, under specified uids and gids. Typical deliveries to local
21932 mailboxes run under the uid and gid of the local user.
21933
21934 Exim also sets a specific current directory while running the transport; for
21935 some transports a home directory setting is also relevant. The &(pipe)&
21936 transport is the only one that sets up environment variables; see section
21937 &<<SECTpipeenv>>& for details.
21938
21939 The values used for the uid, gid, and the directories may come from several
21940 different places. In many cases, the router that handles the address associates
21941 settings with that address as a result of its &%check_local_user%&, &%group%&,
21942 or &%user%& options. However, values may also be given in the transport's own
21943 configuration, and these override anything that comes from the router.
21944
21945
21946
21947 .section "Concurrent deliveries" "SECID131"
21948 .cindex "concurrent deliveries"
21949 .cindex "simultaneous deliveries"
21950 If two different messages for the same local recipient arrive more or less
21951 simultaneously, the two delivery processes are likely to run concurrently. When
21952 the &(appendfile)& transport is used to write to a file, Exim applies locking
21953 rules to stop concurrent processes from writing to the same file at the same
21954 time.
21955
21956 However, when you use a &(pipe)& transport, it is up to you to arrange any
21957 locking that is needed. Here is a silly example:
21958 .code
21959 my_transport:
21960   driver = pipe
21961   command = /bin/sh -c 'cat >>/some/file'
21962 .endd
21963 This is supposed to write the message at the end of the file. However, if two
21964 messages arrive at the same time, the file will be scrambled. You can use the
21965 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21966 file using the same algorithm that Exim itself uses.
21967
21968
21969
21970
21971 .section "Uids and gids" "SECTenvuidgid"
21972 .cindex "local transports" "uid and gid"
21973 .cindex "transport" "local; uid and gid"
21974 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21975 overrides any group that the router set in the address, even if &%user%& is not
21976 set for the transport. This makes it possible, for example, to run local mail
21977 delivery under the uid of the recipient (set by the router), but in a special
21978 group (set by the transport). For example:
21979 .code
21980 # Routers ...
21981 # User/group are set by check_local_user in this router
21982 local_users:
21983   driver = accept
21984   check_local_user
21985   transport = group_delivery
21986
21987 # Transports ...
21988 # This transport overrides the group
21989 group_delivery:
21990   driver = appendfile
21991   file = /var/spool/mail/$local_part_data
21992   group = mail
21993 .endd
21994 If &%user%& is set for a transport, its value overrides what is set in the
21995 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21996 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21997 set.
21998
21999 .oindex "&%initgroups%&"
22000 When the uid is taken from the transport's configuration, the &[initgroups()]&
22001 function is called for the groups associated with that uid if the
22002 &%initgroups%& option is set for the transport. When the uid is not specified
22003 by the transport, but is associated with the address by a router, the option
22004 for calling &[initgroups()]& is taken from the router configuration.
22005
22006 .cindex "&(pipe)& transport" "uid for"
22007 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22008 is set and &%user%& is not set, the uid of the process that called Exim to
22009 receive the message is used, and if &%group%& is not set, the corresponding
22010 original gid is also used.
22011
22012 This is the detailed preference order for obtaining a gid; the first of the
22013 following that is set is used:
22014
22015 .ilist
22016 A &%group%& setting of the transport;
22017 .next
22018 A &%group%& setting of the router;
22019 .next
22020 A gid associated with a user setting of the router, either as a result of
22021 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22022 .next
22023 The group associated with a non-numeric &%user%& setting of the transport;
22024 .next
22025 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22026 the uid is the creator's uid;
22027 .next
22028 The Exim gid if the Exim uid is being used as a default.
22029 .endlist
22030
22031 If, for example, the user is specified numerically on the router and there are
22032 no group settings, no gid is available. In this situation, an error occurs.
22033 This is different for the uid, for which there always is an ultimate default.
22034 The first of the following that is set is used:
22035
22036 .ilist
22037 A &%user%& setting of the transport;
22038 .next
22039 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22040 .next
22041 A &%user%& setting of the router;
22042 .next
22043 A &%check_local_user%& setting of the router;
22044 .next
22045 The Exim uid.
22046 .endlist
22047
22048 Of course, an error will still occur if the uid that is chosen is on the
22049 &%never_users%& list.
22050
22051
22052
22053
22054
22055 .section "Current and home directories" "SECID132"
22056 .cindex "current directory for local transport"
22057 .cindex "home directory" "for local transport"
22058 .cindex "transport" "local; home directory for"
22059 .cindex "transport" "local; current directory for"
22060 Routers may set current and home directories for local transports by means of
22061 the &%transport_current_directory%& and &%transport_home_directory%& options.
22062 However, if the transport's &%current_directory%& or &%home_directory%& options
22063 are set, they override the router's values. In detail, the home directory
22064 for a local transport is taken from the first of these values that is set:
22065
22066 .ilist
22067 The &%home_directory%& option on the transport;
22068 .next
22069 The &%transport_home_directory%& option on the router;
22070 .next
22071 The password data if &%check_local_user%& is set on the router;
22072 .next
22073 The &%router_home_directory%& option on the router.
22074 .endlist
22075
22076 The current directory is taken from the first of these values that is set:
22077
22078 .ilist
22079 The &%current_directory%& option on the transport;
22080 .next
22081 The &%transport_current_directory%& option on the router.
22082 .endlist
22083
22084
22085 If neither the router nor the transport sets a current directory, Exim uses the
22086 value of the home directory, if it is set. Otherwise it sets the current
22087 directory to &_/_& before running a local transport.
22088
22089
22090
22091 .section "Expansion variables derived from the address" "SECID133"
22092 .vindex "&$domain$&"
22093 .vindex "&$local_part$&"
22094 .vindex "&$original_domain$&"
22095 Normally a local delivery is handling a single address, and in that case the
22096 variables such as &$domain$& and &$local_part$& are set during local
22097 deliveries. However, in some circumstances more than one address may be handled
22098 at once (for example, while writing batch SMTP for onward transmission by some
22099 other means). In this case, the variables associated with the local part are
22100 never set, &$domain$& is set only if all the addresses have the same domain,
22101 and &$original_domain$& is never set.
22102 .ecindex IIDenvlotra1
22103 .ecindex IIDenvlotra2
22104 .ecindex IIDenvlotra3
22105
22106
22107
22108
22109
22110
22111
22112 . ////////////////////////////////////////////////////////////////////////////
22113 . ////////////////////////////////////////////////////////////////////////////
22114
22115 .chapter "Generic options for transports" "CHAPtransportgeneric"
22116 .scindex IIDgenoptra1 "generic options" "transport"
22117 .scindex IIDgenoptra2 "options" "generic; for transports"
22118 .scindex IIDgenoptra3 "transport" "generic options for"
22119 The following generic options apply to all transports:
22120
22121
22122 .option body_only transports boolean false
22123 .cindex "transport" "body only"
22124 .cindex "message" "transporting body only"
22125 .cindex "body of message" "transporting"
22126 If this option is set, the message's headers are not transported. It is
22127 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22128 or &(pipe)& transports, the settings of &%message_prefix%& and
22129 &%message_suffix%& should be checked, because this option does not
22130 automatically suppress them.
22131
22132
22133 .option current_directory transports string&!! unset
22134 .cindex "transport" "current directory for"
22135 This specifies the current directory that is to be set while running the
22136 transport, overriding any value that may have been set by the router.
22137 If the expansion fails for any reason, including forced failure, an error is
22138 logged, and delivery is deferred.
22139
22140
22141 .option disable_logging transports boolean false
22142 If this option is set true, nothing is logged for any
22143 deliveries by the transport or for any
22144 transport errors. You should not set this option unless you really, really know
22145 what you are doing.
22146
22147
22148 .option debug_print transports string&!! unset
22149 .cindex "testing" "variables in drivers"
22150 If this option is set and debugging is enabled (see the &%-d%& command line
22151 option), the string is expanded and included in the debugging output when the
22152 transport is run.
22153 If expansion of the string fails, the error message is written to the debugging
22154 output, and Exim carries on processing.
22155 This facility is provided to help with checking out the values of variables and
22156 so on when debugging driver configurations. For example, if a &%headers_add%&
22157 option is not working properly, &%debug_print%& could be used to output the
22158 variables it references. A newline is added to the text if it does not end with
22159 one.
22160 The variables &$transport_name$& and &$router_name$& contain the name of the
22161 transport and the router that called it.
22162
22163 .option delivery_date_add transports boolean false
22164 .cindex "&'Delivery-date:'& header line"
22165 If this option is true, a &'Delivery-date:'& header is added to the message.
22166 This gives the actual time the delivery was made. As this is not a standard
22167 header, Exim has a configuration option (&%delivery_date_remove%&) which
22168 requests its removal from incoming messages, so that delivered messages can
22169 safely be resent to other recipients.
22170
22171
22172 .option driver transports string unset
22173 This specifies which of the available transport drivers is to be used.
22174 There is no default, and this option must be set for every transport.
22175
22176
22177 .option envelope_to_add transports boolean false
22178 .cindex "&'Envelope-to:'& header line"
22179 If this option is true, an &'Envelope-to:'& header is added to the message.
22180 This gives the original address(es) in the incoming envelope that caused this
22181 delivery to happen. More than one address may be present if the transport is
22182 configured to handle several addresses at once, or if more than one original
22183 address was redirected to the same final address. As this is not a standard
22184 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22185 its removal from incoming messages, so that delivered messages can safely be
22186 resent to other recipients.
22187
22188
22189 .option event_action transports string&!! unset
22190 .cindex events
22191 This option declares a string to be expanded for Exim's events mechanism.
22192 For details see chapter &<<CHAPevents>>&.
22193
22194
22195 .option group transports string&!! "Exim group"
22196 .cindex "transport" "group; specifying"
22197 This option specifies a gid for running the transport process, overriding any
22198 value that the router supplies, and also overriding any value associated with
22199 &%user%& (see below).
22200
22201
22202 .option headers_add transports list&!! unset
22203 .cindex "header lines" "adding in transport"
22204 .cindex "transport" "header lines; adding"
22205 This option specifies a list of text headers,
22206 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22207 which are (separately) expanded and added to the header
22208 portion of a message as it is transported, as described in section
22209 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22210 routers. If the result of the expansion is an empty string, or if the expansion
22211 is forced to fail, no action is taken. Other expansion failures are treated as
22212 errors and cause the delivery to be deferred.
22213
22214 Unlike most options, &%headers_add%& can be specified multiple times
22215 for a transport; all listed headers are added.
22216
22217
22218 .option headers_only transports boolean false
22219 .cindex "transport" "header lines only"
22220 .cindex "message" "transporting headers only"
22221 .cindex "header lines" "transporting"
22222 If this option is set, the message's body is not transported. It is mutually
22223 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22224 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22225 checked, since this option does not automatically suppress them.
22226
22227
22228 .option headers_remove transports list&!! unset
22229 .cindex "header lines" "removing"
22230 .cindex "transport" "header lines; removing"
22231 This option specifies a list of text headers,
22232 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22233 to be removed from the message.
22234 However, the option has no effect when an address is just being verified.
22235 Each list item is separately expanded.
22236 If the result of the expansion is an empty string, or if the expansion
22237 is forced to fail, no action is taken. Other expansion failures are treated as
22238 errors and cause the delivery to be deferred.
22239 .new
22240 If an item ends in *, it will match any header with the given prefix.
22241 .wen
22242
22243 Matching headers are omitted from the message as it is transported, as described
22244 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22245 routers.
22246
22247 Unlike most options, &%headers_remove%& can be specified multiple times
22248 for a transport; all listed headers are removed.
22249
22250 &*Warning*&: Because of the separate expansion of the list items,
22251 items that contain a list separator must have it doubled.
22252 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22253
22254
22255
22256 .option headers_rewrite transports string unset
22257 .cindex "transport" "header lines; rewriting"
22258 .cindex "rewriting" "at transport time"
22259 This option allows addresses in header lines to be rewritten at transport time,
22260 that is, as the message is being copied to its destination. The contents of the
22261 option are a colon-separated list of rewriting rules. Each rule is in exactly
22262 the same form as one of the general rewriting rules that are applied when a
22263 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22264 example,
22265 .code
22266 headers_rewrite = a@b c@d f : \
22267                   x@y w@z
22268 .endd
22269 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22270 &'w@z'& in all address-bearing header lines. The rules are applied to the
22271 header lines just before they are written out at transport time, so they affect
22272 only those copies of the message that pass through the transport. However, only
22273 the message's original header lines, and any that were added by a system
22274 filter, are rewritten. If a router or transport adds header lines, they are not
22275 affected by this option. These rewriting rules are &'not'& applied to the
22276 envelope. You can change the return path using &%return_path%&, but you cannot
22277 change envelope recipients at this time.
22278
22279
22280 .option home_directory transports string&!! unset
22281 .cindex "transport" "home directory for"
22282 .vindex "&$home$&"
22283 This option specifies a home directory setting for a local transport,
22284 overriding any value that may be set by the router. The home directory is
22285 placed in &$home$& while expanding the transport's private options. It is also
22286 used as the current directory if no current directory is set by the
22287 &%current_directory%& option on the transport or the
22288 &%transport_current_directory%& option on the router. If the expansion fails
22289 for any reason, including forced failure, an error is logged, and delivery is
22290 deferred.
22291
22292
22293 .option initgroups transports boolean false
22294 .cindex "additional groups"
22295 .cindex "groups" "additional"
22296 .cindex "transport" "group; additional"
22297 If this option is true and the uid for the delivery process is provided by the
22298 transport, the &[initgroups()]& function is called when running the transport
22299 to ensure that any additional groups associated with the uid are set up.
22300
22301
22302 .option max_parallel transports integer&!! unset
22303 .cindex limit "transport parallelism"
22304 .cindex transport "parallel processes"
22305 .cindex transport "concurrency limit"
22306 .cindex "delivery" "parallelism for transport"
22307 If this option is set and expands to an integer greater than zero
22308 it limits the number of concurrent runs of the transport.
22309 The control does not apply to shadow transports.
22310
22311 .cindex "hints database" "transport concurrency control"
22312 Exim implements this control by means of a hints database in which a record is
22313 incremented whenever a transport process is being created. The record
22314 is decremented and possibly removed when the process terminates.
22315 Obviously there is scope for
22316 records to get left lying around if there is a system or program crash. To
22317 guard against this, Exim ignores any records that are more than six hours old.
22318
22319 If you use this option, you should also arrange to delete the
22320 relevant hints database whenever your system reboots. The names of the files
22321 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22322 may be one or two files, depending on the type of DBM in use. The same files
22323 are used for ETRN and smtp transport serialization.
22324
22325
22326 .option message_size_limit transports string&!! 0
22327 .cindex "limit" "message size per transport"
22328 .cindex "size" "of message, limit"
22329 .cindex "transport" "message size; limiting"
22330 This option controls the size of messages passed through the transport. It is
22331 expanded before use; the result of the expansion must be a sequence of decimal
22332 digits, optionally followed by K or M. If the expansion fails for any reason,
22333 including forced failure, or if the result is not of the required form,
22334 delivery is deferred. If the value is greater than zero and the size of a
22335 message exceeds this limit, the address is failed. If there is any chance that
22336 the resulting bounce message could be routed to the same transport, you should
22337 ensure that &%return_size_limit%& is less than the transport's
22338 &%message_size_limit%&, as otherwise the bounce message will fail to get
22339 delivered.
22340
22341
22342
22343 .option rcpt_include_affixes transports boolean false
22344 .cindex "prefix" "for local part, including in envelope"
22345 .cindex "suffix for local part" "including in envelope"
22346 .cindex "local part" "prefix"
22347 .cindex "local part" "suffix"
22348 When this option is false (the default), and an address that has had any
22349 affixes (prefixes or suffixes) removed from the local part is delivered by any
22350 form of SMTP or LMTP, the affixes are not included. For example, if a router
22351 that contains
22352 .code
22353 local_part_prefix = *-
22354 .endd
22355 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22356 is delivered with
22357 .code
22358 RCPT TO:<xyz@some.domain>
22359 .endd
22360 This is also the case when an ACL-time callout is being used to verify a
22361 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22362 whole local part is included in the RCPT command. This option applies to BSMTP
22363 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22364 &(lmtp)& and &(smtp)& transports.
22365
22366
22367 .option retry_use_local_part transports boolean "see below"
22368 .cindex "hints database" "retry keys"
22369 When a delivery suffers a temporary failure, a retry record is created
22370 in Exim's hints database. For remote deliveries, the key for the retry record
22371 is based on the name and/or IP address of the failing remote host. For local
22372 deliveries, the key is normally the entire address, including both the local
22373 part and the domain. This is suitable for most common cases of local delivery
22374 temporary failure &-- for example, exceeding a mailbox quota should delay only
22375 deliveries to that mailbox, not to the whole domain.
22376
22377 However, in some special cases you may want to treat a temporary local delivery
22378 as a failure associated with the domain, and not with a particular local part.
22379 (For example, if you are storing all mail for some domain in files.) You can do
22380 this by setting &%retry_use_local_part%& false.
22381
22382 For all the local transports, its default value is true. For remote transports,
22383 the default value is false for tidiness, but changing the value has no effect
22384 on a remote transport in the current implementation.
22385
22386
22387 .option return_path transports string&!! unset
22388 .cindex "envelope sender"
22389 .cindex "envelope from"
22390 .cindex "transport" "return path; changing"
22391 .cindex "return path" "changing in transport"
22392 If this option is set, the string is expanded at transport time and replaces
22393 the existing return path (envelope sender) value in the copy of the message
22394 that is being delivered. An empty return path is permitted. This feature is
22395 designed for remote deliveries, where the value of this option is used in the
22396 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22397 only effect is to change the address that is placed in the &'Return-path:'&
22398 header line, if one is added to the message (see the next option).
22399
22400 &*Note:*& A changed return path is not logged unless you add
22401 &%return_path_on_delivery%& to the log selector.
22402
22403 .vindex "&$return_path$&"
22404 The expansion can refer to the existing value via &$return_path$&. This is
22405 either the message's envelope sender, or an address set by the
22406 &%errors_to%& option on a router. If the expansion is forced to fail, no
22407 replacement occurs; if it fails for another reason, delivery is deferred. This
22408 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22409 section &<<SECTverp>>&.
22410
22411 &*Note*&: If a delivery error is detected locally, including the case when a
22412 remote server rejects a message at SMTP time, the bounce message is not sent to
22413 the value of this option. It is sent to the previously set errors address.
22414 This defaults to the incoming sender address, but can be changed by setting
22415 &%errors_to%& in a router.
22416
22417
22418
22419 .option return_path_add transports boolean false
22420 .cindex "&'Return-path:'& header line"
22421 If this option is true, a &'Return-path:'& header is added to the message.
22422 Although the return path is normally available in the prefix line of BSD
22423 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22424 have easy access to it.
22425
22426 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22427 the delivery SMTP server makes the final delivery"&. This implies that this
22428 header should not be present in incoming messages. Exim has a configuration
22429 option, &%return_path_remove%&, which requests removal of this header from
22430 incoming messages, so that delivered messages can safely be resent to other
22431 recipients.
22432
22433
22434 .option shadow_condition transports string&!! unset
22435 See &%shadow_transport%& below.
22436
22437
22438 .option shadow_transport transports string unset
22439 .cindex "shadow transport"
22440 .cindex "transport" "shadow"
22441 A local transport may set the &%shadow_transport%& option to the name of
22442 another local transport. Shadow remote transports are not supported.
22443
22444 Whenever a delivery to the main transport succeeds, and either
22445 &%shadow_condition%& is unset, or its expansion does not result in the empty
22446 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22447 passed to the shadow transport, with the same delivery address or addresses. If
22448 expansion fails, no action is taken except that non-forced expansion failures
22449 cause a log line to be written.
22450
22451 The result of the shadow transport is discarded and does not affect the
22452 subsequent processing of the message. Only a single level of shadowing is
22453 provided; the &%shadow_transport%& option is ignored on any transport when it
22454 is running as a shadow. Options concerned with output from pipes are also
22455 ignored. The log line for the successful delivery has an item added on the end,
22456 of the form
22457 .code
22458 ST=<shadow transport name>
22459 .endd
22460 If the shadow transport did not succeed, the error message is put in
22461 parentheses afterwards. Shadow transports can be used for a number of different
22462 purposes, including keeping more detailed log information than Exim normally
22463 provides, and implementing automatic acknowledgment policies based on message
22464 headers that some sites insist on.
22465
22466
22467 .option transport_filter transports string&!! unset
22468 .cindex "transport" "filter"
22469 .cindex "filter" "transport filter"
22470 This option sets up a filtering (in the Unix shell sense) process for messages
22471 at transport time. It should not be confused with mail filtering as set up by
22472 individual users or via a system filter.
22473 If unset, or expanding to an empty string, no filtering is done.
22474
22475 When the message is about to be written out, the command specified by
22476 &%transport_filter%& is started up in a separate, parallel process, and
22477 the entire message, including the header lines, is passed to it on its standard
22478 input (this in fact is done from a third process, to avoid deadlock). The
22479 command must be specified as an absolute path.
22480
22481 The lines of the message that are written to the transport filter are
22482 terminated by newline (&"\n"&). The message is passed to the filter before any
22483 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22484 lines beginning with a dot, and also before any processing implied by the
22485 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22486 &(pipe)& transports.
22487
22488 The standard error for the filter process is set to the same destination as its
22489 standard output; this is read and written to the message's ultimate
22490 destination. The process that writes the message to the filter, the
22491 filter itself, and the original process that reads the result and delivers it
22492 are all run in parallel, like a shell pipeline.
22493
22494 The filter can perform any transformations it likes, but of course should take
22495 care not to break RFC 2822 syntax. Exim does not check the result, except to
22496 test for a final newline when SMTP is in use. All messages transmitted over
22497 SMTP must end with a newline, so Exim supplies one if it is missing.
22498
22499 .cindex "content scanning" "per user"
22500 A transport filter can be used to provide content-scanning on a per-user basis
22501 at delivery time if the only required effect of the scan is to modify the
22502 message. For example, a content scan could insert a new header line containing
22503 a spam score. This could be interpreted by a filter in the user's MUA. It is
22504 not possible to discard a message at this stage.
22505
22506 .cindex "SIZE" "ESMTP extension"
22507 A problem might arise if the filter increases the size of a message that is
22508 being sent down an SMTP connection. If the receiving SMTP server has indicated
22509 support for the SIZE parameter, Exim will have sent the size of the message
22510 at the start of the SMTP session. If what is actually sent is substantially
22511 more, the server might reject the message. This can be worked round by setting
22512 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22513 additions to the message, or to disable the use of SIZE altogether.
22514
22515 .vindex "&$pipe_addresses$&"
22516 The value of the &%transport_filter%& option is the command string for starting
22517 the filter, which is run directly from Exim, not under a shell. The string is
22518 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22519 Exim breaks it up into arguments and then expands each argument separately (see
22520 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22521 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22522 of arguments, one for each address that applies to this delivery. (This isn't
22523 an ideal name for this feature here, but as it was already implemented for the
22524 &(pipe)& transport, it seemed sensible not to change it.)
22525
22526 .vindex "&$host$&"
22527 .vindex "&$host_address$&"
22528 The expansion variables &$host$& and &$host_address$& are available when the
22529 transport is a remote one. They contain the name and IP address of the host to
22530 which the message is being sent. For example:
22531 .code
22532 transport_filter = /some/directory/transport-filter.pl \
22533   $host $host_address $sender_address $pipe_addresses
22534 .endd
22535
22536 Two problems arise if you want to use more complicated expansion items to
22537 generate transport filter commands, both of which due to the fact that the
22538 command is split up &'before'& expansion.
22539 .ilist
22540 If an expansion item contains white space, you must quote it, so that it is all
22541 part of the same command item. If the entire option setting is one such
22542 expansion item, you have to take care what kind of quoting you use. For
22543 example:
22544 .code
22545 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22546 .endd
22547 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22548 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22549 stripped by Exim when it read the option's value. When the value is used, if
22550 the single quotes were missing, the line would be split into two items,
22551 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22552 Exim tried to expand the first one.
22553 .next
22554 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22555 expansion cannot generate multiple arguments, or a command name followed by
22556 arguments. Consider this example:
22557 .code
22558 transport_filter = ${lookup{$host}lsearch{/a/file}\
22559                     {$value}{/bin/cat}}
22560 .endd
22561 The result of the lookup is interpreted as the name of the command, even
22562 if it contains white space. The simplest way round this is to use a shell:
22563 .code
22564 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22565                                {$value}{/bin/cat}}
22566 .endd
22567 .endlist
22568
22569 The filter process is run under the same uid and gid as the normal delivery.
22570 For remote deliveries this is the Exim uid/gid by default. The command should
22571 normally yield a zero return code. Transport filters are not supposed to fail.
22572 A non-zero code is taken to mean that the transport filter encountered some
22573 serious problem. Delivery of the message is deferred; the message remains on
22574 the queue and is tried again later. It is not possible to cause a message to be
22575 bounced from a transport filter.
22576
22577 If a transport filter is set on an autoreply transport, the original message is
22578 passed through the filter as it is being copied into the newly generated
22579 message, which happens if the &%return_message%& option is set.
22580
22581
22582 .option transport_filter_timeout transports time 5m
22583 .cindex "transport" "filter, timeout"
22584 When Exim is reading the output of a transport filter, it applies a timeout
22585 that can be set by this option. Exceeding the timeout is normally treated as a
22586 temporary delivery failure. However, if a transport filter is used with a
22587 &(pipe)& transport, a timeout in the transport filter is treated in the same
22588 way as a timeout in the pipe command itself. By default, a timeout is a hard
22589 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22590 becomes a temporary error.
22591
22592
22593 .option user transports string&!! "Exim user"
22594 .cindex "uid (user id)" "local delivery"
22595 .cindex "transport" "user, specifying"
22596 This option specifies the user under whose uid the delivery process is to be
22597 run, overriding any uid that may have been set by the router. If the user is
22598 given as a name, the uid is looked up from the password data, and the
22599 associated group is taken as the value of the gid to be used if the &%group%&
22600 option is not set.
22601
22602 For deliveries that use local transports, a user and group are normally
22603 specified explicitly or implicitly (for example, as a result of
22604 &%check_local_user%&) by the router or transport.
22605
22606 .cindex "hints database" "access by remote transport"
22607 For remote transports, you should leave this option unset unless you really are
22608 sure you know what you are doing. When a remote transport is running, it needs
22609 to be able to access Exim's hints databases, because each host may have its own
22610 retry data.
22611 .ecindex IIDgenoptra1
22612 .ecindex IIDgenoptra2
22613 .ecindex IIDgenoptra3
22614
22615
22616
22617
22618
22619
22620 . ////////////////////////////////////////////////////////////////////////////
22621 . ////////////////////////////////////////////////////////////////////////////
22622
22623 .chapter "Address batching in local transports" "CHAPbatching" &&&
22624          "Address batching"
22625 .cindex "transport" "local; address batching in"
22626 The only remote transport (&(smtp)&) is normally configured to handle more than
22627 one address at a time, so that when several addresses are routed to the same
22628 remote host, just one copy of the message is sent. Local transports, however,
22629 normally handle one address at a time. That is, a separate instance of the
22630 transport is run for each address that is routed to the transport. A separate
22631 copy of the message is delivered each time.
22632
22633 .cindex "batched local delivery"
22634 .oindex "&%batch_max%&"
22635 .oindex "&%batch_id%&"
22636 In special cases, it may be desirable to handle several addresses at once in a
22637 local transport, for example:
22638
22639 .ilist
22640 In an &(appendfile)& transport, when storing messages in files for later
22641 delivery by some other means, a single copy of the message with multiple
22642 recipients saves space.
22643 .next
22644 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22645 a single copy saves time, and is the normal way LMTP is expected to work.
22646 .next
22647 In a &(pipe)& transport, when passing the message
22648 to a scanner program or
22649 to some other delivery mechanism such as UUCP, multiple recipients may be
22650 acceptable.
22651 .endlist
22652
22653 These three local transports all have the same options for controlling multiple
22654 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22655 repeating the information for each transport, these options are described here.
22656
22657 The &%batch_max%& option specifies the maximum number of addresses that can be
22658 delivered together in a single run of the transport. Its default value is one
22659 (no batching). When more than one address is routed to a transport that has a
22660 &%batch_max%& value greater than one, the addresses are delivered in a batch
22661 (that is, in a single run of the transport with multiple recipients), subject
22662 to certain conditions:
22663
22664 .ilist
22665 .vindex "&$local_part$&"
22666 If any of the transport's options contain a reference to &$local_part$&, no
22667 batching is possible.
22668 .next
22669 .vindex "&$domain$&"
22670 If any of the transport's options contain a reference to &$domain$&, only
22671 addresses with the same domain are batched.
22672 .next
22673 .cindex "customizing" "batching condition"
22674 If &%batch_id%& is set, it is expanded for each address, and only those
22675 addresses with the same expanded value are batched. This allows you to specify
22676 customized batching conditions. Failure of the expansion for any reason,
22677 including forced failure, disables batching, but it does not stop the delivery
22678 from taking place.
22679 .next
22680 Batched addresses must also have the same errors address (where to send
22681 delivery errors), the same header additions and removals, the same user and
22682 group for the transport, and if a host list is present, the first host must
22683 be the same.
22684 .endlist
22685
22686 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22687 both when the file or pipe command is specified in the transport, and when it
22688 is specified by a &(redirect)& router, but all the batched addresses must of
22689 course be routed to the same file or pipe command. These two transports have an
22690 option called &%use_bsmtp%&, which causes them to deliver the message in
22691 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22692 &%check_string%& and &%escape_string%& options are forced to the values
22693 .code
22694 check_string = "."
22695 escape_string = ".."
22696 .endd
22697 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22698 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22699 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22700
22701 .cindex "&'Envelope-to:'& header line"
22702 If the generic &%envelope_to_add%& option is set for a batching transport, the
22703 &'Envelope-to:'& header that is added to the message contains all the addresses
22704 that are being processed together. If you are using a batching &(appendfile)&
22705 transport without &%use_bsmtp%&, the only way to preserve the recipient
22706 addresses is to set the &%envelope_to_add%& option.
22707
22708 .cindex "&(pipe)& transport" "with multiple addresses"
22709 .vindex "&$pipe_addresses$&"
22710 If you are using a &(pipe)& transport without BSMTP, and setting the
22711 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22712 the command. This is not a true variable; it is a bit of magic that causes each
22713 of the recipient addresses to be inserted into the command as a separate
22714 argument. This provides a way of accessing all the addresses that are being
22715 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22716 are specified by a &(redirect)& router.
22717
22718
22719
22720
22721 . ////////////////////////////////////////////////////////////////////////////
22722 . ////////////////////////////////////////////////////////////////////////////
22723
22724 .chapter "The appendfile transport" "CHAPappendfile"
22725 .scindex IIDapptra1 "&(appendfile)& transport"
22726 .scindex IIDapptra2 "transports" "&(appendfile)&"
22727 .cindex "directory creation"
22728 .cindex "creating directories"
22729 The &(appendfile)& transport delivers a message by appending it to an existing
22730 file, or by creating an entirely new file in a specified directory. Single
22731 files to which messages are appended can be in the traditional Unix mailbox
22732 format, or optionally in the MBX format supported by the Pine MUA and
22733 University of Washington IMAP daemon, &'inter alia'&. When each message is
22734 being delivered as a separate file, &"maildir"& format can optionally be used
22735 to give added protection against failures that happen part-way through the
22736 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22737 supported. For all file formats, Exim attempts to create as many levels of
22738 directory as necessary, provided that &%create_directory%& is set.
22739
22740 The code for the optional formats is not included in the Exim binary by
22741 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22742 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22743 included.
22744
22745 .cindex "quota" "system"
22746 Exim recognizes system quota errors, and generates an appropriate message. Exim
22747 also supports its own quota control within the transport, for use when the
22748 system facility is unavailable or cannot be used for some reason.
22749
22750 If there is an error while appending to a file (for example, quota exceeded or
22751 partition filled), Exim attempts to reset the file's length and last
22752 modification time back to what they were before. If there is an error while
22753 creating an entirely new file, the new file is removed.
22754
22755 Before appending to a file, a number of security checks are made, and the
22756 file is locked. A detailed description is given below, after the list of
22757 private options.
22758
22759 The &(appendfile)& transport is most commonly used for local deliveries to
22760 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22761 putting messages into files for remote delivery by some means other than Exim.
22762 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22763 option).
22764
22765
22766
22767 .section "The file and directory options" "SECTfildiropt"
22768 The &%file%& option specifies a single file, to which the message is appended;
22769 the &%directory%& option specifies a directory, in which a new file containing
22770 the message is created. Only one of these two options can be set, and for
22771 normal deliveries to mailboxes, one of them &'must'& be set.
22772
22773 .vindex "&$address_file$&"
22774 .vindex "&$local_part$&"
22775 However, &(appendfile)& is also used for delivering messages to files or
22776 directories whose names (or parts of names) are obtained from alias,
22777 forwarding, or filtering operations (for example, a &%save%& command in a
22778 user's Exim filter). When such a transport is running, &$local_part$& contains
22779 the local part that was aliased or forwarded, and &$address_file$& contains the
22780 name (or partial name) of the file or directory generated by the redirection
22781 operation. There are two cases:
22782
22783 .ilist
22784 If neither &%file%& nor &%directory%& is set, the redirection operation
22785 must specify an absolute path (one that begins with &`/`&). This is the most
22786 common case when users with local accounts use filtering to sort mail into
22787 different folders. See for example, the &(address_file)& transport in the
22788 default configuration. If the path ends with a slash, it is assumed to be the
22789 name of a directory. A delivery to a directory can also be forced by setting
22790 &%maildir_format%& or &%mailstore_format%&.
22791 .next
22792 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22793 used to determine the file or directory name for the delivery. Normally, the
22794 contents of &$address_file$& are used in some way in the string expansion.
22795 .endlist
22796 .new
22797 .cindex "tainted data" "in filenames"
22798 .cindex appendfile "tainted data"
22799 Tainted data may not be used for a file or directory name.
22800 This means that, for instance, &$local_part$& cannot be used directly
22801 as a component of a path.  It can however be used as the key for a lookup
22802 which returns a path (or component).
22803 .wen
22804
22805
22806 .cindex "Sieve filter" "configuring &(appendfile)&"
22807 .cindex "Sieve filter" "relative mailbox path handling"
22808 As an example of the second case, consider an environment where users do not
22809 have home directories. They may be permitted to use Exim filter commands of the
22810 form:
22811 .code
22812 save folder23
22813 .endd
22814 or Sieve filter commands of the form:
22815 .code
22816 require "fileinto";
22817 fileinto "folder23";
22818 .endd
22819 In this situation, the expansion of &%file%& or &%directory%& in the transport
22820 must transform the relative path into an appropriate absolute filename. In the
22821 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22822 is used as a result of a &"keep"& action in the filter. This example shows one
22823 way of handling this requirement:
22824 .code
22825 file = ${if eq{$address_file}{inbox} \
22826             {/var/mail/$local_part_data} \
22827             {${if eq{${substr_0_1:$address_file}}{/} \
22828                   {$address_file} \
22829                   {$home/mail/$address_file} \
22830             }} \
22831        }
22832 .endd
22833 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22834 location, absolute paths are used without change, and other folders are in the
22835 &_mail_& directory within the home directory.
22836
22837 &*Note 1*&: While processing an Exim filter, a relative path such as
22838 &_folder23_& is turned into an absolute path if a home directory is known to
22839 the router. In particular, this is the case if &%check_local_user%& is set. If
22840 you want to prevent this happening at routing time, you can set
22841 &%router_home_directory%& empty. This forces the router to pass the relative
22842 path to the transport.
22843
22844 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22845 the &%file%& or &%directory%& option is still used if it is set.
22846
22847
22848
22849
22850 .section "Private options for appendfile" "SECID134"
22851 .cindex "options" "&(appendfile)& transport"
22852
22853
22854
22855 .option allow_fifo appendfile boolean false
22856 .cindex "fifo (named pipe)"
22857 .cindex "named pipe (fifo)"
22858 .cindex "pipe" "named (fifo)"
22859 Setting this option permits delivery to named pipes (FIFOs) as well as to
22860 regular files. If no process is reading the named pipe at delivery time, the
22861 delivery is deferred.
22862
22863
22864 .option allow_symlink appendfile boolean false
22865 .cindex "symbolic link" "to mailbox"
22866 .cindex "mailbox" "symbolic link"
22867 By default, &(appendfile)& will not deliver if the path name for the file is
22868 that of a symbolic link. Setting this option relaxes that constraint, but there
22869 are security issues involved in the use of symbolic links. Be sure you know
22870 what you are doing if you set this. Details of exactly what this option affects
22871 are included in the discussion which follows this list of options.
22872
22873
22874 .option batch_id appendfile string&!! unset
22875 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22876 However, batching is automatically disabled for &(appendfile)& deliveries that
22877 happen as a result of forwarding or aliasing or other redirection directly to a
22878 file.
22879
22880
22881 .option batch_max appendfile integer 1
22882 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22883
22884
22885 .option check_group appendfile boolean false
22886 When this option is set, the group owner of the file defined by the &%file%&
22887 option is checked to see that it is the same as the group under which the
22888 delivery process is running. The default setting is false because the default
22889 file mode is 0600, which means that the group is irrelevant.
22890
22891
22892 .option check_owner appendfile boolean true
22893 When this option is set, the owner of the file defined by the &%file%& option
22894 is checked to ensure that it is the same as the user under which the delivery
22895 process is running.
22896
22897
22898 .option check_string appendfile string "see below"
22899 .cindex "&""From""& line"
22900 As &(appendfile)& writes the message, the start of each line is tested for
22901 matching &%check_string%&, and if it does, the initial matching characters are
22902 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22903 a literal string, not a regular expression, and the case of any letters it
22904 contains is significant.
22905
22906 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22907 are forced to &"."& and &".."& respectively, and any settings in the
22908 configuration are ignored. Otherwise, they default to &"From&~"& and
22909 &">From&~"& when the &%file%& option is set, and unset when any of the
22910 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22911
22912 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22913 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22914 &"From&~"& indicates the start of a new message. All four options need changing
22915 if another format is used. For example, to deliver to mailboxes in MMDF format:
22916 .cindex "MMDF format mailbox"
22917 .cindex "mailbox" "MMDF format"
22918 .code
22919 check_string = "\1\1\1\1\n"
22920 escape_string = "\1\1\1\1 \n"
22921 message_prefix = "\1\1\1\1\n"
22922 message_suffix = "\1\1\1\1\n"
22923 .endd
22924 .option create_directory appendfile boolean true
22925 .cindex "directory creation"
22926 When this option is true, Exim attempts to create any missing superior
22927 directories for the file that it is about to write. A created directory's mode
22928 is given by the &%directory_mode%& option.
22929
22930 The group ownership of a newly created directory is highly dependent on the
22931 operating system (and possibly the file system) that is being used. For
22932 example, in Solaris, if the parent directory has the setgid bit set, its group
22933 is propagated to the child; if not, the currently set group is used. However,
22934 in FreeBSD, the parent's group is always used.
22935
22936
22937
22938 .option create_file appendfile string anywhere
22939 This option constrains the location of files and directories that are created
22940 by this transport. It applies to files defined by the &%file%& option and
22941 directories defined by the &%directory%& option. In the case of maildir
22942 delivery, it applies to the top level directory, not the maildir directories
22943 beneath.
22944
22945 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22946 &"belowhome"&. In the second and third cases, a home directory must have been
22947 set for the transport. This option is not useful when an explicit filename is
22948 given for normal mailbox deliveries. It is intended for the case when filenames
22949 are generated from users' &_.forward_& files. These are usually handled
22950 by an &(appendfile)& transport called &%address_file%&. See also
22951 &%file_must_exist%&.
22952
22953
22954 .option directory appendfile string&!! unset
22955 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22956 or &%directory%& must be set, unless the delivery is the direct result of a
22957 redirection (see section &<<SECTfildiropt>>&).
22958
22959 When &%directory%& is set, the string is expanded, and the message is delivered
22960 into a new file or files in or below the given directory, instead of being
22961 appended to a single mailbox file. A number of different formats are provided
22962 (see &%maildir_format%& and &%mailstore_format%&), and see section
22963 &<<SECTopdir>>& for further details of this form of delivery.
22964
22965
22966 .option directory_file appendfile string&!! "see below"
22967 .cindex "base62"
22968 .vindex "&$inode$&"
22969 When &%directory%& is set, but neither &%maildir_format%& nor
22970 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22971 whose name is obtained by expanding this string. The default value is:
22972 .code
22973 q${base62:$tod_epoch}-$inode
22974 .endd
22975 This generates a unique name from the current time, in base 62 form, and the
22976 inode of the file. The variable &$inode$& is available only when expanding this
22977 option.
22978
22979
22980 .option directory_mode appendfile "octal integer" 0700
22981 If &(appendfile)& creates any directories as a result of the
22982 &%create_directory%& option, their mode is specified by this option.
22983
22984
22985 .option escape_string appendfile string "see description"
22986 See &%check_string%& above.
22987
22988
22989 .option file appendfile string&!! unset
22990 This option is mutually exclusive with the &%directory%& option, but one of
22991 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22992 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22993 specifies a single file, to which the message is appended. One or more of
22994 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22995 &%file%&.
22996
22997 .cindex "NFS" "lock file"
22998 .cindex "locking files"
22999 .cindex "lock files"
23000 If you are using more than one host to deliver over NFS into the same
23001 mailboxes, you should always use lock files.
23002
23003 The string value is expanded for each delivery, and must yield an absolute
23004 path. The most common settings of this option are variations on one of these
23005 examples:
23006 .code
23007 file = /var/spool/mail/$local_part_data
23008 file = /home/$local_part_data/inbox
23009 file = $home/inbox
23010 .endd
23011 .cindex "&""sticky""& bit"
23012 In the first example, all deliveries are done into the same directory. If Exim
23013 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23014 create a file in the directory, so the &"sticky"& bit must be turned on for
23015 deliveries to be possible, or alternatively the &%group%& option can be used to
23016 run the delivery under a group id which has write access to the directory.
23017
23018
23019
23020 .option file_format appendfile string unset
23021 .cindex "file" "mailbox; checking existing format"
23022 This option requests the transport to check the format of an existing file
23023 before adding to it. The check consists of matching a specific string at the
23024 start of the file. The value of the option consists of an even number of
23025 colon-separated strings. The first of each pair is the test string, and the
23026 second is the name of a transport. If the transport associated with a matched
23027 string is not the current transport, control is passed over to the other
23028 transport. For example, suppose the standard &(local_delivery)& transport has
23029 this added to it:
23030 .code
23031 file_format = "From       : local_delivery :\
23032                \1\1\1\1\n : local_mmdf_delivery"
23033 .endd
23034 Mailboxes that begin with &"From"& are still handled by this transport, but if
23035 a mailbox begins with four binary ones followed by a newline, control is passed
23036 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23037 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23038 is assumed to match the current transport. If the start of a mailbox doesn't
23039 match any string, or if the transport named for a given string is not defined,
23040 delivery is deferred.
23041
23042
23043 .option file_must_exist appendfile boolean false
23044 If this option is true, the file specified by the &%file%& option must exist.
23045 A temporary error occurs if it does not, causing delivery to be deferred.
23046 If this option is false, the file is created if it does not exist.
23047
23048
23049 .option lock_fcntl_timeout appendfile time 0s
23050 .cindex "timeout" "mailbox locking"
23051 .cindex "mailbox" "locking, blocking and non-blocking"
23052 .cindex "locking files"
23053 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23054 when locking an open mailbox file. If the call fails, the delivery process
23055 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23056 Non-blocking calls are used so that the file is not kept open during the wait
23057 for the lock; the reason for this is to make it as safe as possible for
23058 deliveries over NFS in the case when processes might be accessing an NFS
23059 mailbox without using a lock file. This should not be done, but
23060 misunderstandings and hence misconfigurations are not unknown.
23061
23062 On a busy system, however, the performance of a non-blocking lock approach is
23063 not as good as using a blocking lock with a timeout. In this case, the waiting
23064 is done inside the system call, and Exim's delivery process acquires the lock
23065 and can proceed as soon as the previous lock holder releases it.
23066
23067 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23068 timeout, are used. There may still be some retrying: the maximum number of
23069 retries is
23070 .code
23071 (lock_retries * lock_interval) / lock_fcntl_timeout
23072 .endd
23073 rounded up to the next whole number. In other words, the total time during
23074 which &(appendfile)& is trying to get a lock is roughly the same, unless
23075 &%lock_fcntl_timeout%& is set very large.
23076
23077 You should consider setting this option if you are getting a lot of delayed
23078 local deliveries because of errors of the form
23079 .code
23080 failed to lock mailbox /some/file (fcntl)
23081 .endd
23082
23083 .option lock_flock_timeout appendfile time 0s
23084 This timeout applies to file locking when using &[flock()]& (see
23085 &%use_flock%&); the timeout operates in a similar manner to
23086 &%lock_fcntl_timeout%&.
23087
23088
23089 .option lock_interval appendfile time 3s
23090 This specifies the time to wait between attempts to lock the file. See below
23091 for details of locking.
23092
23093
23094 .option lock_retries appendfile integer 10
23095 This specifies the maximum number of attempts to lock the file. A value of zero
23096 is treated as 1. See below for details of locking.
23097
23098
23099 .option lockfile_mode appendfile "octal integer" 0600
23100 This specifies the mode of the created lock file, when a lock file is being
23101 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23102
23103
23104 .option lockfile_timeout appendfile time 30m
23105 .cindex "timeout" "mailbox locking"
23106 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23107 exists and is older than this value, it is assumed to have been left behind by
23108 accident, and Exim attempts to remove it.
23109
23110
23111 .option mailbox_filecount appendfile string&!! unset
23112 .cindex "mailbox" "specifying size of"
23113 .cindex "size" "of mailbox"
23114 If this option is set, it is expanded, and the result is taken as the current
23115 number of files in the mailbox. It must be a decimal number, optionally
23116 followed by K or M. This provides a way of obtaining this information from an
23117 external source that maintains the data.
23118
23119
23120 .option mailbox_size appendfile string&!! unset
23121 .cindex "mailbox" "specifying size of"
23122 .cindex "size" "of mailbox"
23123 If this option is set, it is expanded, and the result is taken as the current
23124 size the mailbox. It must be a decimal number, optionally followed by K or M.
23125 This provides a way of obtaining this information from an external source that
23126 maintains the data. This is likely to be helpful for maildir deliveries where
23127 it is computationally expensive to compute the size of a mailbox.
23128
23129
23130
23131 .option maildir_format appendfile boolean false
23132 .cindex "maildir format" "specifying"
23133 If this option is set with the &%directory%& option, the delivery is into a new
23134 file, in the &"maildir"& format that is used by other mail software. When the
23135 transport is activated directly from a &(redirect)& router (for example, the
23136 &(address_file)& transport in the default configuration), setting
23137 &%maildir_format%& causes the path received from the router to be treated as a
23138 directory, whether or not it ends with &`/`&. This option is available only if
23139 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23140 &<<SECTmaildirdelivery>>& below for further details.
23141
23142
23143 .option maildir_quota_directory_regex appendfile string "See below"
23144 .cindex "maildir format" "quota; directories included in"
23145 .cindex "quota" "maildir; directories included in"
23146 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23147 a regular expression for specifying directories, relative to the quota
23148 directory (see &%quota_directory%&), that should be included in the quota
23149 calculation. The default value is:
23150 .code
23151 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23152 .endd
23153 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23154 (directories whose names begin with a dot). If you want to exclude the
23155 &_Trash_&
23156 folder from the count (as some sites do), you need to change this setting to
23157 .code
23158 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23159 .endd
23160 This uses a negative lookahead in the regular expression to exclude the
23161 directory whose name is &_.Trash_&. When a directory is excluded from quota
23162 calculations, quota processing is bypassed for any messages that are delivered
23163 directly into that directory.
23164
23165
23166 .option maildir_retries appendfile integer 10
23167 This option specifies the number of times to retry when writing a file in
23168 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23169
23170
23171 .option maildir_tag appendfile string&!! unset
23172 This option applies only to deliveries in maildir format, and is described in
23173 section &<<SECTmaildirdelivery>>& below.
23174
23175
23176 .option maildir_use_size_file appendfile&!! boolean false
23177 .cindex "maildir format" "&_maildirsize_& file"
23178 The result of string expansion for this option must be a valid boolean value.
23179 If it is true, it enables support for &_maildirsize_& files. Exim
23180 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23181 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23182 value is zero. See &%maildir_quota_directory_regex%& above and section
23183 &<<SECTmaildirdelivery>>& below for further details.
23184
23185 .option maildirfolder_create_regex appendfile string unset
23186 .cindex "maildir format" "&_maildirfolder_& file"
23187 .cindex "&_maildirfolder_&, creating"
23188 The value of this option is a regular expression. If it is unset, it has no
23189 effect. Otherwise, before a maildir delivery takes place, the pattern is
23190 matched against the name of the maildir directory, that is, the directory
23191 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23192 delivery. If there is a match, Exim checks for the existence of a file called
23193 &_maildirfolder_& in the directory, and creates it if it does not exist.
23194 See section &<<SECTmaildirdelivery>>& for more details.
23195
23196
23197 .option mailstore_format appendfile boolean false
23198 .cindex "mailstore format" "specifying"
23199 If this option is set with the &%directory%& option, the delivery is into two
23200 new files in  &"mailstore"& format. The option is available only if
23201 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23202 below for further details.
23203
23204
23205 .option mailstore_prefix appendfile string&!! unset
23206 This option applies only to deliveries in mailstore format, and is described in
23207 section &<<SECTopdir>>& below.
23208
23209
23210 .option mailstore_suffix appendfile string&!! unset
23211 This option applies only to deliveries in mailstore format, and is described in
23212 section &<<SECTopdir>>& below.
23213
23214
23215 .option mbx_format appendfile boolean false
23216 .cindex "locking files"
23217 .cindex "file" "locking"
23218 .cindex "file" "MBX format"
23219 .cindex "MBX format, specifying"
23220 This option is available only if Exim has been compiled with SUPPORT_MBX
23221 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23222 the message is appended to the mailbox file in MBX format instead of
23223 traditional Unix format. This format is supported by Pine4 and its associated
23224 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23225
23226 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23227 automatically changed by the use of &%mbx_format%&. They should normally be set
23228 empty when using MBX format, so this option almost always appears in this
23229 combination:
23230 .code
23231 mbx_format = true
23232 message_prefix =
23233 message_suffix =
23234 .endd
23235 If none of the locking options are mentioned in the configuration,
23236 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23237 is possible to specify the other kinds of locking with &%mbx_format%&, but
23238 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23239 interworks with &'c-client'&, providing for shared access to the mailbox. It
23240 should not be used if any program that does not use this form of locking is
23241 going to access the mailbox, nor should it be used if the mailbox file is NFS
23242 mounted, because it works only when the mailbox is accessed from a single host.
23243
23244 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23245 the standard version of &'c-client'&, because as long as it has a mailbox open
23246 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23247 append messages to it.
23248
23249
23250 .option message_prefix appendfile string&!! "see below"
23251 .cindex "&""From""& line"
23252 The string specified here is expanded and output at the start of every message.
23253 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23254 in which case it is:
23255 .code
23256 message_prefix = "From ${if def:return_path{$return_path}\
23257   {MAILER-DAEMON}} $tod_bsdinbox\n"
23258 .endd
23259 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23260 &`\n`& to &`\r\n`& in &%message_prefix%&.
23261
23262 .option message_suffix appendfile string&!! "see below"
23263 The string specified here is expanded and output at the end of every message.
23264 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23265 in which case it is a single newline character. The suffix can be suppressed by
23266 setting
23267 .code
23268 message_suffix =
23269 .endd
23270 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23271 &`\n`& to &`\r\n`& in &%message_suffix%&.
23272
23273 .option mode appendfile "octal integer" 0600
23274 If the output file is created, it is given this mode. If it already exists and
23275 has wider permissions, they are reduced to this mode. If it has narrower
23276 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23277 if the delivery is the result of a &%save%& command in a filter file specifying
23278 a particular mode, the mode of the output file is always forced to take that
23279 value, and this option is ignored.
23280
23281
23282 .option mode_fail_narrower appendfile boolean true
23283 This option applies in the case when an existing mailbox file has a narrower
23284 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23285 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23286 continues with the delivery attempt, using the existing mode of the file.
23287
23288
23289 .option notify_comsat appendfile boolean false
23290 If this option is true, the &'comsat'& daemon is notified after every
23291 successful delivery to a user mailbox. This is the daemon that notifies logged
23292 on users about incoming mail.
23293
23294
23295 .option quota appendfile string&!! unset
23296 .cindex "quota" "imposed by Exim"
23297 This option imposes a limit on the size of the file to which Exim is appending,
23298 or to the total space used in the directory tree when the &%directory%& option
23299 is set. In the latter case, computation of the space used is expensive, because
23300 all the files in the directory (and any sub-directories) have to be
23301 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23302 &%maildir_use_size_file%& for ways to avoid this in environments where users
23303 have no shell access to their mailboxes).
23304
23305 As there is no interlock against two simultaneous deliveries into a
23306 multi-file mailbox, it is possible for the quota to be overrun in this case.
23307 For single-file mailboxes, of course, an interlock is a necessity.
23308
23309 A file's size is taken as its &'used'& value. Because of blocking effects, this
23310 may be a lot less than the actual amount of disk space allocated to the file.
23311 If the sizes of a number of files are being added up, the rounding effect can
23312 become quite noticeable, especially on systems that have large block sizes.
23313 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23314 the obvious value which users understand most easily.
23315
23316 The value of the option is expanded, and must then be a numerical value
23317 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23318 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23319 and further option modifiers. If Exim is running on a system with
23320 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23321 be handled.
23322
23323 The option modifier &%no_check%& can be used to force delivery even if the over
23324 quota condition is met. The quota gets updated as usual.
23325
23326 &*Note*&: A value of zero is interpreted as &"no quota"&.
23327
23328 The expansion happens while Exim is running as root, before it changes uid for
23329 the delivery. This means that files that are inaccessible to the end user can
23330 be used to hold quota values that are looked up in the expansion. When delivery
23331 fails because this quota is exceeded, the handling of the error is as for
23332 system quota failures.
23333
23334 By default, Exim's quota checking mimics system quotas, and restricts the
23335 mailbox to the specified maximum size, though the value is not accurate to the
23336 last byte, owing to separator lines and additional headers that may get added
23337 during message delivery. When a mailbox is nearly full, large messages may get
23338 refused even though small ones are accepted, because the size of the current
23339 message is added to the quota when the check is made. This behaviour can be
23340 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23341 for exceeding the quota does not include the current message. Thus, deliveries
23342 continue until the quota has been exceeded; thereafter, no further messages are
23343 delivered. See also &%quota_warn_threshold%&.
23344
23345
23346 .option quota_directory appendfile string&!! unset
23347 This option defines the directory to check for quota purposes when delivering
23348 into individual files. The default is the delivery directory, or, if a file
23349 called &_maildirfolder_& exists in a maildir directory, the parent of the
23350 delivery directory.
23351
23352
23353 .option quota_filecount appendfile string&!! 0
23354 This option applies when the &%directory%& option is set. It limits the total
23355 number of files in the directory (compare the inode limit in system quotas). It
23356 can only be used if &%quota%& is also set. The value is expanded; an expansion
23357 failure causes delivery to be deferred. A value of zero is interpreted as
23358 &"no quota"&.
23359
23360 The option modifier &%no_check%& can be used to force delivery even if the over
23361 quota condition is met. The quota gets updated as usual.
23362
23363 .option quota_is_inclusive appendfile boolean true
23364 See &%quota%& above.
23365
23366
23367 .option quota_size_regex appendfile string unset
23368 This option applies when one of the delivery modes that writes a separate file
23369 for each message is being used. When Exim wants to find the size of one of
23370 these files in order to test the quota, it first checks &%quota_size_regex%&.
23371 If this is set to a regular expression that matches the filename, and it
23372 captures one string, that string is interpreted as a representation of the
23373 file's size. The value of &%quota_size_regex%& is not expanded.
23374
23375 This feature is useful only when users have no shell access to their mailboxes
23376 &-- otherwise they could defeat the quota simply by renaming the files. This
23377 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23378 the file length to the filename. For example:
23379 .code
23380 maildir_tag = ,S=$message_size
23381 quota_size_regex = ,S=(\d+)
23382 .endd
23383 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23384 number of lines in the message.
23385
23386 The regular expression should not assume that the length is at the end of the
23387 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23388 sometimes add other information onto the ends of message filenames.
23389
23390 Section &<<SECID136>>& contains further information.
23391
23392 This option should not be used when other message-handling software
23393 may duplicate messages by making hardlinks to the files.  When that is done Exim
23394 will count the message size once for each filename, in contrast with the actual
23395 disk usage.  When the option is not set, calculating total usage requires
23396 a system-call per file to get the size; the number of links is then available also
23397 as is used to adjust the effective size.
23398
23399
23400 .option quota_warn_message appendfile string&!! "see below"
23401 See below for the use of this option. If it is not set when
23402 &%quota_warn_threshold%& is set, it defaults to
23403 .code
23404 quota_warn_message = "\
23405   To: $local_part@$domain\n\
23406   Subject: Your mailbox\n\n\
23407   This message is automatically created \
23408   by mail delivery software.\n\n\
23409   The size of your mailbox has exceeded \
23410   a warning threshold that is\n\
23411   set by the system administrator.\n"
23412 .endd
23413
23414
23415 .option quota_warn_threshold appendfile string&!! 0
23416 .cindex "quota" "warning threshold"
23417 .cindex "mailbox" "size warning"
23418 .cindex "size" "of mailbox"
23419 This option is expanded in the same way as &%quota%& (see above). If the
23420 resulting value is greater than zero, and delivery of the message causes the
23421 size of the file or total space in the directory tree to cross the given
23422 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23423 may be specified as a percentage of it by following the value with a percent
23424 sign. For example:
23425 .code
23426 quota = 10M
23427 quota_warn_threshold = 75%
23428 .endd
23429 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23430 percent sign is ignored.
23431
23432 The warning message itself is specified by the &%quota_warn_message%& option,
23433 and it must start with a &'To:'& header line containing the recipient(s) of the
23434 warning message. These do not necessarily have to include the recipient(s) of
23435 the original message. A &'Subject:'& line should also normally be supplied. You
23436 can include any other header lines that you want. If you do not include a
23437 &'From:'& line, the default is:
23438 .code
23439 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23440 .endd
23441 .oindex &%errors_reply_to%&
23442 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23443 option.
23444
23445 The &%quota%& option does not have to be set in order to use this option; they
23446 are independent of one another except when the threshold is specified as a
23447 percentage.
23448
23449
23450 .option use_bsmtp appendfile boolean false
23451 .cindex "envelope from"
23452 .cindex "envelope sender"
23453 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23454 format, with the envelope sender and recipient(s) included as SMTP commands. If
23455 you want to include a leading HELO command with such messages, you can do
23456 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23457 for details of batch SMTP.
23458
23459
23460 .option use_crlf appendfile boolean false
23461 .cindex "carriage return"
23462 .cindex "linefeed"
23463 This option causes lines to be terminated with the two-character CRLF sequence
23464 (carriage return, linefeed) instead of just a linefeed character. In the case
23465 of batched SMTP, the byte sequence written to the file is then an exact image
23466 of what would be sent down a real SMTP connection.
23467
23468 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23469 (which are used to supply the traditional &"From&~"& and blank line separators
23470 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23471 carriage return characters if these are needed. In cases where these options
23472 have non-empty defaults, the values end with a single linefeed, so they must be
23473 changed to end with &`\r\n`& if &%use_crlf%& is set.
23474
23475
23476 .option use_fcntl_lock appendfile boolean "see below"
23477 This option controls the use of the &[fcntl()]& function to lock a file for
23478 exclusive use when a message is being appended. It is set by default unless
23479 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23480 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23481 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23482
23483
23484 .option use_flock_lock appendfile boolean false
23485 This option is provided to support the use of &[flock()]& for file locking, for
23486 the few situations where it is needed. Most modern operating systems support
23487 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23488 each other. Exim uses &[fcntl()]& locking by default.
23489
23490 This option is required only if you are using an operating system where
23491 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23492 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23493 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23494
23495 .cindex "Solaris" "&[flock()]& support"
23496 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23497 have it (and some, I think, provide a not quite right version built on top of
23498 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23499 the ability to use it, and any attempt to do so will cause a configuration
23500 error.
23501
23502 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23503 is just being mapped onto &[fcntl()]& by the OS).
23504
23505
23506 .option use_lockfile appendfile boolean "see below"
23507 If this option is turned off, Exim does not attempt to create a lock file when
23508 appending to a mailbox file. In this situation, the only locking is by
23509 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23510 sure that every MUA that is ever going to look at your users' mailboxes uses
23511 &[fcntl()]& rather than a lock file, and even then only when you are not
23512 delivering over NFS from more than one host.
23513
23514 .cindex "NFS" "lock file"
23515 In order to append to an NFS file safely from more than one host, it is
23516 necessary to take out a lock &'before'& opening the file, and the lock file
23517 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23518 file corruption.
23519
23520 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23521 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23522 except when &%mbx_format%& is set.
23523
23524
23525 .option use_mbx_lock appendfile boolean "see below"
23526 This option is available only if Exim has been compiled with SUPPORT_MBX
23527 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23528 locking rules be used. It is set by default if &%mbx_format%& is set and none
23529 of the locking options are mentioned in the configuration. The locking rules
23530 are the same as are used by the &'c-client'& library that underlies Pine and
23531 the IMAP4 and POP daemons that come with it (see the discussion below). The
23532 rules allow for shared access to the mailbox. However, this kind of locking
23533 does not work when the mailbox is NFS mounted.
23534
23535 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23536 &%use_flock_lock%& to control what kind of locking is used in implementing the
23537 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23538 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23539
23540
23541
23542
23543 .section "Operational details for appending" "SECTopappend"
23544 .cindex "appending to a file"
23545 .cindex "file" "appending"
23546 Before appending to a file, the following preparations are made:
23547
23548 .ilist
23549 If the name of the file is &_/dev/null_&, no action is taken, and a success
23550 return is given.
23551
23552 .next
23553 .cindex "directory creation"
23554 If any directories on the file's path are missing, Exim creates them if the
23555 &%create_directory%& option is set. A created directory's mode is given by the
23556 &%directory_mode%& option.
23557
23558 .next
23559 If &%file_format%& is set, the format of an existing file is checked. If this
23560 indicates that a different transport should be used, control is passed to that
23561 transport.
23562
23563 .next
23564 .cindex "file" "locking"
23565 .cindex "locking files"
23566 .cindex "NFS" "lock file"
23567 If &%use_lockfile%& is set, a lock file is built in a way that will work
23568 reliably over NFS, as follows:
23569
23570 .olist
23571 Create a &"hitching post"& file whose name is that of the lock file with the
23572 current time, primary host name, and process id added, by opening for writing
23573 as a new file. If this fails with an access error, delivery is deferred.
23574 .next
23575 Close the hitching post file, and hard link it to the lock filename.
23576 .next
23577 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23578 Unlink the hitching post name.
23579 .next
23580 Otherwise, use &[stat()]& to get information about the hitching post file, and
23581 then unlink hitching post name. If the number of links is exactly two, creation
23582 of the lock file succeeded but something (for example, an NFS server crash and
23583 restart) caused this fact not to be communicated to the &[link()]& call.
23584 .next
23585 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23586 up to &%lock_retries%& times. However, since any program that writes to a
23587 mailbox should complete its task very quickly, it is reasonable to time out old
23588 lock files that are normally the result of user agent and system crashes. If an
23589 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23590 it before trying again.
23591 .endlist olist
23592
23593 .next
23594 A call is made to &[lstat()]& to discover whether the main file exists, and if
23595 so, what its characteristics are. If &[lstat()]& fails for any reason other
23596 than non-existence, delivery is deferred.
23597
23598 .next
23599 .cindex "symbolic link" "to mailbox"
23600 .cindex "mailbox" "symbolic link"
23601 If the file does exist and is a symbolic link, delivery is deferred, unless the
23602 &%allow_symlink%& option is set, in which case the ownership of the link is
23603 checked, and then &[stat()]& is called to find out about the real file, which
23604 is then subjected to the checks below. The check on the top-level link
23605 ownership prevents one user creating a link for another's mailbox in a sticky
23606 directory, though allowing symbolic links in this case is definitely not a good
23607 idea. If there is a chain of symbolic links, the intermediate ones are not
23608 checked.
23609
23610 .next
23611 If the file already exists but is not a regular file, or if the file's owner
23612 and group (if the group is being checked &-- see &%check_group%& above) are
23613 different from the user and group under which the delivery is running,
23614 delivery is deferred.
23615
23616 .next
23617 If the file's permissions are more generous than specified, they are reduced.
23618 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23619 is set false, in which case the delivery is tried using the existing
23620 permissions.
23621
23622 .next
23623 The file's inode number is saved, and the file is then opened for appending.
23624 If this fails because the file has vanished, &(appendfile)& behaves as if it
23625 hadn't existed (see below). For any other failures, delivery is deferred.
23626
23627 .next
23628 If the file is opened successfully, check that the inode number hasn't
23629 changed, that it is still a regular file, and that the owner and permissions
23630 have not changed. If anything is wrong, defer delivery and freeze the message.
23631
23632 .next
23633 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23634 option is set. Otherwise, check that the file is being created in a permitted
23635 directory if the &%create_file%& option is set (deferring on failure), and then
23636 open for writing as a new file, with the O_EXCL and O_CREAT options,
23637 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23638 set). In this case, which can happen if the link points to a non-existent file,
23639 the file is opened for writing using O_CREAT but not O_EXCL, because
23640 that prevents link following.
23641
23642 .next
23643 .cindex "loop" "while file testing"
23644 If opening fails because the file exists, obey the tests given above for
23645 existing files. However, to avoid looping in a situation where the file is
23646 being continuously created and destroyed, the exists/not-exists loop is broken
23647 after 10 repetitions, and the message is then frozen.
23648
23649 .next
23650 If opening fails with any other error, defer delivery.
23651
23652 .next
23653 .cindex "file" "locking"
23654 .cindex "locking files"
23655 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23656 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23657 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23658 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23659 file, and an exclusive lock on the file whose name is
23660 .code
23661 /tmp/.<device-number>.<inode-number>
23662 .endd
23663 using the device and inode numbers of the open mailbox file, in accordance with
23664 the MBX locking rules. This file is created with a mode that is specified by
23665 the &%lockfile_mode%& option.
23666
23667 If Exim fails to lock the file, there are two possible courses of action,
23668 depending on the value of the locking timeout. This is obtained from
23669 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23670
23671 If the timeout value is zero, the file is closed, Exim waits for
23672 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23673 to lock it again. This happens up to &%lock_retries%& times, after which the
23674 delivery is deferred.
23675
23676 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23677 &[flock()]& are used (with the given timeout), so there has already been some
23678 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23679 immediately. It retries up to
23680 .code
23681 (lock_retries * lock_interval) / <timeout>
23682 .endd
23683 times (rounded up).
23684 .endlist
23685
23686 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23687 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23688
23689
23690 .section "Operational details for delivery to a new file" "SECTopdir"
23691 .cindex "delivery" "to single file"
23692 .cindex "&""From""& line"
23693 When the &%directory%& option is set instead of &%file%&, each message is
23694 delivered into a newly-created file or set of files. When &(appendfile)& is
23695 activated directly from a &(redirect)& router, neither &%file%& nor
23696 &%directory%& is normally set, because the path for delivery is supplied by the
23697 router. (See for example, the &(address_file)& transport in the default
23698 configuration.) In this case, delivery is to a new file if either the path name
23699 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23700
23701 No locking is required while writing the message to a new file, so the various
23702 locking options of the transport are ignored. The &"From"& line that by default
23703 separates messages in a single file is not normally needed, nor is the escaping
23704 of message lines that start with &"From"&, and there is no need to ensure a
23705 newline at the end of each message. Consequently, the default values for
23706 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23707 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23708
23709 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23710 the files in the delivery directory by default. However, you can specify a
23711 different directory by setting &%quota_directory%&. Also, for maildir
23712 deliveries (see below) the &_maildirfolder_& convention is honoured.
23713
23714
23715 .cindex "maildir format"
23716 .cindex "mailstore format"
23717 There are three different ways in which delivery to individual files can be
23718 done, controlled by the settings of the &%maildir_format%& and
23719 &%mailstore_format%& options. Note that code to support maildir or mailstore
23720 formats is not included in the binary unless SUPPORT_MAILDIR or
23721 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23722
23723 .cindex "directory creation"
23724 In all three cases an attempt is made to create the directory and any necessary
23725 sub-directories if they do not exist, provided that the &%create_directory%&
23726 option is set (the default). The location of a created directory can be
23727 constrained by setting &%create_file%&. A created directory's mode is given by
23728 the &%directory_mode%& option. If creation fails, or if the
23729 &%create_directory%& option is not set when creation is required, delivery is
23730 deferred.
23731
23732
23733
23734 .section "Maildir delivery" "SECTmaildirdelivery"
23735 .cindex "maildir format" "description of"
23736 If the &%maildir_format%& option is true, Exim delivers each message by writing
23737 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23738 directory that is defined by the &%directory%& option (the &"delivery
23739 directory"&). If the delivery is successful, the file is renamed into the
23740 &_new_& subdirectory.
23741
23742 In the filename, <&'stime'&> is the current time of day in seconds, and
23743 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23744 Exim checks that the time-of-day clock has moved on by at least one microsecond
23745 before terminating the delivery process. This guarantees uniqueness for the
23746 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23747 opening it. If any response other than ENOENT (does not exist) is given,
23748 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23749
23750 Before Exim carries out a maildir delivery, it ensures that subdirectories
23751 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23752 do not exist, Exim tries to create them and any superior directories in their
23753 path, subject to the &%create_directory%& and &%create_file%& options. If the
23754 &%maildirfolder_create_regex%& option is set, and the regular expression it
23755 contains matches the delivery directory, Exim also ensures that a file called
23756 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23757 &_maildirfolder_& file cannot be created, delivery is deferred.
23758
23759 These features make it possible to use Exim to create all the necessary files
23760 and directories in a maildir mailbox, including subdirectories for maildir++
23761 folders. Consider this example:
23762 .code
23763 maildir_format = true
23764 directory = /var/mail/$local_part_data\
23765            ${if eq{$local_part_suffix}{}{}\
23766            {/.${substr_1:$local_part_suffix}}}
23767 maildirfolder_create_regex = /\.[^/]+$
23768 .endd
23769 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23770 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23771 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23772 not match this name, so Exim will not look for or create the file
23773 &_/var/mail/pimbo/maildirfolder_&, though it will create
23774 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23775
23776 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23777 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23778 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23779 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23780 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23781
23782 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23783 not inadvertently match the toplevel maildir directory, because a
23784 &_maildirfolder_& file at top level would completely break quota calculations.
23785
23786 .cindex "quota" "in maildir delivery"
23787 .cindex "maildir++"
23788 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23789 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23790 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23791 Exim assumes the directory is a maildir++ folder directory, which is one level
23792 down from the user's top level mailbox directory. This causes it to start at
23793 the parent directory instead of the current directory when calculating the
23794 amount of space used.
23795
23796 One problem with delivering into a multi-file mailbox is that it is
23797 computationally expensive to compute the size of the mailbox for quota
23798 checking. Various approaches have been taken to reduce the amount of work
23799 needed. The next two sections describe two of them. A third alternative is to
23800 use some external process for maintaining the size data, and use the expansion
23801 of the &%mailbox_size%& option as a way of importing it into Exim.
23802
23803
23804
23805
23806 .section "Using tags to record message sizes" "SECID135"
23807 If &%maildir_tag%& is set, the string is expanded for each delivery.
23808 When the maildir file is renamed into the &_new_& sub-directory, the
23809 tag is added to its name. However, if adding the tag takes the length of the
23810 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23811 the tag is dropped and the maildir file is created with no tag.
23812
23813
23814 .vindex "&$message_size$&"
23815 Tags can be used to encode the size of files in their names; see
23816 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23817 happens after the message has been written. The value of the &$message_size$&
23818 variable is set to the number of bytes actually written. If the expansion is
23819 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23820 be deferred. The expanded tag may contain any printing characters except &"/"&.
23821 Non-printing characters in the string are ignored; if the resulting string is
23822 empty, it is ignored. If it starts with an alphanumeric character, a leading
23823 colon is inserted; this default has not proven to be the path that popular
23824 maildir implementations have chosen (but changing it in Exim would break
23825 backwards compatibility).
23826
23827 For one common implementation, you might set:
23828 .code
23829 maildir_tag = ,S=${message_size}
23830 .endd
23831 but you should check the documentation of the other software to be sure.
23832
23833 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23834 as this allows Exim to extract the size from your tag, instead of having to
23835 &[stat()]& each message file.
23836
23837
23838 .section "Using a maildirsize file" "SECID136"
23839 .cindex "quota" "in maildir delivery"
23840 .cindex "maildir format" "&_maildirsize_& file"
23841 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23842 storing quota and message size information in a file called &_maildirsize_&
23843 within the toplevel maildir directory. If this file does not exist, Exim
23844 creates it, setting the quota from the &%quota%& option of the transport. If
23845 the maildir directory itself does not exist, it is created before any attempt
23846 to write a &_maildirsize_& file.
23847
23848 The &_maildirsize_& file is used to hold information about the sizes of
23849 messages in the maildir, thus speeding up quota calculations. The quota value
23850 in the file is just a cache; if the quota is changed in the transport, the new
23851 value overrides the cached value when the next message is delivered. The cache
23852 is maintained for the benefit of other programs that access the maildir and
23853 need to know the quota.
23854
23855 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23856 file is maintained (with a zero quota setting), but no quota is imposed.
23857
23858 A regular expression is available for controlling which directories in the
23859 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23860 See the description of the &%maildir_quota_directory_regex%& option above for
23861 details.
23862
23863
23864 .section "Mailstore delivery" "SECID137"
23865 .cindex "mailstore format" "description of"
23866 If the &%mailstore_format%& option is true, each message is written as two
23867 files in the given directory. A unique base name is constructed from the
23868 message id and the current delivery process, and the files that are written use
23869 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23870 contains the message's envelope, and the &_.msg_& file contains the message
23871 itself. The base name is placed in the variable &$mailstore_basename$&.
23872
23873 During delivery, the envelope is first written to a file with the suffix
23874 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23875 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23876 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23877 file before accessing either of them. An alternative approach is to wait for
23878 the absence of a &_.tmp_& file.
23879
23880 The envelope file starts with any text defined by the &%mailstore_prefix%&
23881 option, expanded and terminated by a newline if there isn't one. Then follows
23882 the sender address on one line, then all the recipient addresses, one per line.
23883 There can be more than one recipient only if the &%batch_max%& option is set
23884 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23885 appended to the file, followed by a newline if it does not end with one.
23886
23887 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23888 failure, it is ignored. Other expansion errors are treated as serious
23889 configuration errors, and delivery is deferred. The variable
23890 &$mailstore_basename$& is available for use during these expansions.
23891
23892
23893 .section "Non-special new file delivery" "SECID138"
23894 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23895 file is created directly in the named directory. For example, when delivering
23896 messages into files in batched SMTP format for later delivery to some host (see
23897 section &<<SECTbatchSMTP>>&), a setting such as
23898 .code
23899 directory = /var/bsmtp/$host
23900 .endd
23901 might be used. A message is written to a file with a temporary name, which is
23902 then renamed when the delivery is complete. The final name is obtained by
23903 expanding the contents of the &%directory_file%& option.
23904 .ecindex IIDapptra1
23905 .ecindex IIDapptra2
23906
23907
23908
23909
23910
23911
23912 . ////////////////////////////////////////////////////////////////////////////
23913 . ////////////////////////////////////////////////////////////////////////////
23914
23915 .chapter "The autoreply transport" "CHID8"
23916 .scindex IIDauttra1 "transports" "&(autoreply)&"
23917 .scindex IIDauttra2 "&(autoreply)& transport"
23918 The &(autoreply)& transport is not a true transport in that it does not cause
23919 the message to be transmitted. Instead, it generates a new mail message as an
23920 automatic reply to the incoming message. &'References:'& and
23921 &'Auto-Submitted:'& header lines are included. These are constructed according
23922 to the rules in RFCs 2822 and 3834, respectively.
23923
23924 If the router that passes the message to this transport does not have the
23925 &%unseen%& option set, the original message (for the current recipient) is not
23926 delivered anywhere. However, when the &%unseen%& option is set on the router
23927 that passes the message to this transport, routing of the address continues, so
23928 another router can set up a normal message delivery.
23929
23930
23931 The &(autoreply)& transport is usually run as the result of mail filtering, a
23932 &"vacation"& message being the standard example. However, it can also be run
23933 directly from a router like any other transport. To reduce the possibility of
23934 message cascades, messages created by the &(autoreply)& transport always have
23935 empty envelope sender addresses, like bounce messages.
23936
23937 The parameters of the message to be sent can be specified in the configuration
23938 by options described below. However, these are used only when the address
23939 passed to the transport does not contain its own reply information. When the
23940 transport is run as a consequence of a
23941 &%mail%&
23942 or &%vacation%& command in a filter file, the parameters of the message are
23943 supplied by the filter, and passed with the address. The transport's options
23944 that define the message are then ignored (so they are not usually set in this
23945 case). The message is specified entirely by the filter or by the transport; it
23946 is never built from a mixture of options. However, the &%file_optional%&,
23947 &%mode%&, and &%return_message%& options apply in all cases.
23948
23949 &(Autoreply)& is implemented as a local transport. When used as a result of a
23950 command in a user's filter file, &(autoreply)& normally runs under the uid and
23951 gid of the user, and with appropriate current and home directories (see chapter
23952 &<<CHAPenvironment>>&).
23953
23954 There is a subtle difference between routing a message to a &(pipe)& transport
23955 that generates some text to be returned to the sender, and routing it to an
23956 &(autoreply)& transport. This difference is noticeable only if more than one
23957 address from the same message is so handled. In the case of a pipe, the
23958 separate outputs from the different addresses are gathered up and returned to
23959 the sender in a single message, whereas if &(autoreply)& is used, a separate
23960 message is generated for each address that is passed to it.
23961
23962 Non-printing characters are not permitted in the header lines generated for the
23963 message that &(autoreply)& creates, with the exception of newlines that are
23964 immediately followed by white space. If any non-printing characters are found,
23965 the transport defers.
23966 Whether characters with the top bit set count as printing characters or not is
23967 controlled by the &%print_topbitchars%& global option.
23968
23969 If any of the generic options for manipulating headers (for example,
23970 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23971 of the original message that is included in the generated message when
23972 &%return_message%& is set. They do not apply to the generated message itself.
23973
23974 .vindex "&$sender_address$&"
23975 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23976 the message, indicating that there were no recipients, it does not treat this
23977 as an error. This means that autoreplies sent to &$sender_address$& when this
23978 is empty (because the incoming message is a bounce message) do not cause
23979 problems. They are just discarded.
23980
23981
23982
23983 .section "Private options for autoreply" "SECID139"
23984 .cindex "options" "&(autoreply)& transport"
23985
23986 .option bcc autoreply string&!! unset
23987 This specifies the addresses that are to receive &"blind carbon copies"& of the
23988 message when the message is specified by the transport.
23989
23990
23991 .option cc autoreply string&!! unset
23992 This specifies recipients of the message and the contents of the &'Cc:'& header
23993 when the message is specified by the transport.
23994
23995
23996 .option file autoreply string&!! unset
23997 The contents of the file are sent as the body of the message when the message
23998 is specified by the transport. If both &%file%& and &%text%& are set, the text
23999 string comes first.
24000
24001
24002 .option file_expand autoreply boolean false
24003 If this is set, the contents of the file named by the &%file%& option are
24004 subjected to string expansion as they are added to the message.
24005
24006
24007 .option file_optional autoreply boolean false
24008 If this option is true, no error is generated if the file named by the &%file%&
24009 option or passed with the address does not exist or cannot be read.
24010
24011
24012 .option from autoreply string&!! unset
24013 This specifies the contents of the &'From:'& header when the message is
24014 specified by the transport.
24015
24016
24017 .option headers autoreply string&!! unset
24018 This specifies additional RFC 2822 headers that are to be added to the message
24019 when the message is specified by the transport. Several can be given by using
24020 &"\n"& to separate them. There is no check on the format.
24021
24022
24023 .option log autoreply string&!! unset
24024 This option names a file in which a record of every message sent is logged when
24025 the message is specified by the transport.
24026
24027
24028 .option mode autoreply "octal integer" 0600
24029 If either the log file or the &"once"& file has to be created, this mode is
24030 used.
24031
24032
24033 .option never_mail autoreply "address list&!!" unset
24034 If any run of the transport creates a message with a recipient that matches any
24035 item in the list, that recipient is quietly discarded. If all recipients are
24036 discarded, no message is created. This applies both when the recipients are
24037 generated by a filter and when they are specified in the transport.
24038
24039
24040
24041 .option once autoreply string&!! unset
24042 This option names a file or DBM database in which a record of each &'To:'&
24043 recipient is kept when the message is specified by the transport. &*Note*&:
24044 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24045
24046 If &%once%& is unset, or is set to an empty string, the message is always sent.
24047 By default, if &%once%& is set to a non-empty filename, the message
24048 is not sent if a potential recipient is already listed in the database.
24049 However, if the &%once_repeat%& option specifies a time greater than zero, the
24050 message is sent if that much time has elapsed since a message was last sent to
24051 this recipient. A setting of zero time for &%once_repeat%& (the default)
24052 prevents a message from being sent a second time &-- in this case, zero means
24053 infinity.
24054
24055 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24056 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24057 greater than zero, it changes the way Exim implements the &%once%& option.
24058 Instead of using a DBM file to record every recipient it sends to, it uses a
24059 regular file, whose size will never get larger than the given value.
24060
24061 In the file, Exim keeps a linear list of recipient addresses and the times at
24062 which they were sent messages. If the file is full when a new address needs to
24063 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24064 means that a given recipient may receive multiple messages, but at
24065 unpredictable intervals that depend on the rate of turnover of addresses in the
24066 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24067
24068
24069 .option once_file_size autoreply integer 0
24070 See &%once%& above.
24071
24072
24073 .option once_repeat autoreply time&!! 0s
24074 See &%once%& above.
24075 After expansion, the value of this option must be a valid time value.
24076
24077
24078 .option reply_to autoreply string&!! unset
24079 This specifies the contents of the &'Reply-To:'& header when the message is
24080 specified by the transport.
24081
24082
24083 .option return_message autoreply boolean false
24084 If this is set, a copy of the original message is returned with the new
24085 message, subject to the maximum size set in the &%return_size_limit%& global
24086 configuration option.
24087
24088
24089 .option subject autoreply string&!! unset
24090 This specifies the contents of the &'Subject:'& header when the message is
24091 specified by the transport. It is tempting to quote the original subject in
24092 automatic responses. For example:
24093 .code
24094 subject = Re: $h_subject:
24095 .endd
24096 There is a danger in doing this, however. It may allow a third party to
24097 subscribe your users to an opt-in mailing list, provided that the list accepts
24098 bounce messages as subscription confirmations. Well-managed lists require a
24099 non-bounce message to confirm a subscription, so the danger is relatively
24100 small.
24101
24102
24103
24104 .option text autoreply string&!! unset
24105 This specifies a single string to be used as the body of the message when the
24106 message is specified by the transport. If both &%text%& and &%file%& are set,
24107 the text comes first.
24108
24109
24110 .option to autoreply string&!! unset
24111 This specifies recipients of the message and the contents of the &'To:'& header
24112 when the message is specified by the transport.
24113 .ecindex IIDauttra1
24114 .ecindex IIDauttra2
24115
24116
24117
24118
24119 . ////////////////////////////////////////////////////////////////////////////
24120 . ////////////////////////////////////////////////////////////////////////////
24121
24122 .chapter "The lmtp transport" "CHAPLMTP"
24123 .cindex "transports" "&(lmtp)&"
24124 .cindex "&(lmtp)& transport"
24125 .cindex "LMTP" "over a pipe"
24126 .cindex "LMTP" "over a socket"
24127 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24128 specified command
24129 or by interacting with a Unix domain socket.
24130 This transport is something of a cross between the &(pipe)& and &(smtp)&
24131 transports. Exim also has support for using LMTP over TCP/IP; this is
24132 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24133 to be of minority interest, the default build-time configure in &_src/EDITME_&
24134 has it commented out. You need to ensure that
24135 .code
24136 TRANSPORT_LMTP=yes
24137 .endd
24138 .cindex "options" "&(lmtp)& transport"
24139 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24140 included in the Exim binary. The private options of the &(lmtp)& transport are
24141 as follows:
24142
24143 .option batch_id lmtp string&!! unset
24144 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24145
24146
24147 .option batch_max lmtp integer 1
24148 This limits the number of addresses that can be handled in a single delivery.
24149 Most LMTP servers can handle several addresses at once, so it is normally a
24150 good idea to increase this value. See the description of local delivery
24151 batching in chapter &<<CHAPbatching>>&.
24152
24153
24154 .option command lmtp string&!! unset
24155 This option must be set if &%socket%& is not set. The string is a command which
24156 is run in a separate process. It is split up into a command name and list of
24157 arguments, each of which is separately expanded (so expansion cannot change the
24158 number of arguments). The command is run directly, not via a shell. The message
24159 is passed to the new process using the standard input and output to operate the
24160 LMTP protocol.
24161
24162 .option ignore_quota lmtp boolean false
24163 .cindex "LMTP" "ignoring quota errors"
24164 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24165 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24166 in its response to the LHLO command.
24167
24168 .option socket lmtp string&!! unset
24169 This option must be set if &%command%& is not set. The result of expansion must
24170 be the name of a Unix domain socket. The transport connects to the socket and
24171 delivers the message to it using the LMTP protocol.
24172
24173
24174 .option timeout lmtp time 5m
24175 The transport is aborted if the created process or Unix domain socket does not
24176 respond to LMTP commands or message input within this timeout. Delivery
24177 is deferred, and will be tried again later. Here is an example of a typical
24178 LMTP transport:
24179 .code
24180 lmtp:
24181   driver = lmtp
24182   command = /some/local/lmtp/delivery/program
24183   batch_max = 20
24184   user = exim
24185 .endd
24186 This delivers up to 20 addresses at a time, in a mixture of domains if
24187 necessary, running as the user &'exim'&.
24188
24189
24190
24191 . ////////////////////////////////////////////////////////////////////////////
24192 . ////////////////////////////////////////////////////////////////////////////
24193
24194 .chapter "The pipe transport" "CHAPpipetransport"
24195 .scindex IIDpiptra1 "transports" "&(pipe)&"
24196 .scindex IIDpiptra2 "&(pipe)& transport"
24197 The &(pipe)& transport is used to deliver messages via a pipe to a command
24198 running in another process. One example is the use of &(pipe)& as a
24199 pseudo-remote transport for passing messages to some other delivery mechanism
24200 (such as UUCP). Another is the use by individual users to automatically process
24201 their incoming messages. The &(pipe)& transport can be used in one of the
24202 following ways:
24203
24204 .ilist
24205 .vindex "&$local_part$&"
24206 A router routes one address to a transport in the normal way, and the
24207 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24208 contains the local part of the address (as usual), and the command that is run
24209 is specified by the &%command%& option on the transport.
24210 .next
24211 .vindex "&$pipe_addresses$&"
24212 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24213 transport can handle more than one address in a single run. In this case, when
24214 more than one address is routed to the transport, &$local_part$& is not set
24215 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24216 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24217 that are routed to the transport.
24218 .next
24219 .vindex "&$address_pipe$&"
24220 A router redirects an address directly to a pipe command (for example, from an
24221 alias or forward file). In this case, &$address_pipe$& contains the text of the
24222 pipe command, and the &%command%& option on the transport is ignored unless
24223 &%force_command%& is set. If only one address is being transported
24224 (&%batch_max%& is not greater than one, or only one address was redirected to
24225 this pipe command), &$local_part$& contains the local part that was redirected.
24226 .endlist
24227
24228
24229 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24230 deliver messages over pipes using the LMTP interactive protocol. This is
24231 implemented by the &(lmtp)& transport.
24232
24233 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24234 &_.forward_& file, the command runs under the uid and gid of that user. In
24235 other cases, the uid and gid have to be specified explicitly, either on the
24236 transport or on the router that handles the address. Current and &"home"&
24237 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24238 details of the local delivery environment and chapter &<<CHAPbatching>>&
24239 for a discussion of local delivery batching.
24240
24241 .new
24242 .cindex "tainted data" "in pipe command"
24243 .cindex pipe "tainted data"
24244 Tainted data may not be used for the command name.
24245 .wen
24246
24247
24248 .section "Concurrent delivery" "SECID140"
24249 If two messages arrive at almost the same time, and both are routed to a pipe
24250 delivery, the two pipe transports may be run concurrently. You must ensure that
24251 any pipe commands you set up are robust against this happening. If the commands
24252 write to a file, the &%exim_lock%& utility might be of use.
24253 Alternatively the &%max_parallel%& option could be used with a value
24254 of "1" to enforce serialization.
24255
24256
24257
24258
24259 .section "Returned status and data" "SECID141"
24260 .cindex "&(pipe)& transport" "returned data"
24261 If the command exits with a non-zero return code, the delivery is deemed to
24262 have failed, unless either the &%ignore_status%& option is set (in which case
24263 the return code is treated as zero), or the return code is one of those listed
24264 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24265 later"&. In this case, delivery is deferred. Details of a permanent failure are
24266 logged, but are not included in the bounce message, which merely contains
24267 &"local delivery failed"&.
24268
24269 If the command exits on a signal and the &%freeze_signal%& option is set then
24270 the message will be frozen in the queue. If that option is not set, a bounce
24271 will be sent as normal.
24272
24273 If the return code is greater than 128 and the command being run is a shell
24274 script, it normally means that the script was terminated by a signal whose
24275 value is the return code minus 128. The &%freeze_signal%& option does not
24276 apply in this case.
24277
24278 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24279 return code is set to 127. This is the value that a shell returns if it is
24280 asked to run a non-existent command. The wording for the log line suggests that
24281 a non-existent command may be the problem.
24282
24283 The &%return_output%& option can affect the result of a pipe delivery. If it is
24284 set and the command produces any output on its standard output or standard
24285 error streams, the command is considered to have failed, even if it gave a zero
24286 return code or if &%ignore_status%& is set. The output from the command is
24287 included as part of the bounce message. The &%return_fail_output%& option is
24288 similar, except that output is returned only when the command exits with a
24289 failure return code, that is, a value other than zero or a code that matches
24290 &%temp_errors%&.
24291
24292
24293
24294 .section "How the command is run" "SECThowcommandrun"
24295 .cindex "&(pipe)& transport" "path for command"
24296 The command line is (by default) broken down into a command name and arguments
24297 by the &(pipe)& transport itself. The &%allow_commands%& and
24298 &%restrict_to_path%& options can be used to restrict the commands that may be
24299 run.
24300
24301 .cindex "quoting" "in pipe command"
24302 Unquoted arguments are delimited by white space. If an argument appears in
24303 double quotes, backslash is interpreted as an escape character in the usual
24304 way. If an argument appears in single quotes, no escaping is done.
24305
24306 String expansion is applied to the command line except when it comes from a
24307 traditional &_.forward_& file (commands from a filter file are expanded). The
24308 expansion is applied to each argument in turn rather than to the whole line.
24309 For this reason, any string expansion item that contains white space must be
24310 quoted so as to be contained within a single argument. A setting such as
24311 .code
24312 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24313 .endd
24314 will not work, because the expansion item gets split between several
24315 arguments. You have to write
24316 .code
24317 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24318 .endd
24319 to ensure that it is all in one argument. The expansion is done in this way,
24320 argument by argument, so that the number of arguments cannot be changed as a
24321 result of expansion, and quotes or backslashes in inserted variables do not
24322 interact with external quoting. However, this leads to problems if you want to
24323 generate multiple arguments (or the command name plus arguments) from a single
24324 expansion. In this situation, the simplest solution is to use a shell. For
24325 example:
24326 .code
24327 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24328 .endd
24329
24330 .cindex "transport" "filter"
24331 .cindex "filter" "transport filter"
24332 .vindex "&$pipe_addresses$&"
24333 Special handling takes place when an argument consists of precisely the text
24334 &`$pipe_addresses`& (no quotes).
24335 This is not a general expansion variable; the only
24336 place this string is recognized is when it appears as an argument for a pipe or
24337 transport filter command. It causes each address that is being handled to be
24338 inserted in the argument list at that point &'as a separate argument'&. This
24339 avoids any problems with spaces or shell metacharacters, and is of use when a
24340 &(pipe)& transport is handling groups of addresses in a batch.
24341
24342 If &%force_command%& is enabled on the transport, special handling takes place
24343 for an argument that consists of precisely the text &`$address_pipe`&.  It
24344 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24345 argument is inserted in the argument list at that point
24346 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24347 the only item in the argument; in fact, if it were then &%force_command%&
24348 should behave as a no-op.  Rather, it should be used to adjust the command
24349 run while preserving the argument vector separation.
24350
24351 After splitting up into arguments and expansion, the resulting command is run
24352 in a subprocess directly from the transport, &'not'& under a shell. The
24353 message that is being delivered is supplied on the standard input, and the
24354 standard output and standard error are both connected to a single pipe that is
24355 read by Exim. The &%max_output%& option controls how much output the command
24356 may produce, and the &%return_output%& and &%return_fail_output%& options
24357 control what is done with it.
24358
24359 Not running the command under a shell (by default) lessens the security risks
24360 in cases when a command from a user's filter file is built out of data that was
24361 taken from an incoming message. If a shell is required, it can of course be
24362 explicitly specified as the command to be run. However, there are circumstances
24363 where existing commands (for example, in &_.forward_& files) expect to be run
24364 under a shell and cannot easily be modified. To allow for these cases, there is
24365 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24366 works. Instead of breaking up the command line as just described, it expands it
24367 as a single string and passes the result to &_/bin/sh_&. The
24368 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24369 with &%use_shell%&, and the whole mechanism is inherently less secure.
24370
24371
24372
24373 .section "Environment variables" "SECTpipeenv"
24374 .cindex "&(pipe)& transport" "environment for command"
24375 .cindex "environment" "&(pipe)& transport"
24376 The environment variables listed below are set up when the command is invoked.
24377 This list is a compromise for maximum compatibility with other MTAs. Note that
24378 the &%environment%& option can be used to add additional variables to this
24379 environment. The environment for the &(pipe)& transport is not subject
24380 to the &%add_environment%& and &%keep_environment%& main config options.
24381 .display
24382 &`DOMAIN            `&   the domain of the address
24383 &`HOME              `&   the home directory, if set
24384 &`HOST              `&   the host name when called from a router (see below)
24385 &`LOCAL_PART        `&   see below
24386 &`LOCAL_PART_PREFIX `&   see below
24387 &`LOCAL_PART_SUFFIX `&   see below
24388 &`LOGNAME           `&   see below
24389 &`MESSAGE_ID        `&   Exim's local ID for the message
24390 &`PATH              `&   as specified by the &%path%& option below
24391 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24392 &`RECIPIENT         `&   the complete recipient address
24393 &`SENDER            `&   the sender of the message (empty if a bounce)
24394 &`SHELL             `&   &`/bin/sh`&
24395 &`TZ                `&   the value of the &%timezone%& option, if set
24396 &`USER              `&   see below
24397 .endd
24398 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24399 router, LOCAL_PART is set to the local part of the address. When it is
24400 called as a result of a forward or alias expansion, LOCAL_PART is set to
24401 the local part of the address that was expanded. In both cases, any affixes are
24402 removed from the local part, and made available in LOCAL_PART_PREFIX and
24403 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24404 same value as LOCAL_PART for compatibility with other MTAs.
24405
24406 .cindex "HOST"
24407 HOST is set only when a &(pipe)& transport is called from a router that
24408 associates hosts with an address, typically when using &(pipe)& as a
24409 pseudo-remote transport. HOST is set to the first host name specified by
24410 the router.
24411
24412 .cindex "HOME"
24413 If the transport's generic &%home_directory%& option is set, its value is used
24414 for the HOME environment variable. Otherwise, a home directory may be set
24415 by the router's &%transport_home_directory%& option, which defaults to the
24416 user's home directory if &%check_local_user%& is set.
24417
24418
24419 .section "Private options for pipe" "SECID142"
24420 .cindex "options" "&(pipe)& transport"
24421
24422
24423
24424 .option allow_commands pipe "string list&!!" unset
24425 .cindex "&(pipe)& transport" "permitted commands"
24426 The string is expanded, and is then interpreted as a colon-separated list of
24427 permitted commands. If &%restrict_to_path%& is not set, the only commands
24428 permitted are those in the &%allow_commands%& list. They need not be absolute
24429 paths; the &%path%& option is still used for relative paths. If
24430 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24431 in the &%allow_commands%& list, or a name without any slashes that is found on
24432 the path. In other words, if neither &%allow_commands%& nor
24433 &%restrict_to_path%& is set, there is no restriction on the command, but
24434 otherwise only commands that are permitted by one or the other are allowed. For
24435 example, if
24436 .code
24437 allow_commands = /usr/bin/vacation
24438 .endd
24439 and &%restrict_to_path%& is not set, the only permitted command is
24440 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24441 &%use_shell%& is set.
24442
24443
24444 .option batch_id pipe string&!! unset
24445 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24446
24447
24448 .option batch_max pipe integer 1
24449 This limits the number of addresses that can be handled in a single delivery.
24450 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24451
24452
24453 .option check_string pipe string unset
24454 As &(pipe)& writes the message, the start of each line is tested for matching
24455 &%check_string%&, and if it does, the initial matching characters are replaced
24456 by the contents of &%escape_string%&, provided both are set. The value of
24457 &%check_string%& is a literal string, not a regular expression, and the case of
24458 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24459 of &%check_string%& and &%escape_string%& are forced to values that implement
24460 the SMTP escaping protocol. Any settings made in the configuration file are
24461 ignored.
24462
24463
24464 .option command pipe string&!! unset
24465 This option need not be set when &(pipe)& is being used to deliver to pipes
24466 obtained directly from address redirections. In other cases, the option must be
24467 set, to provide a command to be run. It need not yield an absolute path (see
24468 the &%path%& option below). The command is split up into separate arguments by
24469 Exim, and each argument is separately expanded, as described in section
24470 &<<SECThowcommandrun>>& above.
24471
24472
24473 .option environment pipe string&!! unset
24474 .cindex "&(pipe)& transport" "environment for command"
24475 .cindex "environment" "&(pipe)& transport"
24476 This option is used to add additional variables to the environment in which the
24477 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24478 a string which is expanded, and then interpreted as a colon-separated list of
24479 environment settings of the form <&'name'&>=<&'value'&>.
24480
24481
24482 .option escape_string pipe string unset
24483 See &%check_string%& above.
24484
24485
24486 .option freeze_exec_fail pipe boolean false
24487 .cindex "exec failure"
24488 .cindex "failure of exec"
24489 .cindex "&(pipe)& transport" "failure of exec"
24490 Failure to exec the command in a pipe transport is by default treated like
24491 any other failure while running the command. However, if &%freeze_exec_fail%&
24492 is set, failure to exec is treated specially, and causes the message to be
24493 frozen, whatever the setting of &%ignore_status%&.
24494
24495
24496 .option freeze_signal pipe boolean false
24497 .cindex "signal exit"
24498 .cindex "&(pipe)& transport", "signal exit"
24499 Normally if the process run by a command in a pipe transport exits on a signal,
24500 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24501 frozen in Exim's queue instead.
24502
24503
24504 .option force_command pipe boolean false
24505 .cindex "force command"
24506 .cindex "&(pipe)& transport", "force command"
24507 Normally when a router redirects an address directly to a pipe command
24508 the &%command%& option on the transport is ignored.  If &%force_command%&
24509 is set, the &%command%& option will used. This is especially
24510 useful for forcing a wrapper or additional argument to be added to the
24511 command. For example:
24512 .code
24513 command = /usr/bin/remote_exec myhost -- $address_pipe
24514 force_command
24515 .endd
24516
24517 Note that &$address_pipe$& is handled specially in &%command%& when
24518 &%force_command%& is set, expanding out to the original argument vector as
24519 separate items, similarly to a Unix shell &`"$@"`& construct.
24520
24521
24522 .option ignore_status pipe boolean false
24523 If this option is true, the status returned by the subprocess that is set up to
24524 run the command is ignored, and Exim behaves as if zero had been returned.
24525 Otherwise, a non-zero status or termination by signal causes an error return
24526 from the transport unless the status value is one of those listed in
24527 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24528
24529 &*Note*&: This option does not apply to timeouts, which do not return a status.
24530 See the &%timeout_defer%& option for how timeouts are handled.
24531
24532
24533 .option log_defer_output pipe boolean false
24534 .cindex "&(pipe)& transport" "logging output"
24535 If this option is set, and the status returned by the command is
24536 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24537 and any output was produced on stdout or stderr, the first line of it is
24538 written to the main log.
24539
24540
24541 .option log_fail_output pipe boolean false
24542 If this option is set, and the command returns any output on stdout or
24543 stderr, and also ends with a return code that is neither zero nor one of
24544 the return codes listed in &%temp_errors%& (that is, the delivery
24545 failed), the first line of output is written to the main log. This
24546 option and &%log_output%& are mutually exclusive.  Only one of them may
24547 be set.
24548
24549
24550 .option log_output pipe boolean false
24551 If this option is set and the command returns any output on stdout or
24552 stderr, the first line of output is written to the main log, whatever
24553 the return code. This option and &%log_fail_output%& are mutually
24554 exclusive. Only one of them may be set.
24555
24556
24557 .option max_output pipe integer 20K
24558 This specifies the maximum amount of output that the command may produce on its
24559 standard output and standard error file combined. If the limit is exceeded, the
24560 process running the command is killed. This is intended as a safety measure to
24561 catch runaway processes. The limit is applied independently of the settings of
24562 the options that control what is done with such output (for example,
24563 &%return_output%&). Because of buffering effects, the amount of output may
24564 exceed the limit by a small amount before Exim notices.
24565
24566
24567 .option message_prefix pipe string&!! "see below"
24568 The string specified here is expanded and output at the start of every message.
24569 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24570 .code
24571 message_prefix = \
24572   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24573   ${tod_bsdinbox}\n
24574 .endd
24575 .cindex "Cyrus"
24576 .cindex "&%tmail%&"
24577 .cindex "&""From""& line"
24578 This is required by the commonly used &_/usr/bin/vacation_& program.
24579 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24580 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24581 setting
24582 .code
24583 message_prefix =
24584 .endd
24585 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24586 &`\n`& to &`\r\n`& in &%message_prefix%&.
24587
24588
24589 .option message_suffix pipe string&!! "see below"
24590 The string specified here is expanded and output at the end of every message.
24591 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24592 The suffix can be suppressed by setting
24593 .code
24594 message_suffix =
24595 .endd
24596 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24597 &`\n`& to &`\r\n`& in &%message_suffix%&.
24598
24599
24600 .option path pipe string&!! "/bin:/usr/bin"
24601 This option is expanded and
24602 specifies the string that is set up in the PATH environment
24603 variable of the subprocess.
24604 If the &%command%& option does not yield an absolute path name, the command is
24605 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24606 apply to a command specified as a transport filter.
24607
24608
24609 .option permit_coredump pipe boolean false
24610 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24611 a core-dump of a pipe command, enable this command.  This enables core-dumps
24612 during delivery and affects both the Exim binary and the pipe command run.
24613 It is recommended that this option remain off unless and until you have a need
24614 for it and that this only be enabled when needed, as the risk of excessive
24615 resource consumption can be quite high.  Note also that Exim is typically
24616 installed as a setuid binary and most operating systems will inhibit coredumps
24617 of these by default, so further OS-specific action may be required.
24618
24619
24620 .option pipe_as_creator pipe boolean false
24621 .cindex "uid (user id)" "local delivery"
24622 If the generic &%user%& option is not set and this option is true, the delivery
24623 process is run under the uid that was in force when Exim was originally called
24624 to accept the message. If the group id is not otherwise set (via the generic
24625 &%group%& option), the gid that was in force when Exim was originally called to
24626 accept the message is used.
24627
24628
24629 .option restrict_to_path pipe boolean false
24630 When this option is set, any command name not listed in &%allow_commands%& must
24631 contain no slashes. The command is searched for only in the directories listed
24632 in the &%path%& option. This option is intended for use in the case when a pipe
24633 command has been generated from a user's &_.forward_& file. This is usually
24634 handled by a &(pipe)& transport called &%address_pipe%&.
24635
24636
24637 .option return_fail_output pipe boolean false
24638 If this option is true, and the command produced any output and ended with a
24639 return code other than zero or one of the codes listed in &%temp_errors%& (that
24640 is, the delivery failed), the output is returned in the bounce message.
24641 However, if the message has a null sender (that is, it is itself a bounce
24642 message), output from the command is discarded. This option and
24643 &%return_output%& are mutually exclusive. Only one of them may be set.
24644
24645
24646
24647 .option return_output pipe boolean false
24648 If this option is true, and the command produced any output, the delivery is
24649 deemed to have failed whatever the return code from the command, and the output
24650 is returned in the bounce message. Otherwise, the output is just discarded.
24651 However, if the message has a null sender (that is, it is a bounce message),
24652 output from the command is always discarded, whatever the setting of this
24653 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24654 of them may be set.
24655
24656
24657
24658 .option temp_errors pipe "string list" "see below"
24659 .cindex "&(pipe)& transport" "temporary failure"
24660 This option contains either a colon-separated list of numbers, or a single
24661 asterisk. If &%ignore_status%& is false
24662 and &%return_output%& is not set,
24663 and the command exits with a non-zero return code, the failure is treated as
24664 temporary and the delivery is deferred if the return code matches one of the
24665 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24666 codes are treated as permanent errors. The default setting contains the codes
24667 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24668 compiled on a system that does not define these macros, it assumes values of 75
24669 and 73, respectively.
24670
24671
24672 .option timeout pipe time 1h
24673 If the command fails to complete within this time, it is killed. This normally
24674 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24675 specifies no timeout. In order to ensure that any subprocesses created by the
24676 command are also killed, Exim makes the initial process a process group leader,
24677 and kills the whole process group on a timeout. However, this can be defeated
24678 if one of the processes starts a new process group.
24679
24680 .option timeout_defer pipe boolean false
24681 A timeout in a &(pipe)& transport, either in the command that the transport
24682 runs, or in a transport filter that is associated with it, is by default
24683 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24684 is set true, both kinds of timeout become temporary errors, causing the
24685 delivery to be deferred.
24686
24687 .option umask pipe "octal integer" 022
24688 This specifies the umask setting for the subprocess that runs the command.
24689
24690
24691 .option use_bsmtp pipe boolean false
24692 .cindex "envelope sender"
24693 If this option is set true, the &(pipe)& transport writes messages in &"batch
24694 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24695 commands. If you want to include a leading HELO command with such messages,
24696 you can do so by setting the &%message_prefix%& option. See section
24697 &<<SECTbatchSMTP>>& for details of batch SMTP.
24698
24699 .option use_classresources pipe boolean false
24700 .cindex "class resources (BSD)"
24701 This option is available only when Exim is running on FreeBSD, NetBSD, or
24702 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24703 resource limits when a &(pipe)& transport is run to perform a delivery. The
24704 limits for the uid under which the pipe is to run are obtained from the login
24705 class database.
24706
24707
24708 .option use_crlf pipe boolean false
24709 .cindex "carriage return"
24710 .cindex "linefeed"
24711 This option causes lines to be terminated with the two-character CRLF sequence
24712 (carriage return, linefeed) instead of just a linefeed character. In the case
24713 of batched SMTP, the byte sequence written to the pipe is then an exact image
24714 of what would be sent down a real SMTP connection.
24715
24716 The contents of the &%message_prefix%& and &%message_suffix%& options are
24717 written verbatim, so must contain their own carriage return characters if these
24718 are needed. When &%use_bsmtp%& is not set, the default values for both
24719 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24720 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24721
24722
24723 .option use_shell pipe boolean false
24724 .vindex "&$pipe_addresses$&"
24725 If this option is set, it causes the command to be passed to &_/bin/sh_&
24726 instead of being run directly from the transport, as described in section
24727 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24728 where the command is expected to be run under a shell and cannot easily be
24729 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24730 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24731 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24732 its &%-c%& option.
24733
24734
24735
24736 .section "Using an external local delivery agent" "SECID143"
24737 .cindex "local delivery" "using an external agent"
24738 .cindex "&'procmail'&"
24739 .cindex "external local delivery"
24740 .cindex "delivery" "&'procmail'&"
24741 .cindex "delivery" "by external agent"
24742 The &(pipe)& transport can be used to pass all messages that require local
24743 delivery to a separate local delivery agent such as &%procmail%&. When doing
24744 this, care must be taken to ensure that the pipe is run under an appropriate
24745 uid and gid. In some configurations one wants this to be a uid that is trusted
24746 by the delivery agent to supply the correct sender of the message. It may be
24747 necessary to recompile or reconfigure the delivery agent so that it trusts an
24748 appropriate user. The following is an example transport and router
24749 configuration for &%procmail%&:
24750 .code
24751 # transport
24752 procmail_pipe:
24753   driver = pipe
24754   command = /usr/local/bin/procmail -d $local_part_data
24755   return_path_add
24756   delivery_date_add
24757   envelope_to_add
24758   check_string = "From "
24759   escape_string = ">From "
24760   umask = 077
24761   user = $local_part_data
24762   group = mail
24763
24764 # router
24765 procmail:
24766   driver = accept
24767   check_local_user
24768   transport = procmail_pipe
24769 .endd
24770 In this example, the pipe is run as the local user, but with the group set to
24771 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24772 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24773 user to supply a correct sender address. If you do not specify either a
24774 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24775 home directory is the user's home directory by default.
24776
24777 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24778 .code
24779 IFS=" "
24780 .endd
24781 as shown in some &%procmail%& documentation, because Exim does not by default
24782 use a shell to run pipe commands.
24783
24784 .cindex "Cyrus"
24785 The next example shows a transport and a router for a system where local
24786 deliveries are handled by the Cyrus IMAP server.
24787 .code
24788 # transport
24789 local_delivery_cyrus:
24790   driver = pipe
24791   command = /usr/cyrus/bin/deliver \
24792             -m ${substr_1:$local_part_suffix} -- $local_part
24793   user = cyrus
24794   group = mail
24795   return_output
24796   log_output
24797   message_prefix =
24798   message_suffix =
24799
24800 # router
24801 local_user_cyrus:
24802   driver = accept
24803   check_local_user
24804   local_part_suffix = .*
24805   transport = local_delivery_cyrus
24806 .endd
24807 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24808 &%return_output%& to cause any text written by Cyrus to be returned to the
24809 sender.
24810 .ecindex IIDpiptra1
24811 .ecindex IIDpiptra2
24812
24813
24814 . ////////////////////////////////////////////////////////////////////////////
24815 . ////////////////////////////////////////////////////////////////////////////
24816
24817 .chapter "The smtp transport" "CHAPsmtptrans"
24818 .scindex IIDsmttra1 "transports" "&(smtp)&"
24819 .scindex IIDsmttra2 "&(smtp)& transport"
24820 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24821 or LMTP protocol. The list of hosts to try can either be taken from the address
24822 that is being processed (having been set up by the router), or specified
24823 explicitly for the transport. Timeout and retry processing (see chapter
24824 &<<CHAPretry>>&) is applied to each IP address independently.
24825
24826
24827 .section "Multiple messages on a single connection" "SECID144"
24828 The sending of multiple messages over a single TCP/IP connection can arise in
24829 two ways:
24830
24831 .ilist
24832 If a message contains more than &%max_rcpt%& (see below) addresses that are
24833 routed to the same host, more than one copy of the message has to be sent to
24834 that host. In this situation, multiple copies may be sent in a single run of
24835 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24836 does when it has too many addresses to send in one message also depends on the
24837 value of the global &%remote_max_parallel%& option. Details are given in
24838 section &<<SECToutSMTPTCP>>&.)
24839 .next
24840 .cindex "hints database" "remembering routing"
24841 When a message has been successfully delivered over a TCP/IP connection, Exim
24842 looks in its hints database to see if there are any other messages awaiting a
24843 connection to the same host. If there are, a new delivery process is started
24844 for one of them, and the current TCP/IP connection is passed on to it. The new
24845 process may in turn send multiple copies and possibly create yet another
24846 process.
24847 .endlist
24848
24849
24850 For each copy sent over the same TCP/IP connection, a sequence counter is
24851 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24852 no further messages are sent over that connection.
24853
24854
24855
24856 .section "Use of the $host and $host_address variables" "SECID145"
24857 .vindex "&$host$&"
24858 .vindex "&$host_address$&"
24859 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24860 &$host_address$& are the name and IP address of the first host on the host list
24861 passed by the router. However, when the transport is about to connect to a
24862 specific host, and while it is connected to that host, &$host$& and
24863 &$host_address$& are set to the values for that host. These are the values
24864 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24865 &%serialize_hosts%&, and the various TLS options are expanded.
24866
24867
24868 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24869 .vindex &$tls_bits$&
24870 .vindex &$tls_cipher$&
24871 .vindex &$tls_peerdn$&
24872 .vindex &$tls_sni$&
24873 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24874 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24875 are the values that were set when the message was received.
24876 These are the values that are used for options that are expanded before any
24877 SMTP connections are made. Just before each connection is made, these four
24878 variables are emptied. If TLS is subsequently started, they are set to the
24879 appropriate values for the outgoing connection, and these are the values that
24880 are in force when any authenticators are run and when the
24881 &%authenticated_sender%& option is expanded.
24882
24883 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24884 and will be removed in a future release.
24885
24886
24887 .section "Private options for smtp" "SECID146"
24888 .cindex "options" "&(smtp)& transport"
24889 The private options of the &(smtp)& transport are as follows:
24890
24891
24892 .option address_retry_include_sender smtp boolean true
24893 .cindex "4&'xx'& responses" "retrying after"
24894 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24895 is the combination of sender and recipient that is delayed in subsequent queue
24896 runs until the retry time is reached. You can delay the recipient without
24897 reference to the sender (which is what earlier versions of Exim did), by
24898 setting &%address_retry_include_sender%& false. However, this can lead to
24899 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24900
24901 .option allow_localhost smtp boolean false
24902 .cindex "local host" "sending to"
24903 .cindex "fallback" "hosts specified on transport"
24904 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24905 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24906 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24907 the delivery anyway. This should be used only in special cases when the
24908 configuration ensures that no looping will result (for example, a differently
24909 configured Exim is listening on the port to which the message is sent).
24910
24911
24912 .option authenticated_sender smtp string&!! unset
24913 .cindex "Cyrus"
24914 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24915 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24916 overriding any existing authenticated sender value. If the string expansion is
24917 forced to fail, the option is ignored. Other expansion failures cause delivery
24918 to be deferred. If the result of expansion is an empty string, that is also
24919 ignored.
24920
24921 The expansion happens after the outgoing connection has been made and TLS
24922 started, if required. This means that the &$host$&, &$host_address$&,
24923 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24924 particular connection.
24925
24926 If the SMTP session is not authenticated, the expansion of
24927 &%authenticated_sender%& still happens (and can cause the delivery to be
24928 deferred if it fails), but no AUTH= item is added to MAIL commands
24929 unless &%authenticated_sender_force%& is true.
24930
24931 This option allows you to use the &(smtp)& transport in LMTP mode to
24932 deliver mail to Cyrus IMAP and provide the proper local part as the
24933 &"authenticated sender"&, via a setting such as:
24934 .code
24935 authenticated_sender = $local_part
24936 .endd
24937 This removes the need for IMAP subfolders to be assigned special ACLs to
24938 allow direct delivery to those subfolders.
24939
24940 Because of expected uses such as that just described for Cyrus (when no
24941 domain is involved), there is no checking on the syntax of the provided
24942 value.
24943
24944
24945 .option authenticated_sender_force smtp boolean false
24946 If this option is set true, the &%authenticated_sender%& option's value
24947 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24948 authenticated as a client.
24949
24950
24951 .option command_timeout smtp time 5m
24952 This sets a timeout for receiving a response to an SMTP command that has been
24953 sent out. It is also used when waiting for the initial banner line from the
24954 remote host. Its value must not be zero.
24955
24956
24957 .option connect_timeout smtp time 5m
24958 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24959 to a remote host. A setting of zero allows the system timeout (typically
24960 several minutes) to act. To have any effect, the value of this option must be
24961 less than the system timeout. However, it has been observed that on some
24962 systems there is no system timeout, which is why the default value for this
24963 option is 5 minutes, a value recommended by RFC 1123.
24964
24965
24966 .option connection_max_messages smtp integer 500
24967 .cindex "SMTP" "passed connection"
24968 .cindex "SMTP" "multiple deliveries"
24969 .cindex "multiple SMTP deliveries"
24970 This controls the maximum number of separate message deliveries that are sent
24971 over a single TCP/IP connection. If the value is zero, there is no limit.
24972 For testing purposes, this value can be overridden by the &%-oB%& command line
24973 option.
24974
24975
24976 .option dane_require_tls_ciphers smtp string&!! unset
24977 .cindex "TLS" "requiring specific ciphers for DANE"
24978 .cindex "cipher" "requiring specific"
24979 .cindex DANE "TLS ciphers"
24980 This option may be used to override &%tls_require_ciphers%& for connections
24981 where DANE has been determined to be in effect.
24982 If not set, then &%tls_require_ciphers%& will be used.
24983 Normal SMTP delivery is not able to make strong demands of TLS cipher
24984 configuration, because delivery will fall back to plaintext.  Once DANE has
24985 been determined to be in effect, there is no plaintext fallback and making the
24986 TLS cipherlist configuration stronger will increase security, rather than
24987 counter-intuitively decreasing it.
24988 If the option expands to be empty or is forced to fail, then it will
24989 be treated as unset and &%tls_require_ciphers%& will be used instead.
24990
24991
24992 .option data_timeout smtp time 5m
24993 This sets a timeout for the transmission of each block in the data portion of
24994 the message. As a result, the overall timeout for a message depends on the size
24995 of the message. Its value must not be zero. See also &%final_timeout%&.
24996
24997
24998 .option dkim_canon smtp string&!! unset
24999 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25000 .option dkim_domain smtp string list&!! unset
25001 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25002 .option dkim_hash smtp string&!! sha256
25003 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25004 .option dkim_identity smtp string&!! unset
25005 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25006 .option dkim_private_key smtp string&!! unset
25007 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25008 .option dkim_selector smtp string&!! unset
25009 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25010 .option dkim_strict smtp string&!! unset
25011 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25012 .option dkim_sign_headers smtp string&!! "per RFC"
25013 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25014 .option dkim_timestamps smtp string&!! unset
25015 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25016
25017
25018 .option delay_after_cutoff smtp boolean true
25019 .cindex "final cutoff" "retries, controlling"
25020 .cindex retry "final cutoff"
25021 This option controls what happens when all remote IP addresses for a given
25022 domain have been inaccessible for so long that they have passed their retry
25023 cutoff times.
25024
25025 In the default state, if the next retry time has not been reached for any of
25026 them, the address is bounced without trying any deliveries. In other words,
25027 Exim delays retrying an IP address after the final cutoff time until a new
25028 retry time is reached, and can therefore bounce an address without ever trying
25029 a delivery, when machines have been down for a long time. Some people are
25030 unhappy at this prospect, so...
25031
25032 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25033 addresses are past their final cutoff time, Exim tries to deliver to those
25034 IP addresses that have not been tried since the message arrived. If there are
25035 none, of if they all fail, the address is bounced. In other words, it does not
25036 delay when a new message arrives, but immediately tries those expired IP
25037 addresses that haven't been tried since the message arrived. If there is a
25038 continuous stream of messages for the dead hosts, unsetting
25039 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25040 to them.
25041
25042
25043 .option dns_qualify_single smtp boolean true
25044 If the &%hosts%& or &%fallback_hosts%& option is being used,
25045 and the &%gethostbyname%& option is false,
25046 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25047 in chapter &<<CHAPdnslookup>>& for more details.
25048
25049
25050 .option dns_search_parents smtp boolean false
25051 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25052 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25053 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25054 details.
25055
25056
25057 .option dnssec_request_domains smtp "domain list&!!" *
25058 .cindex "MX record" "security"
25059 .cindex "DNSSEC" "MX lookup"
25060 .cindex "security" "MX lookup"
25061 .cindex "DNS" "DNSSEC"
25062 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25063 the dnssec request bit set. Setting this transport option is only useful if the
25064 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25065 router option.
25066
25067
25068
25069 .option dnssec_require_domains smtp "domain list&!!" unset
25070 .cindex "MX record" "security"
25071 .cindex "DNSSEC" "MX lookup"
25072 .cindex "security" "MX lookup"
25073 .cindex "DNS" "DNSSEC"
25074 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25075 the dnssec request bit set.  Setting this transport option is only
25076 useful if the transport overrides or sets the host names. See the
25077 &%dnssec_require_domains%& router option.
25078
25079
25080
25081 .option dscp smtp string&!! unset
25082 .cindex "DCSP" "outbound"
25083 This option causes the DSCP value associated with a socket to be set to one
25084 of a number of fixed strings or to numeric value.
25085 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25086 Common values include &`throughput`&, &`mincost`&, and on newer systems
25087 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25088
25089 The outbound packets from Exim will be marked with this value in the header
25090 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25091 that these values will have any effect, not be stripped by networking
25092 equipment, or do much of anything without cooperation with your Network
25093 Engineer and those of all network operators between the source and destination.
25094
25095
25096 .option fallback_hosts smtp "string list" unset
25097 .cindex "fallback" "hosts specified on transport"
25098 String expansion is not applied to this option. The argument must be a
25099 colon-separated list of host names or IP addresses, optionally also including
25100 port numbers, though the separator can be changed, as described in section
25101 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25102 item in a &%route_list%& setting for the &(manualroute)& router, as described
25103 in section &<<SECTformatonehostitem>>&.
25104
25105 Fallback hosts can also be specified on routers, which associate them with the
25106 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25107 &%fallback_hosts%& specified on the transport is used only if the address does
25108 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25109 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25110 However, &%hosts_randomize%& does apply to fallback host lists.
25111
25112 If Exim is unable to deliver to any of the hosts for a particular address, and
25113 the errors are not permanent rejections, the address is put on a separate
25114 transport queue with its host list replaced by the fallback hosts, unless the
25115 address was routed via MX records and the current host was in the original MX
25116 list. In that situation, the fallback host list is not used.
25117
25118 Once normal deliveries are complete, the fallback queue is delivered by
25119 re-running the same transports with the new host lists. If several failing
25120 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25121 copy of the message is sent.
25122
25123 The resolution of the host names on the fallback list is controlled by the
25124 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25125 both to cases when the host list comes with the address and when it is taken
25126 from &%hosts%&. This option provides a &"use a smart host only if delivery
25127 fails"& facility.
25128
25129
25130 .option final_timeout smtp time 10m
25131 This is the timeout that applies while waiting for the response to the final
25132 line containing just &"."& that terminates a message. Its value must not be
25133 zero.
25134
25135 .option gethostbyname smtp boolean false
25136 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25137 being used, names are looked up using &[gethostbyname()]&
25138 (or &[getipnodebyname()]& when available)
25139 instead of using the DNS. Of course, that function may in fact use the DNS, but
25140 it may also consult other sources of information such as &_/etc/hosts_&.
25141
25142 .option gnutls_compat_mode smtp boolean unset
25143 This option controls whether GnuTLS is used in compatibility mode in an Exim
25144 server. This reduces security slightly, but improves interworking with older
25145 implementations of TLS.
25146
25147 .option helo_data smtp string&!! "see below"
25148 .cindex "HELO" "argument, setting"
25149 .cindex "EHLO" "argument, setting"
25150 .cindex "LHLO argument setting"
25151 The value of this option is expanded after a connection to a another host has
25152 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25153 command that starts the outgoing SMTP or LMTP session. The default value of the
25154 option is:
25155 .code
25156 $primary_hostname
25157 .endd
25158 During the expansion, the variables &$host$& and &$host_address$& are set to
25159 the identity of the remote host, and the variables &$sending_ip_address$& and
25160 &$sending_port$& are set to the local IP address and port number that are being
25161 used. These variables can be used to generate different values for different
25162 servers or different local IP addresses. For example, if you want the string
25163 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25164 interface address, you could use this:
25165 .code
25166 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25167   {$primary_hostname}}
25168 .endd
25169 The use of &%helo_data%& applies both to sending messages and when doing
25170 callouts.
25171
25172 .option hosts smtp "string list&!!" unset
25173 Hosts are associated with an address by a router such as &(dnslookup)&, which
25174 finds the hosts by looking up the address domain in the DNS, or by
25175 &(manualroute)&, which has lists of hosts in its configuration. However,
25176 email addresses can be passed to the &(smtp)& transport by any router, and not
25177 all of them can provide an associated list of hosts.
25178
25179 The &%hosts%& option specifies a list of hosts to be used if the address being
25180 processed does not have any hosts associated with it. The hosts specified by
25181 &%hosts%& are also used, whether or not the address has its own hosts, if
25182 &%hosts_override%& is set.
25183
25184 The string is first expanded, before being interpreted as a colon-separated
25185 list of host names or IP addresses, possibly including port numbers. The
25186 separator may be changed to something other than colon, as described in section
25187 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25188 item in a &%route_list%& setting for the &(manualroute)& router, as described
25189 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25190 of the &(manualroute)& router is not available here.
25191
25192 If the expansion fails, delivery is deferred. Unless the failure was caused by
25193 the inability to complete a lookup, the error is logged to the panic log as
25194 well as the main log. Host names are looked up either by searching directly for
25195 address records in the DNS or by calling &[gethostbyname()]& (or
25196 &[getipnodebyname()]& when available), depending on the setting of the
25197 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25198 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25199 address are used.
25200
25201 During delivery, the hosts are tried in order, subject to their retry status,
25202 unless &%hosts_randomize%& is set.
25203
25204
25205 .option hosts_avoid_esmtp smtp "host list&!!" unset
25206 .cindex "ESMTP, avoiding use of"
25207 .cindex "HELO" "forcing use of"
25208 .cindex "EHLO" "avoiding use of"
25209 .cindex "PIPELINING" "avoiding the use of"
25210 This option is for use with broken hosts that announce ESMTP facilities (for
25211 example, PIPELINING) and then fail to implement them properly. When a host
25212 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25213 start of the SMTP session. This means that it cannot use any of the ESMTP
25214 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25215
25216
25217 .option hosts_avoid_pipelining smtp "host list&!!" unset
25218 .cindex "PIPELINING" "avoiding the use of"
25219 .cindex "ESMTP extensions" PIPELINING
25220 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25221 that matches this list, even if the server host advertises PIPELINING support.
25222
25223 .option hosts_pipe_connect smtp "host list&!!" unset
25224 .cindex "pipelining" "early connection"
25225 .cindex "pipelining" PIPE_CONNECT
25226 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25227 this option controls which to hosts the facility watched for
25228 and recorded, and used for subsequent connections.
25229
25230 The retry hints database is used for the record,
25231 and records are subject to the &%retry_data_expire%& option.
25232 When used, the pipelining saves on roundtrip times.
25233 It also turns SMTP into a client-first protocol
25234 so combines well with TCP Fast Open.
25235
25236 See also the &%pipelining_connect_advertise_hosts%& main option.
25237
25238 Note:
25239 When the facility is used, the transport &%helo_data%& option
25240 will be expanded before the &$sending_ip_address$& variable
25241 is filled in.
25242 A check is made for the use of that variable, without the
25243 presence of a &"def:"& test on it, but suitably complex coding
25244 can avoid the check and produce unexpected results.
25245 You have been warned.
25246
25247
25248 .option hosts_avoid_tls smtp "host list&!!" unset
25249 .cindex "TLS" "avoiding for certain hosts"
25250 Exim will not try to start a TLS session when delivering to any host that
25251 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25252
25253 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25254 .cindex "TLS" "avoiding for certain hosts"
25255 Exim will not try to start a TLS session for a verify callout,
25256 or when delivering in cutthrough mode,
25257 to any host that matches this list.
25258
25259
25260 .option hosts_max_try smtp integer 5
25261 .cindex "host" "maximum number to try"
25262 .cindex "limit" "number of hosts tried"
25263 .cindex "limit" "number of MX tried"
25264 .cindex "MX record" "maximum tried"
25265 This option limits the number of IP addresses that are tried for any one
25266 delivery in cases where there are temporary delivery errors. Section
25267 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25268
25269
25270 .option hosts_max_try_hardlimit smtp integer 50
25271 This is an additional check on the maximum number of IP addresses that Exim
25272 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25273 why it exists.
25274
25275
25276
25277 .option hosts_nopass_tls smtp "host list&!!" unset
25278 .cindex "TLS" "passing connection"
25279 .cindex "multiple SMTP deliveries"
25280 .cindex "TLS" "multiple message deliveries"
25281 For any host that matches this list, a connection on which a TLS session has
25282 been started will not be passed to a new delivery process for sending another
25283 message on the same connection. See section &<<SECTmulmessam>>& for an
25284 explanation of when this might be needed.
25285
25286 .option hosts_noproxy_tls smtp "host list&!!" unset
25287 .cindex "TLS" "passing connection"
25288 .cindex "multiple SMTP deliveries"
25289 .cindex "TLS" "multiple message deliveries"
25290 For any host that matches this list, a TLS session which has
25291 been started will not be passed to a new delivery process for sending another
25292 message on the same session.
25293
25294 The traditional implementation closes down TLS and re-starts it in the new
25295 process, on the same open TCP connection, for each successive message
25296 sent.  If permitted by this option a pipe to to the new process is set up
25297 instead, and the original process maintains the TLS connection and proxies
25298 the SMTP connection from and to the new process and any subsequents.
25299 The new process has no access to TLS information, so cannot include it in
25300 logging.
25301
25302
25303
25304 .option hosts_override smtp boolean false
25305 If this option is set and the &%hosts%& option is also set, any hosts that are
25306 attached to the address are ignored, and instead the hosts specified by the
25307 &%hosts%& option are always used. This option does not apply to
25308 &%fallback_hosts%&.
25309
25310
25311 .option hosts_randomize smtp boolean false
25312 .cindex "randomized host list"
25313 .cindex "host" "list of; randomized"
25314 .cindex "fallback" "randomized hosts"
25315 If this option is set, and either the list of hosts is taken from the
25316 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25317 were not obtained from MX records (this includes fallback hosts from the
25318 router), and were not randomized by the router, the order of trying the hosts
25319 is randomized each time the transport runs. Randomizing the order of a host
25320 list can be used to do crude load sharing.
25321
25322 When &%hosts_randomize%& is true, a host list may be split into groups whose
25323 order is separately randomized. This makes it possible to set up MX-like
25324 behaviour. The boundaries between groups are indicated by an item that is just
25325 &`+`& in the host list. For example:
25326 .code
25327 hosts = host1:host2:host3:+:host4:host5
25328 .endd
25329 The order of the first three hosts and the order of the last two hosts is
25330 randomized for each use, but the first three always end up before the last two.
25331 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25332
25333 .option hosts_require_auth smtp "host list&!!" unset
25334 .cindex "authentication" "required by client"
25335 This option provides a list of servers for which authentication must succeed
25336 before Exim will try to transfer a message. If authentication fails for
25337 servers which are not in this list, Exim tries to send unauthenticated. If
25338 authentication fails for one of these servers, delivery is deferred. This
25339 temporary error is detectable in the retry rules, so it can be turned into a
25340 hard failure if required. See also &%hosts_try_auth%&, and chapter
25341 &<<CHAPSMTPAUTH>>& for details of authentication.
25342
25343
25344 .option hosts_request_ocsp smtp "host list&!!" *
25345 .cindex "TLS" "requiring for certain servers"
25346 Exim will request a Certificate Status on a
25347 TLS session for any host that matches this list.
25348 &%tls_verify_certificates%& should also be set for the transport.
25349
25350 .option hosts_require_dane smtp "host list&!!" unset
25351 .cindex DANE "transport options"
25352 .cindex DANE "requiring for certain servers"
25353 If built with DANE support, Exim  will require that a DNSSEC-validated
25354 TLSA record is present for any host matching the list,
25355 and that a DANE-verified TLS connection is made. See
25356 the &%dnssec_request_domains%& router and transport options.
25357 There will be no fallback to in-clear communication.
25358 See section &<<SECDANE>>&.
25359
25360 .option hosts_require_ocsp smtp "host list&!!" unset
25361 .cindex "TLS" "requiring for certain servers"
25362 Exim will request, and check for a valid Certificate Status being given, on a
25363 TLS session for any host that matches this list.
25364 &%tls_verify_certificates%& should also be set for the transport.
25365
25366 .option hosts_require_tls smtp "host list&!!" unset
25367 .cindex "TLS" "requiring for certain servers"
25368 Exim will insist on using a TLS session when delivering to any host that
25369 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25370 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25371 incoming messages, use an appropriate ACL.
25372
25373 .option hosts_try_auth smtp "host list&!!" unset
25374 .cindex "authentication" "optional in client"
25375 This option provides a list of servers to which, provided they announce
25376 authentication support, Exim will attempt to authenticate as a client when it
25377 connects. If authentication fails, Exim will try to transfer the message
25378 unauthenticated. See also &%hosts_require_auth%&, and chapter
25379 &<<CHAPSMTPAUTH>>& for details of authentication.
25380
25381 .option hosts_try_chunking smtp "host list&!!" *
25382 .cindex CHUNKING "enabling, in client"
25383 .cindex BDAT "SMTP command"
25384 .cindex "RFC 3030" "CHUNKING"
25385 This option provides a list of servers to which, provided they announce
25386 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25387 .new
25388 Unless DKIM signing is being done,
25389 .wen
25390 BDAT will not be used in conjunction with a transport filter.
25391
25392 .option hosts_try_dane smtp "host list&!!" *
25393 .cindex DANE "transport options"
25394 .cindex DANE "attempting for certain servers"
25395 If built with DANE support, Exim  will require that a DNSSEC-validated
25396 TLSA record is present for any host matching the list,
25397 and that a DANE-verified TLS connection is made. See
25398 the &%dnssec_request_domains%& router and transport options.
25399 There will be no fallback to in-clear communication.
25400 See section &<<SECDANE>>&.
25401
25402 .option hosts_try_fastopen smtp "host list&!!" *
25403 .cindex "fast open, TCP" "enabling, in client"
25404 .cindex "TCP Fast Open" "enabling, in client"
25405 .cindex "RFC 7413" "TCP Fast Open"
25406 This option provides a list of servers to which, provided
25407 the facility is supported by this system, Exim will attempt to
25408 perform a TCP Fast Open.
25409 No data is sent on the SYN segment but, if the remote server also
25410 supports the facility, it can send its SMTP banner immediately after
25411 the SYN,ACK segment.  This can save up to one round-trip time.
25412
25413 The facility is only active for previously-contacted servers,
25414 as the initiator must present a cookie in the SYN segment.
25415
25416 On (at least some) current Linux distributions the facility must be enabled
25417 in the kernel by the sysadmin before the support is usable.
25418 There is no option for control of the server side; if the system supports
25419 it it is always enabled.  Note that lengthy operations in the connect ACL,
25420 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25421
25422 .option hosts_try_prdr smtp "host list&!!" *
25423 .cindex "PRDR" "enabling, optional in client"
25424 .cindex "ESMTP extensions" PRDR
25425 This option provides a list of servers to which, provided they announce
25426 PRDR support, Exim will attempt to negotiate PRDR
25427 for multi-recipient messages.
25428 The option can usually be left as default.
25429
25430 .option interface smtp "string list&!!" unset
25431 .cindex "bind IP address"
25432 .cindex "IP address" "binding"
25433 .vindex "&$host$&"
25434 .vindex "&$host_address$&"
25435 This option specifies which interface to bind to when making an outgoing SMTP
25436 call. The value is an IP address, not an interface name such as
25437 &`eth0`&. Do not confuse this with the interface address that was used when a
25438 message was received, which is in &$received_ip_address$&, formerly known as
25439 &$interface_address$&. The name was changed to minimize confusion with the
25440 outgoing interface address. There is no variable that contains an outgoing
25441 interface address because, unless it is set by this option, its value is
25442 unknown.
25443
25444 During the expansion of the &%interface%& option the variables &$host$& and
25445 &$host_address$& refer to the host to which a connection is about to be made
25446 during the expansion of the string. Forced expansion failure, or an empty
25447 string result causes the option to be ignored. Otherwise, after expansion, the
25448 string must be a list of IP addresses, colon-separated by default, but the
25449 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25450 For example:
25451 .code
25452 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25453 .endd
25454 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25455 connection. If none of them are the correct type, the option is ignored. If
25456 &%interface%& is not set, or is ignored, the system's IP functions choose which
25457 interface to use if the host has more than one.
25458
25459
25460 .option keepalive smtp boolean true
25461 .cindex "keepalive" "on outgoing connection"
25462 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25463 connections. When set, it causes the kernel to probe idle connections
25464 periodically, by sending packets with &"old"& sequence numbers. The other end
25465 of the connection should send a acknowledgment if the connection is still okay
25466 or a reset if the connection has been aborted. The reason for doing this is
25467 that it has the beneficial effect of freeing up certain types of connection
25468 that can get stuck when the remote host is disconnected without tidying up the
25469 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25470 unreachable hosts.
25471
25472
25473 .option lmtp_ignore_quota smtp boolean false
25474 .cindex "LMTP" "ignoring quota errors"
25475 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25476 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25477 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25478
25479 .option max_rcpt smtp integer 100
25480 .cindex "RCPT" "maximum number of outgoing"
25481 This option limits the number of RCPT commands that are sent in a single
25482 SMTP message transaction. Each set of addresses is treated independently, and
25483 so can cause parallel connections to the same host if &%remote_max_parallel%&
25484 permits this.
25485
25486
25487 .option multi_domain smtp boolean&!! true
25488 .vindex "&$domain$&"
25489 When this option is set, the &(smtp)& transport can handle a number of
25490 addresses containing a mixture of different domains provided they all resolve
25491 to the same list of hosts. Turning the option off restricts the transport to
25492 handling only one domain at a time. This is useful if you want to use
25493 &$domain$& in an expansion for the transport, because it is set only when there
25494 is a single domain involved in a remote delivery.
25495
25496 It is expanded per-address and can depend on any of
25497 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25498 &$host$&, &$host_address$& and &$host_port$&.
25499
25500 .option port smtp string&!! "see below"
25501 .cindex "port" "sending TCP/IP"
25502 .cindex "TCP/IP" "setting outgoing port"
25503 This option specifies the TCP/IP port on the server to which Exim connects.
25504 &*Note:*& Do not confuse this with the port that was used when a message was
25505 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25506 The name was changed to minimize confusion with the outgoing port. There is no
25507 variable that contains an outgoing port.
25508
25509 If the value of this option begins with a digit it is taken as a port number;
25510 otherwise it is looked up using &[getservbyname()]&. The default value is
25511 normally &"smtp"&,
25512 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25513 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25514 If the expansion fails, or if a port number cannot be found, delivery
25515 is deferred.
25516
25517 Note that at least one Linux distribution has been seen failing
25518 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25519
25520
25521
25522 .option protocol smtp string smtp
25523 .cindex "LMTP" "over TCP/IP"
25524 .cindex "ssmtp protocol" "outbound"
25525 .cindex "TLS" "SSL-on-connect outbound"
25526 .vindex "&$port$&"
25527 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25528 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25529 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25530 deliveries into closed message stores. Exim also has support for running LMTP
25531 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25532
25533 If this option is set to &"smtps"&, the default value for the &%port%& option
25534 changes to &"smtps"&, and the transport initiates TLS immediately after
25535 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25536 The Internet standards bodies used to strongly discourage use of this mode,
25537 but as of RFC 8314 it is perferred over STARTTLS for message submission
25538 (as distinct from MTA-MTA communication).
25539
25540
25541 .option retry_include_ip_address smtp boolean&!! true
25542 Exim normally includes both the host name and the IP address in the key it
25543 constructs for indexing retry data after a temporary delivery failure. This
25544 means that when one of several IP addresses for a host is failing, it gets
25545 tried periodically (controlled by the retry rules), but use of the other IP
25546 addresses is not affected.
25547
25548 However, in some dialup environments hosts are assigned a different IP address
25549 each time they connect. In this situation the use of the IP address as part of
25550 the retry key leads to undesirable behaviour. Setting this option false causes
25551 Exim to use only the host name.
25552 Since it is expanded it can be made to depend on the host or domain.
25553
25554
25555 .option serialize_hosts smtp "host list&!!" unset
25556 .cindex "serializing connections"
25557 .cindex "host" "serializing connections"
25558 Because Exim operates in a distributed manner, if several messages for the same
25559 host arrive at around the same time, more than one simultaneous connection to
25560 the remote host can occur. This is not usually a problem except when there is a
25561 slow link between the hosts. In that situation it may be helpful to restrict
25562 Exim to one connection at a time. This can be done by setting
25563 &%serialize_hosts%& to match the relevant hosts.
25564
25565 .cindex "hints database" "serializing deliveries to a host"
25566 Exim implements serialization by means of a hints database in which a record is
25567 written whenever a process connects to one of the restricted hosts. The record
25568 is deleted when the connection is completed. Obviously there is scope for
25569 records to get left lying around if there is a system or program crash. To
25570 guard against this, Exim ignores any records that are more than six hours old.
25571
25572 If you set up this kind of serialization, you should also arrange to delete the
25573 relevant hints database whenever your system reboots. The names of the files
25574 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25575 may be one or two files, depending on the type of DBM in use. The same files
25576 are used for ETRN serialization.
25577
25578 See also the &%max_parallel%& generic transport option.
25579
25580
25581 .option size_addition smtp integer 1024
25582 .cindex "SIZE" "ESMTP extension"
25583 .cindex "message" "size issue for transport filter"
25584 .cindex "size" "of message"
25585 .cindex "transport" "filter"
25586 .cindex "filter" "transport filter"
25587 If a remote SMTP server indicates that it supports the SIZE option of the
25588 MAIL command, Exim uses this to pass over the message size at the start of
25589 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25590 sends, to allow for headers and other text that may be added during delivery by
25591 configuration options or in a transport filter. It may be necessary to increase
25592 this if a lot of text is added to messages.
25593
25594 Alternatively, if the value of &%size_addition%& is set negative, it disables
25595 the use of the SIZE option altogether.
25596
25597
25598 .option socks_proxy smtp string&!! unset
25599 .cindex proxy SOCKS
25600 This option enables use of SOCKS proxies for connections made by the
25601 transport.  For details see section &<<SECTproxySOCKS>>&.
25602
25603
25604 .option tls_certificate smtp string&!! unset
25605 .cindex "TLS" "client certificate, location of"
25606 .cindex "certificate" "client, location of"
25607 .vindex "&$host$&"
25608 .vindex "&$host_address$&"
25609 The value of this option must be the absolute path to a file which contains the
25610 client's certificate, for possible use when sending a message over an encrypted
25611 connection. The values of &$host$& and &$host_address$& are set to the name and
25612 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25613 details of TLS.
25614
25615 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25616 certificate when sending messages as a client. The global option of the same
25617 name specifies the certificate for Exim as a server; it is not automatically
25618 assumed that the same certificate should be used when Exim is operating as a
25619 client.
25620
25621
25622 .option tls_crl smtp string&!! unset
25623 .cindex "TLS" "client certificate revocation list"
25624 .cindex "certificate" "revocation list for client"
25625 This option specifies a certificate revocation list. The expanded value must
25626 be the name of a file that contains a CRL in PEM format.
25627
25628
25629 .option tls_dh_min_bits smtp integer 1024
25630 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25631 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25632 key agreement is negotiated, the server will provide a large prime number
25633 for use.  This option establishes the minimum acceptable size of that number.
25634 If the parameter offered by the server is too small, then the TLS handshake
25635 will fail.
25636
25637 Only supported when using GnuTLS.
25638
25639
25640 .option tls_privatekey smtp string&!! unset
25641 .cindex "TLS" "client private key, location of"
25642 .vindex "&$host$&"
25643 .vindex "&$host_address$&"
25644 The value of this option must be the absolute path to a file which contains the
25645 client's private key. This is used when sending a message over an encrypted
25646 connection using a client certificate. The values of &$host$& and
25647 &$host_address$& are set to the name and address of the server during the
25648 expansion. If this option is unset, or the expansion is forced to fail, or the
25649 result is an empty string, the private key is assumed to be in the same file as
25650 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25651
25652
25653 .option tls_require_ciphers smtp string&!! unset
25654 .cindex "TLS" "requiring specific ciphers"
25655 .cindex "cipher" "requiring specific"
25656 .vindex "&$host$&"
25657 .vindex "&$host_address$&"
25658 The value of this option must be a list of permitted cipher suites, for use
25659 when setting up an outgoing encrypted connection. (There is a global option of
25660 the same name for controlling incoming connections.) The values of &$host$& and
25661 &$host_address$& are set to the name and address of the server during the
25662 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25663 is used in different ways by OpenSSL and GnuTLS (see sections
25664 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25665 ciphers is a preference order.
25666
25667
25668
25669 .option tls_sni smtp string&!! unset
25670 .cindex "TLS" "Server Name Indication"
25671 .vindex "&$tls_sni$&"
25672 If this option is set then it sets the $tls_out_sni variable and causes any
25673 TLS session to pass this value as the Server Name Indication extension to
25674 the remote side, which can be used by the remote side to select an appropriate
25675 certificate and private key for the session.
25676
25677 See &<<SECTtlssni>>& for more information.
25678
25679 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25680 TLS extensions.
25681
25682
25683
25684
25685 .option tls_tempfail_tryclear smtp boolean true
25686 .cindex "4&'xx'& responses" "to STARTTLS"
25687 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25688 setting up a TLS session, this option determines whether or not Exim should try
25689 to deliver the message unencrypted. If it is set false, delivery to the
25690 current host is deferred; if there are other hosts, they are tried. If this
25691 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25692 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25693 TLS negotiation fails, Exim closes the current connection (because it is in an
25694 unknown state), opens a new one to the same host, and then tries the delivery
25695 in clear.
25696
25697
25698 .option tls_try_verify_hosts smtp "host list&!!" *
25699 .cindex "TLS" "server certificate verification"
25700 .cindex "certificate" "verification of server"
25701 This option gives a list of hosts for which, on encrypted connections,
25702 certificate verification will be tried but need not succeed.
25703 The &%tls_verify_certificates%& option must also be set.
25704 Note that unless the host is in this list
25705 TLS connections will be denied to hosts using self-signed certificates
25706 when &%tls_verify_certificates%& is matched.
25707 The &$tls_out_certificate_verified$& variable is set when
25708 certificate verification succeeds.
25709
25710
25711 .option tls_verify_cert_hostnames smtp "host list&!!" *
25712 .cindex "TLS" "server certificate hostname verification"
25713 .cindex "certificate" "verification of server"
25714 This option give a list of hosts for which,
25715 while verifying the server certificate,
25716 checks will be included on the host name
25717 (note that this will generally be the result of a DNS MX lookup)
25718 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25719 limited to being the initial component of a 3-or-more component FQDN.
25720
25721 There is no equivalent checking on client certificates.
25722
25723
25724 .option tls_verify_certificates smtp string&!! system
25725 .cindex "TLS" "server certificate verification"
25726 .cindex "certificate" "verification of server"
25727 .vindex "&$host$&"
25728 .vindex "&$host_address$&"
25729 The value of this option must be either the
25730 word "system"
25731 or the absolute path to
25732 a file or directory containing permitted certificates for servers,
25733 for use when setting up an encrypted connection.
25734
25735 The "system" value for the option will use a location compiled into the SSL library.
25736 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25737 is taken as empty and an explicit location
25738 must be specified.
25739
25740 The use of a directory for the option value is not available for GnuTLS versions
25741 preceding 3.3.6 and a single file must be used.
25742
25743 With OpenSSL the certificates specified
25744 explicitly
25745 either by file or directory
25746 are added to those given by the system default location.
25747
25748 The values of &$host$& and
25749 &$host_address$& are set to the name and address of the server during the
25750 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25751
25752 For back-compatibility,
25753 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25754 (a single-colon empty list counts as being set)
25755 and certificate verification fails the TLS connection is closed.
25756
25757
25758 .option tls_verify_hosts smtp "host list&!!" unset
25759 .cindex "TLS" "server certificate verification"
25760 .cindex "certificate" "verification of server"
25761 This option gives a list of hosts for which, on encrypted connections,
25762 certificate verification must succeed.
25763 The &%tls_verify_certificates%& option must also be set.
25764 If both this option and &%tls_try_verify_hosts%& are unset
25765 operation is as if this option selected all hosts.
25766
25767 .option utf8_downconvert smtp integer&!! -1
25768 .cindex utf8 "address downconversion"
25769 .cindex i18n "utf8 address downconversion"
25770 If built with internationalization support,
25771 this option controls conversion of UTF-8 in message envelope addresses
25772 to a-label form.
25773 If, after expansion, the value is 1, 0, or -1 then this value overrides
25774 any value previously set for the message.  Otherwise, any previously
25775 set value is used.  To permit use of a previous value,
25776 set this option to an empty string.
25777 For details on the values see section &<<SECTi18nMTA>>&.
25778
25779
25780
25781
25782 .section "How the limits for the number of hosts to try are used" &&&
25783          "SECTvalhosmax"
25784 .cindex "host" "maximum number to try"
25785 .cindex "limit" "hosts; maximum number tried"
25786 There are two options that are concerned with the number of hosts that are
25787 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25788 &%hosts_max_try_hardlimit%&.
25789
25790
25791 The &%hosts_max_try%& option limits the number of hosts that are tried
25792 for a single delivery. However, despite the term &"host"& in its name, the
25793 option actually applies to each IP address independently. In other words, a
25794 multihomed host is treated as several independent hosts, just as it is for
25795 retrying.
25796
25797 Many of the larger ISPs have multiple MX records which often point to
25798 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25799 created as a result of routing one of these domains.
25800
25801 Trying every single IP address on such a long list does not seem sensible; if
25802 several at the top of the list fail, it is reasonable to assume there is some
25803 problem that is likely to affect all of them. Roughly speaking, the value of
25804 &%hosts_max_try%& is the maximum number that are tried before deferring the
25805 delivery. However, the logic cannot be quite that simple.
25806
25807 Firstly, IP addresses that are skipped because their retry times have not
25808 arrived do not count, and in addition, addresses that are past their retry
25809 limits are also not counted, even when they are tried. This means that when
25810 some IP addresses are past their retry limits, more than the value of
25811 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25812 that all IP addresses are considered before timing out an email address (but
25813 see below for an exception).
25814
25815 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25816 list to see if there is a subsequent host with a different (higher valued) MX.
25817 If there is, that host is considered next, and the current IP address is used
25818 but not counted. This behaviour helps in the case of a domain with a retry rule
25819 that hardly ever delays any hosts, as is now explained:
25820
25821 Consider the case of a long list of hosts with one MX value, and a few with a
25822 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25823 hosts at the top of the list are tried at first. With the default retry rule,
25824 which specifies increasing retry times, the higher MX hosts are eventually
25825 tried when those at the top of the list are skipped because they have not
25826 reached their retry times.
25827
25828 However, it is common practice to put a fixed short retry time on domains for
25829 large ISPs, on the grounds that their servers are rarely down for very long.
25830 Unfortunately, these are exactly the domains that tend to resolve to long lists
25831 of hosts. The short retry time means that the lowest MX hosts are tried every
25832 time. The attempts may be in a different order because of random sorting, but
25833 without the special MX check, the higher MX hosts would never be tried until
25834 all the lower MX hosts had timed out (which might be several days), because
25835 there are always some lower MX hosts that have reached their retry times. With
25836 the special check, Exim considers at least one IP address from each MX value at
25837 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25838 reached.
25839
25840 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25841 particular, Exim normally eventually tries all the IP addresses before timing
25842 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25843 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25844 been set up with hundreds of IP addresses for some domains. It can
25845 take a very long time indeed for an address to time out in these cases.
25846
25847 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25848 Exim never tries more than this number of IP addresses; if it hits this limit
25849 and they are all timed out, the email address is bounced, even though not all
25850 possible IP addresses have been tried.
25851 .ecindex IIDsmttra1
25852 .ecindex IIDsmttra2
25853
25854
25855
25856
25857
25858 . ////////////////////////////////////////////////////////////////////////////
25859 . ////////////////////////////////////////////////////////////////////////////
25860
25861 .chapter "Address rewriting" "CHAPrewrite"
25862 .scindex IIDaddrew "rewriting" "addresses"
25863 There are some circumstances in which Exim automatically rewrites domains in
25864 addresses. The two most common are when an address is given without a domain
25865 (referred to as an &"unqualified address"&) or when an address contains an
25866 abbreviated domain that is expanded by DNS lookup.
25867
25868 Unqualified envelope addresses are accepted only for locally submitted
25869 messages, or for messages that are received from hosts matching
25870 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25871 appropriate. Unqualified addresses in header lines are qualified if they are in
25872 locally submitted messages, or messages from hosts that are permitted to send
25873 unqualified envelope addresses. Otherwise, unqualified addresses in header
25874 lines are neither qualified nor rewritten.
25875
25876 One situation in which Exim does &'not'& automatically rewrite a domain is
25877 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25878 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25879 do this. The new RFCs do not contain this suggestion.
25880
25881
25882 .section "Explicitly configured address rewriting" "SECID147"
25883 This chapter describes the rewriting rules that can be used in the
25884 main rewrite section of the configuration file, and also in the generic
25885 &%headers_rewrite%& option that can be set on any transport.
25886
25887 Some people believe that configured address rewriting is a Mortal Sin.
25888 Others believe that life is not possible without it. Exim provides the
25889 facility; you do not have to use it.
25890
25891 The main rewriting rules that appear in the &"rewrite"& section of the
25892 configuration file are applied to addresses in incoming messages, both envelope
25893 addresses and addresses in header lines. Each rule specifies the types of
25894 address to which it applies.
25895
25896 Whether or not addresses in header lines are rewritten depends on the origin of
25897 the headers and the type of rewriting. Global rewriting, that is, rewriting
25898 rules from the rewrite section of the configuration file, is applied only to
25899 those headers that were received with the message. Header lines that are added
25900 by ACLs or by a system filter or by individual routers or transports (which
25901 are specific to individual recipient addresses) are not rewritten by the global
25902 rules.
25903
25904 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25905 applies all headers except those added by routers and transports. That is, as
25906 well as the headers that were received with the message, it also applies to
25907 headers that were added by an ACL or a system filter.
25908
25909
25910 In general, rewriting addresses from your own system or domain has some
25911 legitimacy. Rewriting other addresses should be done only with great care and
25912 in special circumstances. The author of Exim believes that rewriting should be
25913 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25914 Although it can sometimes be used as a routing tool, this is very strongly
25915 discouraged.
25916
25917 There are two commonly encountered circumstances where rewriting is used, as
25918 illustrated by these examples:
25919
25920 .ilist
25921 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25922 exchange mail with each other behind a firewall, but there is only a single
25923 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25924 &'hitch.fict.example'& when sending mail off-site.
25925 .next
25926 A host rewrites the local parts of its own users so that, for example,
25927 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25928 .endlist
25929
25930
25931
25932 .section "When does rewriting happen?" "SECID148"
25933 .cindex "rewriting" "timing of"
25934 .cindex "&ACL;" "rewriting addresses in"
25935 Configured address rewriting can take place at several different stages of a
25936 message's processing.
25937
25938 .vindex "&$sender_address$&"
25939 At the start of an ACL for MAIL, the sender address may have been rewritten
25940 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25941 ordinary rewrite rules have yet been applied. If, however, the sender address
25942 is verified in the ACL, it is rewritten before verification, and remains
25943 rewritten thereafter. The subsequent value of &$sender_address$& is the
25944 rewritten address. This also applies if sender verification happens in a
25945 RCPT ACL. Otherwise, when the sender address is not verified, it is
25946 rewritten as soon as a message's header lines have been received.
25947
25948 .vindex "&$domain$&"
25949 .vindex "&$local_part$&"
25950 Similarly, at the start of an ACL for RCPT, the current recipient's address
25951 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25952 rewrite rules have yet been applied to it. However, the behaviour is different
25953 from the sender address when a recipient is verified. The address is rewritten
25954 for the verification, but the rewriting is not remembered at this stage. The
25955 value of &$local_part$& and &$domain$& after verification are always the same
25956 as they were before (that is, they contain the unrewritten &-- except for
25957 SMTP-time rewriting &-- address).
25958
25959 As soon as a message's header lines have been received, all the envelope
25960 recipient addresses are permanently rewritten, and rewriting is also applied to
25961 the addresses in the header lines (if configured). This happens before adding
25962 any header lines that were specified in MAIL or RCPT ACLs, and
25963 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25964 before the DATA ACL and &[local_scan()]& functions are run.
25965
25966 When an address is being routed, either for delivery or for verification,
25967 rewriting is applied immediately to child addresses that are generated by
25968 redirection, unless &%no_rewrite%& is set on the router.
25969
25970 .cindex "envelope from"
25971 .cindex "envelope sender" "rewriting at transport time"
25972 .cindex "rewriting" "at transport time"
25973 .cindex "header lines" "rewriting at transport time"
25974 At transport time, additional rewriting of addresses in header lines can be
25975 specified by setting the generic &%headers_rewrite%& option on a transport.
25976 This option contains rules that are identical in form to those in the rewrite
25977 section of the configuration file. They are applied to the original message
25978 header lines and any that were added by ACLs or a system filter. They are not
25979 applied to header lines that are added by routers or the transport.
25980
25981 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25982 transport option. However, it is not possible to rewrite envelope recipients at
25983 transport time.
25984
25985
25986
25987
25988 .section "Testing the rewriting rules that apply on input" "SECID149"
25989 .cindex "rewriting" "testing"
25990 .cindex "testing" "rewriting"
25991 Exim's input rewriting configuration appears in a part of the runtime
25992 configuration file headed by &"begin rewrite"&. It can be tested by the
25993 &%-brw%& command line option. This takes an address (which can be a full RFC
25994 2822 address) as its argument. The output is a list of how the address would be
25995 transformed by the rewriting rules for each of the different places it might
25996 appear in an incoming message, that is, for each different header and for the
25997 envelope sender and recipient fields. For example,
25998 .code
25999 exim -brw ph10@exim.workshop.example
26000 .endd
26001 might produce the output
26002 .code
26003 sender: Philip.Hazel@exim.workshop.example
26004 from: Philip.Hazel@exim.workshop.example
26005 to: ph10@exim.workshop.example
26006 cc: ph10@exim.workshop.example
26007 bcc: ph10@exim.workshop.example
26008 reply-to: Philip.Hazel@exim.workshop.example
26009 env-from: Philip.Hazel@exim.workshop.example
26010 env-to: ph10@exim.workshop.example
26011 .endd
26012 which shows that rewriting has been set up for that address when used in any of
26013 the source fields, but not when it appears as a recipient address. At the
26014 present time, there is no equivalent way of testing rewriting rules that are
26015 set for a particular transport.
26016
26017
26018 .section "Rewriting rules" "SECID150"
26019 .cindex "rewriting" "rules"
26020 The rewrite section of the configuration file consists of lines of rewriting
26021 rules in the form
26022 .display
26023 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26024 .endd
26025 Rewriting rules that are specified for the &%headers_rewrite%& generic
26026 transport option are given as a colon-separated list. Each item in the list
26027 takes the same form as a line in the main rewriting configuration (except that
26028 any colons must be doubled, of course).
26029
26030 The formats of source patterns and replacement strings are described below.
26031 Each is terminated by white space, unless enclosed in double quotes, in which
26032 case normal quoting conventions apply inside the quotes. The flags are single
26033 characters which may appear in any order. Spaces and tabs between them are
26034 ignored.
26035
26036 For each address that could potentially be rewritten, the rules are scanned in
26037 order, and replacements for the address from earlier rules can themselves be
26038 replaced by later rules (but see the &"q"& and &"R"& flags).
26039
26040 The order in which addresses are rewritten is undefined, may change between
26041 releases, and must not be relied on, with one exception: when a message is
26042 received, the envelope sender is always rewritten first, before any header
26043 lines are rewritten. For example, the replacement string for a rewrite of an
26044 address in &'To:'& must not assume that the message's address in &'From:'& has
26045 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26046 that the envelope sender has already been rewritten.
26047
26048 .vindex "&$domain$&"
26049 .vindex "&$local_part$&"
26050 The variables &$local_part$& and &$domain$& can be used in the replacement
26051 string to refer to the address that is being rewritten. Note that lookup-driven
26052 rewriting can be done by a rule of the form
26053 .code
26054 *@*   ${lookup ...
26055 .endd
26056 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26057 refer to the address that is being rewritten.
26058
26059
26060 .section "Rewriting patterns" "SECID151"
26061 .cindex "rewriting" "patterns"
26062 .cindex "address list" "in a rewriting pattern"
26063 The source pattern in a rewriting rule is any item which may appear in an
26064 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26065 single-item address list, which means that it is expanded before being tested
26066 against the address. As always, if you use a regular expression as a pattern,
26067 you must take care to escape dollar and backslash characters, or use the &`\N`&
26068 facility to suppress string expansion within the regular expression.
26069
26070 Domains in patterns should be given in lower case. Local parts in patterns are
26071 case-sensitive. If you want to do case-insensitive matching of local parts, you
26072 can use a regular expression that starts with &`^(?i)`&.
26073
26074 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26075 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26076 depending on the type of match which occurred. These can be used in the
26077 replacement string to insert portions of the incoming address. &$0$& always
26078 refers to the complete incoming address. When a regular expression is used, the
26079 numerical variables are set from its capturing subexpressions. For other types
26080 of pattern they are set as follows:
26081
26082 .ilist
26083 If a local part or domain starts with an asterisk, the numerical variables
26084 refer to the character strings matched by asterisks, with &$1$& associated with
26085 the first asterisk, and &$2$& with the second, if present. For example, if the
26086 pattern
26087 .code
26088 *queen@*.fict.example
26089 .endd
26090 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26091 .code
26092 $0 = hearts-queen@wonderland.fict.example
26093 $1 = hearts-
26094 $2 = wonderland
26095 .endd
26096 Note that if the local part does not start with an asterisk, but the domain
26097 does, it is &$1$& that contains the wild part of the domain.
26098
26099 .next
26100 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26101 of the domain are placed in the next available numerical variables. Suppose,
26102 for example, that the address &'foo@bar.baz.example'& is processed by a
26103 rewriting rule of the form
26104 .display
26105 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26106 .endd
26107 and the key in the file that matches the domain is &`*.baz.example`&. Then
26108 .code
26109 $1 = foo
26110 $2 = bar
26111 $3 = baz.example
26112 .endd
26113 If the address &'foo@baz.example'& is looked up, this matches the same
26114 wildcard file entry, and in this case &$2$& is set to the empty string, but
26115 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26116 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26117 whole domain. For non-partial domain lookups, no numerical variables are set.
26118 .endlist
26119
26120
26121 .section "Rewriting replacements" "SECID152"
26122 .cindex "rewriting" "replacements"
26123 If the replacement string for a rule is a single asterisk, addresses that
26124 match the pattern and the flags are &'not'& rewritten, and no subsequent
26125 rewriting rules are scanned. For example,
26126 .code
26127 hatta@lookingglass.fict.example  *  f
26128 .endd
26129 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26130 &'From:'& headers.
26131
26132 .vindex "&$domain$&"
26133 .vindex "&$local_part$&"
26134 If the replacement string is not a single asterisk, it is expanded, and must
26135 yield a fully qualified address. Within the expansion, the variables
26136 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26137 Any letters they contain retain their original case &-- they are not lower
26138 cased. The numerical variables are set up according to the type of pattern that
26139 matched the address, as described above. If the expansion is forced to fail by
26140 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26141 current rule is abandoned, but subsequent rules may take effect. Any other
26142 expansion failure causes the entire rewriting operation to be abandoned, and an
26143 entry written to the panic log.
26144
26145
26146
26147 .section "Rewriting flags" "SECID153"
26148 There are three different kinds of flag that may appear on rewriting rules:
26149
26150 .ilist
26151 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26152 c, f, h, r, s, t.
26153 .next
26154 A flag that specifies rewriting at SMTP time: S.
26155 .next
26156 Flags that control the rewriting process: Q, q, R, w.
26157 .endlist
26158
26159 For rules that are part of the &%headers_rewrite%& generic transport option,
26160 E, F, T, and S are not permitted.
26161
26162
26163
26164 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26165          "SECID154"
26166 .cindex "rewriting" "flags"
26167 If none of the following flag letters, nor the &"S"& flag (see section
26168 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26169 and to both the sender and recipient fields of the envelope, whereas a
26170 transport-time rewriting rule just applies to all headers. Otherwise, the
26171 rewriting rule is skipped unless the relevant addresses are being processed.
26172 .display
26173 &`E`&       rewrite all envelope fields
26174 &`F`&       rewrite the envelope From field
26175 &`T`&       rewrite the envelope To field
26176 &`b`&       rewrite the &'Bcc:'& header
26177 &`c`&       rewrite the &'Cc:'& header
26178 &`f`&       rewrite the &'From:'& header
26179 &`h`&       rewrite all headers
26180 &`r`&       rewrite the &'Reply-To:'& header
26181 &`s`&       rewrite the &'Sender:'& header
26182 &`t`&       rewrite the &'To:'& header
26183 .endd
26184 "All headers" means all of the headers listed above that can be selected
26185 individually, plus their &'Resent-'& versions. It does not include
26186 other headers such as &'Subject:'& etc.
26187
26188 You should be particularly careful about rewriting &'Sender:'& headers, and
26189 restrict this to special known cases in your own domains.
26190
26191
26192 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26193 .cindex "SMTP" "rewriting malformed addresses"
26194 .cindex "RCPT" "rewriting argument of"
26195 .cindex "MAIL" "rewriting argument of"
26196 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26197 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26198 before any other processing; even before syntax checking. The pattern is
26199 required to be a regular expression, and it is matched against the whole of the
26200 data for the command, including any surrounding angle brackets.
26201
26202 .vindex "&$domain$&"
26203 .vindex "&$local_part$&"
26204 This form of rewrite rule allows for the handling of addresses that are not
26205 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26206 input). Because the input is not required to be a syntactically valid address,
26207 the variables &$local_part$& and &$domain$& are not available during the
26208 expansion of the replacement string. The result of rewriting replaces the
26209 original address in the MAIL or RCPT command.
26210
26211
26212 .section "Flags controlling the rewriting process" "SECID155"
26213 There are four flags which control the way the rewriting process works. These
26214 take effect only when a rule is invoked, that is, when the address is of the
26215 correct type (matches the flags) and matches the pattern:
26216
26217 .ilist
26218 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26219 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26220 absence of &"Q"& the rewritten address must always include a domain.
26221 .next
26222 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26223 even if no rewriting actually takes place because of a &"fail"& in the
26224 expansion. The &"q"& flag is not effective if the address is of the wrong type
26225 (does not match the flags) or does not match the pattern.
26226 .next
26227 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26228 address, up to ten times. It can be combined with the &"q"& flag, to stop
26229 rewriting once it fails to match (after at least one successful rewrite).
26230 .next
26231 .cindex "rewriting" "whole addresses"
26232 When an address in a header is rewritten, the rewriting normally applies only
26233 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26234 left unchanged. For example, rewriting might change
26235 .code
26236 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26237 .endd
26238 into
26239 .code
26240 From: Ford Prefect <prefectf@hitch.fict.example>
26241 .endd
26242 .cindex "RFC 2047"
26243 Sometimes there is a need to replace the whole address item, and this can be
26244 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26245 causes an address in a header line to be rewritten, the entire address is
26246 replaced, not just the working part. The replacement must be a complete RFC
26247 2822 address, including the angle brackets if necessary. If text outside angle
26248 brackets contains a character whose value is greater than 126 or less than 32
26249 (except for tab), the text is encoded according to RFC 2047. The character set
26250 is taken from &%headers_charset%&, which gets its default at build time.
26251
26252 When the &"w"& flag is set on a rule that causes an envelope address to be
26253 rewritten, all but the working part of the replacement address is discarded.
26254 .endlist
26255
26256
26257 .section "Rewriting examples" "SECID156"
26258 Here is an example of the two common rewriting paradigms:
26259 .code
26260 *@*.hitch.fict.example  $1@hitch.fict.example
26261 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26262                      {$value}fail}@hitch.fict.example bctfrF
26263 .endd
26264 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26265 the string expansion to fail if the lookup does not succeed. In this context it
26266 has the effect of leaving the original address unchanged, but Exim goes on to
26267 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26268 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26269 explicitly, which would cause the rewritten address to be the same as before,
26270 at the cost of a small bit of processing. Not supplying either of these is an
26271 error, since the rewritten address would then contain no local part.
26272
26273 The first example above replaces the domain with a superior, more general
26274 domain. This may not be desirable for certain local parts. If the rule
26275 .code
26276 root@*.hitch.fict.example  *
26277 .endd
26278 were inserted before the first rule, rewriting would be suppressed for the
26279 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26280
26281 Rewriting can be made conditional on a number of tests, by making use of
26282 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26283 messages that originate outside the local host:
26284 .code
26285 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26286                          {$1@hitch.fict.example}fail}"
26287 .endd
26288 The replacement string is quoted in this example because it contains white
26289 space.
26290
26291 .cindex "rewriting" "bang paths"
26292 .cindex "bang paths" "rewriting"
26293 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26294 an address it treats it as an unqualified local part which it qualifies with
26295 the local qualification domain (if the source of the message is local or if the
26296 remote host is permitted to send unqualified addresses). Rewriting can
26297 sometimes be used to handle simple bang paths with a fixed number of
26298 components. For example, the rule
26299 .code
26300 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26301 .endd
26302 rewrites a two-component bang path &'host.name!user'& as the domain address
26303 &'user@host.name'&. However, there is a security implication in using this as
26304 a global rewriting rule for envelope addresses. It can provide a backdoor
26305 method for using your system as a relay, because the incoming addresses appear
26306 to be local. If the bang path addresses are received via SMTP, it is safer to
26307 use the &"S"& flag to rewrite them as they are received, so that relay checking
26308 can be done on the rewritten addresses.
26309 .ecindex IIDaddrew
26310
26311
26312
26313
26314
26315 . ////////////////////////////////////////////////////////////////////////////
26316 . ////////////////////////////////////////////////////////////////////////////
26317
26318 .chapter "Retry configuration" "CHAPretry"
26319 .scindex IIDretconf1 "retry" "configuration, description of"
26320 .scindex IIDregconf2 "configuration file" "retry section"
26321 The &"retry"& section of the runtime configuration file contains a list of
26322 retry rules that control how often Exim tries to deliver messages that cannot
26323 be delivered at the first attempt. If there are no retry rules (the section is
26324 empty or not present), there are no retries. In this situation, temporary
26325 errors are treated as permanent. The default configuration contains a single,
26326 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26327 line option can be used to test which retry rule will be used for a given
26328 address, domain and error.
26329
26330 The most common cause of retries is temporary failure to deliver to a remote
26331 host because the host is down, or inaccessible because of a network problem.
26332 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26333 address) basis, not on a per-message basis. Thus, if one message has recently
26334 been delayed, delivery of a new message to the same host is not immediately
26335 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26336 log selector is set, the message
26337 .cindex "retry" "time not reached"
26338 &"retry time not reached"& is written to the main log whenever a delivery is
26339 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26340 the handling of errors during remote deliveries.
26341
26342 Retry processing applies to routing as well as to delivering, except as covered
26343 in the next paragraph. The retry rules do not distinguish between these
26344 actions. It is not possible, for example, to specify different behaviour for
26345 failures to route the domain &'snark.fict.example'& and failures to deliver to
26346 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26347 added complication, so did not implement it. However, although they share the
26348 same retry rule, the actual retry times for routing and transporting a given
26349 domain are maintained independently.
26350
26351 When a delivery is not part of a queue run (typically an immediate delivery on
26352 receipt of a message), the routers are always run, and local deliveries are
26353 always attempted, even if retry times are set for them. This makes for better
26354 behaviour if one particular message is causing problems (for example, causing
26355 quota overflow, or provoking an error in a filter file). If such a delivery
26356 suffers a temporary failure, the retry data is updated as normal, and
26357 subsequent delivery attempts from queue runs occur only when the retry time for
26358 the local address is reached.
26359
26360 .section "Changing retry rules" "SECID157"
26361 If you change the retry rules in your configuration, you should consider
26362 whether or not to delete the retry data that is stored in Exim's spool area in
26363 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26364 always safe; that is why they are called &"hints"&.
26365
26366 The hints retry data contains suggested retry times based on the previous
26367 rules. In the case of a long-running problem with a remote host, it might
26368 record the fact that the host has timed out. If your new rules increase the
26369 timeout time for such a host, you should definitely remove the old retry data
26370 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26371 messages that it should now be retaining.
26372
26373
26374
26375 .section "Format of retry rules" "SECID158"
26376 .cindex "retry" "rules"
26377 Each retry rule occupies one line and consists of three or four parts,
26378 separated by white space: a pattern, an error name, an optional list of sender
26379 addresses, and a list of retry parameters. The pattern and sender lists must be
26380 enclosed in double quotes if they contain white space. The rules are searched
26381 in order until one is found where the pattern, error name, and sender list (if
26382 present) match the failing host or address, the error that occurred, and the
26383 message's sender, respectively.
26384
26385
26386 The pattern is any single item that may appear in an address list (see section
26387 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26388 which means that it is expanded before being tested against the address that
26389 has been delayed. A negated address list item is permitted. Address
26390 list processing treats a plain domain name as if it were preceded by &"*@"&,
26391 which makes it possible for many retry rules to start with just a domain. For
26392 example,
26393 .code
26394 lookingglass.fict.example        *  F,24h,30m;
26395 .endd
26396 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26397 whereas
26398 .code
26399 alice@lookingglass.fict.example  *  F,24h,30m;
26400 .endd
26401 applies only to temporary failures involving the local part &%alice%&.
26402 In practice, almost all rules start with a domain name pattern without a local
26403 part.
26404
26405 .cindex "regular expressions" "in retry rules"
26406 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26407 must match a complete address, not just a domain, because that is how regular
26408 expressions work in address lists.
26409 .display
26410 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26411 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26412 .endd
26413
26414
26415 .section "Choosing which retry rule to use for address errors" "SECID159"
26416 When Exim is looking for a retry rule after a routing attempt has failed (for
26417 example, after a DNS timeout), each line in the retry configuration is tested
26418 against the complete address only if &%retry_use_local_part%& is set for the
26419 router. Otherwise, only the domain is used, except when matching against a
26420 regular expression, when the local part of the address is replaced with &"*"&.
26421 A domain on its own can match a domain pattern, or a pattern that starts with
26422 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26423 &%check_local_user%& is true, and false for other routers.
26424
26425 Similarly, when Exim is looking for a retry rule after a local delivery has
26426 failed (for example, after a mailbox full error), each line in the retry
26427 configuration is tested against the complete address only if
26428 &%retry_use_local_part%& is set for the transport (it defaults true for all
26429 local transports).
26430
26431 .cindex "4&'xx'& responses" "retry rules for"
26432 However, when Exim is looking for a retry rule after a remote delivery attempt
26433 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26434 whole address is always used as the key when searching the retry rules. The
26435 rule that is found is used to create a retry time for the combination of the
26436 failing address and the message's sender. It is the combination of sender and
26437 recipient that is delayed in subsequent queue runs until its retry time is
26438 reached. You can delay the recipient without regard to the sender by setting
26439 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26440 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26441 commands.
26442
26443
26444
26445 .section "Choosing which retry rule to use for host and message errors" &&&
26446          "SECID160"
26447 For a temporary error that is not related to an individual address (for
26448 example, a connection timeout), each line in the retry configuration is checked
26449 twice. First, the name of the remote host is used as a domain name (preceded by
26450 &"*@"& when matching a regular expression). If this does not match the line,
26451 the domain from the email address is tried in a similar fashion. For example,
26452 suppose the MX records for &'a.b.c.example'& are
26453 .code
26454 a.b.c.example  MX  5  x.y.z.example
26455                MX  6  p.q.r.example
26456                MX  7  m.n.o.example
26457 .endd
26458 and the retry rules are
26459 .code
26460 p.q.r.example    *      F,24h,30m;
26461 a.b.c.example    *      F,4d,45m;
26462 .endd
26463 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26464 first rule matches neither the host nor the domain, so Exim looks at the second
26465 rule. This does not match the host, but it does match the domain, so it is used
26466 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26467 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26468 first retry rule is used, because it matches the host.
26469
26470 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26471 first rule to determine retry times, but for all the other hosts for the domain
26472 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26473 routing to &'a.b.c.example'& suffers a temporary failure.
26474
26475 &*Note*&: The host name is used when matching the patterns, not its IP address.
26476 However, if a message is routed directly to an IP address without the use of a
26477 host name, for example, if a &(manualroute)& router contains a setting such as:
26478 .code
26479 route_list = *.a.example  192.168.34.23
26480 .endd
26481 then the &"host name"& that is used when searching for a retry rule is the
26482 textual form of the IP address.
26483
26484 .section "Retry rules for specific errors" "SECID161"
26485 .cindex "retry" "specific errors; specifying"
26486 The second field in a retry rule is the name of a particular error, or an
26487 asterisk, which matches any error. The errors that can be tested for are:
26488
26489 .vlist
26490 .vitem &%auth_failed%&
26491 Authentication failed when trying to send to a host in the
26492 &%hosts_require_auth%& list in an &(smtp)& transport.
26493
26494 .vitem &%data_4xx%&
26495 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26496 after the command, or after sending the message's data.
26497
26498 .vitem &%mail_4xx%&
26499 A 4&'xx'& error was received for an outgoing MAIL command.
26500
26501 .vitem &%rcpt_4xx%&
26502 A 4&'xx'& error was received for an outgoing RCPT command.
26503 .endlist
26504
26505 For the three 4&'xx'& errors, either the first or both of the x's can be given
26506 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26507 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26508 and have retries every ten minutes with a one-hour timeout, you could set up a
26509 retry rule of this form:
26510 .code
26511 the.domain.name  rcpt_452   F,1h,10m
26512 .endd
26513 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26514 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26515
26516 .vlist
26517 .vitem &%lost_connection%&
26518 A server unexpectedly closed the SMTP connection. There may, of course,
26519 legitimate reasons for this (host died, network died), but if it repeats a lot
26520 for the same host, it indicates something odd.
26521
26522 .vitem &%lookup%&
26523 A DNS lookup for a host failed.
26524 Note that a &%dnslookup%& router will need to have matched
26525 its &%fail_defer_domains%& option for this retry type to be usable.
26526 Also note that a &%manualroute%& router will probably need
26527 its &%host_find_failed%& option set to &%defer%&.
26528
26529 .vitem &%refused_MX%&
26530 A connection to a host obtained from an MX record was refused.
26531
26532 .vitem &%refused_A%&
26533 A connection to a host not obtained from an MX record was refused.
26534
26535 .vitem &%refused%&
26536 A connection was refused.
26537
26538 .vitem &%timeout_connect_MX%&
26539 A connection attempt to a host obtained from an MX record timed out.
26540
26541 .vitem &%timeout_connect_A%&
26542 A connection attempt to a host not obtained from an MX record timed out.
26543
26544 .vitem &%timeout_connect%&
26545 A connection attempt timed out.
26546
26547 .vitem &%timeout_MX%&
26548 There was a timeout while connecting or during an SMTP session with a host
26549 obtained from an MX record.
26550
26551 .vitem &%timeout_A%&
26552 There was a timeout while connecting or during an SMTP session with a host not
26553 obtained from an MX record.
26554
26555 .vitem &%timeout%&
26556 There was a timeout while connecting or during an SMTP session.
26557
26558 .vitem &%tls_required%&
26559 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26560 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26561 to STARTTLS, or there was a problem setting up the TLS connection.
26562
26563 .vitem &%quota%&
26564 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26565 transport.
26566
26567 .vitem &%quota_%&<&'time'&>
26568 .cindex "quota" "error testing in retry rule"
26569 .cindex "retry" "quota error testing"
26570 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26571 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26572 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26573 for four days.
26574 .endlist
26575
26576 .cindex "mailbox" "time of last read"
26577 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26578 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26579 it should be based on the last time that the user accessed the mailbox.
26580 However, it is not always possible to determine this. Exim uses the following
26581 heuristic rules:
26582
26583 .ilist
26584 If the mailbox is a single file, the time of last access (the &"atime"&) is
26585 used. As no new messages are being delivered (because the mailbox is over
26586 quota), Exim does not access the file, so this is the time of last user access.
26587 .next
26588 .cindex "maildir format" "time of last read"
26589 For a maildir delivery, the time of last modification of the &_new_&
26590 subdirectory is used. As the mailbox is over quota, no new files are created in
26591 the &_new_& subdirectory, because no new messages are being delivered. Any
26592 change to the &_new_& subdirectory is therefore assumed to be the result of an
26593 MUA moving a new message to the &_cur_& directory when it is first read. The
26594 time that is used is therefore the last time that the user read a new message.
26595 .next
26596 For other kinds of multi-file mailbox, the time of last access cannot be
26597 obtained, so a retry rule that uses this type of error field is never matched.
26598 .endlist
26599
26600 The quota errors apply both to system-enforced quotas and to Exim's own quota
26601 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26602 when a local delivery is deferred because a partition is full (the ENOSPC
26603 error).
26604
26605
26606
26607 .section "Retry rules for specified senders" "SECID162"
26608 .cindex "retry" "rules; sender-specific"
26609 You can specify retry rules that apply only when the failing message has a
26610 specific sender. In particular, this can be used to define retry rules that
26611 apply only to bounce messages. The third item in a retry rule can be of this
26612 form:
26613 .display
26614 &`senders=`&<&'address list'&>
26615 .endd
26616 The retry timings themselves are then the fourth item. For example:
26617 .code
26618 *   rcpt_4xx   senders=:   F,1h,30m
26619 .endd
26620 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26621 host. If the address list contains white space, it must be enclosed in quotes.
26622 For example:
26623 .code
26624 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26625 .endd
26626 &*Warning*&: This facility can be unhelpful if it is used for host errors
26627 (which do not depend on the recipient). The reason is that the sender is used
26628 only to match the retry rule. Once the rule has been found for a host error,
26629 its contents are used to set a retry time for the host, and this will apply to
26630 all messages, not just those with specific senders.
26631
26632 When testing retry rules using &%-brt%&, you can supply a sender using the
26633 &%-f%& command line option, like this:
26634 .code
26635 exim -f "" -brt user@dom.ain
26636 .endd
26637 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26638 list is never matched.
26639
26640
26641
26642
26643
26644 .section "Retry parameters" "SECID163"
26645 .cindex "retry" "parameters in rules"
26646 The third (or fourth, if a senders list is present) field in a retry rule is a
26647 sequence of retry parameter sets, separated by semicolons. Each set consists of
26648 .display
26649 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26650 .endd
26651 The letter identifies the algorithm for computing a new retry time; the cutoff
26652 time is the time beyond which this algorithm no longer applies, and the
26653 arguments vary the algorithm's action. The cutoff time is measured from the
26654 time that the first failure for the domain (combined with the local part if
26655 relevant) was detected, not from the time the message was received.
26656
26657 .cindex "retry" "algorithms"
26658 .cindex "retry" "fixed intervals"
26659 .cindex "retry" "increasing intervals"
26660 .cindex "retry" "random intervals"
26661 The available algorithms are:
26662
26663 .ilist
26664 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26665 the interval.
26666 .next
26667 &'G'&: retry at geometrically increasing intervals. The first argument
26668 specifies a starting value for the interval, and the second a multiplier, which
26669 is used to increase the size of the interval at each retry.
26670 .next
26671 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26672 retry, the previous interval is multiplied by the factor in order to get a
26673 maximum for the next interval. The minimum interval is the first argument of
26674 the parameter, and an actual interval is chosen randomly between them. Such a
26675 rule has been found to be helpful in cluster configurations when all the
26676 members of the cluster restart at once, and may therefore synchronize their
26677 queue processing times.
26678 .endlist
26679
26680 When computing the next retry time, the algorithm definitions are scanned in
26681 order until one whose cutoff time has not yet passed is reached. This is then
26682 used to compute a new retry time that is later than the current time. In the
26683 case of fixed interval retries, this simply means adding the interval to the
26684 current time. For geometrically increasing intervals, retry intervals are
26685 computed from the rule's parameters until one that is greater than the previous
26686 interval is found. The main configuration variable
26687 .cindex "limit" "retry interval"
26688 .cindex "retry" "interval, maximum"
26689 .oindex "&%retry_interval_max%&"
26690 &%retry_interval_max%& limits the maximum interval between retries. It
26691 cannot be set greater than &`24h`&, which is its default value.
26692
26693 A single remote domain may have a number of hosts associated with it, and each
26694 host may have more than one IP address. Retry algorithms are selected on the
26695 basis of the domain name, but are applied to each IP address independently. If,
26696 for example, a host has two IP addresses and one is unusable, Exim will
26697 generate retry times for it and will not try to use it until its next retry
26698 time comes. Thus the good IP address is likely to be tried first most of the
26699 time.
26700
26701 .cindex "hints database" "use for retrying"
26702 Retry times are hints rather than promises. Exim does not make any attempt to
26703 run deliveries exactly at the computed times. Instead, a queue runner process
26704 starts delivery processes for delayed messages periodically, and these attempt
26705 new deliveries only for those addresses that have passed their next retry time.
26706 If a new message arrives for a deferred address, an immediate delivery attempt
26707 occurs only if the address has passed its retry time. In the absence of new
26708 messages, the minimum time between retries is the interval between queue runner
26709 processes. There is not much point in setting retry times of five minutes if
26710 your queue runners happen only once an hour, unless there are a significant
26711 number of incoming messages (which might be the case on a system that is
26712 sending everything to a smart host, for example).
26713
26714 The data in the retry hints database can be inspected by using the
26715 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26716 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26717 &'exinext'& utility script can be used to find out what the next retry times
26718 are for the hosts associated with a particular mail domain, and also for local
26719 deliveries that have been deferred.
26720
26721
26722 .section "Retry rule examples" "SECID164"
26723 Here are some example retry rules:
26724 .code
26725 alice@wonderland.fict.example quota_5d  F,7d,3h
26726 wonderland.fict.example       quota_5d
26727 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26728 lookingglass.fict.example     *         F,24h,30m;
26729 *                 refused_A   F,2h,20m;
26730 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26731 .endd
26732 The first rule sets up special handling for mail to
26733 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26734 mailbox has not been read for at least 5 days. Retries continue every three
26735 hours for 7 days. The second rule handles over-quota errors for all other local
26736 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26737 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26738 fail are bounced immediately if the mailbox has not been read for at least 5
26739 days.
26740
26741 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26742 happen every 15 minutes for an hour, then with geometrically increasing
26743 intervals until two days have passed since a delivery first failed. After the
26744 first hour there is a delay of one hour, then two hours, then four hours, and
26745 so on (this is a rather extreme example).
26746
26747 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26748 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26749 all other domains, with special action for connection refusal from hosts that
26750 were not obtained from an MX record.
26751
26752 The final rule in a retry configuration should always have asterisks in the
26753 first two fields so as to provide a general catch-all for any addresses that do
26754 not have their own special handling. This example tries every 15 minutes for 2
26755 hours, then with intervals starting at one hour and increasing by a factor of
26756 1.5 up to 16 hours, then every 8 hours up to 5 days.
26757
26758
26759
26760 .section "Timeout of retry data" "SECID165"
26761 .cindex "timeout" "of retry data"
26762 .oindex "&%retry_data_expire%&"
26763 .cindex "hints database" "data expiry"
26764 .cindex "retry" "timeout of data"
26765 Exim timestamps the data that it writes to its retry hints database. When it
26766 consults the data during a delivery it ignores any that is older than the value
26767 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26768 been tried for 7 days, Exim will try to deliver to it immediately a message
26769 arrives, and if that fails, it will calculate a retry time as if it were
26770 failing for the first time.
26771
26772 This improves the behaviour for messages routed to rarely-used hosts such as MX
26773 backups. If such a host was down at one time, and happens to be down again when
26774 Exim tries a month later, using the old retry data would imply that it had been
26775 down all the time, which is not a justified assumption.
26776
26777 If a host really is permanently dead, this behaviour causes a burst of retries
26778 every now and again, but only if messages routed to it are rare. If there is a
26779 message at least once every 7 days the retry data never expires.
26780
26781
26782
26783
26784 .section "Long-term failures" "SECID166"
26785 .cindex "delivery failure, long-term"
26786 .cindex "retry" "after long-term failure"
26787 Special processing happens when an email address has been failing for so long
26788 that the cutoff time for the last algorithm is reached. For example, using the
26789 default retry rule:
26790 .code
26791 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26792 .endd
26793 the cutoff time is four days. Reaching the retry cutoff is independent of how
26794 long any specific message has been failing; it is the length of continuous
26795 failure for the recipient address that counts.
26796
26797 When the cutoff time is reached for a local delivery, or for all the IP
26798 addresses associated with a remote delivery, a subsequent delivery failure
26799 causes Exim to give up on the address, and a bounce message is generated.
26800 In order to cater for new messages that use the failing address, a next retry
26801 time is still computed from the final algorithm, and is used as follows:
26802
26803 For local deliveries, one delivery attempt is always made for any subsequent
26804 messages. If this delivery fails, the address fails immediately. The
26805 post-cutoff retry time is not used.
26806
26807 .cindex "final cutoff" "retries, controlling"
26808 .cindex retry "final cutoff"
26809 If the delivery is remote, there are two possibilities, controlled by the
26810 .oindex "&%delay_after_cutoff%&"
26811 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26812 default. Until the post-cutoff retry time for one of the IP addresses,
26813 as set by the &%retry_data_expire%& option, is
26814 reached, the failing email address is bounced immediately, without a delivery
26815 attempt taking place. After that time, one new delivery attempt is made to
26816 those IP addresses that are past their retry times, and if that still fails,
26817 the address is bounced and new retry times are computed.
26818
26819 In other words, when all the hosts for a given email address have been failing
26820 for a long time, Exim bounces rather then defers until one of the hosts' retry
26821 times is reached. Then it tries once, and bounces if that attempt fails. This
26822 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26823 to a broken destination, but if the host does recover, Exim will eventually
26824 notice.
26825
26826 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26827 addresses are past their final cutoff time, Exim tries to deliver to those IP
26828 addresses that have not been tried since the message arrived. If there are
26829 no suitable IP addresses, or if they all fail, the address is bounced. In other
26830 words, it does not delay when a new message arrives, but tries the expired
26831 addresses immediately, unless they have been tried since the message arrived.
26832 If there is a continuous stream of messages for the failing domains, setting
26833 &%delay_after_cutoff%& false means that there will be many more attempts to
26834 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26835 true.
26836
26837 .section "Deliveries that work intermittently" "SECID167"
26838 .cindex "retry" "intermittently working deliveries"
26839 Some additional logic is needed to cope with cases where a host is
26840 intermittently available, or when a message has some attribute that prevents
26841 its delivery when others to the same address get through. In this situation,
26842 because some messages are successfully delivered, the &"retry clock"& for the
26843 host or address keeps getting reset by the successful deliveries, and so
26844 failing messages remain in the queue for ever because the cutoff time is never
26845 reached.
26846
26847 Two exceptional actions are applied to prevent this happening. The first
26848 applies to errors that are related to a message rather than a remote host.
26849 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26850 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26851 commands, and quota failures. For this type of error, if a message's arrival
26852 time is earlier than the &"first failed"& time for the error, the earlier time
26853 is used when scanning the retry rules to decide when to try next and when to
26854 time out the address.
26855
26856 The exceptional second action applies in all cases. If a message has been on
26857 the queue for longer than the cutoff time of any applicable retry rule for a
26858 given address, a delivery is attempted for that address, even if it is not yet
26859 time, and if this delivery fails, the address is timed out. A new retry time is
26860 not computed in this case, so that other messages for the same address are
26861 considered immediately.
26862 .ecindex IIDretconf1
26863 .ecindex IIDregconf2
26864
26865
26866
26867
26868
26869
26870 . ////////////////////////////////////////////////////////////////////////////
26871 . ////////////////////////////////////////////////////////////////////////////
26872
26873 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26874 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26875 .scindex IIDauthconf2 "authentication"
26876 The &"authenticators"& section of Exim's runtime configuration is concerned
26877 with SMTP authentication. This facility is an extension to the SMTP protocol,
26878 described in RFC 2554, which allows a client SMTP host to authenticate itself
26879 to a server. This is a common way for a server to recognize clients that are
26880 permitted to use it as a relay. SMTP authentication is not of relevance to the
26881 transfer of mail between servers that have no managerial connection with each
26882 other.
26883
26884 .cindex "AUTH" "description of"
26885 .cindex "ESMTP extensions" AUTH
26886 Very briefly, the way SMTP authentication works is as follows:
26887
26888 .ilist
26889 The server advertises a number of authentication &'mechanisms'& in response to
26890 the client's EHLO command.
26891 .next
26892 The client issues an AUTH command, naming a specific mechanism. The command
26893 may, optionally, contain some authentication data.
26894 .next
26895 The server may issue one or more &'challenges'&, to which the client must send
26896 appropriate responses. In simple authentication mechanisms, the challenges are
26897 just prompts for user names and passwords. The server does not have to issue
26898 any challenges &-- in some mechanisms the relevant data may all be transmitted
26899 with the AUTH command.
26900 .next
26901 The server either accepts or denies authentication.
26902 .next
26903 If authentication succeeds, the client may optionally make use of the AUTH
26904 option on the MAIL command to pass an authenticated sender in subsequent
26905 mail transactions. Authentication lasts for the remainder of the SMTP
26906 connection.
26907 .next
26908 If authentication fails, the client may give up, or it may try a different
26909 authentication mechanism, or it may try transferring mail over the
26910 unauthenticated connection.
26911 .endlist
26912
26913 If you are setting up a client, and want to know which authentication
26914 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26915 SMTP port) on the server, and issue an EHLO command. The response to this
26916 includes the list of supported mechanisms. For example:
26917 .display
26918 &`$ `&&*&`telnet server.example 25`&*&
26919 &`Trying 192.168.34.25...`&
26920 &`Connected to server.example.`&
26921 &`Escape character is &#x0027;^]&#x0027;.`&
26922 &`220 server.example ESMTP Exim 4.20 ...`&
26923 &*&`ehlo client.example`&*&
26924 &`250-server.example Hello client.example [10.8.4.5]`&
26925 &`250-SIZE 52428800`&
26926 &`250-PIPELINING`&
26927 &`250-AUTH PLAIN`&
26928 &`250 HELP`&
26929 .endd
26930 The second-last line of this example output shows that the server supports
26931 authentication using the PLAIN mechanism. In Exim, the different authentication
26932 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26933 routers and transports, which authenticators are included in the binary is
26934 controlled by build-time definitions. The following are currently available,
26935 included by setting
26936 .code
26937 AUTH_CRAM_MD5=yes
26938 AUTH_CYRUS_SASL=yes
26939 AUTH_DOVECOT=yes
26940 AUTH_EXTERNAL=yes
26941 AUTH_GSASL=yes
26942 AUTH_HEIMDAL_GSSAPI=yes
26943 AUTH_PLAINTEXT=yes
26944 AUTH_SPA=yes
26945 AUTH_TLS=yes
26946 .endd
26947 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26948 authentication mechanism (RFC 2195), and the second provides an interface to
26949 the Cyrus SASL authentication library.
26950 The third is an interface to Dovecot's authentication system, delegating the
26951 work via a socket interface.
26952 The fourth provides for negotiation of authentication done via non-SMTP means,
26953 as defined by RFC 4422 Appendix A.
26954 The fifth provides an interface to the GNU SASL authentication library, which
26955 provides mechanisms but typically not data sources.
26956 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26957 supporting setting a server keytab.
26958 The seventh can be configured to support
26959 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26960 not formally documented, but used by several MUAs.
26961 The eighth authenticator
26962 supports Microsoft's &'Secure Password Authentication'& mechanism.
26963 The last is an Exim authenticator but not an SMTP one;
26964 instead it can use information from a TLS negotiation.
26965
26966 The authenticators are configured using the same syntax as other drivers (see
26967 section &<<SECTfordricon>>&). If no authenticators are required, no
26968 authentication section need be present in the configuration file. Each
26969 authenticator can in principle have both server and client functions. When Exim
26970 is receiving SMTP mail, it is acting as a server; when it is sending out
26971 messages over SMTP, it is acting as a client. Authenticator configuration
26972 options are provided for use in both these circumstances.
26973
26974 To make it clear which options apply to which situation, the prefixes
26975 &%server_%& and &%client_%& are used on option names that are specific to
26976 either the server or the client function, respectively. Server and client
26977 functions are disabled if none of their options are set. If an authenticator is
26978 to be used for both server and client functions, a single definition, using
26979 both sets of options, is required. For example:
26980 .code
26981 cram:
26982   driver = cram_md5
26983   public_name = CRAM-MD5
26984   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26985   client_name = ph10
26986   client_secret = secret2
26987 .endd
26988 The &%server_%& option is used when Exim is acting as a server, and the
26989 &%client_%& options when it is acting as a client.
26990
26991 Descriptions of the individual authenticators are given in subsequent chapters.
26992 The remainder of this chapter covers the generic options for the
26993 authenticators, followed by general discussion of the way authentication works
26994 in Exim.
26995
26996 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26997 per-mechanism basis.  Please read carefully to determine which variables hold
26998 account labels such as usercodes and which hold passwords or other
26999 authenticating data.
27000
27001 Note that some mechanisms support two different identifiers for accounts: the
27002 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27003 and &'authz'& are commonly encountered.  The American spelling is standard here.
27004 Conceptually, authentication data such as passwords are tied to the identifier
27005 used to authenticate; servers may have rules to permit one user to act as a
27006 second user, so that after login the session is treated as though that second
27007 user had logged in.  That second user is the &'authorization id'&.  A robust
27008 configuration might confirm that the &'authz'& field is empty or matches the
27009 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27010 as verified data, the &'authz'& as an unverified request which the server might
27011 choose to honour.
27012
27013 A &'realm'& is a text string, typically a domain name, presented by a server
27014 to a client to help it select an account and credentials to use.  In some
27015 mechanisms, the client and server provably agree on the realm, but clients
27016 typically can not treat the realm as secure data to be blindly trusted.
27017
27018
27019
27020 .section "Generic options for authenticators" "SECID168"
27021 .cindex "authentication" "generic options"
27022 .cindex "options" "generic; for authenticators"
27023
27024 .option client_condition authenticators string&!! unset
27025 When Exim is authenticating as a client, it skips any authenticator whose
27026 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27027 used, for example, to skip plain text authenticators when the connection is not
27028 encrypted by a setting such as:
27029 .code
27030 client_condition = ${if !eq{$tls_out_cipher}{}}
27031 .endd
27032
27033
27034 .option client_set_id authenticators string&!! unset
27035 When client authentication succeeds, this condition is expanded; the
27036 result is used in the log lines for outbound messages.
27037 Typically it will be the user name used for authentication.
27038
27039
27040 .option driver authenticators string unset
27041 This option must always be set. It specifies which of the available
27042 authenticators is to be used.
27043
27044
27045 .option public_name authenticators string unset
27046 This option specifies the name of the authentication mechanism that the driver
27047 implements, and by which it is known to the outside world. These names should
27048 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27049 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27050 defaults to the driver's instance name.
27051
27052
27053 .option server_advertise_condition authenticators string&!! unset
27054 When a server is about to advertise an authentication mechanism, the condition
27055 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27056 mechanism is not advertised.
27057 If the expansion fails, the mechanism is not advertised. If the failure was not
27058 forced, and was not caused by a lookup defer, the incident is logged.
27059 See section &<<SECTauthexiser>>& below for further discussion.
27060
27061
27062 .option server_condition authenticators string&!! unset
27063 This option must be set for a &%plaintext%& server authenticator, where it
27064 is used directly to control authentication. See section &<<SECTplainserver>>&
27065 for details.
27066
27067 For the &(gsasl)& authenticator, this option is required for various
27068 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27069
27070 For the other authenticators, &%server_condition%& can be used as an additional
27071 authentication or authorization mechanism that is applied after the other
27072 authenticator conditions succeed. If it is set, it is expanded when the
27073 authenticator would otherwise return a success code. If the expansion is forced
27074 to fail, authentication fails. Any other expansion failure causes a temporary
27075 error code to be returned. If the result of a successful expansion is an empty
27076 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27077 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27078 other result, a temporary error code is returned, with the expanded string as
27079 the error text.
27080
27081
27082 .option server_debug_print authenticators string&!! unset
27083 If this option is set and authentication debugging is enabled (see the &%-d%&
27084 command line option), the string is expanded and included in the debugging
27085 output when the authenticator is run as a server. This can help with checking
27086 out the values of variables.
27087 If expansion of the string fails, the error message is written to the debugging
27088 output, and Exim carries on processing.
27089
27090
27091 .option server_set_id authenticators string&!! unset
27092 .vindex "&$authenticated_id$&"
27093 .vindex "&$authenticated_fail_id$&"
27094 When an Exim server successfully authenticates a client, this string is
27095 expanded using data from the authentication, and preserved for any incoming
27096 messages in the variable &$authenticated_id$&. It is also included in the log
27097 lines for incoming messages. For example, a user/password authenticator
27098 configuration might preserve the user name that was used to authenticate, and
27099 refer to it subsequently during delivery of the message.
27100 On a failing authentication the expansion result is instead saved in
27101 the &$authenticated_fail_id$& variable.
27102 If expansion fails, the option is ignored.
27103
27104
27105 .option server_mail_auth_condition authenticators string&!! unset
27106 This option allows a server to discard authenticated sender addresses supplied
27107 as part of MAIL commands in SMTP connections that are authenticated by the
27108 driver on which &%server_mail_auth_condition%& is set. The option is not used
27109 as part of the authentication process; instead its (unexpanded) value is
27110 remembered for later use.
27111 How it is used is described in the following section.
27112
27113
27114
27115
27116
27117 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27118 .cindex "authentication" "sender; authenticated"
27119 .cindex "AUTH" "on MAIL command"
27120 When a client supplied an AUTH= item on a MAIL command, Exim applies
27121 the following checks before accepting it as the authenticated sender of the
27122 message:
27123
27124 .ilist
27125 If the connection is not using extended SMTP (that is, HELO was used rather
27126 than EHLO), the use of AUTH= is a syntax error.
27127 .next
27128 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27129 .next
27130 .vindex "&$authenticated_sender$&"
27131 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27132 running, the value of &$authenticated_sender$& is set to the value obtained
27133 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27134 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27135 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27136 given for the MAIL command.
27137 .next
27138 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27139 is accepted and placed in &$authenticated_sender$& only if the client has
27140 authenticated.
27141 .next
27142 If the AUTH= value was accepted by either of the two previous rules, and
27143 the client has authenticated, and the authenticator has a setting for the
27144 &%server_mail_auth_condition%&, the condition is checked at this point. The
27145 valued that was saved from the authenticator is expanded. If the expansion
27146 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27147 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27148 the value of &$authenticated_sender$& is retained and passed on with the
27149 message.
27150 .endlist
27151
27152
27153 When &$authenticated_sender$& is set for a message, it is passed on to other
27154 hosts to which Exim authenticates as a client. Do not confuse this value with
27155 &$authenticated_id$&, which is a string obtained from the authentication
27156 process, and which is not usually a complete email address.
27157
27158 .vindex "&$sender_address$&"
27159 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27160 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27161 therefore make use of &$authenticated_sender$&. The converse is not true: the
27162 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27163 ACL is run.
27164
27165
27166
27167 .section "Authentication on an Exim server" "SECTauthexiser"
27168 .cindex "authentication" "on an Exim server"
27169 When Exim receives an EHLO command, it advertises the public names of those
27170 authenticators that are configured as servers, subject to the following
27171 conditions:
27172
27173 .ilist
27174 The client host must match &%auth_advertise_hosts%& (default *).
27175 .next
27176 It the &%server_advertise_condition%& option is set, its expansion must not
27177 yield the empty string, &"0"&, &"no"&, or &"false"&.
27178 .endlist
27179
27180 The order in which the authenticators are defined controls the order in which
27181 the mechanisms are advertised.
27182
27183 Some mail clients (for example, some versions of Netscape) require the user to
27184 provide a name and password for authentication whenever AUTH is advertised,
27185 even though authentication may not in fact be needed (for example, Exim may be
27186 set up to allow unconditional relaying from the client by an IP address check).
27187 You can make such clients more friendly by not advertising AUTH to them.
27188 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27189 that runs for RCPT) to relay without authentication, you should set
27190 .code
27191 auth_advertise_hosts = ! 10.9.8.0/24
27192 .endd
27193 so that no authentication mechanisms are advertised to them.
27194
27195 The &%server_advertise_condition%& controls the advertisement of individual
27196 authentication mechanisms. For example, it can be used to restrict the
27197 advertisement of a particular mechanism to encrypted connections, by a setting
27198 such as:
27199 .code
27200 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27201 .endd
27202 .vindex "&$tls_in_cipher$&"
27203 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27204 yields &"yes"&, which allows the advertisement to happen.
27205
27206 When an Exim server receives an AUTH command from a client, it rejects it
27207 immediately if AUTH was not advertised in response to an earlier EHLO
27208 command. This is the case if
27209
27210 .ilist
27211 The client host does not match &%auth_advertise_hosts%&; or
27212 .next
27213 No authenticators are configured with server options; or
27214 .next
27215 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27216 server authenticators.
27217 .endlist
27218
27219
27220 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27221 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27222 AUTH is accepted from any client host.
27223
27224 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27225 server authentication mechanism that was advertised in response to EHLO and
27226 that matches the one named in the AUTH command. If it finds one, it runs
27227 the appropriate authentication protocol, and authentication either succeeds or
27228 fails. If there is no matching advertised mechanism, the AUTH command is
27229 rejected with a 504 error.
27230
27231 .vindex "&$received_protocol$&"
27232 .vindex "&$sender_host_authenticated$&"
27233 When a message is received from an authenticated host, the value of
27234 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27235 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27236 public name) of the authenticator driver that successfully authenticated the
27237 client from which the message was received. This variable is empty if there was
27238 no successful authentication.
27239
27240 .cindex authentication "expansion item"
27241 Successful authentication sets up information used by the
27242 &%authresults%& expansion item.
27243
27244
27245
27246
27247 .section "Testing server authentication" "SECID169"
27248 .cindex "authentication" "testing a server"
27249 .cindex "AUTH" "testing a server"
27250 .cindex "base64 encoding" "creating authentication test data"
27251 Exim's &%-bh%& option can be useful for testing server authentication
27252 configurations. The data for the AUTH command has to be sent using base64
27253 encoding. A quick way to produce such data for testing is the following Perl
27254 script:
27255 .code
27256 use MIME::Base64;
27257 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27258 .endd
27259 .cindex "binary zero" "in authentication data"
27260 This interprets its argument as a Perl string, and then encodes it. The
27261 interpretation as a Perl string allows binary zeros, which are required for
27262 some kinds of authentication, to be included in the data. For example, a
27263 command line to run this script on such data might be
27264 .code
27265 encode '\0user\0password'
27266 .endd
27267 Note the use of single quotes to prevent the shell interpreting the
27268 backslashes, so that they can be interpreted by Perl to specify characters
27269 whose code value is zero.
27270
27271 &*Warning 1*&: If either of the user or password strings starts with an octal
27272 digit, you must use three zeros instead of one after the leading backslash. If
27273 you do not, the octal digit that starts your string will be incorrectly
27274 interpreted as part of the code for the first character.
27275
27276 &*Warning 2*&: If there are characters in the strings that Perl interprets
27277 specially, you must use a Perl escape to prevent them being misinterpreted. For
27278 example, a command such as
27279 .code
27280 encode '\0user@domain.com\0pas$$word'
27281 .endd
27282 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27283
27284 If you have the &%mimencode%& command installed, another way to do produce
27285 base64-encoded strings is to run the command
27286 .code
27287 echo -e -n `\0user\0password' | mimencode
27288 .endd
27289 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27290 in the argument, and the &%-n%& option specifies no newline at the end of its
27291 output. However, not all versions of &%echo%& recognize these options, so you
27292 should check your version before relying on this suggestion.
27293
27294
27295
27296 .section "Authentication by an Exim client" "SECID170"
27297 .cindex "authentication" "on an Exim client"
27298 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27299 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27300 announces support for authentication, and the host matches an entry in either
27301 of these options, Exim (as a client) tries to authenticate as follows:
27302
27303 .ilist
27304 For each authenticator that is configured as a client, in the order in which
27305 they are defined in the configuration, it searches the authentication
27306 mechanisms announced by the server for one whose name matches the public name
27307 of the authenticator.
27308 .next
27309 .vindex "&$host$&"
27310 .vindex "&$host_address$&"
27311 When it finds one that matches, it runs the authenticator's client code. The
27312 variables &$host$& and &$host_address$& are available for any string expansions
27313 that the client might do. They are set to the server's name and IP address. If
27314 any expansion is forced to fail, the authentication attempt is abandoned, and
27315 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27316 delivery to be deferred.
27317 .next
27318 If the result of the authentication attempt is a temporary error or a timeout,
27319 Exim abandons trying to send the message to the host for the moment. It will
27320 try again later. If there are any backup hosts available, they are tried in the
27321 usual way.
27322 .next
27323 If the response to authentication is a permanent error (5&'xx'& code), Exim
27324 carries on searching the list of authenticators and tries another one if
27325 possible. If all authentication attempts give permanent errors, or if there are
27326 no attempts because no mechanisms match (or option expansions force failure),
27327 what happens depends on whether the host matches &%hosts_require_auth%& or
27328 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27329 delivery is deferred. The error can be detected in the retry rules, and thereby
27330 turned into a permanent error if you wish. In the second case, Exim tries to
27331 deliver the message unauthenticated.
27332 .endlist
27333
27334 Note that the hostlist test for whether to do authentication can be
27335 confused if name-IP lookups change between the time the peer is decided
27336 upon and the time that the transport runs.  For example, with a manualroute
27337 router given a host name, and with DNS "round-robin" used by that name: if
27338 the local resolver cache times out between the router and the transport
27339 running, the transport may get an IP for the name for its authentication
27340 check which does not match the connection peer IP.
27341 No authentication will then be done, despite the names being identical.
27342
27343 For such cases use a separate transport which always authenticates.
27344
27345 .cindex "AUTH" "on MAIL command"
27346 When Exim has authenticated itself to a remote server, it adds the AUTH
27347 parameter to the MAIL commands it sends, if it has an authenticated sender for
27348 the message. If the message came from a remote host, the authenticated sender
27349 is the one that was receiving on an incoming MAIL command, provided that the
27350 incoming connection was authenticated and the &%server_mail_auth%& condition
27351 allowed the authenticated sender to be retained. If a local process calls Exim
27352 to send a message, the sender address that is built from the login name and
27353 &%qualify_domain%& is treated as authenticated. However, if the
27354 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27355 the authenticated sender that was received with the message.
27356 .ecindex IIDauthconf1
27357 .ecindex IIDauthconf2
27358
27359
27360
27361
27362
27363
27364 . ////////////////////////////////////////////////////////////////////////////
27365 . ////////////////////////////////////////////////////////////////////////////
27366
27367 .chapter "The plaintext authenticator" "CHAPplaintext"
27368 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27369 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27370 The &(plaintext)& authenticator can be configured to support the PLAIN and
27371 LOGIN authentication mechanisms, both of which transfer authentication data as
27372 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27373 security risk; you are strongly advised to insist on the use of SMTP encryption
27374 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27375 use unencrypted plain text, you should not use the same passwords for SMTP
27376 connections as you do for login accounts.
27377
27378 .section "Avoiding cleartext use" "SECTplain_TLS"
27379 The following generic option settings will disable &(plaintext)& authenticators when
27380 TLS is not being used:
27381 .code
27382   server_advertise_condition = ${if def:tls_in_cipher }
27383   client_condition =           ${if def:tls_out_cipher}
27384 .endd
27385
27386 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27387 but is still vulnerable to a Man In The Middle attack unless certificates
27388 (including their names) have been properly verified.
27389
27390 .section "Plaintext server options" "SECID171"
27391 .cindex "options" "&(plaintext)& authenticator (server)"
27392 When configured as a server, &(plaintext)& uses the following options:
27393
27394 .option server_condition authenticators string&!! unset
27395 This is actually a global authentication option, but it must be set in order to
27396 configure the &(plaintext)& driver as a server. Its use is described below.
27397
27398 .option server_prompts plaintext "string list&!!" unset
27399 The contents of this option, after expansion, must be a colon-separated list of
27400 prompt strings. If expansion fails, a temporary authentication rejection is
27401 given.
27402
27403 .section "Using plaintext in a server" "SECTplainserver"
27404 .cindex "AUTH" "in &(plaintext)& authenticator"
27405 .cindex "binary zero" "in &(plaintext)& authenticator"
27406 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27407         "in &(plaintext)& authenticator"
27408 .vindex "&$auth1$&, &$auth2$&, etc"
27409 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27410
27411 When running as a server, &(plaintext)& performs the authentication test by
27412 expanding a string. The data sent by the client with the AUTH command, or in
27413 response to subsequent prompts, is base64 encoded, and so may contain any byte
27414 values when decoded. If any data is supplied with the command, it is treated as
27415 a list of strings, separated by NULs (binary zeros), the first three of which
27416 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27417 (neither LOGIN nor PLAIN uses more than three strings).
27418
27419 For compatibility with previous releases of Exim, the values are also placed in
27420 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27421 variables for this purpose is now deprecated, as it can lead to confusion in
27422 string expansions that also use them for other things.
27423
27424 If there are more strings in &%server_prompts%& than the number of strings
27425 supplied with the AUTH command, the remaining prompts are used to obtain more
27426 data. Each response from the client may be a list of NUL-separated strings.
27427
27428 .vindex "&$authenticated_id$&"
27429 Once a sufficient number of data strings have been received,
27430 &%server_condition%& is expanded. If the expansion is forced to fail,
27431 authentication fails. Any other expansion failure causes a temporary error code
27432 to be returned. If the result of a successful expansion is an empty string,
27433 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27434 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27435 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27436 For any other result, a temporary error code is returned, with the expanded
27437 string as the error text.
27438
27439 &*Warning*&: If you use a lookup in the expansion to find the user's
27440 password, be sure to make the authentication fail if the user is unknown.
27441 There are good and bad examples at the end of the next section.
27442
27443
27444
27445 .section "The PLAIN authentication mechanism" "SECID172"
27446 .cindex "PLAIN authentication mechanism"
27447 .cindex authentication PLAIN
27448 .cindex "binary zero" "in &(plaintext)& authenticator"
27449 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27450 sent as one item of data (that is, one combined string containing two NUL
27451 separators). The data is sent either as part of the AUTH command, or
27452 subsequently in response to an empty prompt from the server.
27453
27454 The second and third strings are a user name and a corresponding password.
27455 Using a single fixed user name and password as an example, this could be
27456 configured as follows:
27457 .code
27458 fixed_plain:
27459   driver = plaintext
27460   public_name = PLAIN
27461   server_prompts = :
27462   server_condition = \
27463     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27464   server_set_id = $auth2
27465 .endd
27466 Note that the default result strings from &%if%& (&"true"& or an empty string)
27467 are exactly what we want here, so they need not be specified. Obviously, if the
27468 password contains expansion-significant characters such as dollar, backslash,
27469 or closing brace, they have to be escaped.
27470
27471 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27472 the end of a string list are ignored). If all the data comes as part of the
27473 AUTH command, as is commonly the case, the prompt is not used. This
27474 authenticator is advertised in the response to EHLO as
27475 .code
27476 250-AUTH PLAIN
27477 .endd
27478 and a client host can authenticate itself by sending the command
27479 .code
27480 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27481 .endd
27482 As this contains three strings (more than the number of prompts), no further
27483 data is required from the client. Alternatively, the client may just send
27484 .code
27485 AUTH PLAIN
27486 .endd
27487 to initiate authentication, in which case the server replies with an empty
27488 prompt. The client must respond with the combined data string.
27489
27490 The data string is base64 encoded, as required by the RFC. This example,
27491 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27492 represents a zero byte. This is split up into three strings, the first of which
27493 is empty. The &%server_condition%& option in the authenticator checks that the
27494 second two are &`username`& and &`mysecret`& respectively.
27495
27496 Having just one fixed user name and password, as in this example, is not very
27497 realistic, though for a small organization with only a handful of
27498 authenticating clients it could make sense.
27499
27500 A more sophisticated instance of this authenticator could use the user name in
27501 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27502 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27503 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27504 This is an incorrect example:
27505 .code
27506 server_condition = \
27507   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27508 .endd
27509 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27510 which it then compares to the supplied password (&$auth3$&). Why is this example
27511 incorrect? It works fine for existing users, but consider what happens if a
27512 non-existent user name is given. The lookup fails, but as no success/failure
27513 strings are given for the lookup, it yields an empty string. Thus, to defeat
27514 the authentication, all a client has to do is to supply a non-existent user
27515 name and an empty password. The correct way of writing this test is:
27516 .code
27517 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27518   {${if eq{$value}{$auth3}}} {false}}
27519 .endd
27520 In this case, if the lookup succeeds, the result is checked; if the lookup
27521 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27522 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27523 always fails if its second argument is empty. However, the second way of
27524 writing the test makes the logic clearer.
27525
27526
27527 .section "The LOGIN authentication mechanism" "SECID173"
27528 .cindex "LOGIN authentication mechanism"
27529 .cindex authentication LOGIN
27530 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27531 in a number of programs. No data is sent with the AUTH command. Instead, a
27532 user name and password are supplied separately, in response to prompts. The
27533 plaintext authenticator can be configured to support this as in this example:
27534 .code
27535 fixed_login:
27536   driver = plaintext
27537   public_name = LOGIN
27538   server_prompts = User Name : Password
27539   server_condition = \
27540     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27541   server_set_id = $auth1
27542 .endd
27543 Because of the way plaintext operates, this authenticator accepts data supplied
27544 with the AUTH command (in contravention of the specification of LOGIN), but
27545 if the client does not supply it (as is the case for LOGIN clients), the prompt
27546 strings are used to obtain two data items.
27547
27548 Some clients are very particular about the precise text of the prompts. For
27549 example, Outlook Express is reported to recognize only &"Username:"& and
27550 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27551 strings. It uses the &%ldapauth%& expansion condition to check the user
27552 name and password by binding to an LDAP server:
27553 .code
27554 login:
27555   driver = plaintext
27556   public_name = LOGIN
27557   server_prompts = Username:: : Password::
27558   server_condition = ${if and{{ \
27559     !eq{}{$auth1} }{ \
27560     ldapauth{\
27561       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27562       pass=${quote:$auth2} \
27563       ldap://ldap.example.org/} }} }
27564   server_set_id = uid=$auth1,ou=people,o=example.org
27565 .endd
27566 We have to check that the username is not empty before using it, because LDAP
27567 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27568 operator to correctly quote the DN for authentication. However, the basic
27569 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27570 correct one to use for the password, because quoting is needed only to make
27571 the password conform to the Exim syntax. At the LDAP level, the password is an
27572 uninterpreted string.
27573
27574
27575 .section "Support for different kinds of authentication" "SECID174"
27576 A number of string expansion features are provided for the purpose of
27577 interfacing to different ways of user authentication. These include checking
27578 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27579 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27580 &<<SECTexpcond>>&.
27581
27582
27583
27584
27585 .section "Using plaintext in a client" "SECID175"
27586 .cindex "options" "&(plaintext)& authenticator (client)"
27587 The &(plaintext)& authenticator has two client options:
27588
27589 .option client_ignore_invalid_base64 plaintext boolean false
27590 If the client receives a server prompt that is not a valid base64 string,
27591 authentication is abandoned by default. However, if this option is set true,
27592 the error in the challenge is ignored and the client sends the response as
27593 usual.
27594
27595 .option client_send plaintext string&!! unset
27596 The string is a colon-separated list of authentication data strings. Each
27597 string is independently expanded before being sent to the server. The first
27598 string is sent with the AUTH command; any more strings are sent in response
27599 to prompts from the server. Before each string is expanded, the value of the
27600 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27601 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27602 way. Thus, the prompt that is received in response to sending the first string
27603 (with the AUTH command) can be used in the expansion of the second string, and
27604 so on. If an invalid base64 string is received when
27605 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27606 &$auth$&<&'n'&> variable.
27607
27608 &*Note*&: You cannot use expansion to create multiple strings, because
27609 splitting takes priority and happens first.
27610
27611 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27612 the data, further processing is applied to each string before it is sent. If
27613 there are any single circumflex characters in the string, they are converted to
27614 NULs. Should an actual circumflex be required as data, it must be doubled in
27615 the string.
27616
27617 This is an example of a client configuration that implements the PLAIN
27618 authentication mechanism with a fixed user name and password:
27619 .code
27620 fixed_plain:
27621   driver = plaintext
27622   public_name = PLAIN
27623   client_send = ^username^mysecret
27624 .endd
27625 The lack of colons means that the entire text is sent with the AUTH
27626 command, with the circumflex characters converted to NULs. A similar example
27627 that uses the LOGIN mechanism is:
27628 .code
27629 fixed_login:
27630   driver = plaintext
27631   public_name = LOGIN
27632   client_send = : username : mysecret
27633 .endd
27634 The initial colon means that the first string is empty, so no data is sent with
27635 the AUTH command itself. The remaining strings are sent in response to
27636 prompts.
27637 .ecindex IIDplaiauth1
27638 .ecindex IIDplaiauth2
27639
27640
27641
27642
27643 . ////////////////////////////////////////////////////////////////////////////
27644 . ////////////////////////////////////////////////////////////////////////////
27645
27646 .chapter "The cram_md5 authenticator" "CHID9"
27647 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27648 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27649 .cindex "CRAM-MD5 authentication mechanism"
27650 .cindex authentication CRAM-MD5
27651 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27652 sends a challenge string to the client, and the response consists of a user
27653 name and the CRAM-MD5 digest of the challenge string combined with a secret
27654 string (password) which is known to both server and client. Thus, the secret
27655 is not sent over the network as plain text, which makes this authenticator more
27656 secure than &(plaintext)&. However, the downside is that the secret has to be
27657 available in plain text at either end.
27658
27659
27660 .section "Using cram_md5 as a server" "SECID176"
27661 .cindex "options" "&(cram_md5)& authenticator (server)"
27662 This authenticator has one server option, which must be set to configure the
27663 authenticator as a server:
27664
27665 .option server_secret cram_md5 string&!! unset
27666 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27667 When the server receives the client's response, the user name is placed in
27668 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27669 obtain the password for that user. The server then computes the CRAM-MD5 digest
27670 that the client should have sent, and checks that it received the correct
27671 string. If the expansion of &%server_secret%& is forced to fail, authentication
27672 fails. If the expansion fails for some other reason, a temporary error code is
27673 returned to the client.
27674
27675 For compatibility with previous releases of Exim, the user name is also placed
27676 in &$1$&. However, the use of this variables for this purpose is now
27677 deprecated, as it can lead to confusion in string expansions that also use
27678 numeric variables for other things.
27679
27680 For example, the following authenticator checks that the user name given by the
27681 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27682 user name, authentication fails.
27683 .code
27684 fixed_cram:
27685   driver = cram_md5
27686   public_name = CRAM-MD5
27687   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27688   server_set_id = $auth1
27689 .endd
27690 .vindex "&$authenticated_id$&"
27691 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27692 name in &$authenticated_id$&. A more typical configuration might look up the
27693 secret string in a file, using the user name as the key. For example:
27694 .code
27695 lookup_cram:
27696   driver = cram_md5
27697   public_name = CRAM-MD5
27698   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27699                   {$value}fail}
27700   server_set_id = $auth1
27701 .endd
27702 Note that this expansion explicitly forces failure if the lookup fails
27703 because &$auth1$& contains an unknown user name.
27704
27705 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27706 using the relevant libraries, you need to know the realm to specify in the
27707 lookup and then ask for the &"userPassword"& attribute for that user in that
27708 realm, with:
27709 .code
27710 cyrusless_crammd5:
27711   driver = cram_md5
27712   public_name = CRAM-MD5
27713   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27714                   dbmjz{/etc/sasldb2}{$value}fail}
27715   server_set_id = $auth1
27716 .endd
27717
27718 .section "Using cram_md5 as a client" "SECID177"
27719 .cindex "options" "&(cram_md5)& authenticator (client)"
27720 When used as a client, the &(cram_md5)& authenticator has two options:
27721
27722
27723
27724 .option client_name cram_md5 string&!! "the primary host name"
27725 This string is expanded, and the result used as the user name data when
27726 computing the response to the server's challenge.
27727
27728
27729 .option client_secret cram_md5 string&!! unset
27730 This option must be set for the authenticator to work as a client. Its value is
27731 expanded and the result used as the secret string when computing the response.
27732
27733
27734 .vindex "&$host$&"
27735 .vindex "&$host_address$&"
27736 Different user names and secrets can be used for different servers by referring
27737 to &$host$& or &$host_address$& in the options. Forced failure of either
27738 expansion string is treated as an indication that this authenticator is not
27739 prepared to handle this case. Exim moves on to the next configured client
27740 authenticator. Any other expansion failure causes Exim to give up trying to
27741 send the message to the current server.
27742
27743 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27744 strings, is:
27745 .code
27746 fixed_cram:
27747   driver = cram_md5
27748   public_name = CRAM-MD5
27749   client_name = ph10
27750   client_secret = secret
27751 .endd
27752 .ecindex IIDcramauth1
27753 .ecindex IIDcramauth2
27754
27755
27756
27757 . ////////////////////////////////////////////////////////////////////////////
27758 . ////////////////////////////////////////////////////////////////////////////
27759
27760 .chapter "The cyrus_sasl authenticator" "CHID10"
27761 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27762 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27763 .cindex "Cyrus" "SASL library"
27764 .cindex "Kerberos"
27765 The code for this authenticator was provided by Matthew Byng-Maddick while
27766 at A L Digital Ltd.
27767
27768 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27769 library implementation of the RFC 2222 (&"Simple Authentication and Security
27770 Layer"&). This library supports a number of authentication mechanisms,
27771 including PLAIN and LOGIN, but also several others that Exim does not support
27772 directly. In particular, there is support for Kerberos authentication.
27773
27774 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27775 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27776 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27777 name of the driver to determine which mechanism to support.
27778
27779 Where access to some kind of secret file is required, for example, in GSSAPI
27780 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27781 user, and that the Cyrus SASL library has no way of escalating privileges
27782 by default. You may also find you need to set environment variables,
27783 depending on the driver you are using.
27784
27785 The application name provided by Exim is &"exim"&, so various SASL options may
27786 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27787 Kerberos, note that because of limitations in the GSSAPI interface,
27788 changing the server keytab might need to be communicated down to the Kerberos
27789 layer independently. The mechanism for doing so is dependent upon the Kerberos
27790 implementation.
27791
27792 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27793 may be set to point to an alternative keytab file. Exim will pass this
27794 variable through from its own inherited environment when started as root or the
27795 Exim user. The keytab file needs to be readable by the Exim user.
27796 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27797 environment variable.  In practice, for those releases, the Cyrus authenticator
27798 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27799 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27800
27801
27802 .section "Using cyrus_sasl as a server" "SECID178"
27803 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27804 (on a successful authentication) into &$auth1$&. For compatibility with
27805 previous releases of Exim, the username is also placed in &$1$&. However, the
27806 use of this variable for this purpose is now deprecated, as it can lead to
27807 confusion in string expansions that also use numeric variables for other
27808 things.
27809
27810
27811 .option server_hostname cyrus_sasl string&!! "see below"
27812 This option selects the hostname that is used when communicating with the
27813 library. The default value is &`$primary_hostname`&. It is up to the underlying
27814 SASL plug-in what it does with this data.
27815
27816
27817 .option server_mech cyrus_sasl string "see below"
27818 This option selects the authentication mechanism this driver should use. The
27819 default is the value of the generic &%public_name%& option. This option allows
27820 you to use a different underlying mechanism from the advertised name. For
27821 example:
27822 .code
27823 sasl:
27824   driver = cyrus_sasl
27825   public_name = X-ANYTHING
27826   server_mech = CRAM-MD5
27827   server_set_id = $auth1
27828 .endd
27829
27830 .option server_realm cyrus_sasl string&!! unset
27831 This specifies the SASL realm that the server claims to be in.
27832
27833
27834 .option server_service cyrus_sasl string &`smtp`&
27835 This is the SASL service that the server claims to implement.
27836
27837
27838 For straightforward cases, you do not need to set any of the authenticator's
27839 private options. All you need to do is to specify an appropriate mechanism as
27840 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27841 PLAIN, you could have two authenticators as follows:
27842 .code
27843 sasl_cram_md5:
27844   driver = cyrus_sasl
27845   public_name = CRAM-MD5
27846   server_set_id = $auth1
27847
27848 sasl_plain:
27849   driver = cyrus_sasl
27850   public_name = PLAIN
27851   server_set_id = $auth2
27852 .endd
27853 Cyrus SASL does implement the LOGIN authentication method, even though it is
27854 not a standard method. It is disabled by default in the source distribution,
27855 but it is present in many binary distributions.
27856 .ecindex IIDcyrauth1
27857 .ecindex IIDcyrauth2
27858
27859
27860
27861
27862 . ////////////////////////////////////////////////////////////////////////////
27863 . ////////////////////////////////////////////////////////////////////////////
27864 .chapter "The dovecot authenticator" "CHAPdovecot"
27865 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27866 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27867 This authenticator is an interface to the authentication facility of the
27868 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27869 Note that Dovecot must be configured to use auth-client not auth-userdb.
27870 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27871 to use the same mechanisms for SMTP authentication. This is a server
27872 authenticator only. There is only one option:
27873
27874 .option server_socket dovecot string unset
27875
27876 This option must specify the UNIX socket that is the interface to Dovecot
27877 authentication. The &%public_name%& option must specify an authentication
27878 mechanism that Dovecot is configured to support. You can have several
27879 authenticators for different mechanisms. For example:
27880 .code
27881 dovecot_plain:
27882   driver = dovecot
27883   public_name = PLAIN
27884   server_socket = /var/run/dovecot/auth-client
27885   server_set_id = $auth1
27886
27887 dovecot_ntlm:
27888   driver = dovecot
27889   public_name = NTLM
27890   server_socket = /var/run/dovecot/auth-client
27891   server_set_id = $auth1
27892 .endd
27893 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27894 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27895 option is passed in the Dovecot authentication command. If, for a TLS
27896 connection, a client certificate has been verified, the &"valid-client-cert"&
27897 option is passed. When authentication succeeds, the identity of the user
27898 who authenticated is placed in &$auth1$&.
27899
27900 .new
27901 The Dovecot configuration to match the above wil look
27902 something like:
27903 .code
27904 conf.d/10-master.conf :-
27905
27906 service auth {
27907 ...
27908 #SASL
27909   unix_listener auth-client {
27910     mode = 0660
27911     user = mail
27912   }
27913 ...
27914 }
27915
27916 conf.d/10-auth.conf :-
27917
27918 auth_mechanisms = plain login ntlm
27919 .endd
27920 .wen
27921
27922 .ecindex IIDdcotauth1
27923 .ecindex IIDdcotauth2
27924
27925
27926 . ////////////////////////////////////////////////////////////////////////////
27927 . ////////////////////////////////////////////////////////////////////////////
27928 .chapter "The gsasl authenticator" "CHAPgsasl"
27929 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27930 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27931 .cindex "authentication" "GNU SASL"
27932 .cindex "authentication" "SASL"
27933 .cindex "authentication" "EXTERNAL"
27934 .cindex "authentication" "ANONYMOUS"
27935 .cindex "authentication" "PLAIN"
27936 .cindex "authentication" "LOGIN"
27937 .cindex "authentication" "DIGEST-MD5"
27938 .cindex "authentication" "CRAM-MD5"
27939 .cindex "authentication" "SCRAM family"
27940 The &(gsasl)& authenticator provides integration for the GNU SASL
27941 library and the mechanisms it provides.  This is new as of the 4.80 release
27942 and there are a few areas where the library does not let Exim smoothly
27943 scale to handle future authentication mechanisms, so no guarantee can be
27944 made that any particular new authentication mechanism will be supported
27945 without code changes in Exim.
27946
27947 .new
27948 The library is expected to add support in an upcoming
27949 realease for the SCRAM-SHA-256 method.
27950 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27951 when this happens.
27952
27953
27954 .option client_authz gsasl string&!! unset
27955 This option can be used to supply an &'authorization id'&
27956 which is different to the &'authentication_id'& provided
27957 by &%client_username%& option.
27958 If unset or (after expansion) empty it is not used,
27959 which is the common case.
27960
27961 .option client_channelbinding gsasl boolean false
27962 See &%server_channelbinding%& below.
27963
27964 .option client_password gsasl string&!! unset
27965 This option is exapanded before use, and should result in
27966 the password to be used, in clear.
27967
27968 .option client_username gsasl string&!! unset
27969 This option is exapanded before use, and should result in
27970 the account name to be used.
27971 .wen
27972
27973 .new
27974 .option client_spassword gsasl string&!! unset
27975 If a SCRAM mechanism is being used and this option is set
27976 it is used in preference to &%client_password%&.
27977 The value after expansion should be
27978 a 40 (for SHA-1) or 64 (for SHA-256) character string
27979 with the PBKDF2-prepared password, hex-encoded.
27980 Note that this value will depend on the salt and iteration-count
27981 supplied by the server.
27982 .wen
27983
27984
27985
27986 .option server_channelbinding gsasl boolean false
27987 Do not set this true and rely on the properties
27988 without consulting a cryptographic engineer.
27989
27990 Some authentication mechanisms are able to use external context at both ends
27991 of the session to bind the authentication to that context, and fail the
27992 authentication process if that context differs.  Specifically, some TLS
27993 ciphersuites can provide identifying information about the cryptographic
27994 context.
27995
27996 This should have meant that certificate identity and verification becomes a
27997 non-issue, as a man-in-the-middle attack will cause the correct client and
27998 server to see different identifiers and authentication will fail.
27999
28000 .new
28001 This is
28002 only usable by mechanisms which support "channel binding"; at time of
28003 writing, that's the SCRAM family.
28004 When using this feature the "-PLUS" variants of the method names need to be used.
28005 .wen
28006
28007 This defaults off to ensure smooth upgrade across Exim releases, in case
28008 this option causes some clients to start failing.  Some future release
28009 of Exim might have switched the default to be true.
28010
28011 However, Channel Binding in TLS has proven to be vulnerable in current versions.
28012 Do not plan to rely upon this feature for security, ever, without consulting
28013 with a subject matter expert (a cryptographic engineer).
28014
28015
28016 .option server_hostname gsasl string&!! "see below"
28017 This option selects the hostname that is used when communicating with the
28018 library. The default value is &`$primary_hostname`&.
28019 Some mechanisms will use this data.
28020
28021
28022 .option server_mech gsasl string "see below"
28023 This option selects the authentication mechanism this driver should use. The
28024 default is the value of the generic &%public_name%& option. This option allows
28025 you to use a different underlying mechanism from the advertised name. For
28026 example:
28027 .code
28028 sasl:
28029   driver = gsasl
28030   public_name = X-ANYTHING
28031   server_mech = CRAM-MD5
28032   server_set_id = $auth1
28033 .endd
28034
28035
28036 .option server_password gsasl string&!! unset
28037 Various mechanisms need access to the cleartext password on the server, so
28038 that proof-of-possession can be demonstrated on the wire, without sending
28039 the password itself.
28040
28041 The data available for lookup varies per mechanism.
28042 In all cases, &$auth1$& is set to the &'authentication id'&.
28043 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28044 if available, else the empty string.
28045 The &$auth3$& variable will always be the &'realm'& if available,
28046 else the empty string.
28047
28048 A forced failure will cause authentication to defer.
28049
28050 If using this option, it may make sense to set the &%server_condition%&
28051 option to be simply "true".
28052
28053
28054 .option server_realm gsasl string&!! unset
28055 This specifies the SASL realm that the server claims to be in.
28056 Some mechanisms will use this data.
28057
28058
28059 .option server_scram_iter gsasl string&!! 4096
28060 This option provides data for the SCRAM family of mechanisms.
28061 .new
28062 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28063 when this option is expanded.
28064
28065 The result of expansion should be a decimal number,
28066 and represents both a lower-bound on the security, and
28067 a compute cost factor imposed on the client
28068 (if it does not cache results, or the server changes
28069 either the iteration count or the salt).
28070 A minimum value of 4096 is required by the standards
28071 for all current SCRAM mechanism variants.
28072 .wen
28073
28074 .option server_scram_salt gsasl string&!! unset
28075 This option provides data for the SCRAM family of mechanisms.
28076 .new
28077 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28078 when this option is expanded.
28079 The value should be a base64-encoded string,
28080 of random data typically 4-to-16 bytes long.
28081 If unset or empty after expansion the library will provides a value for the
28082 protocol conversation.
28083 .wen
28084
28085
28086 .new
28087 .option server_key gsasl string&!! unset
28088 .option server_skey gsasl string&!! unset
28089 These options can be used for the SCRAM family of mechanisms
28090 to provide stored information related to a password,
28091 the storage of which is preferable to plaintext.
28092
28093 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28094 &%server_skey%& is StoredKey.
28095
28096 They are only available for version 1.9.0 (or later) of the gsasl library.
28097 When this is so, the macros
28098 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28099 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28100 will be defined.
28101
28102 The &$authN$& variables are available when these options are expanded.
28103
28104 If set, the results of expansion should for each
28105 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28106 of base64-coded data, and will be used in preference to the
28107 &%server_password%& option.
28108 If unset or not of the right length, &%server_password%& will be used.
28109
28110 The libgsasl library release includes a utility &'gsasl'& which can be used
28111 to generate these values.
28112 .wen
28113
28114
28115 .option server_service gsasl string &`smtp`&
28116 This is the SASL service that the server claims to implement.
28117 Some mechanisms will use this data.
28118
28119
28120 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28121 .vindex "&$auth1$&, &$auth2$&, etc"
28122 These may be set when evaluating specific options, as detailed above.
28123 They will also be set when evaluating &%server_condition%&.
28124
28125 Unless otherwise stated below, the &(gsasl)& integration will use the following
28126 meanings for these variables:
28127
28128 .ilist
28129 .vindex "&$auth1$&"
28130 &$auth1$&: the &'authentication id'&
28131 .next
28132 .vindex "&$auth2$&"
28133 &$auth2$&: the &'authorization id'&
28134 .next
28135 .vindex "&$auth3$&"
28136 &$auth3$&: the &'realm'&
28137 .endlist
28138
28139 On a per-mechanism basis:
28140
28141 .ilist
28142 .cindex "authentication" "EXTERNAL"
28143 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28144 the &%server_condition%& option must be present.
28145 .next
28146 .cindex "authentication" "ANONYMOUS"
28147 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28148 the &%server_condition%& option must be present.
28149 .next
28150 .cindex "authentication" "GSSAPI"
28151 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28152 &$auth2$& will be set to the &'authorization id'&,
28153 the &%server_condition%& option must be present.
28154 .endlist
28155
28156 An &'anonymous token'& is something passed along as an unauthenticated
28157 identifier; this is analogous to FTP anonymous authentication passing an
28158 email address, or software-identifier@, as the "password".
28159
28160
28161 An example showing the password having the realm specified in the callback
28162 and demonstrating a Cyrus SASL to GSASL migration approach is:
28163 .code
28164 gsasl_cyrusless_crammd5:
28165   driver = gsasl
28166   public_name = CRAM-MD5
28167   server_realm = imap.example.org
28168   server_password = ${lookup{$auth1:$auth3:userPassword}\
28169                     dbmjz{/etc/sasldb2}{$value}fail}
28170   server_set_id = ${quote:$auth1}
28171   server_condition = yes
28172 .endd
28173
28174
28175 . ////////////////////////////////////////////////////////////////////////////
28176 . ////////////////////////////////////////////////////////////////////////////
28177
28178 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28179 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28180 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28181 .cindex "authentication" "GSSAPI"
28182 .cindex "authentication" "Kerberos"
28183 The &(heimdal_gssapi)& authenticator provides server integration for the
28184 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28185 reliably.
28186
28187 .option server_hostname heimdal_gssapi string&!! "see below"
28188 This option selects the hostname that is used, with &%server_service%&,
28189 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28190 identifier.  The default value is &`$primary_hostname`&.
28191
28192 .option server_keytab heimdal_gssapi string&!! unset
28193 If set, then Heimdal will not use the system default keytab (typically
28194 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28195 The value should be a pathname, with no &"file:"& prefix.
28196
28197 .option server_service heimdal_gssapi string&!! "smtp"
28198 This option specifies the service identifier used, in conjunction with
28199 &%server_hostname%&, for building the identifier for finding credentials
28200 from the keytab.
28201
28202
28203 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28204 Beware that these variables will typically include a realm, thus will appear
28205 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28206 not verified, so a malicious client can set it to anything.
28207
28208 The &$auth1$& field should be safely trustable as a value from the Key
28209 Distribution Center.  Note that these are not quite email addresses.
28210 Each identifier is for a role, and so the left-hand-side may include a
28211 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28212
28213 .vindex "&$auth1$&, &$auth2$&, etc"
28214 .ilist
28215 .vindex "&$auth1$&"
28216 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28217 .next
28218 .vindex "&$auth2$&"
28219 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28220 authentication.  If that was empty, this will also be set to the
28221 GSS Display Name.
28222 .endlist
28223
28224
28225 . ////////////////////////////////////////////////////////////////////////////
28226 . ////////////////////////////////////////////////////////////////////////////
28227
28228 .chapter "The spa authenticator" "CHAPspa"
28229 .scindex IIDspaauth1 "&(spa)& authenticator"
28230 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28231 .cindex "authentication" "Microsoft Secure Password"
28232 .cindex "authentication" "NTLM"
28233 .cindex "Microsoft Secure Password Authentication"
28234 .cindex "NTLM authentication"
28235 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28236 Password Authentication'& mechanism,
28237 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28238 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28239 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28240 server side was subsequently contributed by Tom Kistner. The mechanism works as
28241 follows:
28242
28243 .ilist
28244 After the AUTH command has been accepted, the client sends an SPA
28245 authentication request based on the user name and optional domain.
28246 .next
28247 The server sends back a challenge.
28248 .next
28249 The client builds a challenge response which makes use of the user's password
28250 and sends it to the server, which then accepts or rejects it.
28251 .endlist
28252
28253 Encryption is used to protect the password in transit.
28254
28255
28256
28257 .section "Using spa as a server" "SECID179"
28258 .cindex "options" "&(spa)& authenticator (server)"
28259 The &(spa)& authenticator has just one server option:
28260
28261 .option server_password spa string&!! unset
28262 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28263 This option is expanded, and the result must be the cleartext password for the
28264 authenticating user, whose name is at this point in &$auth1$&. For
28265 compatibility with previous releases of Exim, the user name is also placed in
28266 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28267 it can lead to confusion in string expansions that also use numeric variables
28268 for other things. For example:
28269 .code
28270 spa:
28271   driver = spa
28272   public_name = NTLM
28273   server_password = \
28274     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28275 .endd
28276 If the expansion is forced to fail, authentication fails. Any other expansion
28277 failure causes a temporary error code to be returned.
28278
28279
28280
28281
28282
28283 .section "Using spa as a client" "SECID180"
28284 .cindex "options" "&(spa)& authenticator (client)"
28285 The &(spa)& authenticator has the following client options:
28286
28287
28288
28289 .option client_domain spa string&!! unset
28290 This option specifies an optional domain for the authentication.
28291
28292
28293 .option client_password spa string&!! unset
28294 This option specifies the user's password, and must be set.
28295
28296
28297 .option client_username spa string&!! unset
28298 This option specifies the user name, and must be set. Here is an example of a
28299 configuration of this authenticator for use with the mail servers at
28300 &'msn.com'&:
28301 .code
28302 msn:
28303   driver = spa
28304   public_name = MSN
28305   client_username = msn/msn_username
28306   client_password = msn_plaintext_password
28307   client_domain = DOMAIN_OR_UNSET
28308 .endd
28309 .ecindex IIDspaauth1
28310 .ecindex IIDspaauth2
28311
28312
28313
28314
28315
28316 . ////////////////////////////////////////////////////////////////////////////
28317 . ////////////////////////////////////////////////////////////////////////////
28318
28319 .chapter "The external authenticator" "CHAPexternauth"
28320 .scindex IIDexternauth1 "&(external)& authenticator"
28321 .scindex IIDexternauth2 "authenticators" "&(external)&"
28322 .cindex "authentication" "Client Certificate"
28323 .cindex "authentication" "X509"
28324 .cindex "Certificate-based authentication"
28325 The &(external)& authenticator provides support for
28326 authentication based on non-SMTP information.
28327 The specification is in RFC 4422 Appendix A
28328 (&url(https://tools.ietf.org/html/rfc4422)).
28329 It is only a transport and negotiation mechanism;
28330 the process of authentication is entirely controlled
28331 by the server configuration.
28332
28333 The client presents an identity in-clear.
28334 It is probably wise for a server to only advertise,
28335 and for clients to only attempt,
28336 this authentication method on a secure (eg. under TLS) connection.
28337
28338 One possible use, compatible with the
28339 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28340 is for using X509 client certificates.
28341
28342 It thus overlaps in function with the TLS authenticator
28343 (see &<<CHAPtlsauth>>&)
28344 but is a full SMTP SASL authenticator
28345 rather than being implicit for TLS-connection carried
28346 client certificates only.
28347
28348 The examples and discussion in this chapter assume that
28349 client-certificate authentication is being done.
28350
28351 The client must present a certificate,
28352 for which it must have been requested via the
28353 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28354 (see &<<CHAPTLS>>&).
28355 For authentication to be effective the certificate should be
28356 verifiable against a trust-anchor certificate known to the server.
28357
28358 .section "External options" "SECTexternsoptions"
28359 .cindex "options" "&(external)& authenticator (server)"
28360 The &(external)& authenticator has two server options:
28361
28362 .option server_param2 external string&!! unset
28363 .option server_param3 external string&!! unset
28364 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28365 These options are expanded before the &%server_condition%& option
28366 and the result are placed in &$auth2$& and &$auth3$& resectively.
28367 If the expansion is forced to fail, authentication fails. Any other expansion
28368 failure causes a temporary error code to be returned.
28369
28370 They can be used to clarify the coding of a complex &%server_condition%&.
28371
28372 .section "Using external in a server" "SECTexternserver"
28373 .cindex "AUTH" "in &(external)& authenticator"
28374 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28375         "in &(external)& authenticator"
28376 .vindex "&$auth1$&, &$auth2$&, etc"
28377 .cindex "base64 encoding" "in &(external)& authenticator"
28378
28379 When running as a server, &(external)& performs the authentication test by
28380 expanding a string. The data sent by the client with the AUTH command, or in
28381 response to subsequent prompts, is base64 encoded, and so may contain any byte
28382 values when decoded. The decoded value is treated as
28383 an identity for authentication and
28384 placed in the expansion variable &$auth1$&.
28385
28386 For compatibility with previous releases of Exim, the value is also placed in
28387 the expansion variable &$1$&. However, the use of this
28388 variable for this purpose is now deprecated, as it can lead to confusion in
28389 string expansions that also use them for other things.
28390
28391 .vindex "&$authenticated_id$&"
28392 Once an identity has been received,
28393 &%server_condition%& is expanded. If the expansion is forced to fail,
28394 authentication fails. Any other expansion failure causes a temporary error code
28395 to be returned. If the result of a successful expansion is an empty string,
28396 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28397 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28398 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28399 For any other result, a temporary error code is returned, with the expanded
28400 string as the error text.
28401
28402 Example:
28403 .code
28404 ext_ccert_san_mail:
28405   driver =            external
28406   public_name =       EXTERNAL
28407
28408   server_advertise_condition = $tls_in_certificate_verified
28409   server_param2 =     ${certextract {subj_altname,mail,>:} \
28410                                     {$tls_in_peercert}}
28411   server_condition =  ${if forany {$auth2} \
28412                             {eq {$item}{$auth1}}}
28413   server_set_id =     $auth1
28414 .endd
28415 This accepts a client certificate that is verifiable against any
28416 of your configured trust-anchors
28417 (which usually means the full set of public CAs)
28418 and which has a mail-SAN matching the claimed identity sent by the client.
28419
28420 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28421 The account name is therefore guessable by an opponent.
28422 TLS 1.3 protects both server and client certificates, and is not vulnerable
28423 in this way.
28424
28425
28426 .section "Using external in a client" "SECTexternclient"
28427 .cindex "options" "&(external)& authenticator (client)"
28428 The &(external)& authenticator has one client option:
28429
28430 .option client_send external string&!! unset
28431 This option is expanded and sent with the AUTH command as the
28432 identity being asserted.
28433
28434 Example:
28435 .code
28436 ext_ccert:
28437   driver =      external
28438   public_name = EXTERNAL
28439
28440   client_condition = ${if !eq{$tls_out_cipher}{}}
28441   client_send = myaccount@smarthost.example.net
28442 .endd
28443
28444
28445 .ecindex IIDexternauth1
28446 .ecindex IIDexternauth2
28447
28448
28449
28450
28451
28452 . ////////////////////////////////////////////////////////////////////////////
28453 . ////////////////////////////////////////////////////////////////////////////
28454
28455 .chapter "The tls authenticator" "CHAPtlsauth"
28456 .scindex IIDtlsauth1 "&(tls)& authenticator"
28457 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28458 .cindex "authentication" "Client Certificate"
28459 .cindex "authentication" "X509"
28460 .cindex "Certificate-based authentication"
28461 The &(tls)& authenticator provides server support for
28462 authentication based on client certificates.
28463
28464 It is not an SMTP authentication mechanism and is not
28465 advertised by the server as part of the SMTP EHLO response.
28466 It is an Exim authenticator in the sense that it affects
28467 the protocol element of the log line, can be tested for
28468 by the &%authenticated%& ACL condition, and can set
28469 the &$authenticated_id$& variable.
28470
28471 The client must present a verifiable certificate,
28472 for which it must have been requested via the
28473 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28474 (see &<<CHAPTLS>>&).
28475
28476 If an authenticator of this type is configured it is
28477 run before any SMTP-level communication is done,
28478 and can authenticate the connection.
28479 If it does, SMTP authentication is not offered.
28480
28481 A maximum of one authenticator of this type may be present.
28482
28483
28484 .cindex "options" "&(tls)& authenticator (server)"
28485 The &(tls)& authenticator has three server options:
28486
28487 .option server_param1 tls string&!! unset
28488 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28489 This option is expanded after the TLS negotiation and
28490 the result is placed in &$auth1$&.
28491 If the expansion is forced to fail, authentication fails. Any other expansion
28492 failure causes a temporary error code to be returned.
28493
28494 .option server_param2 tls string&!! unset
28495 .option server_param3 tls string&!! unset
28496 As above, for &$auth2$& and &$auth3$&.
28497
28498 &%server_param1%& may also be spelled &%server_param%&.
28499
28500
28501 Example:
28502 .code
28503 tls:
28504   driver = tls
28505   server_param1 =     ${certextract {subj_altname,mail,>:} \
28506                                     {$tls_in_peercert}}
28507   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28508                                  {forany {$auth1} \
28509                             {!= {0} \
28510                                 {${lookup ldap{ldap:///\
28511                          mailname=${quote_ldap_dn:${lc:$item}},\
28512                          ou=users,LDAP_DC?mailid} {$value}{0} \
28513                        }    }  } }}}
28514   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28515 .endd
28516 This accepts a client certificate that is verifiable against any
28517 of your configured trust-anchors
28518 (which usually means the full set of public CAs)
28519 and which has a SAN with a good account name.
28520
28521 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28522 The account name is therefore guessable by an opponent.
28523 TLS 1.3 protects both server and client certificates, and is not vulnerable
28524 in this way.
28525 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28526
28527 . An alternative might use
28528 . .code
28529 .   server_param1 = ${sha256:$tls_in_peercert}
28530 . .endd
28531 . to require one of a set of specific certs that define a given account
28532 . (the verification is still required, but mostly irrelevant).
28533 . This would help for per-device use.
28534 .
28535 . However, for the future we really need support for checking a
28536 . user cert in LDAP - which probably wants a base-64 DER.
28537
28538 .ecindex IIDtlsauth1
28539 .ecindex IIDtlsauth2
28540
28541
28542 Note that because authentication is traditionally an SMTP operation,
28543 the &%authenticated%& ACL condition cannot be used in
28544 a connect- or helo-ACL.
28545
28546
28547
28548 . ////////////////////////////////////////////////////////////////////////////
28549 . ////////////////////////////////////////////////////////////////////////////
28550
28551 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28552          "Encrypted SMTP connections"
28553 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28554 .scindex IIDencsmtp2 "SMTP" "encryption"
28555 .cindex "TLS" "on SMTP connection"
28556 .cindex "OpenSSL"
28557 .cindex "GnuTLS"
28558 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28559 Sockets Layer), is implemented by making use of the OpenSSL library or the
28560 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28561 cryptographic code in the Exim distribution itself for implementing TLS. In
28562 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28563 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28564 You also need to understand the basic concepts of encryption at a managerial
28565 level, and in particular, the way that public keys, private keys, and
28566 certificates are used.
28567
28568 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28569 connection is established, the client issues a STARTTLS command. If the
28570 server accepts this, the client and the server negotiate an encryption
28571 mechanism. If the negotiation succeeds, the data that subsequently passes
28572 between them is encrypted.
28573
28574 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28575 and if so, what cipher suite is in use, whether the client supplied a
28576 certificate, and whether or not that certificate was verified. This makes it
28577 possible for an Exim server to deny or accept certain commands based on the
28578 encryption state.
28579
28580 &*Warning*&: Certain types of firewall and certain anti-virus products can
28581 disrupt TLS connections. You need to turn off SMTP scanning for these products
28582 in order to get TLS to work.
28583
28584
28585
28586 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28587          "SECID284"
28588 .cindex "submissions protocol"
28589 .cindex "ssmtp protocol"
28590 .cindex "smtps protocol"
28591 .cindex "SMTP" "submissions protocol"
28592 .cindex "SMTP" "ssmtp protocol"
28593 .cindex "SMTP" "smtps protocol"
28594 The history of port numbers for TLS in SMTP is a little messy and has been
28595 contentious.  As of RFC 8314, the common practice of using the historically
28596 allocated port 465 for "email submission but with TLS immediately upon connect
28597 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28598 by them in preference to STARTTLS.
28599
28600 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28601 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28602 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28603
28604 This approach was, for a while, officially abandoned when encrypted SMTP was
28605 standardized, but many clients kept using it, even as the TCP port number was
28606 reassigned for other use.
28607 Thus you may encounter guidance claiming that you shouldn't enable use of
28608 this port.
28609 In practice, a number of mail-clients have only ever supported submissions,
28610 not submission with STARTTLS upgrade.
28611 Ideally, offer both submission (587) and submissions (465) service.
28612
28613 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28614 global option. Its value must be a list of port numbers;
28615 the most common use is expected to be:
28616 .code
28617 tls_on_connect_ports = 465
28618 .endd
28619 The port numbers specified by this option apply to all SMTP connections, both
28620 via the daemon and via &'inetd'&. You still need to specify all the ports that
28621 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28622 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28623 an extra port &-- rather, it specifies different behaviour on a port that is
28624 defined elsewhere.
28625
28626 There is also a &%-tls-on-connect%& command line option. This overrides
28627 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28628
28629
28630
28631
28632
28633
28634 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28635 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28636 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28637 To build Exim to use OpenSSL you need to set
28638 .code
28639 USE_OPENSSL=yes
28640 .endd
28641 in Local/Makefile.
28642
28643 To build Exim to use GnuTLS, you need to set
28644 .code
28645 USE_GNUTLS=yes
28646 .endd
28647 in Local/Makefile.
28648
28649 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28650 include files and libraries for GnuTLS can be found.
28651
28652 There are some differences in usage when using GnuTLS instead of OpenSSL:
28653
28654 .ilist
28655 The &%tls_verify_certificates%& option
28656 cannot be the path of a directory
28657 for GnuTLS versions before 3.3.6
28658 (for later versions, or OpenSSL, it can be either).
28659 .next
28660 The default value for &%tls_dhparam%& differs for historical reasons.
28661 .next
28662 .vindex "&$tls_in_peerdn$&"
28663 .vindex "&$tls_out_peerdn$&"
28664 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28665 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28666 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28667 .next
28668 OpenSSL identifies cipher suites using hyphens as separators, for example:
28669 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28670 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28671 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28672 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28673 to handle its own older variants) when processing lists of cipher suites in the
28674 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28675 option).
28676 .next
28677 The &%tls_require_ciphers%& options operate differently, as described in the
28678 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28679 .next
28680 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28681 When using OpenSSL, this option is ignored.
28682 (If an API is found to let OpenSSL be configured in this way,
28683 let the Exim Maintainers know and we'll likely use it).
28684 .next
28685 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28686 main option, it must be ordered to match the &%tls_certificate%& list.
28687 .next
28688 Some other recently added features may only be available in one or the other.
28689 This should be documented with the feature.  If the documentation does not
28690 explicitly state that the feature is infeasible in the other TLS
28691 implementation, then patches are welcome.
28692 .endlist
28693
28694
28695 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28696 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28697 an explicit path; if the latter, then the text about generation still applies,
28698 but not the chosen filename.
28699 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28700 See the documentation of &%tls_dhparam%& for more information.
28701
28702 GnuTLS uses D-H parameters that may take a substantial amount of time
28703 to compute. It is unreasonable to re-compute them for every TLS session.
28704 Therefore, Exim keeps this data in a file in its spool directory, called
28705 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28706 of bits requested.
28707 The file is owned by the Exim user and is readable only by
28708 its owner. Every Exim process that start up GnuTLS reads the D-H
28709 parameters from this file. If the file does not exist, the first Exim process
28710 that needs it computes the data and writes it to a temporary file which is
28711 renamed once it is complete. It does not matter if several Exim processes do
28712 this simultaneously (apart from wasting a few resources). Once a file is in
28713 place, new Exim processes immediately start using it.
28714
28715 For maximum security, the parameters that are stored in this file should be
28716 recalculated periodically, the frequency depending on your paranoia level.
28717 If you are avoiding using the fixed D-H primes published in RFCs, then you
28718 are concerned about some advanced attacks and will wish to do this; if you do
28719 not regenerate then you might as well stick to the standard primes.
28720
28721 Arranging this is easy in principle; just delete the file when you want new
28722 values to be computed. However, there may be a problem. The calculation of new
28723 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28724 If the system is not very active, &_/dev/random_& may delay returning data
28725 until enough randomness (entropy) is available. This may cause Exim to hang for
28726 a substantial amount of time, causing timeouts on incoming connections.
28727
28728 The solution is to generate the parameters externally to Exim. They are stored
28729 in &_gnutls-params-N_& in PEM format, which means that they can be
28730 generated externally using the &(certtool)& command that is part of GnuTLS.
28731
28732 To replace the parameters with new ones, instead of deleting the file
28733 and letting Exim re-create it, you can generate new parameters using
28734 &(certtool)& and, when this has been done, replace Exim's cache file by
28735 renaming. The relevant commands are something like this:
28736 .code
28737 # ls
28738 [ look for file; assume gnutls-params-2236 is the most recent ]
28739 # rm -f new-params
28740 # touch new-params
28741 # chown exim:exim new-params
28742 # chmod 0600 new-params
28743 # certtool --generate-dh-params --bits 2236 >>new-params
28744 # openssl dhparam -noout -text -in new-params | head
28745 [ check the first line, make sure it's not more than 2236;
28746   if it is, then go back to the start ("rm") and repeat
28747   until the size generated is at most the size requested ]
28748 # chmod 0400 new-params
28749 # mv new-params gnutls-params-2236
28750 .endd
28751 If Exim never has to generate the parameters itself, the possibility of
28752 stalling is removed.
28753
28754 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28755 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28756 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28757 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28758 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28759 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28760 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28761 which applies to all D-H usage, client or server.  If the value returned by
28762 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28763 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28764 limit, which is still much higher than Exim historically used.
28765
28766 The filename and bits used will change as the GnuTLS maintainers change the
28767 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28768 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28769 2432 bits, while NSS is limited to 2236 bits.
28770
28771 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28772 increase the chance of the generated prime actually being within acceptable
28773 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28774 procedure above.  There is no sane procedure available to Exim to double-check
28775 the size of the generated prime, so it might still be too large.
28776
28777
28778 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28779 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28780 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28781 There is a function in the OpenSSL library that can be passed a list of cipher
28782 suites before the cipher negotiation takes place. This specifies which ciphers
28783 are acceptable for TLS versions prior to 1.3.
28784 The list is colon separated and may contain names like
28785 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28786 directly to this function call.
28787 Many systems will install the OpenSSL manual-pages, so you may have
28788 &'ciphers(1)'& available to you.
28789 The following quotation from the OpenSSL
28790 documentation specifies what forms of item are allowed in the cipher string:
28791
28792 .ilist
28793 It can consist of a single cipher suite such as RC4-SHA.
28794 .next
28795 It can represent a list of cipher suites containing a certain algorithm,
28796 or cipher suites of a certain type. For example SHA1 represents all
28797 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28798 SSL v3 algorithms.
28799 .next
28800 Lists of cipher suites can be combined in a single cipher string using
28801 the + character. This is used as a logical and operation. For example
28802 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28803 algorithms.
28804 .endlist
28805
28806 Each cipher string can be optionally preceded by one of the characters &`!`&,
28807 &`-`& or &`+`&.
28808 .ilist
28809 If &`!`& is used, the ciphers are permanently deleted from the list. The
28810 ciphers deleted can never reappear in the list even if they are explicitly
28811 stated.
28812 .next
28813 If &`-`& is used, the ciphers are deleted from the list, but some or all
28814 of the ciphers can be added again by later options.
28815 .next
28816 If &`+`& is used, the ciphers are moved to the end of the list. This
28817 option does not add any new ciphers; it just moves matching existing ones.
28818 .endlist
28819
28820 If none of these characters is present, the string is interpreted as
28821 a list of ciphers to be appended to the current preference list. If the list
28822 includes any ciphers already present they will be ignored: that is, they will
28823 not be moved to the end of the list.
28824 .endlist
28825
28826 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28827 string:
28828 .code
28829 # note single-quotes to get ! past any shell history expansion
28830 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28831 .endd
28832
28833 This example will let the library defaults be permitted on the MX port, where
28834 there's probably no identity verification anyway, but ups the ante on the
28835 submission ports where the administrator might have some influence on the
28836 choice of clients used:
28837 .code
28838 # OpenSSL variant; see man ciphers(1)
28839 tls_require_ciphers = ${if =={$received_port}{25}\
28840                            {DEFAULT}\
28841                            {HIGH:!MD5:!SHA1}}
28842 .endd
28843
28844 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28845 .code
28846 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28847 .endd
28848
28849 For TLS version 1.3 the control available is less fine-grained
28850 and Exim does not provide access to it at present.
28851 The value of the &%tls_require_ciphers%& option is ignored when
28852 TLS version 1.3 is negotiated.
28853
28854 As of writing the library default cipher suite list for TLSv1.3 is
28855 .code
28856 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28857 .endd
28858
28859
28860 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28861          "SECTreqciphgnu"
28862 .cindex "GnuTLS" "specifying parameters for"
28863 .cindex "TLS" "specifying ciphers (GnuTLS)"
28864 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28865 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28866 .cindex "TLS" "specifying protocols (GnuTLS)"
28867 .cindex "TLS" "specifying priority string (GnuTLS)"
28868 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28869 The GnuTLS library allows the caller to provide a "priority string", documented
28870 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28871 ciphersuite specification in OpenSSL.
28872
28873 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28874 and controls both protocols and ciphers.
28875
28876 The &%tls_require_ciphers%& option is available both as an global option,
28877 controlling how Exim behaves as a server, and also as an option of the
28878 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28879 the value is string expanded.  The resulting string is not an Exim list and
28880 the string is given to the GnuTLS library, so that Exim does not need to be
28881 aware of future feature enhancements of GnuTLS.
28882
28883 Documentation of the strings accepted may be found in the GnuTLS manual, under
28884 "Priority strings".  This is online as
28885 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28886 but beware that this relates to GnuTLS 3, which may be newer than the version
28887 installed on your system.  If you are using GnuTLS 3,
28888 then the example code
28889 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28890 on that site can be used to test a given string.
28891
28892 For example:
28893 .code
28894 # Disable older versions of protocols
28895 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28896 .endd
28897
28898 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28899 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28900 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28901
28902 This example will let the library defaults be permitted on the MX port, where
28903 there's probably no identity verification anyway, and lowers security further
28904 by increasing compatibility; but this ups the ante on the submission ports
28905 where the administrator might have some influence on the choice of clients
28906 used:
28907 .code
28908 # GnuTLS variant
28909 tls_require_ciphers = ${if =={$received_port}{25}\
28910                            {NORMAL:%COMPAT}\
28911                            {SECURE128}}
28912 .endd
28913
28914
28915 .section "Configuring an Exim server to use TLS" "SECID182"
28916 .cindex "TLS" "configuring an Exim server"
28917 .cindex "ESMTP extensions" STARTTLS
28918 When Exim has been built with TLS support, it advertises the availability of
28919 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28920 but not to any others. The default value of this option is *, which means
28921 that STARTTLS is always advertised.  Set it to blank to never advertise;
28922 this is reasonable for systems that want to use TLS only as a client.
28923
28924 If STARTTLS is to be used you
28925 need to set some other options in order to make TLS available.
28926
28927 If a client issues a STARTTLS command and there is some configuration
28928 problem in the server, the command is rejected with a 454 error. If the client
28929 persists in trying to issue SMTP commands, all except QUIT are rejected
28930 with the error
28931 .code
28932 554 Security failure
28933 .endd
28934 If a STARTTLS command is issued within an existing TLS session, it is
28935 rejected with a 554 error code.
28936
28937 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28938 must be set to match some hosts. The default is * which matches all hosts.
28939
28940 If this is all you do, TLS encryption will be enabled but not authentication -
28941 meaning that the peer has no assurance it is actually you he is talking to.
28942 You gain protection from a passive sniffer listening on the wire but not
28943 from someone able to intercept the communication.
28944
28945 Further protection requires some further configuration at the server end.
28946
28947 To make TLS work you need to set, in the server,
28948 .code
28949 tls_certificate = /some/file/name
28950 tls_privatekey = /some/file/name
28951 .endd
28952 These options are, in fact, expanded strings, so you can make them depend on
28953 the identity of the client that is connected if you wish. The first file
28954 contains the server's X509 certificate, and the second contains the private key
28955 that goes with it. These files need to be
28956 PEM format and readable by the Exim user, and must
28957 always be given as full path names.
28958 The key must not be password-protected.
28959 They can be the same file if both the
28960 certificate and the key are contained within it. If &%tls_privatekey%& is not
28961 set, or if its expansion is forced to fail or results in an empty string, this
28962 is assumed to be the case. The certificate file may also contain intermediate
28963 certificates that need to be sent to the client to enable it to authenticate
28964 the server's certificate.
28965
28966 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28967 colon-separated lists of file paths.  Ciphers using given authentication
28968 algorithms require the presence of a suitable certificate to supply the
28969 public-key.  The server selects among the certificates to present to the
28970 client depending on the selected cipher, hence the priority ordering for
28971 ciphers will affect which certificate is used.
28972
28973 If you do not understand about certificates and keys, please try to find a
28974 source of this background information, which is not Exim-specific. (There are a
28975 few comments below in section &<<SECTcerandall>>&.)
28976
28977 &*Note*&: These options do not apply when Exim is operating as a client &--
28978 they apply only in the case of a server. If you need to use a certificate in an
28979 Exim client, you must set the options of the same names in an &(smtp)&
28980 transport.
28981
28982 With just these options, an Exim server will be able to use TLS. It does not
28983 require the client to have a certificate (but see below for how to insist on
28984 this). There is one other option that may be needed in other situations. If
28985 .code
28986 tls_dhparam = /some/file/name
28987 .endd
28988 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28989 with the parameters contained in the file.
28990 Set this to &`none`& to disable use of DH entirely, by making no prime
28991 available:
28992 .code
28993 tls_dhparam = none
28994 .endd
28995 This may also be set to a string identifying a standard prime to be used for
28996 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28997 used is &`ike23`&.  There are a few standard primes available, see the
28998 documentation for &%tls_dhparam%& for the complete list.
28999
29000 See the command
29001 .code
29002 openssl dhparam
29003 .endd
29004 for a way of generating file data.
29005
29006 The strings supplied for these three options are expanded every time a client
29007 host connects. It is therefore possible to use different certificates and keys
29008 for different hosts, if you so wish, by making use of the client's IP address
29009 in &$sender_host_address$& to control the expansion. If a string expansion is
29010 forced to fail, Exim behaves as if the option is not set.
29011
29012 .cindex "cipher" "logging"
29013 .cindex "log" "TLS cipher"
29014 .vindex "&$tls_in_cipher$&"
29015 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29016 an incoming TLS connection. It is included in the &'Received:'& header of an
29017 incoming message (by default &-- you can, of course, change this), and it is
29018 also included in the log line that records a message's arrival, keyed by
29019 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29020 condition can be used to test for specific cipher suites in ACLs.
29021
29022 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29023 can check the name of the cipher suite and vary their actions accordingly. The
29024 cipher suite names vary, depending on which TLS library is being used. For
29025 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29026 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29027 documentation for more details.
29028
29029 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29030 (again depending on the &%tls_cipher%& log selector).
29031
29032
29033 .section "Requesting and verifying client certificates" "SECID183"
29034 .cindex "certificate" "verification of client"
29035 .cindex "TLS" "client certificate verification"
29036 If you want an Exim server to request a certificate when negotiating a TLS
29037 session with a client, you must set either &%tls_verify_hosts%& or
29038 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29039 apply to all TLS connections. For any host that matches one of these options,
29040 Exim requests a certificate as part of the setup of the TLS session. The
29041 contents of the certificate are verified by comparing it with a list of
29042 expected trust-anchors or certificates.
29043 These may be the system default set (depending on library version),
29044 an explicit file or,
29045 depending on library version, a directory, identified by
29046 &%tls_verify_certificates%&.
29047
29048 A file can contain multiple certificates, concatenated end to end. If a
29049 directory is used
29050 (OpenSSL only),
29051 each certificate must be in a separate file, with a name (or a symbolic link)
29052 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29053 certificate. You can compute the relevant hash by running the command
29054 .code
29055 openssl x509 -hash -noout -in /cert/file
29056 .endd
29057 where &_/cert/file_& contains a single certificate.
29058
29059 There is no checking of names of the client against the certificate
29060 Subject Name or Subject Alternate Names.
29061
29062 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29063 what happens if the client does not supply a certificate, or if the certificate
29064 does not match any of the certificates in the collection named by
29065 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29066 attempt to set up a TLS session is aborted, and the incoming connection is
29067 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29068 session continues. ACLs that run for subsequent SMTP commands can detect the
29069 fact that no certificate was verified, and vary their actions accordingly. For
29070 example, you can insist on a certificate before accepting a message for
29071 relaying, but not when the message is destined for local delivery.
29072
29073 .vindex "&$tls_in_peerdn$&"
29074 When a client supplies a certificate (whether it verifies or not), the value of
29075 the Distinguished Name of the certificate is made available in the variable
29076 &$tls_in_peerdn$& during subsequent processing of the message.
29077
29078 .cindex "log" "distinguished name"
29079 Because it is often a long text string, it is not included in the log line or
29080 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29081 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29082 &%received_header_text%& to change the &'Received:'& header. When no
29083 certificate is supplied, &$tls_in_peerdn$& is empty.
29084
29085
29086 .section "Revoked certificates" "SECID184"
29087 .cindex "TLS" "revoked certificates"
29088 .cindex "revocation list"
29089 .cindex "certificate" "revocation list"
29090 .cindex "OCSP" "stapling"
29091 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29092 certificates are revoked. If you have such a list, you can pass it to an Exim
29093 server using the global option called &%tls_crl%& and to an Exim client using
29094 an identically named option for the &(smtp)& transport. In each case, the value
29095 of the option is expanded and must then be the name of a file that contains a
29096 CRL in PEM format.
29097 The downside is that clients have to periodically re-download a potentially huge
29098 file from every certificate authority they know of.
29099
29100 The way with most moving parts at query time is Online Certificate
29101 Status Protocol (OCSP), where the client verifies the certificate
29102 against an OCSP server run by the CA.  This lets the CA track all
29103 usage of the certs.  It requires running software with access to the
29104 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29105 is based on HTTP and can be proxied accordingly.
29106
29107 The only widespread OCSP server implementation (known to this writer)
29108 comes as part of OpenSSL and aborts on an invalid request, such as
29109 connecting to the port and then disconnecting.  This requires
29110 re-entering the passphrase each time some random client does this.
29111
29112 The third way is OCSP Stapling; in this, the server using a certificate
29113 issued by the CA periodically requests an OCSP proof of validity from
29114 the OCSP server, then serves it up inline as part of the TLS
29115 negotiation.   This approach adds no extra round trips, does not let the
29116 CA track users, scales well with number of certs issued by the CA and is
29117 resilient to temporary OCSP server failures, as long as the server
29118 starts retrying to fetch an OCSP proof some time before its current
29119 proof expires.  The downside is that it requires server support.
29120
29121 Unless Exim is built with the support disabled,
29122 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29123 support for OCSP stapling is included.
29124
29125 There is a global option called &%tls_ocsp_file%&.
29126 The file specified therein is expected to be in DER format, and contain
29127 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29128 option will be re-expanded for SNI, if the &%tls_certificate%& option
29129 contains &`tls_in_sni`&, as per other TLS options.
29130
29131 Exim does not at this time implement any support for fetching a new OCSP
29132 proof.  The burden is on the administrator to handle this, outside of
29133 Exim.  The file specified should be replaced atomically, so that the
29134 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29135 on each connection, so a new file will be handled transparently on the
29136 next connection.
29137
29138 When built with OpenSSL Exim will check for a valid next update timestamp
29139 in the OCSP proof; if not present, or if the proof has expired, it will be
29140 ignored.
29141
29142 For the client to be able to verify the stapled OCSP the server must
29143 also supply, in its stapled information, any intermediate
29144 certificates for the chain leading to the OCSP proof from the signer
29145 of the server certificate.  There may be zero or one such. These
29146 intermediate certificates should be added to the server OCSP stapling
29147 file named by &%tls_ocsp_file%&.
29148
29149 Note that the proof only covers the terminal server certificate,
29150 not any of the chain from CA to it.
29151
29152 There is no current way to staple a proof for a client certificate.
29153
29154 .code
29155   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29156   OCSP server is supplied.  The server URL may be included in the
29157   server certificate, if the CA is helpful.
29158
29159   One failure mode seen was the OCSP Signer cert expiring before the end
29160   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29161   noted this as invalid overall, but the re-fetch script did not.
29162 .endd
29163
29164
29165
29166
29167 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29168 .cindex "cipher" "logging"
29169 .cindex "log" "TLS cipher"
29170 .cindex "log" "distinguished name"
29171 .cindex "TLS" "configuring an Exim client"
29172 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29173 deliveries as well as to incoming, the latter one causing logging of the
29174 server certificate's DN. The remaining client configuration for TLS is all
29175 within the &(smtp)& transport.
29176
29177 .cindex "ESMTP extensions" STARTTLS
29178 It is not necessary to set any options to have TLS work in the &(smtp)&
29179 transport. If Exim is built with TLS support, and TLS is advertised by a
29180 server, the &(smtp)& transport always tries to start a TLS session. However,
29181 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29182 transport) to a list of server hosts for which TLS should not be used.
29183
29184 If you do not want Exim to attempt to send messages unencrypted when an attempt
29185 to set up an encrypted connection fails in any way, you can set
29186 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29187 those hosts, delivery is always deferred if an encrypted connection cannot be
29188 set up. If there are any other hosts for the address, they are tried in the
29189 usual way.
29190
29191 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29192 the message unencrypted. It always does this if the response to STARTTLS is
29193 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29194 session after a success response code, what happens is controlled by the
29195 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29196 delivery to this host is deferred, and other hosts (if available) are tried. If
29197 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29198 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29199 negotiation fails, Exim closes the current connection (because it is in an
29200 unknown state), opens a new one to the same host, and then tries the delivery
29201 unencrypted.
29202
29203 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29204 transport provide the client with a certificate, which is passed to the server
29205 if it requests it. If the server is Exim, it will request a certificate only if
29206 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29207
29208 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29209 for client use (they are usable for server use).
29210 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29211 in failed connections.
29212
29213 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29214 specifies a collection of expected server certificates.
29215 These may be
29216 the system default set (depending on library version),
29217 a file,
29218 or (depending on library version) a directory.
29219 The client verifies the server's certificate
29220 against this collection, taking into account any revoked certificates that are
29221 in the list defined by &%tls_crl%&.
29222 Failure to verify fails the TLS connection unless either of the
29223 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29224
29225 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29226 certificate verification to the listed servers.  Verification either must
29227 or need not succeed respectively.
29228
29229 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29230 name checks are made on the server certificate.
29231 .new
29232 The match against this list is, as per other Exim usage, the
29233 IP for the host.  That is most closely associated with the
29234 name on the DNS A (or AAAA) record for the host.
29235 However, the name that needs to be in the certificate
29236 is the one at the head of any CNAME chain leading to the A record.
29237 .wen
29238 The option defaults to always checking.
29239
29240 The &(smtp)& transport has two OCSP-related options:
29241 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29242 is requested and required for the connection to proceed.  The default
29243 value is empty.
29244 &%hosts_request_ocsp%&; a host-list for which (additionally)
29245 a Certificate Status is requested (but not necessarily verified).  The default
29246 value is "*" meaning that requests are made unless configured
29247 otherwise.
29248
29249 The host(s) should also be in &%hosts_require_tls%&, and
29250 &%tls_verify_certificates%& configured for the transport,
29251 for OCSP to be relevant.
29252
29253 If
29254 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29255 list of permitted cipher suites. If either of these checks fails, delivery to
29256 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29257 alternative hosts, if any.
29258
29259  &*Note*&:
29260 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29261 is operating as a client. Exim does not assume that a server certificate (set
29262 by the global options of the same name) should also be used when operating as a
29263 client.
29264
29265 .vindex "&$host$&"
29266 .vindex "&$host_address$&"
29267 All the TLS options in the &(smtp)& transport are expanded before use, with
29268 &$host$& and &$host_address$& containing the name and address of the server to
29269 which the client is connected. Forced failure of an expansion causes Exim to
29270 behave as if the relevant option were unset.
29271
29272 .vindex &$tls_out_bits$&
29273 .vindex &$tls_out_cipher$&
29274 .vindex &$tls_out_peerdn$&
29275 .vindex &$tls_out_sni$&
29276 Before an SMTP connection is established, the
29277 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29278 variables are emptied. (Until the first connection, they contain the values
29279 that were set when the message was received.) If STARTTLS is subsequently
29280 successfully obeyed, these variables are set to the relevant values for the
29281 outgoing connection.
29282
29283
29284
29285 .section "Use of TLS Server Name Indication" "SECTtlssni"
29286 .cindex "TLS" "Server Name Indication"
29287 .vindex "&$tls_in_sni$&"
29288 .oindex "&%tls_in_sni%&"
29289 With TLS1.0 or above, there is an extension mechanism by which extra
29290 information can be included at various points in the protocol.  One of these
29291 extensions, documented in RFC 6066 (and before that RFC 4366) is
29292 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29293 client in the initial handshake, so that the server can examine the servername
29294 within and possibly choose to use different certificates and keys (and more)
29295 for this session.
29296
29297 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29298 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29299 address.
29300
29301 With SMTP to MX, there are the same problems here as in choosing the identity
29302 against which to validate a certificate: you can't rely on insecure DNS to
29303 provide the identity which you then cryptographically verify.  So this will
29304 be of limited use in that environment.
29305
29306 With SMTP to Submission, there is a well-defined hostname which clients are
29307 connecting to and can validate certificates against.  Thus clients &*can*&
29308 choose to include this information in the TLS negotiation.  If this becomes
29309 wide-spread, then hosters can choose to present different certificates to
29310 different clients.  Or even negotiate different cipher suites.
29311
29312 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29313 if not empty, will be sent on a TLS session as part of the handshake.  There's
29314 nothing more to it.  Choosing a sensible value not derived insecurely is the
29315 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29316 for the lifetime of the client connection (including during authentication).
29317
29318 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29319 received from a client.
29320 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29321
29322 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29323 option (prior to expansion) then the following options will be re-expanded
29324 during TLS session handshake, to permit alternative values to be chosen:
29325
29326 .ilist
29327 &%tls_certificate%&
29328 .next
29329 &%tls_crl%&
29330 .next
29331 &%tls_privatekey%&
29332 .next
29333 &%tls_verify_certificates%&
29334 .next
29335 &%tls_ocsp_file%&
29336 .endlist
29337
29338 Great care should be taken to deal with matters of case, various injection
29339 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29340 can always be referenced; it is important to remember that &$tls_in_sni$& is
29341 arbitrary unverified data provided prior to authentication.
29342 Further, the initial certificate is loaded before SNI has arrived, so
29343 an expansion for &%tls_certificate%& must have a default which is used
29344 when &$tls_in_sni$& is empty.
29345
29346 The Exim developers are proceeding cautiously and so far no other TLS options
29347 are re-expanded.
29348
29349 When Exim is built against OpenSSL, OpenSSL must have been built with support
29350 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29351 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29352 see &`-servername`& in the output, then OpenSSL has support.
29353
29354 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29355 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29356 built, then you have SNI support).
29357
29358
29359
29360 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29361          "SECTmulmessam"
29362 .cindex "multiple SMTP deliveries with TLS"
29363 .cindex "TLS" "multiple message deliveries"
29364 Exim sends multiple messages down the same TCP/IP connection by starting up
29365 an entirely new delivery process for each message, passing the socket from
29366 one process to the next. This implementation does not fit well with the use
29367 of TLS, because there is quite a lot of state information associated with a TLS
29368 connection, not just a socket identification. Passing all the state information
29369 to a new process is not feasible. Consequently, for sending using TLS Exim
29370 starts an additional proxy process for handling the encryption, piping the
29371 unencrypted data stream from and to the delivery processes.
29372
29373 An older mode of operation can be enabled on a per-host basis by the
29374 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29375 this list the proxy process described above is not used; instead Exim
29376 shuts down an existing TLS session being run by the delivery process
29377 before passing the socket to a new process. The new process may then
29378 try to start a new TLS session, and if successful, may try to re-authenticate
29379 if AUTH is in use, before sending the next message.
29380
29381 The RFC is not clear as to whether or not an SMTP session continues in clear
29382 after TLS has been shut down, or whether TLS may be restarted again later, as
29383 just described. However, if the server is Exim, this shutdown and
29384 reinitialization works. It is not known which (if any) other servers operate
29385 successfully if the client closes a TLS session and continues with unencrypted
29386 SMTP, but there are certainly some that do not work. For such servers, Exim
29387 should not pass the socket to another process, because the failure of the
29388 subsequent attempt to use it would cause Exim to record a temporary host error,
29389 and delay other deliveries to that host.
29390
29391 To test for this case, Exim sends an EHLO command to the server after
29392 closing down the TLS session. If this fails in any way, the connection is
29393 closed instead of being passed to a new delivery process, but no retry
29394 information is recorded.
29395
29396 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29397 &(smtp)& transport to match those hosts for which Exim should not pass
29398 connections to new processes if TLS has been used.
29399
29400
29401
29402
29403 .section "Certificates and all that" "SECTcerandall"
29404 .cindex "certificate" "references to discussion"
29405 In order to understand fully how TLS works, you need to know about
29406 certificates, certificate signing, and certificate authorities.
29407 This is a large topic and an introductory guide is unsuitable for the Exim
29408 reference manual, so instead we provide pointers to existing documentation.
29409
29410 The Apache web-server was for a long time the canonical guide, so their
29411 documentation is a good place to start; their SSL module's Introduction
29412 document is currently at
29413 .display
29414 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29415 .endd
29416 and their FAQ is at
29417 .display
29418 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29419 .endd
29420
29421 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29422 0-201-61598-3) in 2001, contains both introductory and more in-depth
29423 descriptions.
29424 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29425 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29426 Ivan is the author of the popular TLS testing tools at
29427 &url(https://www.ssllabs.com/).
29428
29429
29430 .section "Certificate chains" "SECID186"
29431 The file named by &%tls_certificate%& may contain more than one
29432 certificate. This is useful in the case where the certificate that is being
29433 sent is validated by an intermediate certificate which the other end does
29434 not have. Multiple certificates must be in the correct order in the file.
29435 First the host's certificate itself, then the first intermediate
29436 certificate to validate the issuer of the host certificate, then the next
29437 intermediate certificate to validate the issuer of the first intermediate
29438 certificate, and so on, until finally (optionally) the root certificate.
29439 The root certificate must already be trusted by the recipient for
29440 validation to succeed, of course, but if it's not preinstalled, sending the
29441 root certificate along with the rest makes it available for the user to
29442 install if the receiving end is a client MUA that can interact with a user.
29443
29444 Note that certificates using MD5 are unlikely to work on today's Internet;
29445 even if your libraries allow loading them for use in Exim when acting as a
29446 server, increasingly clients will not accept such certificates.  The error
29447 diagnostics in such a case can be frustratingly vague.
29448
29449
29450
29451 .section "Self-signed certificates" "SECID187"
29452 .cindex "certificate" "self-signed"
29453 You can create a self-signed certificate using the &'req'& command provided
29454 with OpenSSL, like this:
29455 . ==== Do not shorten the duration here without reading and considering
29456 . ==== the text below.  Please leave it at 9999 days.
29457 .code
29458 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29459             -days 9999 -nodes
29460 .endd
29461 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29462 delimited and so can be identified independently. The &%-days%& option
29463 specifies a period for which the certificate is valid. The &%-nodes%& option is
29464 important: if you do not set it, the key is encrypted with a passphrase
29465 that you are prompted for, and any use that is made of the key causes more
29466 prompting for the passphrase. This is not helpful if you are going to use
29467 this certificate and key in an MTA, where prompting is not possible.
29468
29469 . ==== I expect to still be working 26 years from now.  The less technical
29470 . ==== debt I create, in terms of storing up trouble for my later years, the
29471 . ==== happier I will be then.  We really have reached the point where we
29472 . ==== should start, at the very least, provoking thought and making folks
29473 . ==== pause before proceeding, instead of leaving all the fixes until two
29474 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29475 . ==== -pdp, 2012
29476 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29477 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29478 the above command might produce a date in the past.  Think carefully about
29479 the lifetime of the systems you're deploying, and either reduce the duration
29480 of the certificate or reconsider your platform deployment.  (At time of
29481 writing, reducing the duration is the most likely choice, but the inexorable
29482 progression of time takes us steadily towards an era where this will not
29483 be a sensible resolution).
29484
29485 A self-signed certificate made in this way is sufficient for testing, and
29486 may be adequate for all your requirements if you are mainly interested in
29487 encrypting transfers, and not in secure identification.
29488
29489 However, many clients require that the certificate presented by the server be a
29490 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29491 certificate. In this situation, the self-signed certificate described above
29492 must be installed on the client host as a trusted root &'certification
29493 authority'& (CA), and the certificate used by Exim must be a user certificate
29494 signed with that self-signed certificate.
29495
29496 For information on creating self-signed CA certificates and using them to sign
29497 user certificates, see the &'General implementation overview'& chapter of the
29498 Open-source PKI book, available online at
29499 &url(https://sourceforge.net/projects/ospkibook/).
29500 .ecindex IIDencsmtp1
29501 .ecindex IIDencsmtp2
29502
29503
29504
29505 .section DANE "SECDANE"
29506 .cindex DANE
29507 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29508 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29509 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29510 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29511 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29512 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29513
29514 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29515 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29516 by (a) is thought to be smaller than that of the set of root CAs.
29517
29518 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29519 fail to pass on a server's STARTTLS.
29520
29521 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29522 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29523 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29524
29525 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29526 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29527 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29528 DNSSEC.
29529 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29530 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29531
29532 There are no changes to Exim specific to server-side operation of DANE.
29533 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29534 in &_Local/Makefile_&.
29535 If it has been included, the macro "_HAVE_DANE" will be defined.
29536
29537 A TLSA record consist of 4 fields, the "Certificate Usage", the
29538 "Selector", the "Matching type", and the "Certificate Association Data".
29539 For a detailed description of the TLSA record see
29540 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29541
29542 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29543 These are the "Trust Anchor" and "End Entity" variants.
29544 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29545 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29546 this is appropriate for a single system, using a self-signed certificate.
29547 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29548 well-known one.
29549 A private CA at simplest is just a self-signed certificate (with certain
29550 attributes) which is used to sign server certificates, but running one securely
29551 does require careful arrangement.
29552 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29553 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29554 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29555 all of which point to a single TLSA record.
29556 DANE-TA and DANE-EE can both be used together.
29557
29558 Our recommendation is to use DANE with a certificate from a public CA,
29559 because this enables a variety of strategies for remote clients to verify
29560 your certificate.
29561 You can then publish information both via DANE and another technology,
29562 "MTA-STS", described below.
29563
29564 When you use DANE-TA to publish trust anchor information, you ask entities
29565 outside your administrative control to trust the Certificate Authority for
29566 connections to you.
29567 If using a private CA then you should expect others to still apply the
29568 technical criteria they'd use for a public CA to your certificates.
29569 In particular, you should probably try to follow current best practices for CA
29570 operation around hash algorithms and key sizes.
29571 Do not expect other organizations to lower their security expectations just
29572 because a particular profile might be reasonable for your own internal use.
29573
29574 When this text was last updated, this in practice means to avoid use of SHA-1
29575 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29576 than 4096, for interoperability); to use keyUsage fields correctly; to use
29577 random serial numbers.
29578 The list of requirements is subject to change as best practices evolve.
29579 If you're not already using a private CA, or it doesn't meet these
29580 requirements, then we encourage you to avoid all these issues and use a public
29581 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29582
29583 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29584 a "Matching Type" (3rd) field of SHA2-512(2).
29585
29586 For the "Certificate Authority Data" (4th) field, commands like
29587
29588 .code
29589   openssl x509 -pubkey -noout <certificate.pem \
29590   | openssl rsa -outform der -pubin 2>/dev/null \
29591   | openssl sha512 \
29592   | awk '{print $2}'
29593 .endd
29594
29595 are workable to create a hash of the certificate's public key.
29596
29597 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29598
29599 .code
29600   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29601 .endd
29602
29603 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29604 is useful for quickly generating TLSA records.
29605
29606
29607 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29608
29609 The Certificate issued by the CA published in the DANE-TA model should be
29610 issued using a strong hash algorithm.
29611 Exim, and importantly various other MTAs sending to you, will not
29612 re-enable hash algorithms which have been disabled by default in TLS
29613 libraries.
29614 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29615 interoperability (and probably the maximum too, in 2018).
29616
29617 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29618 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29619 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29620
29621 .code
29622   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29623                                  {= {4}{$tls_out_tlsa_usage}} } \
29624                          {*}{}}
29625 .endd
29626
29627 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29628 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29629 found. If the definition of &%hosts_request_ocsp%& includes the
29630 string "tls_out_tlsa_usage", they are re-expanded in time to
29631 control the OCSP request.
29632
29633 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29634 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29635
29636
29637 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29638 and &%dane_require_tls_ciphers%&.
29639 The &"require"& variant will result in failure if the target host is not
29640 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29641 the &%dnssec_request_domains%& router or transport option.
29642
29643 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29644
29645 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29646 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29647 will be required for the host.  If it does not, the host will not
29648 be used; there is no fallback to non-DANE or non-TLS.
29649
29650 If DANE is requested and usable, then the TLS cipher list configuration
29651 prefers to use the option &%dane_require_tls_ciphers%& and falls
29652 back to &%tls_require_ciphers%& only if that is unset.
29653 This lets you configure "decent crypto" for DANE and "better than nothing
29654 crypto" as the default.  Note though that while GnuTLS lets the string control
29655 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29656 limited to ciphersuite constraints.
29657
29658 If DANE is requested and useable (see above) the following transport options are ignored:
29659 .code
29660   hosts_require_tls
29661   tls_verify_hosts
29662   tls_try_verify_hosts
29663   tls_verify_certificates
29664   tls_crl
29665   tls_verify_cert_hostnames
29666 .endd
29667
29668 If DANE is not usable, whether requested or not, and CA-anchored
29669 verification evaluation is wanted, the above variables should be set appropriately.
29670
29671 The router and transport option &%dnssec_request_domains%& must not be
29672 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29673
29674 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29675
29676 There is a new variable &$tls_out_dane$& which will have "yes" if
29677 verification succeeded using DANE and "no" otherwise (only useful
29678 in combination with events; see &<<CHAPevents>>&),
29679 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29680
29681 .cindex DANE reporting
29682 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29683 to achieve DANE-verified connection, if one was either requested and offered, or
29684 required.  This is intended to support TLS-reporting as defined in
29685 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29686 The &$event_data$& will be one of the Result Types defined in
29687 Section 4.3 of that document.
29688
29689 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29690
29691 DANE is specified in published RFCs and decouples certificate authority trust
29692 selection from a "race to the bottom" of "you must trust everything for mail
29693 to get through".  There is an alternative technology called MTA-STS, which
29694 instead publishes MX trust anchor information on an HTTPS website.  At the
29695 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29696 Exim has no support for MTA-STS as a client, but Exim mail server operators
29697 can choose to publish information describing their TLS configuration using
29698 MTA-STS to let those clients who do use that protocol derive trust
29699 information.
29700
29701 The MTA-STS design requires a certificate from a public Certificate Authority
29702 which is recognized by clients sending to you.
29703 That selection of which CAs are trusted by others is outside your control.
29704
29705 The most interoperable course of action is probably to use
29706 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29707 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29708 records for DANE clients (such as Exim and Postfix) and to publish anchor
29709 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29710 domain itself (with caveats around occasionally broken MTA-STS because of
29711 incompatible specification changes prior to reaching RFC status).
29712
29713
29714
29715 . ////////////////////////////////////////////////////////////////////////////
29716 . ////////////////////////////////////////////////////////////////////////////
29717
29718 .chapter "Access control lists" "CHAPACL"
29719 .scindex IIDacl "&ACL;" "description"
29720 .cindex "control of incoming mail"
29721 .cindex "message" "controlling incoming"
29722 .cindex "policy control" "access control lists"
29723 Access Control Lists (ACLs) are defined in a separate section of the runtime
29724 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29725 name, terminated by a colon. Here is a complete ACL section that contains just
29726 one very small ACL:
29727 .code
29728 begin acl
29729 small_acl:
29730   accept   hosts = one.host.only
29731 .endd
29732 You can have as many lists as you like in the ACL section, and the order in
29733 which they appear does not matter. The lists are self-terminating.
29734
29735 The majority of ACLs are used to control Exim's behaviour when it receives
29736 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29737 when a local process submits a message using SMTP by specifying the &%-bs%&
29738 option. The most common use is for controlling which recipients are accepted
29739 in incoming messages. In addition, you can define an ACL that is used to check
29740 local non-SMTP messages. The default configuration file contains an example of
29741 a realistic ACL for checking RCPT commands. This is discussed in chapter
29742 &<<CHAPdefconfil>>&.
29743
29744
29745 .section "Testing ACLs" "SECID188"
29746 The &%-bh%& command line option provides a way of testing your ACL
29747 configuration locally by running a fake SMTP session with which you interact.
29748
29749
29750 .section "Specifying when ACLs are used" "SECID189"
29751 .cindex "&ACL;" "options for specifying"
29752 In order to cause an ACL to be used, you have to name it in one of the relevant
29753 options in the main part of the configuration. These options are:
29754 .cindex "AUTH" "ACL for"
29755 .cindex "DATA" "ACLs for"
29756 .cindex "ETRN" "ACL for"
29757 .cindex "EXPN" "ACL for"
29758 .cindex "HELO" "ACL for"
29759 .cindex "EHLO" "ACL for"
29760 .cindex "DKIM" "ACL for"
29761 .cindex "MAIL" "ACL for"
29762 .cindex "QUIT, ACL for"
29763 .cindex "RCPT" "ACL for"
29764 .cindex "STARTTLS, ACL for"
29765 .cindex "VRFY" "ACL for"
29766 .cindex "SMTP" "connection, ACL for"
29767 .cindex "non-SMTP messages" "ACLs for"
29768 .cindex "MIME content scanning" "ACL for"
29769 .cindex "PRDR" "ACL for"
29770
29771 .table2 140pt
29772 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29773 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29774 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29775 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29776 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29777 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29778 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29779 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29780 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29781 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29782 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29783 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29784 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29785 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29786 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29787 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29788 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29789 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29790 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29791 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29792 .endtable
29793
29794 For example, if you set
29795 .code
29796 acl_smtp_rcpt = small_acl
29797 .endd
29798 the little ACL defined above is used whenever Exim receives a RCPT command
29799 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29800 done when RCPT commands arrive. A rejection of RCPT should cause the
29801 sending MTA to give up on the recipient address contained in the RCPT
29802 command, whereas rejection at other times may cause the client MTA to keep on
29803 trying to deliver the message. It is therefore recommended that you do as much
29804 testing as possible at RCPT time.
29805
29806
29807 .section "The non-SMTP ACLs" "SECID190"
29808 .cindex "non-SMTP messages" "ACLs for"
29809 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29810 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29811 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29812 the state of the SMTP connection such as encryption and authentication) are not
29813 relevant and are forbidden in these ACLs. However, the sender and recipients
29814 are known, so the &%senders%& and &%sender_domains%& conditions and the
29815 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29816 &$authenticated_sender$& are also available. You can specify added header lines
29817 in any of these ACLs.
29818
29819 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29820 non-SMTP message, before any of the message has been read. (This is the
29821 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29822 batched SMTP input, it runs after the DATA command has been reached. The
29823 result of this ACL is ignored; it cannot be used to reject a message. If you
29824 really need to, you could set a value in an ACL variable here and reject based
29825 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29826 controls, and in particular, it can be used to set
29827 .code
29828 control = suppress_local_fixups
29829 .endd
29830 This cannot be used in the other non-SMTP ACLs because by the time they are
29831 run, it is too late.
29832
29833 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29834 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29835
29836 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29837 kind of rejection is treated as permanent, because there is no way of sending a
29838 temporary error for these kinds of message.
29839
29840
29841 .section "The SMTP connect ACL" "SECID191"
29842 .cindex "SMTP" "connection, ACL for"
29843 .oindex &%smtp_banner%&
29844 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29845 session, after the test specified by &%host_reject_connection%& (which is now
29846 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29847 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29848 the message override the banner message that is otherwise specified by the
29849 &%smtp_banner%& option.
29850
29851
29852 .section "The EHLO/HELO ACL" "SECID192"
29853 .cindex "EHLO" "ACL for"
29854 .cindex "HELO" "ACL for"
29855 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29856 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29857 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29858 Note that a client may issue more than one EHLO or HELO command in an SMTP
29859 session, and indeed is required to issue a new EHLO or HELO after successfully
29860 setting up encryption following a STARTTLS command.
29861
29862 Note also that a deny neither forces the client to go away nor means that
29863 mail will be refused on the connection.  Consider checking for
29864 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29865
29866 If the command is accepted by an &%accept%& verb that has a &%message%&
29867 modifier, the message may not contain more than one line (it will be truncated
29868 at the first newline and a panic logged if it does). Such a message cannot
29869 affect the EHLO options that are listed on the second and subsequent lines of
29870 an EHLO response.
29871
29872
29873 .section "The DATA ACLs" "SECID193"
29874 .cindex "DATA" "ACLs for"
29875 Two ACLs are associated with the DATA command, because it is two-stage
29876 command, with two responses being sent to the client.
29877 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29878 is obeyed. This gives you control after all the RCPT commands, but before
29879 the message itself is received. It offers the opportunity to give a negative
29880 response to the DATA command before the data is transmitted. Header lines
29881 added by MAIL or RCPT ACLs are not visible at this time, but any that
29882 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29883
29884 You cannot test the contents of the message, for example, to verify addresses
29885 in the headers, at RCPT time or when the DATA command is received. Such
29886 tests have to appear in the ACL that is run after the message itself has been
29887 received, before the final response to the DATA command is sent. This is
29888 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29889 associated with the DATA command.
29890
29891 .cindex CHUNKING "BDAT command"
29892 .cindex BDAT "SMTP command"
29893 .cindex "RFC 3030" CHUNKING
29894 If CHUNKING was advertised and a BDAT command sequence is received,
29895 the &%acl_smtp_predata%& ACL is not run.
29896 . XXX why not?  It should be possible, for the first BDAT.
29897 The &%acl_smtp_data%& is run after the last BDAT command and all of
29898 the data specified is received.
29899
29900 For both of these ACLs, it is not possible to reject individual recipients. An
29901 error response rejects the entire message. Unfortunately, it is known that some
29902 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29903 before or after the data) correctly &-- they keep the message on their queues
29904 and try again later, but that is their problem, though it does waste some of
29905 your resources.
29906
29907 The &%acl_smtp_data%& ACL is run after
29908 the &%acl_smtp_data_prdr%&,
29909 the &%acl_smtp_dkim%&
29910 and the &%acl_smtp_mime%& ACLs.
29911
29912 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29913 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29914 enabled (which is the default).
29915
29916 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29917 received, and is executed for each DKIM signature found in a message.  If not
29918 otherwise specified, the default action is to accept.
29919
29920 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29921
29922 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29923
29924
29925 .section "The SMTP MIME ACL" "SECID194"
29926 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29927 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29928
29929 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29930
29931
29932 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29933 .cindex "PRDR" "ACL for"
29934 .oindex "&%prdr_enable%&"
29935 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29936 with PRDR support enabled (which is the default).
29937 It becomes active only when the PRDR feature is negotiated between
29938 client and server for a message, and more than one recipient
29939 has been accepted.
29940
29941 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29942 has been received, and is executed once for each recipient of the message
29943 with &$local_part$& and &$domain$& valid.
29944 The test may accept, defer or deny for individual recipients.
29945 The &%acl_smtp_data%& will still be called after this ACL and
29946 can reject the message overall, even if this ACL has accepted it
29947 for some or all recipients.
29948
29949 PRDR may be used to support per-user content filtering.  Without it
29950 one must defer any recipient after the first that has a different
29951 content-filter configuration.  With PRDR, the RCPT-time check
29952 .cindex "PRDR" "variable for"
29953 for this can be disabled when the variable &$prdr_requested$&
29954 is &"yes"&.
29955 Any required difference in behaviour of the main DATA-time
29956 ACL should however depend on the PRDR-time ACL having run, as Exim
29957 will avoid doing so in some situations (e.g. single-recipient mails).
29958
29959 See also the &%prdr_enable%& global option
29960 and the &%hosts_try_prdr%& smtp transport option.
29961
29962 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29963 If the ACL is not defined, processing completes as if
29964 the feature was not requested by the client.
29965
29966 .section "The QUIT ACL" "SECTQUITACL"
29967 .cindex "QUIT, ACL for"
29968 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29969 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29970 does not in fact control any access.
29971 For this reason, it may only accept
29972 or warn as its final result.
29973
29974 This ACL can be used for tasks such as custom logging at the end of an SMTP
29975 session. For example, you can use ACL variables in other ACLs to count
29976 messages, recipients, etc., and log the totals at QUIT time using one or
29977 more &%logwrite%& modifiers on a &%warn%& verb.
29978
29979 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29980 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29981
29982 You do not need to have a final &%accept%&, but if you do, you can use a
29983 &%message%& modifier to specify custom text that is sent as part of the 221
29984 response to QUIT.
29985
29986 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29987 failure (for example, failure to open a log file, or when Exim is bombing out
29988 because it has detected an unrecoverable error), all SMTP commands from the
29989 client are given temporary error responses until QUIT is received or the
29990 connection is closed. In these special cases, the QUIT ACL does not run.
29991
29992
29993 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29994 .vindex &$acl_smtp_notquit$&
29995 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29996 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29997 trouble, such as being unable to write to its log files, this ACL is not run,
29998 because it might try to do things (such as write to log files) that make the
29999 situation even worse.
30000
30001 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30002 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30003 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30004 and &%warn%&.
30005
30006 .vindex &$smtp_notquit_reason$&
30007 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30008 to a string that indicates the reason for the termination of the SMTP
30009 connection. The possible values are:
30010 .table2
30011 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30012 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30013 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30014 .irow &`connection-lost`&          "The SMTP connection has been lost"
30015 .irow &`data-timeout`&             "Timeout while reading message data"
30016 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30017 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30018 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30019 .irow &`synchronization-error`&    "SMTP synchronization error"
30020 .irow &`tls-failed`&               "TLS failed to start"
30021 .endtable
30022 In most cases when an SMTP connection is closed without having received QUIT,
30023 Exim sends an SMTP response message before actually closing the connection.
30024 With the exception of the &`acl-drop`& case, the default message can be
30025 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30026 &%drop%& verb in another ACL, it is the message from the other ACL that is
30027 used.
30028
30029
30030 .section "Finding an ACL to use" "SECID195"
30031 .cindex "&ACL;" "finding which to use"
30032 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30033 you can use different ACLs in different circumstances. For example,
30034 .code
30035 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30036                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30037 .endd
30038 In the default configuration file there are some example settings for
30039 providing an RFC 4409 message &"submission"& service on port 587 and
30040 an RFC 8314 &"submissions"& service on port 465. You can use a string
30041 expansion like this to choose an ACL for MUAs on these ports which is
30042 more appropriate for this purpose than the default ACL on port 25.
30043
30044 The expanded string does not have to be the name of an ACL in the
30045 configuration file; there are other possibilities. Having expanded the
30046 string, Exim searches for an ACL as follows:
30047
30048 .ilist
30049 If the string begins with a slash, Exim uses it as a filename, and reads its
30050 contents as an ACL. The lines are processed in the same way as lines in the
30051 Exim configuration file. In particular, continuation lines are supported, blank
30052 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30053 If the file does not exist or cannot be read, an error occurs (typically
30054 causing a temporary failure of whatever caused the ACL to be run). For example:
30055 .code
30056 acl_smtp_data = /etc/acls/\
30057   ${lookup{$sender_host_address}lsearch\
30058   {/etc/acllist}{$value}{default}}
30059 .endd
30060 This looks up an ACL file to use on the basis of the host's IP address, falling
30061 back to a default if the lookup fails. If an ACL is successfully read from a
30062 file, it is retained in memory for the duration of the Exim process, so that it
30063 can be re-used without having to re-read the file.
30064 .next
30065 If the string does not start with a slash, and does not contain any spaces,
30066 Exim searches the ACL section of the configuration for an ACL whose name
30067 matches the string.
30068 .next
30069 If no named ACL is found, or if the string contains spaces, Exim parses
30070 the string as an inline ACL. This can save typing in cases where you just
30071 want to have something like
30072 .code
30073 acl_smtp_vrfy = accept
30074 .endd
30075 in order to allow free use of the VRFY command. Such a string may contain
30076 newlines; it is processed in the same way as an ACL that is read from a file.
30077 .endlist
30078
30079
30080
30081
30082 .section "ACL return codes" "SECID196"
30083 .cindex "&ACL;" "return codes"
30084 Except for the QUIT ACL, which does not affect the SMTP return code (see
30085 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30086 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30087 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30088 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30089 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30090 This also causes a 4&'xx'& return code.
30091
30092 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30093 &"deny"&, because there is no mechanism for passing temporary errors to the
30094 submitters of non-SMTP messages.
30095
30096
30097 ACLs that are relevant to message reception may also return &"discard"&. This
30098 has the effect of &"accept"&, but causes either the entire message or an
30099 individual recipient address to be discarded. In other words, it is a
30100 blackholing facility. Use it with care.
30101
30102 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30103 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30104 RCPT ACL is to discard just the one recipient address. If there are no
30105 recipients left when the message's data is received, the DATA ACL is not
30106 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30107 remaining recipients. The &"discard"& return is not permitted for the
30108 &%acl_smtp_predata%& ACL.
30109
30110 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30111 is done on the address and the result determines the SMTP response.
30112
30113
30114 .cindex "&[local_scan()]& function" "when all recipients discarded"
30115 The &[local_scan()]& function is always run, even if there are no remaining
30116 recipients; it may create new recipients.
30117
30118
30119
30120 .section "Unset ACL options" "SECID197"
30121 .cindex "&ACL;" "unset options"
30122 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30123 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30124 not defined at all. For any defined ACL, the default action when control
30125 reaches the end of the ACL statements is &"deny"&.
30126
30127 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30128 these two are ACLs that are used only for their side effects. They cannot be
30129 used to accept or reject anything.
30130
30131 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30132 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30133 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30134 when the ACL is not defined is &"accept"&.
30135
30136 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30137 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30138 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30139 messages over an SMTP connection. For an example, see the ACL in the default
30140 configuration file.
30141
30142
30143
30144
30145 .section "Data for message ACLs" "SECID198"
30146 .cindex "&ACL;" "data for message ACL"
30147 .vindex &$domain$&
30148 .vindex &$local_part$&
30149 .vindex &$sender_address$&
30150 .vindex &$sender_host_address$&
30151 .vindex &$smtp_command$&
30152 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30153 that contain information about the host and the message's sender (for example,
30154 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30155 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30156 &$local_part$& are set from the argument address. The entire SMTP command
30157 is available in &$smtp_command$&.
30158
30159 When an ACL for the AUTH parameter of MAIL is running, the variables that
30160 contain information about the host are set, but &$sender_address$& is not yet
30161 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30162 how it is used.
30163
30164 .vindex "&$message_size$&"
30165 The &$message_size$& variable is set to the value of the SIZE parameter on
30166 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30167 that parameter is not given. The value is updated to the true message size by
30168 the time the final DATA ACL is run (after the message data has been
30169 received).
30170
30171 .vindex "&$rcpt_count$&"
30172 .vindex "&$recipients_count$&"
30173 The &$rcpt_count$& variable increases by one for each RCPT command received.
30174 The &$recipients_count$& variable increases by one each time a RCPT command is
30175 accepted, so while an ACL for RCPT is being processed, it contains the number
30176 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30177 &$rcpt_count$& contains the total number of RCPT commands, and
30178 &$recipients_count$& contains the total number of accepted recipients.
30179
30180
30181
30182
30183
30184 .section "Data for non-message ACLs" "SECTdatfornon"
30185 .cindex "&ACL;" "data for non-message ACL"
30186 .vindex &$smtp_command_argument$&
30187 .vindex &$smtp_command$&
30188 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30189 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30190 and the entire SMTP command is available in &$smtp_command$&.
30191 These variables can be tested using a &%condition%& condition. For example,
30192 here is an ACL for use with AUTH, which insists that either the session is
30193 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30194 does not permit authentication methods that use cleartext passwords on
30195 unencrypted connections.
30196 .code
30197 acl_check_auth:
30198   accept encrypted = *
30199   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30200                      {CRAM-MD5}}
30201   deny   message   = TLS encryption or CRAM-MD5 required
30202 .endd
30203 (Another way of applying this restriction is to arrange for the authenticators
30204 that use cleartext passwords not to be advertised when the connection is not
30205 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30206 option to do this.)
30207
30208
30209
30210 .section "Format of an ACL" "SECID199"
30211 .cindex "&ACL;" "format of"
30212 .cindex "&ACL;" "verbs, definition of"
30213 An individual ACL consists of a number of statements. Each statement starts
30214 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30215 Modifiers can change the way the verb operates, define error and log messages,
30216 set variables, insert delays, and vary the processing of accepted messages.
30217
30218 If all the conditions are met, the verb is obeyed. The same condition may be
30219 used (with different arguments) more than once in the same statement. This
30220 provides a means of specifying an &"and"& conjunction between conditions. For
30221 example:
30222 .code
30223 deny  dnslists = list1.example
30224       dnslists = list2.example
30225 .endd
30226 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30227 the conditions and modifiers when it reaches a condition that fails. What
30228 happens then depends on the verb (and in one case, on a special modifier). Not
30229 all the conditions make sense at every testing point. For example, you cannot
30230 test a sender address in the ACL that is run for a VRFY command.
30231
30232
30233 .section "ACL verbs" "SECID200"
30234 The ACL verbs are as follows:
30235
30236 .ilist
30237 .cindex "&%accept%& ACL verb"
30238 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30239 of the conditions are not met, what happens depends on whether &%endpass%&
30240 appears among the conditions (for syntax see below). If the failing condition
30241 is before &%endpass%&, control is passed to the next ACL statement; if it is
30242 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30243 check a RCPT command:
30244 .code
30245 accept domains = +local_domains
30246        endpass
30247        verify = recipient
30248 .endd
30249 If the recipient domain does not match the &%domains%& condition, control
30250 passes to the next statement. If it does match, the recipient is verified, and
30251 the command is accepted if verification succeeds. However, if verification
30252 fails, the ACL yields &"deny"&, because the failing condition is after
30253 &%endpass%&.
30254
30255 The &%endpass%& feature has turned out to be confusing to many people, so its
30256 use is not recommended nowadays. It is always possible to rewrite an ACL so
30257 that &%endpass%& is not needed, and it is no longer used in the default
30258 configuration.
30259
30260 .cindex "&%message%& ACL modifier" "with &%accept%&"
30261 If a &%message%& modifier appears on an &%accept%& statement, its action
30262 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30263 (when an &%accept%& verb either accepts or passes control to the next
30264 statement), &%message%& can be used to vary the message that is sent when an
30265 SMTP command is accepted. For example, in a RCPT ACL you could have:
30266 .display
30267 &`accept  `&<&'some conditions'&>
30268 &`        message = OK, I will allow you through today`&
30269 .endd
30270 You can specify an SMTP response code, optionally followed by an &"extended
30271 response code"& at the start of the message, but the first digit must be the
30272 same as would be sent by default, which is 2 for an &%accept%& verb.
30273
30274 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30275 an error message that is used when access is denied. This behaviour is retained
30276 for backward compatibility, but current &"best practice"& is to avoid the use
30277 of &%endpass%&.
30278
30279
30280 .next
30281 .cindex "&%defer%& ACL verb"
30282 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30283 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30284 &%defer%& is the same as &%deny%&, because there is no way of sending a
30285 temporary error. For a RCPT command, &%defer%& is much the same as using a
30286 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30287 be used in any ACL, and even for a recipient it might be a simpler approach.
30288
30289
30290 .next
30291 .cindex "&%deny%& ACL verb"
30292 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30293 the conditions are not met, control is passed to the next ACL statement. For
30294 example,
30295 .code
30296 deny dnslists = blackholes.mail-abuse.org
30297 .endd
30298 rejects commands from hosts that are on a DNS black list.
30299
30300
30301 .next
30302 .cindex "&%discard%& ACL verb"
30303 &%discard%&: This verb behaves like &%accept%&, except that it returns
30304 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30305 that are concerned with receiving messages. When all the conditions are true,
30306 the sending entity receives a &"success"& response. However, &%discard%& causes
30307 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30308 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30309 message's recipients are discarded. Recipients that are discarded before DATA
30310 do not appear in the log line when the &%received_recipients%& log selector is set.
30311
30312 If the &%log_message%& modifier is set when &%discard%& operates,
30313 its contents are added to the line that is automatically written to the log.
30314 The &%message%& modifier operates exactly as it does for &%accept%&.
30315
30316
30317 .next
30318 .cindex "&%drop%& ACL verb"
30319 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30320 forcibly closed after the 5&'xx'& error message has been sent. For example:
30321 .code
30322 drop   condition = ${if > {$rcpt_count}{20}}
30323        message   = I don't take more than 20 RCPTs
30324 .endd
30325 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30326 The connection is always dropped after sending a 550 response.
30327
30328 .next
30329 .cindex "&%require%& ACL verb"
30330 &%require%&: If all the conditions are met, control is passed to the next ACL
30331 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30332 example, when checking a RCPT command,
30333 .code
30334 require message = Sender did not verify
30335         verify  = sender
30336 .endd
30337 passes control to subsequent statements only if the message's sender can be
30338 verified. Otherwise, it rejects the command. Note the positioning of the
30339 &%message%& modifier, before the &%verify%& condition. The reason for this is
30340 discussed in section &<<SECTcondmodproc>>&.
30341
30342 .next
30343 .cindex "&%warn%& ACL verb"
30344 &%warn%&: If all the conditions are true, a line specified by the
30345 &%log_message%& modifier is written to Exim's main log. Control always passes
30346 to the next ACL statement. If any condition is false, the log line is not
30347 written. If an identical log line is requested several times in the same
30348 message, only one copy is actually written to the log. If you want to force
30349 duplicates to be written, use the &%logwrite%& modifier instead.
30350
30351 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30352 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30353 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30354 first failing condition. There is more about adding header lines in section
30355 &<<SECTaddheadacl>>&.
30356
30357 If any condition on a &%warn%& statement cannot be completed (that is, there is
30358 some sort of defer), the log line specified by &%log_message%& is not written.
30359 This does not include the case of a forced failure from a lookup, which
30360 is considered to be a successful completion. After a defer, no further
30361 conditions or modifiers in the &%warn%& statement are processed. The incident
30362 is logged, and the ACL continues to be processed, from the next statement
30363 onwards.
30364
30365
30366 .vindex "&$acl_verify_message$&"
30367 When one of the &%warn%& conditions is an address verification that fails, the
30368 text of the verification failure message is in &$acl_verify_message$&. If you
30369 want this logged, you must set it up explicitly. For example:
30370 .code
30371 warn   !verify = sender
30372        log_message = sender verify failed: $acl_verify_message
30373 .endd
30374 .endlist
30375
30376 At the end of each ACL there is an implicit unconditional &%deny%&.
30377
30378 As you can see from the examples above, the conditions and modifiers are
30379 written one to a line, with the first one on the same line as the verb, and
30380 subsequent ones on following lines. If you have a very long condition, you can
30381 continue it onto several physical lines by the usual backslash continuation
30382 mechanism. It is conventional to align the conditions vertically.
30383
30384
30385
30386 .section "ACL variables" "SECTaclvariables"
30387 .cindex "&ACL;" "variables"
30388 There are some special variables that can be set during ACL processing. They
30389 can be used to pass information between different ACLs, different invocations
30390 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30391 transports, and filters that are used to deliver a message. The names of these
30392 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30393 an underscore, but the remainder of the name can be any sequence of
30394 alphanumeric characters and underscores that you choose. There is no limit on
30395 the number of ACL variables. The two sets act as follows:
30396 .ilist
30397 The values of those variables whose names begin with &$acl_c$& persist
30398 throughout an SMTP connection. They are never reset. Thus, a value that is set
30399 while receiving one message is still available when receiving the next message
30400 on the same SMTP connection.
30401 .next
30402 The values of those variables whose names begin with &$acl_m$& persist only
30403 while a message is being received. They are reset afterwards. They are also
30404 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30405 .endlist
30406
30407 When a message is accepted, the current values of all the ACL variables are
30408 preserved with the message and are subsequently made available at delivery
30409 time. The ACL variables are set by a modifier called &%set%&. For example:
30410 .code
30411 accept hosts = whatever
30412        set acl_m4 = some value
30413 accept authenticated = *
30414        set acl_c_auth = yes
30415 .endd
30416 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30417 be set. If you want to set a variable without taking any action, you can use a
30418 &%warn%& verb without any other modifiers or conditions.
30419
30420 .oindex &%strict_acl_vars%&
30421 What happens if a syntactically valid but undefined ACL variable is
30422 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30423 false (the default), an empty string is substituted; if it is true, an
30424 error is generated.
30425
30426 Versions of Exim before 4.64 have a limited set of numbered variables, but
30427 their names are compatible, so there is no problem with upgrading.
30428
30429
30430 .section "Condition and modifier processing" "SECTcondmodproc"
30431 .cindex "&ACL;" "conditions; processing"
30432 .cindex "&ACL;" "modifiers; processing"
30433 An exclamation mark preceding a condition negates its result. For example:
30434 .code
30435 deny   domains = *.dom.example
30436       !verify  = recipient
30437 .endd
30438 causes the ACL to return &"deny"& if the recipient domain ends in
30439 &'dom.example'& and the recipient address cannot be verified. Sometimes
30440 negation can be used on the right-hand side of a condition. For example, these
30441 two statements are equivalent:
30442 .code
30443 deny  hosts = !192.168.3.4
30444 deny !hosts =  192.168.3.4
30445 .endd
30446 However, for many conditions (&%verify%& being a good example), only left-hand
30447 side negation of the whole condition is possible.
30448
30449 The arguments of conditions and modifiers are expanded. A forced failure
30450 of an expansion causes a condition to be ignored, that is, it behaves as if the
30451 condition is true. Consider these two statements:
30452 .code
30453 accept  senders = ${lookup{$host_name}lsearch\
30454                   {/some/file}{$value}fail}
30455 accept  senders = ${lookup{$host_name}lsearch\
30456                   {/some/file}{$value}{}}
30457 .endd
30458 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30459 the returned list is searched, but if the lookup fails the behaviour is
30460 different in the two cases. The &%fail%& in the first statement causes the
30461 condition to be ignored, leaving no further conditions. The &%accept%& verb
30462 therefore succeeds. The second statement, however, generates an empty list when
30463 the lookup fails. No sender can match an empty list, so the condition fails,
30464 and therefore the &%accept%& also fails.
30465
30466 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30467 specify actions that are taken as the conditions for a statement are checked;
30468 others specify text for messages that are used when access is denied or a
30469 warning is generated. The &%control%& modifier affects the way an incoming
30470 message is handled.
30471
30472 The positioning of the modifiers in an ACL statement is important, because the
30473 processing of a verb ceases as soon as its outcome is known. Only those
30474 modifiers that have already been encountered will take effect. For example,
30475 consider this use of the &%message%& modifier:
30476 .code
30477 require message = Can't verify sender
30478         verify  = sender
30479         message = Can't verify recipient
30480         verify  = recipient
30481         message = This message cannot be used
30482 .endd
30483 If sender verification fails, Exim knows that the result of the statement is
30484 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30485 so its text is used as the error message. If sender verification succeeds, but
30486 recipient verification fails, the second message is used. If recipient
30487 verification succeeds, the third message becomes &"current"&, but is never used
30488 because there are no more conditions to cause failure.
30489
30490 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30491 modifier that is used, because all the conditions must be true for rejection to
30492 happen. Specifying more than one &%message%& modifier does not make sense, and
30493 the message can even be specified after all the conditions. For example:
30494 .code
30495 deny   hosts = ...
30496       !senders = *@my.domain.example
30497        message = Invalid sender from client host
30498 .endd
30499 The &"deny"& result does not happen until the end of the statement is reached,
30500 by which time Exim has set up the message.
30501
30502
30503
30504 .section "ACL modifiers" "SECTACLmodi"
30505 .cindex "&ACL;" "modifiers; list of"
30506 The ACL modifiers are as follows:
30507
30508 .vlist
30509 .vitem &*add_header*&&~=&~<&'text'&>
30510 This modifier specifies one or more header lines that are to be added to an
30511 incoming message, assuming, of course, that the message is ultimately
30512 accepted. For details, see section &<<SECTaddheadacl>>&.
30513
30514 .vitem &*continue*&&~=&~<&'text'&>
30515 .cindex "&%continue%& ACL modifier"
30516 .cindex "database" "updating in ACL"
30517 This modifier does nothing of itself, and processing of the ACL always
30518 continues with the next condition or modifier. The value of &%continue%& is in
30519 the side effects of expanding its argument. Typically this could be used to
30520 update a database. It is really just a syntactic tidiness, to avoid having to
30521 write rather ugly lines like this:
30522 .display
30523 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30524 .endd
30525 Instead, all you need is
30526 .display
30527 &`continue = `&<&'some expansion'&>
30528 .endd
30529
30530 .vitem &*control*&&~=&~<&'text'&>
30531 .cindex "&%control%& ACL modifier"
30532 This modifier affects the subsequent processing of the SMTP connection or of an
30533 incoming message that is accepted. The effect of the first type of control
30534 lasts for the duration of the connection, whereas the effect of the second type
30535 lasts only until the current message has been received. The message-specific
30536 controls always apply to the whole message, not to individual recipients,
30537 even if the &%control%& modifier appears in a RCPT ACL.
30538
30539 As there are now quite a few controls that can be applied, they are described
30540 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30541 in several different ways. For example:
30542
30543 . ==== As this is a nested list, any displays it contains must be indented
30544 . ==== as otherwise they are too far to the left. That comment applies only
30545 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30546 . ==== way.
30547
30548 .ilist
30549 It can be at the end of an &%accept%& statement:
30550 .code
30551     accept  ...some conditions
30552             control = queue
30553 .endd
30554 In this case, the control is applied when this statement yields &"accept"&, in
30555 other words, when the conditions are all true.
30556
30557 .next
30558 It can be in the middle of an &%accept%& statement:
30559 .code
30560     accept  ...some conditions...
30561             control = queue
30562             ...some more conditions...
30563 .endd
30564 If the first set of conditions are true, the control is applied, even if the
30565 statement does not accept because one of the second set of conditions is false.
30566 In this case, some subsequent statement must yield &"accept"& for the control
30567 to be relevant.
30568
30569 .next
30570 It can be used with &%warn%& to apply the control, leaving the
30571 decision about accepting or denying to a subsequent verb. For
30572 example:
30573 .code
30574     warn    ...some conditions...
30575             control = freeze
30576     accept  ...
30577 .endd
30578 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30579 &%logwrite%&, so it does not add anything to the message and does not write a
30580 log entry.
30581
30582 .next
30583 If you want to apply a control unconditionally, you can use it with a
30584 &%require%& verb. For example:
30585 .code
30586     require  control = no_multiline_responses
30587 .endd
30588 .endlist
30589
30590 .vitem &*delay*&&~=&~<&'time'&>
30591 .cindex "&%delay%& ACL modifier"
30592 .oindex "&%-bh%&"
30593 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30594 the time interval before proceeding. However, when testing Exim using the
30595 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30596 output instead). The time is given in the usual Exim notation, and the delay
30597 happens as soon as the modifier is processed. In an SMTP session, pending
30598 output is flushed before the delay is imposed.
30599
30600 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30601 example:
30602 .code
30603 deny    ...some conditions...
30604         delay = 30s
30605 .endd
30606 The delay happens if all the conditions are true, before the statement returns
30607 &"deny"&. Compare this with:
30608 .code
30609 deny    delay = 30s
30610         ...some conditions...
30611 .endd
30612 which waits for 30s before processing the conditions. The &%delay%& modifier
30613 can also be used with &%warn%& and together with &%control%&:
30614 .code
30615 warn    ...some conditions...
30616         delay = 2m
30617         control = freeze
30618 accept  ...
30619 .endd
30620
30621 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30622 responses to several commands are no longer buffered and sent in one packet (as
30623 they would normally be) because all output is flushed before imposing the
30624 delay. This optimization is disabled so that a number of small delays do not
30625 appear to the client as one large aggregated delay that might provoke an
30626 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30627 using a &%control%& modifier to set &%no_delay_flush%&.
30628
30629
30630 .vitem &*endpass*&
30631 .cindex "&%endpass%& ACL modifier"
30632 This modifier, which has no argument, is recognized only in &%accept%& and
30633 &%discard%& statements. It marks the boundary between the conditions whose
30634 failure causes control to pass to the next statement, and the conditions whose
30635 failure causes the ACL to return &"deny"&. This concept has proved to be
30636 confusing to some people, so the use of &%endpass%& is no longer recommended as
30637 &"best practice"&. See the description of &%accept%& above for more details.
30638
30639
30640 .vitem &*log_message*&&~=&~<&'text'&>
30641 .cindex "&%log_message%& ACL modifier"
30642 This modifier sets up a message that is used as part of the log message if the
30643 ACL denies access or a &%warn%& statement's conditions are true. For example:
30644 .code
30645 require log_message = wrong cipher suite $tls_in_cipher
30646         encrypted   = DES-CBC3-SHA
30647 .endd
30648 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30649 example:
30650 .display
30651 &`discard `&<&'some conditions'&>
30652 &`        log_message = Discarded $local_part@$domain because...`&
30653 .endd
30654 When access is denied, &%log_message%& adds to any underlying error message
30655 that may exist because of a condition failure. For example, while verifying a
30656 recipient address, a &':fail:'& redirection might have already set up a
30657 message.
30658
30659 The message may be defined before the conditions to which it applies, because
30660 the string expansion does not happen until Exim decides that access is to be
30661 denied. This means that any variables that are set by the condition are
30662 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30663 variables are set after a DNS black list lookup succeeds. If the expansion of
30664 &%log_message%& fails, or if the result is an empty string, the modifier is
30665 ignored.
30666
30667 .vindex "&$acl_verify_message$&"
30668 If you want to use a &%warn%& statement to log the result of an address
30669 verification, you can use &$acl_verify_message$& to include the verification
30670 error message.
30671
30672 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30673 the start of the logged message. If the same warning log message is requested
30674 more than once while receiving  a single email message, only one copy is
30675 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30676 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30677 is logged for a successful &%warn%& statement.
30678
30679 If &%log_message%& is not present and there is no underlying error message (for
30680 example, from the failure of address verification), but &%message%& is present,
30681 the &%message%& text is used for logging rejections. However, if any text for
30682 logging contains newlines, only the first line is logged. In the absence of
30683 both &%log_message%& and &%message%&, a default built-in message is used for
30684 logging rejections.
30685
30686
30687 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30688 .cindex "&%log_reject_target%& ACL modifier"
30689 .cindex "logging in ACL" "specifying which log"
30690 This modifier makes it possible to specify which logs are used for messages
30691 about ACL rejections. Its argument is a colon-separated list of words that can
30692 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30693 may be empty, in which case a rejection is not logged at all. For example, this
30694 ACL fragment writes no logging information when access is denied:
30695 .display
30696 &`deny `&<&'some conditions'&>
30697 &`     log_reject_target =`&
30698 .endd
30699 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30700 permanent and temporary rejections. Its effect lasts for the rest of the
30701 current ACL.
30702
30703
30704 .vitem &*logwrite*&&~=&~<&'text'&>
30705 .cindex "&%logwrite%& ACL modifier"
30706 .cindex "logging in ACL" "immediate"
30707 This modifier writes a message to a log file as soon as it is encountered when
30708 processing an ACL. (Compare &%log_message%&, which, except in the case of
30709 &%warn%& and &%discard%&, is used only if the ACL statement denies
30710 access.) The &%logwrite%& modifier can be used to log special incidents in
30711 ACLs. For example:
30712 .display
30713 &`accept `&<&'some special conditions'&>
30714 &`       control  = freeze`&
30715 &`       logwrite = froze message because ...`&
30716 .endd
30717 By default, the message is written to the main log. However, it may begin
30718 with a colon, followed by a comma-separated list of log names, and then
30719 another colon, to specify exactly which logs are to be written. For
30720 example:
30721 .code
30722 logwrite = :main,reject: text for main and reject logs
30723 logwrite = :panic: text for panic log only
30724 .endd
30725
30726
30727 .vitem &*message*&&~=&~<&'text'&>
30728 .cindex "&%message%& ACL modifier"
30729 This modifier sets up a text string that is expanded and used as a response
30730 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30731 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30732 there is some complication if &%endpass%& is involved; see the description of
30733 &%accept%& for details.)
30734
30735 The expansion of the message happens at the time Exim decides that the ACL is
30736 to end, not at the time it processes &%message%&. If the expansion fails, or
30737 generates an empty string, the modifier is ignored. Here is an example where
30738 &%message%& must be specified first, because the ACL ends with a rejection if
30739 the &%hosts%& condition fails:
30740 .code
30741 require  message = Host not recognized
30742          hosts = 10.0.0.0/8
30743 .endd
30744 (Once a condition has failed, no further conditions or modifiers are
30745 processed.)
30746
30747 .cindex "SMTP" "error codes"
30748 .oindex "&%smtp_banner%&
30749 For ACLs that are triggered by SMTP commands, the message is returned as part
30750 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30751 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30752 is accepted. In the case of the connect ACL, accepting with a message modifier
30753 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30754 accept message may not contain more than one line (otherwise it will be
30755 truncated at the first newline and a panic logged), and it cannot affect the
30756 EHLO options.
30757
30758 When SMTP is involved, the message may begin with an overriding response code,
30759 consisting of three digits optionally followed by an &"extended response code"&
30760 of the form &'n.n.n'&, each code being followed by a space. For example:
30761 .code
30762 deny  message = 599 1.2.3 Host not welcome
30763       hosts = 192.168.34.0/24
30764 .endd
30765 The first digit of the supplied response code must be the same as would be sent
30766 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30767 access, but for the predata ACL, note that the default success code is 354, not
30768 2&'xx'&.
30769
30770 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30771 the message modifier cannot override the 221 response code.
30772
30773 The text in a &%message%& modifier is literal; any quotes are taken as
30774 literals, but because the string is expanded, backslash escapes are processed
30775 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30776 response.
30777
30778 .vindex "&$acl_verify_message$&"
30779 For ACLs that are called by an &%acl =%& ACL condition, the message is
30780 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30781
30782 If &%message%& is used on a statement that verifies an address, the message
30783 specified overrides any message that is generated by the verification process.
30784 However, the original message is available in the variable
30785 &$acl_verify_message$&, so you can incorporate it into your message if you
30786 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30787 routers to be passed back as part of the SMTP response, you should either not
30788 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30789
30790 For compatibility with previous releases of Exim, a &%message%& modifier that
30791 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30792 modifier, but this usage is now deprecated. However, &%message%& acts only when
30793 all the conditions are true, wherever it appears in an ACL command, whereas
30794 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30795 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30796 effect.
30797
30798
30799 .vitem &*queue*&&~=&~<&'text'&>
30800 .cindex "&%queue%& ACL modifier"
30801 .cindex "named queues" "selecting in ACL"
30802 This modifier specifies the use of a named queue for spool files
30803 for the message.
30804 It can only be used before the message is received (i.e. not in
30805 the DATA ACL).
30806 This could be used, for example, for known high-volume burst sources
30807 of traffic, or for quarantine of messages.
30808 Separate queue-runner processes will be needed for named queues.
30809 If the text after expansion is empty, the default queue is used.
30810
30811
30812 .vitem &*remove_header*&&~=&~<&'text'&>
30813 This modifier specifies one or more header names in a colon-separated list
30814  that are to be removed from an incoming message, assuming, of course, that
30815 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30816
30817
30818 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30819 .cindex "&%set%& ACL modifier"
30820 This modifier puts a value into one of the ACL variables (see section
30821 &<<SECTaclvariables>>&).
30822
30823
30824 .vitem &*udpsend*&&~=&~<&'parameters'&>
30825 .cindex "UDP communications"
30826 This modifier sends a UDP packet, for purposes such as statistics
30827 collection or behaviour monitoring. The parameters are expanded, and
30828 the result of the expansion must be a colon-separated list consisting
30829 of a destination server, port number, and the packet contents. The
30830 server can be specified as a host name or IPv4 or IPv6 address. The
30831 separator can be changed with the usual angle bracket syntax. For
30832 example, you might want to collect information on which hosts connect
30833 when:
30834 .code
30835 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30836              $tod_zulu $sender_host_address
30837 .endd
30838 .endlist
30839
30840
30841
30842
30843 .section "Use of the control modifier" "SECTcontrols"
30844 .cindex "&%control%& ACL modifier"
30845 The &%control%& modifier supports the following settings:
30846
30847 .vlist
30848 .vitem &*control&~=&~allow_auth_unadvertised*&
30849 This modifier allows a client host to use the SMTP AUTH command even when it
30850 has not been advertised in response to EHLO. Furthermore, because there are
30851 apparently some really broken clients that do this, Exim will accept AUTH after
30852 HELO (rather than EHLO) when this control is set. It should be used only if you
30853 really need it, and you should limit its use to those broken clients that do
30854 not work without it. For example:
30855 .code
30856 warn hosts   = 192.168.34.25
30857      control = allow_auth_unadvertised
30858 .endd
30859 Normally, when an Exim server receives an AUTH command, it checks the name of
30860 the authentication mechanism that is given in the command to ensure that it
30861 matches an advertised mechanism. When this control is set, the check that a
30862 mechanism has been advertised is bypassed. Any configured mechanism can be used
30863 by the client. This control is permitted only in the connection and HELO ACLs.
30864
30865
30866 .vitem &*control&~=&~caseful_local_part*& &&&
30867        &*control&~=&~caselower_local_part*&
30868 .cindex "&ACL;" "case of local part in"
30869 .cindex "case of local parts"
30870 .vindex "&$local_part$&"
30871 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30872 (that is, during RCPT processing). By default, the contents of &$local_part$&
30873 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30874 any uppercase letters in the original local part are restored in &$local_part$&
30875 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30876 is encountered.
30877
30878 These controls affect only the current recipient. Moreover, they apply only to
30879 local part handling that takes place directly in the ACL (for example, as a key
30880 in lookups). If a test to verify the recipient is obeyed, the case-related
30881 handling of the local part during the verification is controlled by the router
30882 configuration (see the &%caseful_local_part%& generic router option).
30883
30884 This facility could be used, for example, to add a spam score to local parts
30885 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30886 spam score:
30887 .code
30888 warn  control = caseful_local_part
30889       set acl_m4 = ${eval:\
30890                      $acl_m4 + \
30891                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30892                     }
30893       control = caselower_local_part
30894 .endd
30895 Notice that we put back the lower cased version afterwards, assuming that
30896 is what is wanted for subsequent tests.
30897
30898
30899 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30900 .cindex "&ACL;" "cutthrough routing"
30901 .cindex "cutthrough" "requesting"
30902 This option requests delivery be attempted while the item is being received.
30903
30904 The option is usable in the RCPT ACL.
30905 If enabled for a message received via smtp and routed to an smtp transport,
30906 and only one transport, interface, destination host and port combination
30907 is used for all recipients of the message,
30908 then the delivery connection is made while the receiving connection is open
30909 and data is copied from one to the other.
30910
30911 An attempt to set this option for any recipient but the first
30912 for a mail will be quietly ignored.
30913 If a recipient-verify callout
30914 (with use_sender)
30915 connection is subsequently
30916 requested in the same ACL it is held open and used for
30917 any subsequent recipients and the data,
30918 otherwise one is made after the initial RCPT ACL completes.
30919
30920 Note that routers are used in verify mode,
30921 and cannot depend on content of received headers.
30922 Note also that headers cannot be
30923 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30924 Headers may be modified by routers (subject to the above) and transports.
30925 The &'Received-By:'& header is generated as soon as the body reception starts,
30926 rather than the traditional time after the full message is received;
30927 this will affect the timestamp.
30928
30929 All the usual ACLs are called; if one results in the message being
30930 rejected, all effort spent in delivery (including the costs on
30931 the ultimate destination) will be wasted.
30932 Note that in the case of data-time ACLs this includes the entire
30933 message body.
30934
30935 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30936 of outgoing messages is done, because it sends data to the ultimate destination
30937 before the entire message has been received from the source.
30938 It is not supported for messages received with the SMTP PRDR
30939 or CHUNKING
30940 options in use.
30941
30942 Should the ultimate destination system positively accept or reject the mail,
30943 a corresponding indication is given to the source system and nothing is queued.
30944 If the item is successfully delivered in cutthrough mode
30945 the delivery log lines are tagged with ">>" rather than "=>" and appear
30946 before the acceptance "<=" line.
30947
30948 If there is a temporary error the item is queued for later delivery in the
30949 usual fashion.
30950 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30951 to the control; the default value is &"spool"& and the alternate value
30952 &"pass"& copies an SMTP defer response from the target back to the initiator
30953 and does not queue the message.
30954 Note that this is independent of any recipient verify conditions in the ACL.
30955
30956 Delivery in this mode avoids the generation of a bounce mail to a
30957 (possibly faked)
30958 sender when the destination system is doing content-scan based rejection.
30959
30960
30961 .vitem &*control&~=&~debug/*&<&'options'&>
30962 .cindex "&ACL;" "enabling debug logging"
30963 .cindex "debugging" "enabling from an ACL"
30964 This control turns on debug logging, almost as though Exim had been invoked
30965 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30966 by default called &'debuglog'&.
30967 The filename can be adjusted with the &'tag'& option, which
30968 may access any variables already defined.  The logging may be adjusted with
30969 the &'opts'& option, which takes the same values as the &`-d`& command-line
30970 option.
30971 Logging started this way may be stopped, and the file removed,
30972 with the &'kill'& option.
30973 Some examples (which depend on variables that don't exist in all
30974 contexts):
30975 .code
30976       control = debug
30977       control = debug/tag=.$sender_host_address
30978       control = debug/opts=+expand+acl
30979       control = debug/tag=.$message_exim_id/opts=+expand
30980       control = debug/kill
30981 .endd
30982
30983
30984 .vitem &*control&~=&~dkim_disable_verify*&
30985 .cindex "disable DKIM verify"
30986 .cindex "DKIM" "disable verify"
30987 This control turns off DKIM verification processing entirely.  For details on
30988 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30989
30990
30991 .vitem &*control&~=&~dmarc_disable_verify*&
30992 .cindex "disable DMARC verify"
30993 .cindex "DMARC" "disable verify"
30994 This control turns off DMARC verification processing entirely.  For details on
30995 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30996
30997
30998 .vitem &*control&~=&~dscp/*&<&'value'&>
30999 .cindex "&ACL;" "setting DSCP value"
31000 .cindex "DSCP" "inbound"
31001 This option causes the DSCP value associated with the socket for the inbound
31002 connection to be adjusted to a given value, given as one of a number of fixed
31003 strings or to numeric value.
31004 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31005 Common values include &`throughput`&, &`mincost`&, and on newer systems
31006 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31007
31008 The outbound packets from Exim will be marked with this value in the header
31009 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31010 that these values will have any effect, not be stripped by networking
31011 equipment, or do much of anything without cooperation with your Network
31012 Engineer and those of all network operators between the source and destination.
31013
31014
31015 .vitem &*control&~=&~enforce_sync*& &&&
31016        &*control&~=&~no_enforce_sync*&
31017 .cindex "SMTP" "synchronization checking"
31018 .cindex "synchronization checking in SMTP"
31019 These controls make it possible to be selective about when SMTP synchronization
31020 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31021 state of the switch (it is true by default). See the description of this option
31022 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31023
31024 The effect of these two controls lasts for the remainder of the SMTP
31025 connection. They can appear in any ACL except the one for the non-SMTP
31026 messages. The most straightforward place to put them is in the ACL defined by
31027 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31028 before the first synchronization check. The expected use is to turn off the
31029 synchronization checks for badly-behaved hosts that you nevertheless need to
31030 work with.
31031
31032
31033 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31034 .cindex "fake defer"
31035 .cindex "defer, fake"
31036 This control works in exactly the same way as &%fakereject%& (described below)
31037 except that it causes an SMTP 450 response after the message data instead of a
31038 550 response. You must take care when using &%fakedefer%& because it causes the
31039 messages to be duplicated when the sender retries. Therefore, you should not
31040 use &%fakedefer%& if the message is to be delivered normally.
31041
31042 .vitem &*control&~=&~fakereject/*&<&'message'&>
31043 .cindex "fake rejection"
31044 .cindex "rejection, fake"
31045 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31046 words, only when an SMTP message is being received. If Exim accepts the
31047 message, instead the final 250 response, a 550 rejection message is sent.
31048 However, Exim proceeds to deliver the message as normal. The control applies
31049 only to the current message, not to any subsequent ones that may be received in
31050 the same SMTP connection.
31051
31052 The text for the 550 response is taken from the &%control%& modifier. If no
31053 message is supplied, the following is used:
31054 .code
31055 550-Your message has been rejected but is being
31056 550-kept for evaluation.
31057 550-If it was a legitimate message, it may still be
31058 550 delivered to the target recipient(s).
31059 .endd
31060 This facility should be used with extreme caution.
31061
31062 .vitem &*control&~=&~freeze*&
31063 .cindex "frozen messages" "forcing in ACL"
31064 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31065 other words, only when a message is being received. If the message is accepted,
31066 it is placed on Exim's queue and frozen. The control applies only to the
31067 current message, not to any subsequent ones that may be received in the same
31068 SMTP connection.
31069
31070 This modifier can optionally be followed by &`/no_tell`&. If the global option
31071 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31072 is told about the freezing), provided all the &*control=freeze*& modifiers that
31073 are obeyed for the current message have the &`/no_tell`& option.
31074
31075 .vitem &*control&~=&~no_delay_flush*&
31076 .cindex "SMTP" "output flushing, disabling for delay"
31077 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31078 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31079 use. This control, as long as it is encountered before the &%delay%& modifier,
31080 disables such output flushing.
31081
31082 .vitem &*control&~=&~no_callout_flush*&
31083 .cindex "SMTP" "output flushing, disabling for callout"
31084 Exim normally flushes SMTP output before performing a callout in an ACL, to
31085 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31086 use. This control, as long as it is encountered before the &%verify%& condition
31087 that causes the callout, disables such output flushing.
31088
31089 .vitem &*control&~=&~no_mbox_unspool*&
31090 This control is available when Exim is compiled with the content scanning
31091 extension. Content scanning may require a copy of the current message, or parts
31092 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31093 or spam scanner. Normally, such copies are deleted when they are no longer
31094 needed. If this control is set, the copies are not deleted. The control applies
31095 only to the current message, not to any subsequent ones that may be received in
31096 the same SMTP connection. It is provided for debugging purposes and is unlikely
31097 to be useful in production.
31098
31099 .vitem &*control&~=&~no_multiline_responses*&
31100 .cindex "multiline responses, suppressing"
31101 This control is permitted for any ACL except the one for non-SMTP messages.
31102 It seems that there are broken clients in use that cannot handle multiline
31103 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31104
31105 If this control is set, multiline SMTP responses from ACL rejections are
31106 suppressed. One way of doing this would have been to put out these responses as
31107 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31108 (&"use multiline responses for more"& it says &-- ha!), and some of the
31109 responses might get close to that. So this facility, which is after all only a
31110 sop to broken clients, is implemented by doing two very easy things:
31111
31112 .ilist
31113 Extra information that is normally output as part of a rejection caused by
31114 sender verification failure is omitted. Only the final line (typically &"sender
31115 verification failed"&) is sent.
31116 .next
31117 If a &%message%& modifier supplies a multiline response, only the first
31118 line is output.
31119 .endlist
31120
31121 The setting of the switch can, of course, be made conditional on the
31122 calling host. Its effect lasts until the end of the SMTP connection.
31123
31124 .vitem &*control&~=&~no_pipelining*&
31125 .cindex "PIPELINING" "suppressing advertising"
31126 .cindex "ESMTP extensions" PIPELINING
31127 This control turns off the advertising of the PIPELINING extension to SMTP in
31128 the current session. To be useful, it must be obeyed before Exim sends its
31129 response to an EHLO command. Therefore, it should normally appear in an ACL
31130 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31131 &%pipelining_advertise_hosts%&.
31132
31133 .new
31134 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31135        &*control&~=&~queue_only*&
31136 .oindex "&%queue%&"
31137 .oindex "&%queue_only%&"
31138 .cindex "queueing incoming messages"
31139 .cindex queueing "forcing in ACL"
31140 .cindex "first pass routing"
31141 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31142 other words, only when a message is being received. If the message is accepted,
31143 it is placed on Exim's queue and left there for delivery by a subsequent queue
31144 runner.
31145 If used with no options set,
31146 no immediate delivery process is started. In other words, it has the
31147 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31148
31149 If the &'first_pass_route'& option is given then
31150 the behaviour is like the command-line &'-oqds'& option;
31151 a delivery process is started which stops short of making
31152 any SMTP delivery.  The benefit is that the hints database will be updated for
31153 the message being waiting for a specific host, and a later queue run will be
31154 able to send all such messages on a single connection.
31155
31156 The control only applies to the current message, not to any subsequent ones that
31157  may be received in the same SMTP connection.
31158 .wen
31159
31160 .vitem &*control&~=&~submission/*&<&'options'&>
31161 .cindex "message" "submission"
31162 .cindex "submission mode"
31163 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31164 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31165 the current message is a submission from a local MUA. In this case, Exim
31166 operates in &"submission mode"&, and applies certain fixups to the message if
31167 necessary. For example, it adds a &'Date:'& header line if one is not present.
31168 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31169 late (the message has already been created).
31170
31171 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31172 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31173 submission mode; the available options for this control are described there.
31174 The control applies only to the current message, not to any subsequent ones
31175 that may be received in the same SMTP connection.
31176
31177 .vitem &*control&~=&~suppress_local_fixups*&
31178 .cindex "submission fixups, suppressing"
31179 This control applies to locally submitted (non TCP/IP) messages, and is the
31180 complement of &`control = submission`&. It disables the fixups that are
31181 normally applied to locally-submitted messages. Specifically:
31182
31183 .ilist
31184 Any &'Sender:'& header line is left alone (in this respect, it is a
31185 dynamic version of &%local_sender_retain%&).
31186 .next
31187 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31188 .next
31189 There is no check that &'From:'& corresponds to the actual sender.
31190 .endlist ilist
31191
31192 This control may be useful when a remotely-originated message is accepted,
31193 passed to some scanning program, and then re-submitted for delivery. It can be
31194 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31195 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31196 data is read.
31197
31198 &*Note:*& This control applies only to the current message, not to any others
31199 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31200
31201 .vitem &*control&~=&~utf8_downconvert*&
31202 This control enables conversion of UTF-8 in message envelope addresses
31203 to a-label form.
31204 For details see section &<<SECTi18nMTA>>&.
31205 .endlist vlist
31206
31207
31208 .section "Summary of message fixup control" "SECTsummesfix"
31209 All four possibilities for message fixups can be specified:
31210
31211 .ilist
31212 Locally submitted, fixups applied: the default.
31213 .next
31214 Locally submitted, no fixups applied: use
31215 &`control = suppress_local_fixups`&.
31216 .next
31217 Remotely submitted, no fixups applied: the default.
31218 .next
31219 Remotely submitted, fixups applied: use &`control = submission`&.
31220 .endlist
31221
31222
31223
31224 .section "Adding header lines in ACLs" "SECTaddheadacl"
31225 .cindex "header lines" "adding in an ACL"
31226 .cindex "header lines" "position of added lines"
31227 .cindex "&%add_header%& ACL modifier"
31228 The &%add_header%& modifier can be used to add one or more extra header lines
31229 to an incoming message, as in this example:
31230 .code
31231 warn dnslists = sbl.spamhaus.org : \
31232                 dialup.mail-abuse.org
31233      add_header = X-blacklisted-at: $dnslist_domain
31234 .endd
31235 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31236 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31237 receiving a message). The message must ultimately be accepted for
31238 &%add_header%& to have any significant effect. You can use &%add_header%& with
31239 any ACL verb, including &%deny%& (though this is potentially useful only in a
31240 RCPT ACL).
31241
31242 Headers will not be added to the message if the modifier is used in
31243 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31244
31245 Leading and trailing newlines are removed from
31246 the data for the &%add_header%& modifier; if it then
31247 contains one or more newlines that
31248 are not followed by a space or a tab, it is assumed to contain multiple header
31249 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31250 front of any line that is not a valid header line.
31251
31252 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31253 They are added to the message before processing the DATA and MIME ACLs.
31254 However, if an identical header line is requested more than once, only one copy
31255 is actually added to the message. Further header lines may be accumulated
31256 during the DATA and MIME ACLs, after which they are added to the message, again
31257 with duplicates suppressed. Thus, it is possible to add two identical header
31258 lines to an SMTP message, but only if one is added before DATA and one after.
31259 In the case of non-SMTP messages, new headers are accumulated during the
31260 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31261 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31262 are included in the entry that is written to the reject log.
31263
31264 .cindex "header lines" "added; visibility of"
31265 Header lines are not visible in string expansions
31266 of message headers
31267 until they are added to the
31268 message. It follows that header lines defined in the MAIL, RCPT, and predata
31269 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31270 header lines that are added by the DATA or MIME ACLs are not visible in those
31271 ACLs. Because of this restriction, you cannot use header lines as a way of
31272 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31273 this, you can use ACL variables, as described in section
31274 &<<SECTaclvariables>>&.
31275
31276 The list of headers yet to be added is given by the &%$headers_added%& variable.
31277
31278 The &%add_header%& modifier acts immediately as it is encountered during the
31279 processing of an ACL. Notice the difference between these two cases:
31280 .display
31281 &`accept add_header = ADDED: some text`&
31282 &`       `&<&'some condition'&>
31283
31284 &`accept `&<&'some condition'&>
31285 &`       add_header = ADDED: some text`&
31286 .endd
31287 In the first case, the header line is always added, whether or not the
31288 condition is true. In the second case, the header line is added only if the
31289 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31290 ACL statement. All those that are encountered before a condition fails are
31291 honoured.
31292
31293 .cindex "&%warn%& ACL verb"
31294 For compatibility with previous versions of Exim, a &%message%& modifier for a
31295 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31296 effect only if all the conditions are true, even if it appears before some of
31297 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31298 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31299 are present on a &%warn%& verb, both are processed according to their
31300 specifications.
31301
31302 By default, new header lines are added to a message at the end of the existing
31303 header lines. However, you can specify that any particular header line should
31304 be added right at the start (before all the &'Received:'& lines), immediately
31305 after the first block of &'Received:'& lines, or immediately before any line
31306 that is not a &'Received:'& or &'Resent-something:'& header.
31307
31308 This is done by specifying &":at_start:"&, &":after_received:"&, or
31309 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31310 header line, respectively. (Header text cannot start with a colon, as there has
31311 to be a header name first.) For example:
31312 .code
31313 warn add_header = \
31314        :after_received:X-My-Header: something or other...
31315 .endd
31316 If more than one header line is supplied in a single &%add_header%& modifier,
31317 each one is treated independently and can therefore be placed differently. If
31318 you add more than one line at the start, or after the Received: block, they end
31319 up in reverse order.
31320
31321 &*Warning*&: This facility currently applies only to header lines that are
31322 added in an ACL. It does NOT work for header lines that are added in a
31323 system filter or in a router or transport.
31324
31325
31326
31327 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31328 .cindex "header lines" "removing in an ACL"
31329 .cindex "header lines" "position of removed lines"
31330 .cindex "&%remove_header%& ACL modifier"
31331 The &%remove_header%& modifier can be used to remove one or more header lines
31332 from an incoming message, as in this example:
31333 .code
31334 warn   message        = Remove internal headers
31335        remove_header  = x-route-mail1 : x-route-mail2
31336 .endd
31337 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31338 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31339 receiving a message). The message must ultimately be accepted for
31340 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31341 with any ACL verb, including &%deny%&, though this is really not useful for
31342 any verb that doesn't result in a delivered message.
31343
31344 Headers will not be removed from the message if the modifier is used in
31345 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31346
31347 More than one header can be removed at the same time by using a colon separated
31348 list of header names. The header matching is case insensitive. Wildcards are
31349 not permitted, nor is list expansion performed, so you cannot use hostlists to
31350 create a list of headers, however both connection and message variable expansion
31351 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31352 .code
31353 warn   hosts           = +internal_hosts
31354        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31355 warn   message         = Remove internal headers
31356        remove_header   = $acl_c_ihdrs
31357 .endd
31358 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31359 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31360 If multiple header lines match, all are removed.
31361 There is no harm in attempting to remove the same header twice nor in removing
31362 a non-existent header. Further header lines to be removed may be accumulated
31363 during the DATA and MIME ACLs, after which they are removed from the message,
31364 if present. In the case of non-SMTP messages, headers to be removed are
31365 accumulated during the non-SMTP ACLs, and are removed from the message after
31366 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31367 ACL, there really is no effect because there is no logging of what headers
31368 would have been removed.
31369
31370 .cindex "header lines" "removed; visibility of"
31371 Header lines are not visible in string expansions until the DATA phase when it
31372 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31373 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31374 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31375 this restriction, you cannot use header lines as a way of controlling data
31376 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31377 you should instead use ACL variables, as described in section
31378 &<<SECTaclvariables>>&.
31379
31380 The &%remove_header%& modifier acts immediately as it is encountered during the
31381 processing of an ACL. Notice the difference between these two cases:
31382 .display
31383 &`accept remove_header = X-Internal`&
31384 &`       `&<&'some condition'&>
31385
31386 &`accept `&<&'some condition'&>
31387 &`       remove_header = X-Internal`&
31388 .endd
31389 In the first case, the header line is always removed, whether or not the
31390 condition is true. In the second case, the header line is removed only if the
31391 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31392 same ACL statement. All those that are encountered before a condition fails
31393 are honoured.
31394
31395 &*Warning*&: This facility currently applies only to header lines that are
31396 present during ACL processing. It does NOT remove header lines that are added
31397 in a system filter or in a router or transport.
31398
31399
31400
31401
31402 .section "ACL conditions" "SECTaclconditions"
31403 .cindex "&ACL;" "conditions; list of"
31404 Some of the conditions listed in this section are available only when Exim is
31405 compiled with the content-scanning extension. They are included here briefly
31406 for completeness. More detailed descriptions can be found in the discussion on
31407 content scanning in chapter &<<CHAPexiscan>>&.
31408
31409 Not all conditions are relevant in all circumstances. For example, testing
31410 senders and recipients does not make sense in an ACL that is being run as the
31411 result of the arrival of an ETRN command, and checks on message headers can be
31412 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31413 can use the same condition (with different parameters) more than once in the
31414 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31415 The conditions are as follows:
31416
31417
31418 .vlist
31419 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31420 .cindex "&ACL;" "nested"
31421 .cindex "&ACL;" "indirect"
31422 .cindex "&ACL;" "arguments"
31423 .cindex "&%acl%& ACL condition"
31424 The possible values of the argument are the same as for the
31425 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31426 &"accept"& the condition is true; if it returns &"deny"& the condition is
31427 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31428 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31429 condition false. This means that further processing of the &%warn%& verb
31430 ceases, but processing of the ACL continues.
31431
31432 If the argument is a named ACL, up to nine space-separated optional values
31433 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31434 and $acl_narg is set to the count of values.
31435 Previous values of these variables are restored after the call returns.
31436 The name and values are expanded separately.
31437 Note that spaces in complex expansions which are used as arguments
31438 will act as argument separators.
31439
31440 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31441 the connection is dropped. If it returns &"discard"&, the verb must be
31442 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31443 conditions are tested.
31444
31445 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31446 loops. This condition allows you to use different ACLs in different
31447 circumstances. For example, different ACLs can be used to handle RCPT commands
31448 for different local users or different local domains.
31449
31450 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31451 .cindex "&%authenticated%& ACL condition"
31452 .cindex "authentication" "ACL checking"
31453 .cindex "&ACL;" "testing for authentication"
31454 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31455 the name of the authenticator is tested against the list. To test for
31456 authentication by any authenticator, you can set
31457 .code
31458 authenticated = *
31459 .endd
31460
31461 .vitem &*condition&~=&~*&<&'string'&>
31462 .cindex "&%condition%& ACL condition"
31463 .cindex "customizing" "ACL condition"
31464 .cindex "&ACL;" "customized test"
31465 .cindex "&ACL;" "testing, customized"
31466 This feature allows you to make up custom conditions. If the result of
31467 expanding the string is an empty string, the number zero, or one of the strings
31468 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31469 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31470 any other value, some error is assumed to have occurred, and the ACL returns
31471 &"defer"&. However, if the expansion is forced to fail, the condition is
31472 ignored. The effect is to treat it as true, whether it is positive or
31473 negative.
31474
31475 .vitem &*decode&~=&~*&<&'location'&>
31476 .cindex "&%decode%& ACL condition"
31477 This condition is available only when Exim is compiled with the
31478 content-scanning extension, and it is allowed only in the ACL defined by
31479 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31480 If all goes well, the condition is true. It is false only if there are
31481 problems such as a syntax error or a memory shortage. For more details, see
31482 chapter &<<CHAPexiscan>>&.
31483
31484 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31485 .cindex "&%dnslists%& ACL condition"
31486 .cindex "DNS list" "in ACL"
31487 .cindex "black list (DNS)"
31488 .cindex "&ACL;" "testing a DNS list"
31489 This condition checks for entries in DNS black lists. These are also known as
31490 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31491 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31492 different variants of this condition to describe briefly here. See sections
31493 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31494
31495 .vitem &*domains&~=&~*&<&'domain&~list'&>
31496 .cindex "&%domains%& ACL condition"
31497 .cindex "domain" "ACL checking"
31498 .cindex "&ACL;" "testing a recipient domain"
31499 .vindex "&$domain_data$&"
31500 This condition is relevant only after a RCPT command. It checks that the domain
31501 of the recipient address is in the domain list. If percent-hack processing is
31502 enabled, it is done before this test is done. If the check succeeds with a
31503 lookup, the result of the lookup is placed in &$domain_data$& until the next
31504 &%domains%& test.
31505
31506 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31507 use &%domains%& in a DATA ACL.
31508
31509
31510 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31511 .cindex "&%encrypted%& ACL condition"
31512 .cindex "encryption" "checking in an ACL"
31513 .cindex "&ACL;" "testing for encryption"
31514 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31515 name of the cipher suite in use is tested against the list. To test for
31516 encryption without testing for any specific cipher suite(s), set
31517 .code
31518 encrypted = *
31519 .endd
31520
31521
31522 .vitem &*hosts&~=&~*&<&'host&~list'&>
31523 .cindex "&%hosts%& ACL condition"
31524 .cindex "host" "ACL checking"
31525 .cindex "&ACL;" "testing the client host"
31526 This condition tests that the calling host matches the host list. If you have
31527 name lookups or wildcarded host names and IP addresses in the same host list,
31528 you should normally put the IP addresses first. For example, you could have:
31529 .code
31530 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31531 .endd
31532 The lookup in this example uses the host name for its key. This is implied by
31533 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31534 and it wouldn't matter which way round you had these two items.)
31535
31536 The reason for the problem with host names lies in the left-to-right way that
31537 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31538 but when it reaches an item that requires a host name, it fails if it cannot
31539 find a host name to compare with the pattern. If the above list is given in the
31540 opposite order, the &%accept%& statement fails for a host whose name cannot be
31541 found, even if its IP address is 10.9.8.7.
31542
31543 If you really do want to do the name check first, and still recognize the IP
31544 address even if the name lookup fails, you can rewrite the ACL like this:
31545 .code
31546 accept hosts = dbm;/etc/friendly/hosts
31547 accept hosts = 10.9.8.7
31548 .endd
31549 The default action on failing to find the host name is to assume that the host
31550 is not in the list, so the first &%accept%& statement fails. The second
31551 statement can then check the IP address.
31552
31553 .vindex "&$host_data$&"
31554 If a &%hosts%& condition is satisfied by means of a lookup, the result
31555 of the lookup is made available in the &$host_data$& variable. This
31556 allows you, for example, to set up a statement like this:
31557 .code
31558 deny  hosts = net-lsearch;/some/file
31559       message = $host_data
31560 .endd
31561 which gives a custom error message for each denied host.
31562
31563 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31564 .cindex "&%local_parts%& ACL condition"
31565 .cindex "local part" "ACL checking"
31566 .cindex "&ACL;" "testing a local part"
31567 .vindex "&$local_part_data$&"
31568 This condition is relevant only after a RCPT command. It checks that the local
31569 part of the recipient address is in the list. If percent-hack processing is
31570 enabled, it is done before this test. If the check succeeds with a lookup, the
31571 result of the lookup is placed in &$local_part_data$&, which remains set until
31572 the next &%local_parts%& test.
31573
31574 .vitem &*malware&~=&~*&<&'option'&>
31575 .cindex "&%malware%& ACL condition"
31576 .cindex "&ACL;" "virus scanning"
31577 .cindex "&ACL;" "scanning for viruses"
31578 This condition is available only when Exim is compiled with the
31579 content-scanning extension
31580 and only after a DATA command.
31581 It causes the incoming message to be scanned for
31582 viruses. For details, see chapter &<<CHAPexiscan>>&.
31583
31584 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31585 .cindex "&%mime_regex%& ACL condition"
31586 .cindex "&ACL;" "testing by regex matching"
31587 This condition is available only when Exim is compiled with the
31588 content-scanning extension, and it is allowed only in the ACL defined by
31589 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31590 with any of the regular expressions. For details, see chapter
31591 &<<CHAPexiscan>>&.
31592
31593 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31594 .cindex "rate limiting"
31595 This condition can be used to limit the rate at which a user or host submits
31596 messages. Details are given in section &<<SECTratelimiting>>&.
31597
31598 .vitem &*recipients&~=&~*&<&'address&~list'&>
31599 .cindex "&%recipients%& ACL condition"
31600 .cindex "recipient" "ACL checking"
31601 .cindex "&ACL;" "testing a recipient"
31602 This condition is relevant only after a RCPT command. It checks the entire
31603 recipient address against a list of recipients.
31604
31605 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31606 .cindex "&%regex%& ACL condition"
31607 .cindex "&ACL;" "testing by regex matching"
31608 This condition is available only when Exim is compiled with the
31609 content-scanning extension, and is available only in the DATA, MIME, and
31610 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31611 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31612
31613 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31614 .cindex "&%sender_domains%& ACL condition"
31615 .cindex "sender" "ACL checking"
31616 .cindex "&ACL;" "testing a sender domain"
31617 .vindex "&$domain$&"
31618 .vindex "&$sender_address_domain$&"
31619 This condition tests the domain of the sender of the message against the given
31620 domain list. &*Note*&: The domain of the sender address is in
31621 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31622 of this condition. This is an exception to the general rule for testing domain
31623 lists. It is done this way so that, if this condition is used in an ACL for a
31624 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31625 influence the sender checking.
31626
31627 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31628 relaying, because sender addresses are easily, and commonly, forged.
31629
31630 .vitem &*senders&~=&~*&<&'address&~list'&>
31631 .cindex "&%senders%& ACL condition"
31632 .cindex "sender" "ACL checking"
31633 .cindex "&ACL;" "testing a sender"
31634 This condition tests the sender of the message against the given list. To test
31635 for a bounce message, which has an empty sender, set
31636 .code
31637 senders = :
31638 .endd
31639 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31640 relaying, because sender addresses are easily, and commonly, forged.
31641
31642 .vitem &*spam&~=&~*&<&'username'&>
31643 .cindex "&%spam%& ACL condition"
31644 .cindex "&ACL;" "scanning for spam"
31645 This condition is available only when Exim is compiled with the
31646 content-scanning extension. It causes the incoming message to be scanned by
31647 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31648
31649 .vitem &*verify&~=&~certificate*&
31650 .cindex "&%verify%& ACL condition"
31651 .cindex "TLS" "client certificate verification"
31652 .cindex "certificate" "verification of client"
31653 .cindex "&ACL;" "certificate verification"
31654 .cindex "&ACL;" "testing a TLS certificate"
31655 This condition is true in an SMTP session if the session is encrypted, and a
31656 certificate was received from the client, and the certificate was verified. The
31657 server requests a certificate only if the client matches &%tls_verify_hosts%&
31658 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31659
31660 .vitem &*verify&~=&~csa*&
31661 .cindex "CSA verification"
31662 This condition checks whether the sending host (the client) is authorized to
31663 send email. Details of how this works are given in section
31664 &<<SECTverifyCSA>>&.
31665
31666 .vitem &*verify&~=&~header_names_ascii*&
31667 .cindex "&%verify%& ACL condition"
31668 .cindex "&ACL;" "verifying header names only ASCII"
31669 .cindex "header lines" "verifying header names only ASCII"
31670 .cindex "verifying" "header names only ASCII"
31671 This condition is relevant only in an ACL that is run after a message has been
31672 received, that is, in an ACL specified by &%acl_smtp_data%& or
31673 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31674 there are no non-ASCII characters, also excluding control characters.  The
31675 allowable characters are decimal ASCII values 33 through 126.
31676
31677 Exim itself will handle headers with non-ASCII characters, but it can cause
31678 problems for downstream applications, so this option will allow their
31679 detection and rejection in the DATA ACL's.
31680
31681 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31682 .cindex "&%verify%& ACL condition"
31683 .cindex "&ACL;" "verifying sender in the header"
31684 .cindex "header lines" "verifying the sender in"
31685 .cindex "sender" "verifying in header"
31686 .cindex "verifying" "sender in header"
31687 This condition is relevant only in an ACL that is run after a message has been
31688 received, that is, in an ACL specified by &%acl_smtp_data%& or
31689 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31690 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31691 is loosely thought of as a &"sender"& address (hence the name of the test).
31692 However, an address that appears in one of these headers need not be an address
31693 that accepts bounce messages; only sender addresses in envelopes are required
31694 to accept bounces. Therefore, if you use the callout option on this check, you
31695 might want to arrange for a non-empty address in the MAIL command.
31696
31697 Details of address verification and the options are given later, starting at
31698 section &<<SECTaddressverification>>& (callouts are described in section
31699 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31700 condition to restrict it to bounce messages only:
31701 .code
31702 deny    senders = :
31703        !verify  = header_sender
31704         message = A valid sender header is required for bounces
31705 .endd
31706
31707 .vitem &*verify&~=&~header_syntax*&
31708 .cindex "&%verify%& ACL condition"
31709 .cindex "&ACL;" "verifying header syntax"
31710 .cindex "header lines" "verifying syntax"
31711 .cindex "verifying" "header syntax"
31712 This condition is relevant only in an ACL that is run after a message has been
31713 received, that is, in an ACL specified by &%acl_smtp_data%& or
31714 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31715 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31716 and &'Bcc:'&), returning true if there are no problems.
31717 Unqualified addresses (local parts without domains) are
31718 permitted only in locally generated messages and from hosts that match
31719 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31720 appropriate.
31721
31722 Note that this condition is a syntax check only. However, a common spamming
31723 ploy used to be to send syntactically invalid headers such as
31724 .code
31725 To: @
31726 .endd
31727 and this condition can be used to reject such messages, though they are not as
31728 common as they used to be.
31729
31730 .vitem &*verify&~=&~helo*&
31731 .cindex "&%verify%& ACL condition"
31732 .cindex "&ACL;" "verifying HELO/EHLO"
31733 .cindex "HELO" "verifying"
31734 .cindex "EHLO" "verifying"
31735 .cindex "verifying" "EHLO"
31736 .cindex "verifying" "HELO"
31737 This condition is true if a HELO or EHLO command has been received from the
31738 client host, and its contents have been verified. If there has been no previous
31739 attempt to verify the HELO/EHLO contents, it is carried out when this
31740 condition is encountered. See the description of the &%helo_verify_hosts%& and
31741 &%helo_try_verify_hosts%& options for details of how to request verification
31742 independently of this condition, and for detail of the verification.
31743
31744 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31745 option), this condition is always true.
31746
31747
31748 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31749 .cindex "verifying" "not blind"
31750 .cindex "bcc recipients, verifying none"
31751 This condition checks that there are no blind (bcc) recipients in the message.
31752 Every envelope recipient must appear either in a &'To:'& header line or in a
31753 &'Cc:'& header line for this condition to be true. Local parts are checked
31754 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31755 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31756 used only in a DATA or non-SMTP ACL.
31757
31758 There is one possible option, &`case_insensitive`&.  If this is present then
31759 local parts are checked case-insensitively.
31760
31761 There are, of course, many legitimate messages that make use of blind (bcc)
31762 recipients. This check should not be used on its own for blocking messages.
31763
31764
31765 .vitem &*verify&~=&~recipient/*&<&'options'&>
31766 .cindex "&%verify%& ACL condition"
31767 .cindex "&ACL;" "verifying recipient"
31768 .cindex "recipient" "verifying"
31769 .cindex "verifying" "recipient"
31770 .vindex "&$address_data$&"
31771 This condition is relevant only after a RCPT command. It verifies the current
31772 recipient. Details of address verification are given later, starting at section
31773 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31774 of &$address_data$& is the last value that was set while routing the address.
31775 This applies even if the verification fails. When an address that is being
31776 verified is redirected to a single address, verification continues with the new
31777 address, and in that case, the subsequent value of &$address_data$& is the
31778 value for the child address.
31779
31780 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31781 .cindex "&%verify%& ACL condition"
31782 .cindex "&ACL;" "verifying host reverse lookup"
31783 .cindex "host" "verifying reverse lookup"
31784 This condition ensures that a verified host name has been looked up from the IP
31785 address of the client host. (This may have happened already if the host name
31786 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31787 Verification ensures that the host name obtained from a reverse DNS lookup, or
31788 one of its aliases, does, when it is itself looked up in the DNS, yield the
31789 original IP address.
31790
31791 There is one possible option, &`defer_ok`&.  If this is present and a
31792 DNS operation returns a temporary error, the verify condition succeeds.
31793
31794 If this condition is used for a locally generated message (that is, when there
31795 is no client host involved), it always succeeds.
31796
31797 .vitem &*verify&~=&~sender/*&<&'options'&>
31798 .cindex "&%verify%& ACL condition"
31799 .cindex "&ACL;" "verifying sender"
31800 .cindex "sender" "verifying"
31801 .cindex "verifying" "sender"
31802 This condition is relevant only after a MAIL or RCPT command, or after a
31803 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31804 the message's sender is empty (that is, this is a bounce message), the
31805 condition is true. Otherwise, the sender address is verified.
31806
31807 .vindex "&$address_data$&"
31808 .vindex "&$sender_address_data$&"
31809 If there is data in the &$address_data$& variable at the end of routing, its
31810 value is placed in &$sender_address_data$& at the end of verification. This
31811 value can be used in subsequent conditions and modifiers in the same ACL
31812 statement. It does not persist after the end of the current statement. If you
31813 want to preserve the value for longer, you can save it in an ACL variable.
31814
31815 Details of verification are given later, starting at section
31816 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31817 to avoid doing it more than once per message.
31818
31819 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31820 .cindex "&%verify%& ACL condition"
31821 This is a variation of the previous option, in which a modified address is
31822 verified as a sender.
31823
31824 Note that '/' is legal in local-parts; if the address may have such
31825 (eg. is generated from the received message)
31826 they must be protected from the options parsing by doubling:
31827 .code
31828 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31829 .endd
31830 .endlist
31831
31832
31833
31834 .section "Using DNS lists" "SECTmorednslists"
31835 .cindex "DNS list" "in ACL"
31836 .cindex "black list (DNS)"
31837 .cindex "&ACL;" "testing a DNS list"
31838 In its simplest form, the &%dnslists%& condition tests whether the calling host
31839 is on at least one of a number of DNS lists by looking up the inverted IP
31840 address in one or more DNS domains. (Note that DNS list domains are not mail
31841 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31842 special options instead.) For example, if the calling host's IP
31843 address is 192.168.62.43, and the ACL statement is
31844 .code
31845 deny dnslists = blackholes.mail-abuse.org : \
31846                 dialups.mail-abuse.org
31847 .endd
31848 the following records are looked up:
31849 .code
31850 43.62.168.192.blackholes.mail-abuse.org
31851 43.62.168.192.dialups.mail-abuse.org
31852 .endd
31853 As soon as Exim finds an existing DNS record, processing of the list stops.
31854 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31855 to test that a host is on more than one list (an &"and"& conjunction), you can
31856 use two separate conditions:
31857 .code
31858 deny dnslists = blackholes.mail-abuse.org
31859      dnslists = dialups.mail-abuse.org
31860 .endd
31861 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31862 behaves as if the host does not match the list item, that is, as if the DNS
31863 record does not exist. If there are further items in the DNS list, they are
31864 processed.
31865
31866 This is usually the required action when &%dnslists%& is used with &%deny%&
31867 (which is the most common usage), because it prevents a DNS failure from
31868 blocking mail. However, you can change this behaviour by putting one of the
31869 following special items in the list:
31870 .display
31871 &`+include_unknown `&   behave as if the item is on the list
31872 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31873 &`+defer_unknown   `&   give a temporary error
31874 .endd
31875 .cindex "&`+include_unknown`&"
31876 .cindex "&`+exclude_unknown`&"
31877 .cindex "&`+defer_unknown`&"
31878 Each of these applies to any subsequent items on the list. For example:
31879 .code
31880 deny dnslists = +defer_unknown : foo.bar.example
31881 .endd
31882 Testing the list of domains stops as soon as a match is found. If you want to
31883 warn for one list and block for another, you can use two different statements:
31884 .code
31885 deny  dnslists = blackholes.mail-abuse.org
31886 warn  dnslists = dialups.mail-abuse.org
31887       message  = X-Warn: sending host is on dialups list
31888 .endd
31889 .cindex caching "of dns lookup"
31890 .cindex DNS TTL
31891 DNS list lookups are cached by Exim for the duration of the SMTP session
31892 (but limited by the DNS return TTL value),
31893 so a lookup based on the IP address is done at most once for any incoming
31894 connection (assuming long-enough TTL).
31895 Exim does not share information between multiple incoming
31896 connections (but your local name server cache should be active).
31897
31898 There are a number of DNS lists to choose from, some commercial, some free,
31899 or free for small deployments.  An overview can be found at
31900 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31901
31902
31903
31904 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31905 .cindex "DNS list" "keyed by explicit IP address"
31906 By default, the IP address that is used in a DNS list lookup is the IP address
31907 of the calling host. However, you can specify another IP address by listing it
31908 after the domain name, introduced by a slash. For example:
31909 .code
31910 deny dnslists = black.list.tld/192.168.1.2
31911 .endd
31912 This feature is not very helpful with explicit IP addresses; it is intended for
31913 use with IP addresses that are looked up, for example, the IP addresses of the
31914 MX hosts or nameservers of an email sender address. For an example, see section
31915 &<<SECTmulkeyfor>>& below.
31916
31917
31918
31919
31920 .section "DNS lists keyed on domain names" "SECID202"
31921 .cindex "DNS list" "keyed by domain name"
31922 There are some lists that are keyed on domain names rather than inverted IP
31923 addresses (see, e.g., the &'domain based zones'& link at
31924 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31925 with these lists. You can change the name that is looked up in a DNS list by
31926 listing it after the domain name, introduced by a slash. For example,
31927 .code
31928 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31929       message  = Sender's domain is listed at $dnslist_domain
31930 .endd
31931 This particular example is useful only in ACLs that are obeyed after the
31932 RCPT or DATA commands, when a sender address is available. If (for
31933 example) the message's sender is &'user@tld.example'& the name that is looked
31934 up by this example is
31935 .code
31936 tld.example.dsn.rfc-ignorant.org
31937 .endd
31938 A single &%dnslists%& condition can contain entries for both names and IP
31939 addresses. For example:
31940 .code
31941 deny dnslists = sbl.spamhaus.org : \
31942                 dsn.rfc-ignorant.org/$sender_address_domain
31943 .endd
31944 The first item checks the sending host's IP address; the second checks a domain
31945 name. The whole condition is true if either of the DNS lookups succeeds.
31946
31947
31948
31949
31950 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31951 .cindex "DNS list" "multiple keys for"
31952 The syntax described above for looking up explicitly-defined values (either
31953 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31954 name for the DNS list, what follows the slash can in fact be a list of items.
31955 As with all lists in Exim, the default separator is a colon. However, because
31956 this is a sublist within the list of DNS blacklist domains, it is necessary
31957 either to double the separators like this:
31958 .code
31959 dnslists = black.list.tld/name.1::name.2
31960 .endd
31961 or to change the separator character, like this:
31962 .code
31963 dnslists = black.list.tld/<;name.1;name.2
31964 .endd
31965 If an item in the list is an IP address, it is inverted before the DNS
31966 blacklist domain is appended. If it is not an IP address, no inversion
31967 occurs. Consider this condition:
31968 .code
31969 dnslists = black.list.tld/<;192.168.1.2;a.domain
31970 .endd
31971 The DNS lookups that occur are:
31972 .code
31973 2.1.168.192.black.list.tld
31974 a.domain.black.list.tld
31975 .endd
31976 Once a DNS record has been found (that matches a specific IP return
31977 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31978 are done. If there is a temporary DNS error, the rest of the sublist of domains
31979 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31980 only if no other DNS lookup in this sublist succeeds. In other words, a
31981 successful lookup for any of the items in the sublist overrides a temporary
31982 error for a previous item.
31983
31984 The ability to supply a list of items after the slash is in some sense just a
31985 syntactic convenience. These two examples have the same effect:
31986 .code
31987 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31988 dnslists = black.list.tld/a.domain::b.domain
31989 .endd
31990 However, when the data for the list is obtained from a lookup, the second form
31991 is usually much more convenient. Consider this example:
31992 .code
31993 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31994                                    ${lookup dnsdb {>|mxh=\
31995                                    $sender_address_domain} }} }
31996      message  = The mail servers for the domain \
31997                 $sender_address_domain \
31998                 are listed at $dnslist_domain ($dnslist_value); \
31999                 see $dnslist_text.
32000 .endd
32001 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32002 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32003 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32004 of expanding the condition might be something like this:
32005 .code
32006 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32007 .endd
32008 Thus, this example checks whether or not the IP addresses of the sender
32009 domain's mail servers are on the Spamhaus black list.
32010
32011 The key that was used for a successful DNS list lookup is put into the variable
32012 &$dnslist_matched$& (see section &<<SECID204>>&).
32013
32014
32015
32016
32017 .section "Data returned by DNS lists" "SECID203"
32018 .cindex "DNS list" "data returned from"
32019 DNS lists are constructed using address records in the DNS. The original RBL
32020 just used the address 127.0.0.1 on the right hand side of each record, but the
32021 RBL+ list and some other lists use a number of values with different meanings.
32022 The values used on the RBL+ list are:
32023 .display
32024 127.1.0.1  RBL
32025 127.1.0.2  DUL
32026 127.1.0.3  DUL and RBL
32027 127.1.0.4  RSS
32028 127.1.0.5  RSS and RBL
32029 127.1.0.6  RSS and DUL
32030 127.1.0.7  RSS and DUL and RBL
32031 .endd
32032 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32033 different values. Some DNS lists may return more than one address record;
32034 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32035
32036
32037 .section "Variables set from DNS lists" "SECID204"
32038 .cindex "expansion" "variables, set from DNS list"
32039 .cindex "DNS list" "variables set from"
32040 .vindex "&$dnslist_domain$&"
32041 .vindex "&$dnslist_matched$&"
32042 .vindex "&$dnslist_text$&"
32043 .vindex "&$dnslist_value$&"
32044 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32045 the name of the overall domain that matched (for example,
32046 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32047 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32048 the DNS record. When the key is an IP address, it is not reversed in
32049 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32050 cases, for example:
32051 .code
32052 deny dnslists = spamhaus.example
32053 .endd
32054 the key is also available in another variable (in this case,
32055 &$sender_host_address$&). In more complicated cases, however, this is not true.
32056 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32057 might generate a dnslists lookup like this:
32058 .code
32059 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32060 .endd
32061 If this condition succeeds, the value in &$dnslist_matched$& might be
32062 &`192.168.6.7`& (for example).
32063
32064 If more than one address record is returned by the DNS lookup, all the IP
32065 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32066 The variable &$dnslist_text$& contains the contents of any associated TXT
32067 record. For lists such as RBL+ the TXT record for a merged entry is often not
32068 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32069 information.
32070
32071 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32072 &-- even if these appear before the condition in the ACL, they are not
32073 expanded until after it has failed. For example:
32074 .code
32075 deny    hosts = !+local_networks
32076         message = $sender_host_address is listed \
32077                   at $dnslist_domain
32078         dnslists = rbl-plus.mail-abuse.example
32079 .endd
32080
32081
32082
32083 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32084 .cindex "DNS list" "matching specific returned data"
32085 You can add an equals sign and an IP address after a &%dnslists%& domain name
32086 in order to restrict its action to DNS records with a matching right hand side.
32087 For example,
32088 .code
32089 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32090 .endd
32091 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32092 any address record is considered to be a match. For the moment, we assume
32093 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32094 describes how multiple records are handled.
32095
32096 More than one IP address may be given for checking, using a comma as a
32097 separator. These are alternatives &-- if any one of them matches, the
32098 &%dnslists%& condition is true. For example:
32099 .code
32100 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32101 .endd
32102 If you want to specify a constraining address list and also specify names or IP
32103 addresses to be looked up, the constraining address list must be specified
32104 first. For example:
32105 .code
32106 deny dnslists = dsn.rfc-ignorant.org\
32107                 =127.0.0.2/$sender_address_domain
32108 .endd
32109
32110 If the character &`&&`& is used instead of &`=`&, the comparison for each
32111 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32112 In other words, the listed addresses are used as bit masks. The comparison is
32113 true if all the bits in the mask are present in the address that is being
32114 tested. For example:
32115 .code
32116 dnslists = a.b.c&0.0.0.3
32117 .endd
32118 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32119 want to test whether one bit or another bit is present (as opposed to both
32120 being present), you must use multiple values. For example:
32121 .code
32122 dnslists = a.b.c&0.0.0.1,0.0.0.2
32123 .endd
32124 matches if the final component of the address is an odd number or two times
32125 an odd number.
32126
32127
32128
32129 .section "Negated DNS matching conditions" "SECID205"
32130 You can supply a negative list of IP addresses as part of a &%dnslists%&
32131 condition. Whereas
32132 .code
32133 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32134 .endd
32135 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32136 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32137 .code
32138 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32139 .endd
32140 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32141 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32142 words, the result of the test is inverted if an exclamation mark appears before
32143 the &`=`& (or the &`&&`&) sign.
32144
32145 &*Note*&: This kind of negation is not the same as negation in a domain,
32146 host, or address list (which is why the syntax is different).
32147
32148 If you are using just one list, the negation syntax does not gain you much. The
32149 previous example is precisely equivalent to
32150 .code
32151 deny  dnslists = a.b.c
32152      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32153 .endd
32154 However, if you are using multiple lists, the negation syntax is clearer.
32155 Consider this example:
32156 .code
32157 deny  dnslists = sbl.spamhaus.org : \
32158                  list.dsbl.org : \
32159                  dnsbl.njabl.org!=127.0.0.3 : \
32160                  relays.ordb.org
32161 .endd
32162 Using only positive lists, this would have to be:
32163 .code
32164 deny  dnslists = sbl.spamhaus.org : \
32165                  list.dsbl.org
32166 deny  dnslists = dnsbl.njabl.org
32167      !dnslists = dnsbl.njabl.org=127.0.0.3
32168 deny  dnslists = relays.ordb.org
32169 .endd
32170 which is less clear, and harder to maintain.
32171
32172
32173
32174
32175 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32176 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32177 thereby providing more than one IP address. When an item in a &%dnslists%& list
32178 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32179 the match to specific results from the DNS lookup, there are two ways in which
32180 the checking can be handled. For example, consider the condition:
32181 .code
32182 dnslists = a.b.c=127.0.0.1
32183 .endd
32184 What happens if the DNS lookup for the incoming IP address yields both
32185 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32186 condition true because at least one given value was found, or is it false
32187 because at least one of the found values was not listed? And how does this
32188 affect negated conditions? Both possibilities are provided for with the help of
32189 additional separators &`==`& and &`=&&`&.
32190
32191 .ilist
32192 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32193 IP addresses matches one of the listed addresses. For the example above, the
32194 condition is true because 127.0.0.1 matches.
32195 .next
32196 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32197 looked up IP addresses matches one of the listed addresses. If the condition is
32198 changed to:
32199 .code
32200 dnslists = a.b.c==127.0.0.1
32201 .endd
32202 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32203 false because 127.0.0.2 is not listed. You would need to have:
32204 .code
32205 dnslists = a.b.c==127.0.0.1,127.0.0.2
32206 .endd
32207 for the condition to be true.
32208 .endlist
32209
32210 When &`!`& is used to negate IP address matching, it inverts the result, giving
32211 the precise opposite of the behaviour above. Thus:
32212 .ilist
32213 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32214 addresses matches one of the listed addresses. Consider:
32215 .code
32216 dnslists = a.b.c!&0.0.0.1
32217 .endd
32218 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32219 false because 127.0.0.1 matches.
32220 .next
32221 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32222 looked up IP address that does not match. Consider:
32223 .code
32224 dnslists = a.b.c!=&0.0.0.1
32225 .endd
32226 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32227 true, because 127.0.0.2 does not match. You would need to have:
32228 .code
32229 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32230 .endd
32231 for the condition to be false.
32232 .endlist
32233 When the DNS lookup yields only a single IP address, there is no difference
32234 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32235
32236
32237
32238
32239 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32240 .cindex "DNS list" "information from merged"
32241 When the facility for restricting the matching IP values in a DNS list is used,
32242 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32243 the true reason for rejection. This happens when lists are merged and the IP
32244 address in the A record is used to distinguish them; unfortunately there is
32245 only one TXT record. One way round this is not to use merged lists, but that
32246 can be inefficient because it requires multiple DNS lookups where one would do
32247 in the vast majority of cases when the host of interest is not on any of the
32248 lists.
32249
32250 A less inefficient way of solving this problem is available. If
32251 two domain names, comma-separated, are given, the second is used first to
32252 do an initial check, making use of any IP value restrictions that are set.
32253 If there is a match, the first domain is used, without any IP value
32254 restrictions, to get the TXT record. As a byproduct of this, there is also
32255 a check that the IP being tested is indeed on the first list. The first
32256 domain is the one that is put in &$dnslist_domain$&. For example:
32257 .code
32258 deny   dnslists = \
32259          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32260          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32261        message  = \
32262          rejected because $sender_host_address is blacklisted \
32263          at $dnslist_domain\n$dnslist_text
32264 .endd
32265 For the first blacklist item, this starts by doing a lookup in
32266 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32267 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32268 value, and as long as something is found, it looks for the corresponding TXT
32269 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32270 The second blacklist item is processed similarly.
32271
32272 If you are interested in more than one merged list, the same list must be
32273 given several times, but because the results of the DNS lookups are cached,
32274 the DNS calls themselves are not repeated. For example:
32275 .code
32276 deny dnslists = \
32277          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32278          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32279          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32280          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32281 .endd
32282 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32283 values matches (or if no record is found), this is the only lookup that is
32284 done. Only if there is a match is one of the more specific lists consulted.
32285
32286
32287
32288 .section "DNS lists and IPv6" "SECTmorednslistslast"
32289 .cindex "IPv6" "DNS black lists"
32290 .cindex "DNS list" "IPv6 usage"
32291 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32292 nibble by nibble. For example, if the calling host's IP address is
32293 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32294 .code
32295 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32296   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32297 .endd
32298 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32299 lists contain wildcard records, intended for IPv4, that interact badly with
32300 IPv6. For example, the DNS entry
32301 .code
32302 *.3.some.list.example.    A    127.0.0.1
32303 .endd
32304 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32305 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32306
32307 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32308 &%condition%& condition, as in this example:
32309 .code
32310 deny   condition = ${if isip4{$sender_host_address}}
32311        dnslists  = some.list.example
32312 .endd
32313
32314 If an explicit key is being used for a DNS lookup and it may be an IPv6
32315 address you should specify alternate list separators for both the outer
32316 (DNS list name) list and inner (lookup keys) list:
32317 .code
32318        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32319 .endd
32320
32321 .section "Rate limiting incoming messages" "SECTratelimiting"
32322 .cindex "rate limiting" "client sending"
32323 .cindex "limiting client sending rates"
32324 .oindex "&%smtp_ratelimit_*%&"
32325 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32326 which clients can send email. This is more powerful than the
32327 &%smtp_ratelimit_*%& options, because those options control the rate of
32328 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32329 works across all connections (concurrent and sequential) from the same client
32330 host. The syntax of the &%ratelimit%& condition is:
32331 .display
32332 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32333 .endd
32334 If the average client sending rate is less than &'m'& messages per time
32335 period &'p'& then the condition is false; otherwise it is true.
32336
32337 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32338 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32339 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32340 of &'p'&.
32341
32342 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32343 time interval, for example, &`8h`& for eight hours. A larger time constant
32344 means that it takes Exim longer to forget a client's past behaviour. The
32345 parameter &'m'& is the maximum number of messages that a client is permitted to
32346 send in each time interval. It also specifies the number of messages permitted
32347 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32348 constant, you can allow a client to send more messages in a burst without
32349 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32350 both small, messages must be sent at an even rate.
32351
32352 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32353 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32354 when deploying the &%ratelimit%& ACL condition. The script prints usage
32355 instructions when it is run with no arguments.
32356
32357 The key is used to look up the data for calculating the client's average
32358 sending rate. This data is stored in Exim's spool directory, alongside the
32359 retry and other hints databases. The default key is &$sender_host_address$&,
32360 which means Exim computes the sending rate of each client host IP address.
32361 By changing the key you can change how Exim identifies clients for the purpose
32362 of ratelimiting. For example, to limit the sending rate of each authenticated
32363 user, independent of the computer they are sending from, set the key to
32364 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32365 example, &$authenticated_id$& is only meaningful if the client has
32366 authenticated (which you can check with the &%authenticated%& ACL condition).
32367
32368 The lookup key does not have to identify clients: If you want to limit the
32369 rate at which a recipient receives messages, you can use the key
32370 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32371 ACL.
32372
32373 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32374 specifies what Exim measures the rate of, for example, messages or recipients
32375 or bytes. You can adjust the measurement using the &%unique=%& and/or
32376 &%count=%& options. You can also control when Exim updates the recorded rate
32377 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32378 separated by a slash, like the other parameters. They may appear in any order.
32379
32380 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32381 any options that alter the meaning of the stored data. The limit &'m'& is not
32382 stored, so you can alter the configured maximum rate and Exim will still
32383 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32384 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32385 behaviour. The lookup key is not affected by changes to the update mode and
32386 the &%count=%& option.
32387
32388
32389 .section "Ratelimit options for what is being measured" "ratoptmea"
32390 .cindex "rate limiting" "per_* options"
32391 The &%per_conn%& option limits the client's connection rate. It is not
32392 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32393 &%acl_not_smtp_start%& ACLs.
32394
32395 The &%per_mail%& option limits the client's rate of sending messages. This is
32396 the default if none of the &%per_*%& options is specified. It can be used in
32397 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32398 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32399
32400 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32401 the same ACLs as the &%per_mail%& option, though it is best to use this option
32402 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32403 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32404 in its MAIL command, which may be inaccurate or completely missing. You can
32405 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32406 in kilobytes, megabytes, or gigabytes, respectively.
32407
32408 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32409 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32410 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32411 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32412 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32413 in either case the rate limiting engine will see a message with many
32414 recipients as a large high-speed burst.
32415
32416 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32417 number of different recipients that the client has sent messages to in the
32418 last time period. That is, if the client repeatedly sends messages to the same
32419 recipient, its measured rate is not increased. This option can only be used in
32420 &%acl_smtp_rcpt%&.
32421
32422 The &%per_cmd%& option causes Exim to recompute the rate every time the
32423 condition is processed. This can be used to limit the rate of any SMTP
32424 command. If it is used in multiple ACLs it can limit the aggregate rate of
32425 multiple different commands.
32426
32427 The &%count=%& option can be used to alter how much Exim adds to the client's
32428 measured rate. For example, the &%per_byte%& option is equivalent to
32429 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32430 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32431 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32432
32433 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32434
32435
32436 .section "Ratelimit update modes" "ratoptupd"
32437 .cindex "rate limiting" "reading data without updating"
32438 You can specify one of three options with the &%ratelimit%& condition to
32439 control when its database is updated. This section describes the &%readonly%&
32440 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32441
32442 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32443 previously-computed rate to check against the limit.
32444
32445 For example, you can test the client's sending rate and deny it access (when
32446 it is too fast) in the connect ACL. If the client passes this check then it
32447 can go on to send a message, in which case its recorded rate will be updated
32448 in the MAIL ACL. Subsequent connections from the same client will check this
32449 new rate.
32450 .code
32451 acl_check_connect:
32452  deny ratelimit = 100 / 5m / readonly
32453       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32454                   (max $sender_rate_limit)
32455 # ...
32456 acl_check_mail:
32457  warn ratelimit = 100 / 5m / strict
32458       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32459                   (max $sender_rate_limit)
32460 .endd
32461
32462 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32463 processing a message then it may increase the client's measured rate more than
32464 it should. For example, this will happen if you check the &%per_rcpt%& option
32465 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32466 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32467 multiple update problems by using the &%readonly%& option on later ratelimit
32468 checks.
32469
32470 The &%per_*%& options described above do not make sense in some ACLs. If you
32471 use a &%per_*%& option in an ACL where it is not normally permitted then the
32472 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32473 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32474 next section) so you must specify the &%readonly%& option explicitly.
32475
32476
32477 .section "Ratelimit options for handling fast clients" "ratoptfast"
32478 .cindex "rate limiting" "strict and leaky modes"
32479 If a client's average rate is greater than the maximum, the rate limiting
32480 engine can react in two possible ways, depending on the presence of the
32481 &%strict%& or &%leaky%& update modes. This is independent of the other
32482 counter-measures (such as rejecting the message) that may be specified by the
32483 rest of the ACL.
32484
32485 The &%leaky%& (default) option means that the client's recorded rate is not
32486 updated if it is above the limit. The effect of this is that Exim measures the
32487 client's average rate of successfully sent email,
32488 up to the given limit.
32489 This is appropriate if the countermeasure when the condition is true
32490 consists of refusing the message, and
32491 is generally the better choice if you have clients that retry automatically.
32492 If the action when true is anything more complex then this option is
32493 likely not what is wanted.
32494
32495 The &%strict%& option means that the client's recorded rate is always
32496 updated. The effect of this is that Exim measures the client's average rate
32497 of attempts to send email, which can be much higher than the maximum it is
32498 actually allowed. If the client is over the limit it may be subjected to
32499 counter-measures by the ACL. It must slow down and allow sufficient time to
32500 pass that its computed rate falls below the maximum before it can send email
32501 again. The time (the number of smoothing periods) it must wait and not
32502 attempt to send mail can be calculated with this formula:
32503 .code
32504         ln(peakrate/maxrate)
32505 .endd
32506
32507
32508 .section "Limiting the rate of different events" "ratoptuniq"
32509 .cindex "rate limiting" "counting unique events"
32510 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32511 rate of different events. For example, the &%per_addr%& option uses this
32512 mechanism to count the number of different recipients that the client has
32513 sent messages to in the last time period; it is equivalent to
32514 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32515 measure the rate that a client uses different sender addresses with the
32516 options &`per_mail/unique=$sender_address`&.
32517
32518 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32519 has seen for that key. The whole set is thrown away when it is older than the
32520 rate smoothing period &'p'&, so each different event is counted at most once
32521 per period. In the &%leaky%& update mode, an event that causes the client to
32522 go over the limit is not added to the set, in the same way that the client's
32523 recorded rate is not updated in the same situation.
32524
32525 When you combine the &%unique=%& and &%readonly%& options, the specific
32526 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32527 rate.
32528
32529 The &%unique=%& mechanism needs more space in the ratelimit database than the
32530 other &%ratelimit%& options in order to store the event set. The number of
32531 unique values is potentially as large as the rate limit, so the extra space
32532 required increases with larger limits.
32533
32534 The uniqueification is not perfect: there is a small probability that Exim
32535 will think a new event has happened before. If the sender's rate is less than
32536 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32537 the measured rate can go above the limit, in which case Exim may under-count
32538 events by a significant margin. Fortunately, if the rate is high enough (2.7
32539 times the limit) that the false positive rate goes above 9%, then Exim will
32540 throw away the over-full event set before the measured rate falls below the
32541 limit. Therefore the only harm should be that exceptionally high sending rates
32542 are logged incorrectly; any countermeasures you configure will be as effective
32543 as intended.
32544
32545
32546 .section "Using rate limiting" "useratlim"
32547 Exim's other ACL facilities are used to define what counter-measures are taken
32548 when the rate limit is exceeded. This might be anything from logging a warning
32549 (for example, while measuring existing sending rates in order to define
32550 policy), through time delays to slow down fast senders, up to rejecting the
32551 message. For example:
32552 .code
32553 # Log all senders' rates
32554 warn ratelimit = 0 / 1h / strict
32555      log_message = Sender rate $sender_rate / $sender_rate_period
32556
32557 # Slow down fast senders; note the need to truncate $sender_rate
32558 # at the decimal point.
32559 warn ratelimit = 100 / 1h / per_rcpt / strict
32560      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32561                    $sender_rate_limit }s
32562
32563 # Keep authenticated users under control
32564 deny authenticated = *
32565      ratelimit = 100 / 1d / strict / $authenticated_id
32566
32567 # System-wide rate limit
32568 defer ratelimit = 10 / 1s / $primary_hostname
32569       message = Sorry, too busy. Try again later.
32570
32571 # Restrict incoming rate from each host, with a default
32572 # set using a macro and special cases looked up in a table.
32573 defer ratelimit = ${lookup {$sender_host_address} \
32574                    cdb {DB/ratelimits.cdb} \
32575                    {$value} {RATELIMIT} }
32576       message = Sender rate exceeds $sender_rate_limit \
32577                messages per $sender_rate_period
32578 .endd
32579 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32580 especially with the &%per_rcpt%& option, you may suffer from a performance
32581 bottleneck caused by locking on the ratelimit hints database. Apart from
32582 making your ACLs less complicated, you can reduce the problem by using a
32583 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32584 this means that Exim will lose its hints data after a reboot (including retry
32585 hints, the callout cache, and ratelimit data).
32586
32587
32588
32589 .section "Address verification" "SECTaddressverification"
32590 .cindex "verifying address" "options for"
32591 .cindex "policy control" "address verification"
32592 Several of the &%verify%& conditions described in section
32593 &<<SECTaclconditions>>& cause addresses to be verified. Section
32594 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32595 The verification conditions can be followed by options that modify the
32596 verification process. The options are separated from the keyword and from each
32597 other by slashes, and some of them contain parameters. For example:
32598 .code
32599 verify = sender/callout
32600 verify = recipient/defer_ok/callout=10s,defer_ok
32601 .endd
32602 The first stage of address verification, which always happens, is to run the
32603 address through the routers, in &"verify mode"&. Routers can detect the
32604 difference between verification and routing for delivery, and their actions can
32605 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32606 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32607 The available options are as follows:
32608
32609 .ilist
32610 If the &%callout%& option is specified, successful routing to one or more
32611 remote hosts is followed by a &"callout"& to those hosts as an additional
32612 check. Callouts and their sub-options are discussed in the next section.
32613 .next
32614 If there is a defer error while doing verification routing, the ACL
32615 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32616 options, the condition is forced to be true instead. Note that this is a main
32617 verification option as well as a suboption for callouts.
32618 .next
32619 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32620 discusses the reporting of sender address verification failures.
32621 .next
32622 The &%success_on_redirect%& option causes verification always to succeed
32623 immediately after a successful redirection. By default, if a redirection
32624 generates just one address, that address is also verified. See further
32625 discussion in section &<<SECTredirwhilveri>>&.
32626 .endlist
32627
32628 .cindex "verifying address" "differentiating failures"
32629 .vindex "&$recipient_verify_failure$&"
32630 .vindex "&$sender_verify_failure$&"
32631 .vindex "&$acl_verify_message$&"
32632 After an address verification failure, &$acl_verify_message$& contains the
32633 error message that is associated with the failure. It can be preserved by
32634 coding like this:
32635 .code
32636 warn  !verify = sender
32637        set acl_m0 = $acl_verify_message
32638 .endd
32639 If you are writing your own custom rejection message or log message when
32640 denying access, you can use this variable to include information about the
32641 verification failure.
32642
32643 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32644 appropriate) contains one of the following words:
32645
32646 .ilist
32647 &%qualify%&: The address was unqualified (no domain), and the message
32648 was neither local nor came from an exempted host.
32649 .next
32650 &%route%&: Routing failed.
32651 .next
32652 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32653 occurred at or before the MAIL command (that is, on initial
32654 connection, HELO, or MAIL).
32655 .next
32656 &%recipient%&: The RCPT command in a callout was rejected.
32657 .next
32658 &%postmaster%&: The postmaster check in a callout was rejected.
32659 .endlist
32660
32661 The main use of these variables is expected to be to distinguish between
32662 rejections of MAIL and rejections of RCPT in callouts.
32663
32664 The above variables may also be set after a &*successful*&
32665 address verification to:
32666
32667 .ilist
32668 &%random%&: A random local-part callout succeeded
32669 .endlist
32670
32671
32672
32673
32674 .section "Callout verification" "SECTcallver"
32675 .cindex "verifying address" "by callout"
32676 .cindex "callout" "verification"
32677 .cindex "SMTP" "callout verification"
32678 For non-local addresses, routing verifies the domain, but is unable to do any
32679 checking of the local part. There are situations where some means of verifying
32680 the local part is desirable. One way this can be done is to make an SMTP
32681 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32682 a subsequent host for a recipient address, to see if the host accepts the
32683 address. We use the term &'callout'& to cover both cases. Note that for a
32684 sender address, the callback is not to the client host that is trying to
32685 deliver the message, but to one of the hosts that accepts incoming mail for the
32686 sender's domain.
32687
32688 Exim does not do callouts by default. If you want them to happen, you must
32689 request them by setting appropriate options on the &%verify%& condition, as
32690 described below. This facility should be used with care, because it can add a
32691 lot of resource usage to the cost of verifying an address. However, Exim does
32692 cache the results of callouts, which helps to reduce the cost. Details of
32693 caching are in section &<<SECTcallvercache>>&.
32694
32695 Recipient callouts are usually used only between hosts that are controlled by
32696 the same administration. For example, a corporate gateway host could use
32697 callouts to check for valid recipients on an internal mailserver. A successful
32698 callout does not guarantee that a real delivery to the address would succeed;
32699 on the other hand, a failing callout does guarantee that a delivery would fail.
32700
32701 If the &%callout%& option is present on a condition that verifies an address, a
32702 second stage of verification occurs if the address is successfully routed to
32703 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32704 &(manualroute)& router, where the router specifies the hosts. However, if a
32705 router that does not set up hosts routes to an &(smtp)& transport with a
32706 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32707 &%hosts_override%& set, its hosts are always used, whether or not the router
32708 supplies a host list.
32709 Callouts are only supported on &(smtp)& transports.
32710
32711 The port that is used is taken from the transport, if it is specified and is a
32712 remote transport. (For routers that do verification only, no transport need be
32713 specified.) Otherwise, the default SMTP port is used. If a remote transport
32714 specifies an outgoing interface, this is used; otherwise the interface is not
32715 specified. Likewise, the text that is used for the HELO command is taken from
32716 the transport's &%helo_data%& option; if there is no transport, the value of
32717 &$smtp_active_hostname$& is used.
32718
32719 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32720 test whether a bounce message could be delivered to the sender address. The
32721 following SMTP commands are sent:
32722 .display
32723 &`HELO `&<&'local host name'&>
32724 &`MAIL FROM:<>`&
32725 &`RCPT TO:`&<&'the address to be tested'&>
32726 &`QUIT`&
32727 .endd
32728 LHLO is used instead of HELO if the transport's &%protocol%& option is
32729 set to &"lmtp"&.
32730
32731 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32732 settings.
32733
32734 A recipient callout check is similar. By default, it also uses an empty address
32735 for the sender. This default is chosen because most hosts do not make use of
32736 the sender address when verifying a recipient. Using the same address means
32737 that a single cache entry can be used for each recipient. Some sites, however,
32738 do make use of the sender address when verifying. These are catered for by the
32739 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32740
32741 If the response to the RCPT command is a 2&'xx'& code, the verification
32742 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32743 Exim tries the next host, if any. If there is a problem with all the remote
32744 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32745 &%callout%& option is given, in which case the condition is forced to succeed.
32746
32747 .cindex "SMTP" "output flushing, disabling for callout"
32748 A callout may take a little time. For this reason, Exim normally flushes SMTP
32749 output before performing a callout in an ACL, to avoid unexpected timeouts in
32750 clients when the SMTP PIPELINING extension is in use. The flushing can be
32751 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32752
32753
32754
32755
32756 .section "Additional parameters for callouts" "CALLaddparcall"
32757 .cindex "callout" "additional parameters for"
32758 The &%callout%& option can be followed by an equals sign and a number of
32759 optional parameters, separated by commas. For example:
32760 .code
32761 verify = recipient/callout=10s,defer_ok
32762 .endd
32763 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32764 separate verify options, is retained for backwards compatibility, but is now
32765 deprecated. The additional parameters for &%callout%& are as follows:
32766
32767
32768 .vlist
32769 .vitem <&'a&~time&~interval'&>
32770 .cindex "callout" "timeout, specifying"
32771 This specifies the timeout that applies for the callout attempt to each host.
32772 For example:
32773 .code
32774 verify = sender/callout=5s
32775 .endd
32776 The default is 30 seconds. The timeout is used for each response from the
32777 remote host. It is also used for the initial connection, unless overridden by
32778 the &%connect%& parameter.
32779
32780
32781 .vitem &*connect&~=&~*&<&'time&~interval'&>
32782 .cindex "callout" "connection timeout, specifying"
32783 This parameter makes it possible to set a different (usually smaller) timeout
32784 for making the SMTP connection. For example:
32785 .code
32786 verify = sender/callout=5s,connect=1s
32787 .endd
32788 If not specified, this timeout defaults to the general timeout value.
32789
32790 .vitem &*defer_ok*&
32791 .cindex "callout" "defer, action on"
32792 When this parameter is present, failure to contact any host, or any other kind
32793 of temporary error, is treated as success by the ACL. However, the cache is not
32794 updated in this circumstance.
32795
32796 .vitem &*fullpostmaster*&
32797 .cindex "callout" "full postmaster check"
32798 This operates like the &%postmaster%& option (see below), but if the check for
32799 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32800 accordance with the specification in RFC 2821. The RFC states that the
32801 unqualified address &'postmaster'& should be accepted.
32802
32803
32804 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32805 .cindex "callout" "sender when verifying header"
32806 When verifying addresses in header lines using the &%header_sender%&
32807 verification option, Exim behaves by default as if the addresses are envelope
32808 sender addresses from a message. Callout verification therefore tests to see
32809 whether a bounce message could be delivered, by using an empty address in the
32810 MAIL command. However, it is arguable that these addresses might never be used
32811 as envelope senders, and could therefore justifiably reject bounce messages
32812 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32813 address to use in the MAIL command. For example:
32814 .code
32815 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32816 .endd
32817 This parameter is available only for the &%header_sender%& verification option.
32818
32819
32820 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32821 .cindex "callout" "overall timeout, specifying"
32822 This parameter sets an overall timeout for performing a callout verification.
32823 For example:
32824 .code
32825 verify = sender/callout=5s,maxwait=30s
32826 .endd
32827 This timeout defaults to four times the callout timeout for individual SMTP
32828 commands. The overall timeout applies when there is more than one host that can
32829 be tried. The timeout is checked before trying the next host. This prevents
32830 very long delays if there are a large number of hosts and all are timing out
32831 (for example, when network connections are timing out).
32832
32833
32834 .vitem &*no_cache*&
32835 .cindex "callout" "cache, suppressing"
32836 .cindex "caching callout, suppressing"
32837 When this parameter is given, the callout cache is neither read nor updated.
32838
32839 .vitem &*postmaster*&
32840 .cindex "callout" "postmaster; checking"
32841 When this parameter is set, a successful callout check is followed by a similar
32842 check for the local part &'postmaster'& at the same domain. If this address is
32843 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32844 the postmaster check is recorded in a cache record; if it is a failure, this is
32845 used to fail subsequent callouts for the domain without a connection being
32846 made, until the cache record expires.
32847
32848 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32849 The postmaster check uses an empty sender in the MAIL command by default.
32850 You can use this parameter to do a postmaster check using a different address.
32851 For example:
32852 .code
32853 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32854 .endd
32855 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32856 one overrides. The &%postmaster%& parameter is equivalent to this example:
32857 .code
32858 require  verify = sender/callout=postmaster_mailfrom=
32859 .endd
32860 &*Warning*&: The caching arrangements for postmaster checking do not take
32861 account of the sender address. It is assumed that either the empty address or
32862 a fixed non-empty address will be used. All that Exim remembers is that the
32863 postmaster check for the domain succeeded or failed.
32864
32865
32866 .vitem &*random*&
32867 .cindex "callout" "&""random""& check"
32868 When this parameter is set, before doing the normal callout check, Exim does a
32869 check for a &"random"& local part at the same domain. The local part is not
32870 really random &-- it is defined by the expansion of the option
32871 &%callout_random_local_part%&, which defaults to
32872 .code
32873 $primary_hostname-$tod_epoch-testing
32874 .endd
32875 The idea here is to try to determine whether the remote host accepts all local
32876 parts without checking. If it does, there is no point in doing callouts for
32877 specific local parts. If the &"random"& check succeeds, the result is saved in
32878 a cache record, and used to force the current and subsequent callout checks to
32879 succeed without a connection being made, until the cache record expires.
32880
32881 .vitem &*use_postmaster*&
32882 .cindex "callout" "sender for recipient check"
32883 This parameter applies to recipient callouts only. For example:
32884 .code
32885 deny  !verify = recipient/callout=use_postmaster
32886 .endd
32887 .vindex "&$qualify_domain$&"
32888 It causes a non-empty postmaster address to be used in the MAIL command when
32889 performing the callout for the recipient, and also for a &"random"& check if
32890 that is configured. The local part of the address is &`postmaster`& and the
32891 domain is the contents of &$qualify_domain$&.
32892
32893 .vitem &*use_sender*&
32894 This option applies to recipient callouts only. For example:
32895 .code
32896 require  verify = recipient/callout=use_sender
32897 .endd
32898 It causes the message's actual sender address to be used in the MAIL
32899 command when performing the callout, instead of an empty address. There is no
32900 need to use this option unless you know that the called hosts make use of the
32901 sender when checking recipients. If used indiscriminately, it reduces the
32902 usefulness of callout caching.
32903
32904 .vitem &*hold*&
32905 This option applies to recipient callouts only. For example:
32906 .code
32907 require  verify = recipient/callout=use_sender,hold
32908 .endd
32909 It causes the connection to be held open and used for any further recipients
32910 and for eventual delivery (should that be done quickly).
32911 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32912 when that is used for the connections.
32913 The advantage is only gained if there are no callout cache hits
32914 (which could be enforced by the no_cache option),
32915 if the use_sender option is used,
32916 if neither the random nor the use_postmaster option is used,
32917 and if no other callouts intervene.
32918 .endlist
32919
32920 If you use any of the parameters that set a non-empty sender for the MAIL
32921 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32922 &%use_sender%&), you should think about possible loops. Recipient checking is
32923 usually done between two hosts that are under the same management, and the host
32924 that receives the callouts is not normally configured to do callouts itself.
32925 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32926 these circumstances.
32927
32928 However, if you use a non-empty sender address for a callout to an arbitrary
32929 host, there is the likelihood that the remote host will itself initiate a
32930 callout check back to your host. As it is checking what appears to be a message
32931 sender, it is likely to use an empty address in MAIL, thus avoiding a
32932 callout loop. However, to be on the safe side it would be best to set up your
32933 own ACLs so that they do not do sender verification checks when the recipient
32934 is the address you use for header sender or postmaster callout checking.
32935
32936 Another issue to think about when using non-empty senders for callouts is
32937 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32938 by the sender/recipient combination; thus, for any given recipient, many more
32939 actual callouts are performed than when an empty sender or postmaster is used.
32940
32941
32942
32943
32944 .section "Callout caching" "SECTcallvercache"
32945 .cindex "hints database" "callout cache"
32946 .cindex "callout" "cache, description of"
32947 .cindex "caching" "callout"
32948 Exim caches the results of callouts in order to reduce the amount of resources
32949 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32950 option. A hints database called &"callout"& is used for the cache. Two
32951 different record types are used: one records the result of a callout check for
32952 a specific address, and the other records information that applies to the
32953 entire domain (for example, that it accepts the local part &'postmaster'&).
32954
32955 When an original callout fails, a detailed SMTP error message is given about
32956 the failure. However, for subsequent failures use the cache data, this message
32957 is not available.
32958
32959 The expiry times for negative and positive address cache records are
32960 independent, and can be set by the global options &%callout_negative_expire%&
32961 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32962
32963 If a host gives a negative response to an SMTP connection, or rejects any
32964 commands up to and including
32965 .code
32966 MAIL FROM:<>
32967 .endd
32968 (but not including the MAIL command with a non-empty address),
32969 any callout attempt is bound to fail. Exim remembers such failures in a
32970 domain cache record, which it uses to fail callouts for the domain without
32971 making new connections, until the domain record times out. There are two
32972 separate expiry times for domain cache records:
32973 &%callout_domain_negative_expire%& (default 3h) and
32974 &%callout_domain_positive_expire%& (default 7d).
32975
32976 Domain records expire when the negative expiry time is reached if callouts
32977 cannot be made for the domain, or if the postmaster check failed.
32978 Otherwise, they expire when the positive expiry time is reached. This
32979 ensures that, for example, a host that stops accepting &"random"& local parts
32980 will eventually be noticed.
32981
32982 The callout caching mechanism is based on the domain of the address that is
32983 being tested. If the domain routes to several hosts, it is assumed that their
32984 behaviour will be the same.
32985
32986
32987
32988 .section "Sender address verification reporting" "SECTsenaddver"
32989 .cindex "verifying" "suppressing error details"
32990 See section &<<SECTaddressverification>>& for a general discussion of
32991 verification. When sender verification fails in an ACL, the details of the
32992 failure are given as additional output lines before the 550 response to the
32993 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32994 you might see:
32995 .code
32996 MAIL FROM:<xyz@abc.example>
32997 250 OK
32998 RCPT TO:<pqr@def.example>
32999 550-Verification failed for <xyz@abc.example>
33000 550-Called:   192.168.34.43
33001 550-Sent:     RCPT TO:<xyz@abc.example>
33002 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33003 550 Sender verification failed
33004 .endd
33005 If more than one RCPT command fails in the same way, the details are given
33006 only for the first of them. However, some administrators do not want to send
33007 out this much information. You can suppress the details by adding
33008 &`/no_details`& to the ACL statement that requests sender verification. For
33009 example:
33010 .code
33011 verify = sender/no_details
33012 .endd
33013
33014 .section "Redirection while verifying" "SECTredirwhilveri"
33015 .cindex "verifying" "redirection while"
33016 .cindex "address redirection" "while verifying"
33017 A dilemma arises when a local address is redirected by aliasing or forwarding
33018 during verification: should the generated addresses themselves be verified,
33019 or should the successful expansion of the original address be enough to verify
33020 it? By default, Exim takes the following pragmatic approach:
33021
33022 .ilist
33023 When an incoming address is redirected to just one child address, verification
33024 continues with the child address, and if that fails to verify, the original
33025 verification also fails.
33026 .next
33027 When an incoming address is redirected to more than one child address,
33028 verification does not continue. A success result is returned.
33029 .endlist
33030
33031 This seems the most reasonable behaviour for the common use of aliasing as a
33032 way of redirecting different local parts to the same mailbox. It means, for
33033 example, that a pair of alias entries of the form
33034 .code
33035 A.Wol:   aw123
33036 aw123:   :fail: Gone away, no forwarding address
33037 .endd
33038 work as expected, with both local parts causing verification failure. When a
33039 redirection generates more than one address, the behaviour is more like a
33040 mailing list, where the existence of the alias itself is sufficient for
33041 verification to succeed.
33042
33043 It is possible, however, to change the default behaviour so that all successful
33044 redirections count as successful verifications, however many new addresses are
33045 generated. This is specified by the &%success_on_redirect%& verification
33046 option. For example:
33047 .code
33048 require verify = recipient/success_on_redirect/callout=10s
33049 .endd
33050 In this example, verification succeeds if a router generates a new address, and
33051 the callout does not occur, because no address was routed to a remote host.
33052
33053 When verification is being tested via the &%-bv%& option, the treatment of
33054 redirections is as just described, unless the &%-v%& or any debugging option is
33055 also specified. In that case, full verification is done for every generated
33056 address and a report is output for each of them.
33057
33058
33059
33060 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33061 .cindex "CSA" "verifying"
33062 Client SMTP Authorization is a system that allows a site to advertise
33063 which machines are and are not permitted to send email. This is done by placing
33064 special SRV records in the DNS; these are looked up using the client's HELO
33065 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33066 Authorization checks in Exim are performed by the ACL condition:
33067 .code
33068 verify = csa
33069 .endd
33070 This fails if the client is not authorized. If there is a DNS problem, or if no
33071 valid CSA SRV record is found, or if the client is authorized, the condition
33072 succeeds. These three cases can be distinguished using the expansion variable
33073 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33074 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33075 be likely to cause problems for legitimate email.
33076
33077 The error messages produced by the CSA code include slightly more
33078 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33079 looking up the CSA SRV record, or problems looking up the CSA target
33080 address record. There are four reasons for &$csa_status$& being &"fail"&:
33081
33082 .ilist
33083 The client's host name is explicitly not authorized.
33084 .next
33085 The client's IP address does not match any of the CSA target IP addresses.
33086 .next
33087 The client's host name is authorized but it has no valid target IP addresses
33088 (for example, the target's addresses are IPv6 and the client is using IPv4).
33089 .next
33090 The client's host name has no CSA SRV record but a parent domain has asserted
33091 that all subdomains must be explicitly authorized.
33092 .endlist
33093
33094 The &%csa%& verification condition can take an argument which is the domain to
33095 use for the DNS query. The default is:
33096 .code
33097 verify = csa/$sender_helo_name
33098 .endd
33099 This implementation includes an extension to CSA. If the query domain
33100 is an address literal such as [192.0.2.95], or if it is a bare IP
33101 address, Exim searches for CSA SRV records in the reverse DNS as if
33102 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33103 meaningful to say:
33104 .code
33105 verify = csa/$sender_host_address
33106 .endd
33107 In fact, this is the check that Exim performs if the client does not say HELO.
33108 This extension can be turned off by setting the main configuration option
33109 &%dns_csa_use_reverse%& to be false.
33110
33111 If a CSA SRV record is not found for the domain itself, a search
33112 is performed through its parent domains for a record which might be
33113 making assertions about subdomains. The maximum depth of this search is limited
33114 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33115 default. Exim does not look for CSA SRV records in a top level domain, so the
33116 default settings handle HELO domains as long as seven
33117 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33118 of legitimate HELO domains.
33119
33120 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33121 direct SRV lookups, this is not sufficient because of the extra parent domain
33122 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33123 addresses into lookups in the reverse DNS space. The result of a successful
33124 lookup such as:
33125 .code
33126 ${lookup dnsdb {csa=$sender_helo_name}}
33127 .endd
33128 has two space-separated fields: an authorization code and a target host name.
33129 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33130 authorization required but absent, or &"?"& for unknown.
33131
33132
33133
33134
33135 .section "Bounce address tag validation" "SECTverifyPRVS"
33136 .cindex "BATV, verifying"
33137 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33138 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33139 Genuine incoming bounce messages should therefore always be addressed to
33140 recipients that have a valid tag. This scheme is a way of detecting unwanted
33141 bounce messages caused by sender address forgeries (often called &"collateral
33142 spam"&), because the recipients of such messages do not include valid tags.
33143
33144 There are two expansion items to help with the implementation of the BATV
33145 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33146 the original envelope sender address by using a simple key to add a hash of the
33147 address and some time-based randomizing information. The &%prvs%& expansion
33148 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33149 The syntax of these expansion items is described in section
33150 &<<SECTexpansionitems>>&.
33151 The validity period on signed addresses is seven days.
33152
33153 As an example, suppose the secret per-address keys are stored in an MySQL
33154 database. A query to look up the key for an address could be defined as a macro
33155 like this:
33156 .code
33157 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33158                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33159                 }{$value}}
33160 .endd
33161 Suppose also that the senders who make use of BATV are defined by an address
33162 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33163 use this:
33164 .code
33165 # Bounces: drop unsigned addresses for BATV senders
33166 deny senders = :
33167      recipients = +batv_senders
33168      message = This address does not send an unsigned reverse path
33169
33170 # Bounces: In case of prvs-signed address, check signature.
33171 deny senders = :
33172      condition  = ${prvscheck {$local_part@$domain}\
33173                   {PRVSCHECK_SQL}{1}}
33174      !condition = $prvscheck_result
33175      message = Invalid reverse path signature.
33176 .endd
33177 The first statement rejects recipients for bounce messages that are addressed
33178 to plain BATV sender addresses, because it is known that BATV senders do not
33179 send out messages with plain sender addresses. The second statement rejects
33180 recipients that are prvs-signed, but with invalid signatures (either because
33181 the key is wrong, or the signature has timed out).
33182
33183 A non-prvs-signed address is not rejected by the second statement, because the
33184 &%prvscheck%& expansion yields an empty string if its first argument is not a
33185 prvs-signed address, thus causing the &%condition%& condition to be false. If
33186 the first argument is a syntactically valid prvs-signed address, the yield is
33187 the third string (in this case &"1"&), whether or not the cryptographic and
33188 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33189 of the checks (empty for failure, &"1"& for success).
33190
33191 There is one more issue you must consider when implementing prvs-signing:
33192 you have to ensure that the routers accept prvs-signed addresses and
33193 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33194 router to remove the signature with a configuration along these lines:
33195 .code
33196 batv_redirect:
33197   driver = redirect
33198   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33199 .endd
33200 This works because, if the third argument of &%prvscheck%& is empty, the result
33201 of the expansion of a prvs-signed address is the decoded value of the original
33202 address. This router should probably be the first of your routers that handles
33203 local addresses.
33204
33205 To create BATV-signed addresses in the first place, a transport of this form
33206 can be used:
33207 .code
33208 external_smtp_batv:
33209   driver = smtp
33210   return_path = ${prvs {$return_path} \
33211                        {${lookup mysql{SELECT \
33212                        secret FROM batv_prvs WHERE \
33213                        sender='${quote_mysql:$sender_address}'} \
33214                        {$value}fail}}}
33215 .endd
33216 If no key can be found for the existing return path, no signing takes place.
33217
33218
33219
33220 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33221 .cindex "&ACL;" "relay control"
33222 .cindex "relaying" "control by ACL"
33223 .cindex "policy control" "relay control"
33224 An MTA is said to &'relay'& a message if it receives it from some host and
33225 delivers it directly to another host as a result of a remote address contained
33226 within it. Redirecting a local address via an alias or forward file and then
33227 passing the message on to another host is not relaying,
33228 .cindex "&""percent hack""&"
33229 but a redirection as a result of the &"percent hack"& is.
33230
33231 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33232 A host which is acting as a gateway or an MX backup is concerned with incoming
33233 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33234 a host which is acting as a smart host for a number of clients is concerned
33235 with outgoing relaying from those clients to the Internet at large. Often the
33236 same host is fulfilling both functions,
33237 . ///
33238 . as illustrated in the diagram below,
33239 . ///
33240 but in principle these two kinds of relaying are entirely independent. What is
33241 not wanted is the transmission of mail from arbitrary remote hosts through your
33242 system to arbitrary domains.
33243
33244
33245 You can implement relay control by means of suitable statements in the ACL that
33246 runs for each RCPT command. For convenience, it is often easiest to use
33247 Exim's named list facility to define the domains and hosts involved. For
33248 example, suppose you want to do the following:
33249
33250 .ilist
33251 Deliver a number of domains to mailboxes on the local host (or process them
33252 locally in some other way). Let's say these are &'my.dom1.example'& and
33253 &'my.dom2.example'&.
33254 .next
33255 Relay mail for a number of other domains for which you are the secondary MX.
33256 These might be &'friend1.example'& and &'friend2.example'&.
33257 .next
33258 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33259 Suppose your LAN is 192.168.45.0/24.
33260 .endlist
33261
33262
33263 In the main part of the configuration, you put the following definitions:
33264 .code
33265 domainlist local_domains    = my.dom1.example : my.dom2.example
33266 domainlist relay_to_domains = friend1.example : friend2.example
33267 hostlist   relay_from_hosts = 192.168.45.0/24
33268 .endd
33269 Now you can use these definitions in the ACL that is run for every RCPT
33270 command:
33271 .code
33272 acl_check_rcpt:
33273   accept domains = +local_domains : +relay_to_domains
33274   accept hosts   = +relay_from_hosts
33275 .endd
33276 The first statement accepts any RCPT command that contains an address in
33277 the local or relay domains. For any other domain, control passes to the second
33278 statement, which accepts the command only if it comes from one of the relay
33279 hosts. In practice, you will probably want to make your ACL more sophisticated
33280 than this, for example, by including sender and recipient verification. The
33281 default configuration includes a more comprehensive example, which is described
33282 in chapter &<<CHAPdefconfil>>&.
33283
33284
33285
33286 .section "Checking a relay configuration" "SECTcheralcon"
33287 .cindex "relaying" "checking control of"
33288 You can check the relay characteristics of your configuration in the same way
33289 that you can test any ACL behaviour for an incoming SMTP connection, by using
33290 the &%-bh%& option to run a fake SMTP session with which you interact.
33291 .ecindex IIDacl
33292
33293
33294
33295 . ////////////////////////////////////////////////////////////////////////////
33296 . ////////////////////////////////////////////////////////////////////////////
33297
33298 .chapter "Content scanning at ACL time" "CHAPexiscan"
33299 .scindex IIDcosca "content scanning" "at ACL time"
33300 The extension of Exim to include content scanning at ACL time, formerly known
33301 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33302 was integrated into the main source for Exim release 4.50, and Tom continues to
33303 maintain it. Most of the wording of this chapter is taken from Tom's
33304 specification.
33305
33306 It is also possible to scan the content of messages at other times. The
33307 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33308 scanning after all the ACLs have run. A transport filter can be used to scan
33309 messages at delivery time (see the &%transport_filter%& option, described in
33310 chapter &<<CHAPtransportgeneric>>&).
33311
33312 If you want to include the ACL-time content-scanning features when you compile
33313 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33314 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33315
33316 .ilist
33317 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33318 for all MIME parts for SMTP and non-SMTP messages, respectively.
33319 .next
33320 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33321 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33322 run at the end of message reception (the &%acl_smtp_data%& ACL).
33323 .next
33324 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33325 of messages, or parts of messages, for debugging purposes.
33326 .next
33327 Additional expansion variables that are set in the new ACL and by the new
33328 conditions.
33329 .next
33330 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33331 .endlist
33332
33333 Content-scanning is continually evolving, and new features are still being
33334 added. While such features are still unstable and liable to incompatible
33335 changes, they are made available in Exim by setting options whose names begin
33336 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33337 this manual. You can find out about them by reading the file called
33338 &_doc/experimental.txt_&.
33339
33340 All the content-scanning facilities work on a MBOX copy of the message that is
33341 temporarily created in a file called:
33342 .display
33343 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33344 .endd
33345 The &_.eml_& extension is a friendly hint to virus scanners that they can
33346 expect an MBOX-like structure inside that file. The file is created when the
33347 first content scanning facility is called. Subsequent calls to content
33348 scanning conditions open the same file again. The directory is recursively
33349 removed when the &%acl_smtp_data%& ACL has finished running, unless
33350 .code
33351 control = no_mbox_unspool
33352 .endd
33353 has been encountered. When the MIME ACL decodes files, they are put into the
33354 same directory by default.
33355
33356
33357
33358 .section "Scanning for viruses" "SECTscanvirus"
33359 .cindex "virus scanning"
33360 .cindex "content scanning" "for viruses"
33361 .cindex "content scanning" "the &%malware%& condition"
33362 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33363 It supports a &"generic"& interface to scanners called via the shell, and
33364 specialized interfaces for &"daemon"& type virus scanners, which are resident
33365 in memory and thus are much faster.
33366
33367 Since message data needs to have arrived,
33368 the condition may be only called in ACL defined by
33369 &%acl_smtp_data%&,
33370 &%acl_smtp_data_prdr%&,
33371 &%acl_smtp_mime%& or
33372 &%acl_smtp_dkim%&
33373
33374 A timeout of 2 minutes is applied to a scanner call (by default);
33375 if it expires then a defer action is taken.
33376
33377 .oindex "&%av_scanner%&"
33378 You can set the &%av_scanner%& option in the main part of the configuration
33379 to specify which scanner to use, together with any additional options that
33380 are needed. The basic syntax is as follows:
33381 .display
33382 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33383 .endd
33384 If you do not set &%av_scanner%&, it defaults to
33385 .code
33386 av_scanner = sophie:/var/run/sophie
33387 .endd
33388 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33389 before use.
33390 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33391 The following scanner types are supported in this release,
33392 though individual ones can be included or not at build time:
33393
33394 .vlist
33395 .vitem &%avast%&
33396 .cindex "virus scanners" "avast"
33397 This is the scanner daemon of Avast. It has been tested with Avast Core
33398 Security (currently at version 2.2.0).
33399 You can get a trial version at &url(https://www.avast.com) or for Linux
33400 at &url(https://www.avast.com/linux-server-antivirus).
33401 This scanner type takes one option,
33402 which can be either a full path to a UNIX socket,
33403 or host and port specifiers separated by white space.
33404 The host may be a name or an IP address; the port is either a
33405 single number or a pair of numbers with a dash between.
33406 A list of options may follow. These options are interpreted on the
33407 Exim's side of the malware scanner, or are given on separate lines to
33408 the daemon as options before the main scan command.
33409
33410 .cindex &`pass_unscanned`& "avast"
33411 If &`pass_unscanned`&
33412 is set, any files the Avast scanner can't scan (e.g.
33413 decompression bombs, or invalid archives) are considered clean. Use with
33414 care.
33415
33416 For example:
33417 .code
33418 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33419 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33420 av_scanner = avast:192.168.2.22 5036
33421 .endd
33422 If you omit the argument, the default path
33423 &_/var/run/avast/scan.sock_&
33424 is used.
33425 If you use a remote host,
33426 you need to make Exim's spool directory available to it,
33427 as the scanner is passed a file path, not file contents.
33428 For information about available commands and their options you may use
33429 .code
33430 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33431     FLAGS
33432     SENSITIVITY
33433     PACK
33434 .endd
33435
33436 If the scanner returns a temporary failure (e.g. license issues, or
33437 permission problems), the message is deferred and a paniclog entry is
33438 written.  The usual &`defer_ok`& option is available.
33439
33440 .vitem &%aveserver%&
33441 .cindex "virus scanners" "Kaspersky"
33442 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33443 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33444 which is the path to the daemon's UNIX socket. The default is shown in this
33445 example:
33446 .code
33447 av_scanner = aveserver:/var/run/aveserver
33448 .endd
33449
33450
33451 .vitem &%clamd%&
33452 .cindex "virus scanners" "clamd"
33453 This daemon-type scanner is GPL and free. You can get it at
33454 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33455 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33456 in the MIME ACL. This is no longer believed to be necessary.
33457
33458 The options are a list of server specifiers, which may be
33459 a UNIX socket specification,
33460 a TCP socket specification,
33461 or a (global) option.
33462
33463 A socket specification consists of a space-separated list.
33464 For a Unix socket the first element is a full path for the socket,
33465 for a TCP socket the first element is the IP address
33466 and the second a port number,
33467 Any further elements are per-server (non-global) options.
33468 These per-server options are supported:
33469 .code
33470 retry=<timespec>        Retry on connect fail
33471 .endd
33472
33473 The &`retry`& option specifies a time after which a single retry for
33474 a failed connect is made.  The default is to not retry.
33475
33476 If a Unix socket file is specified, only one server is supported.
33477
33478 Examples:
33479 .code
33480 av_scanner = clamd:/opt/clamd/socket
33481 av_scanner = clamd:192.0.2.3 1234
33482 av_scanner = clamd:192.0.2.3 1234:local
33483 av_scanner = clamd:192.0.2.3 1234 retry=10s
33484 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33485 .endd
33486 If the value of av_scanner points to a UNIX socket file or contains the
33487 &`local`&
33488 option, then the ClamAV interface will pass a filename containing the data
33489 to be scanned, which should normally result in less I/O happening and be
33490 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33491 Exim does not assume that there is a common filesystem with the remote host.
33492
33493 The final example shows that multiple TCP targets can be specified.  Exim will
33494 randomly use one for each incoming email (i.e. it load balances them).  Note
33495 that only TCP targets may be used if specifying a list of scanners; a UNIX
33496 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33497 unavailable, Exim will try the remaining one(s) until it finds one that works.
33498 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33499 not keep track of scanner state between multiple messages, and the scanner
33500 selection is random, so the message will get logged in the mainlog for each
33501 email that the down scanner gets chosen first (message wrapped to be readable):
33502 .code
33503 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33504    clamd: connection to localhost, port 3310 failed
33505    (Connection refused)
33506 .endd
33507
33508 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33509 contributing the code for this scanner.
33510
33511 .vitem &%cmdline%&
33512 .cindex "virus scanners" "command line interface"
33513 This is the keyword for the generic command line scanner interface. It can be
33514 used to attach virus scanners that are invoked from the shell. This scanner
33515 type takes 3 mandatory options:
33516
33517 .olist
33518 The full path and name of the scanner binary, with all command line options,
33519 and a placeholder (&`%s`&) for the directory to scan.
33520
33521 .next
33522 A regular expression to match against the STDOUT and STDERR output of the
33523 virus scanner. If the expression matches, a virus was found. You must make
33524 absolutely sure that this expression matches on &"virus found"&. This is called
33525 the &"trigger"& expression.
33526
33527 .next
33528 Another regular expression, containing exactly one pair of parentheses, to
33529 match the name of the virus found in the scanners output. This is called the
33530 &"name"& expression.
33531 .endlist olist
33532
33533 For example, Sophos Sweep reports a virus on a line like this:
33534 .code
33535 Virus 'W32/Magistr-B' found in file ./those.bat
33536 .endd
33537 For the trigger expression, we can match the phrase &"found in file"&. For the
33538 name expression, we want to extract the W32/Magistr-B string, so we can match
33539 for the single quotes left and right of it. Altogether, this makes the
33540 configuration setting:
33541 .code
33542 av_scanner = cmdline:\
33543              /path/to/sweep -ss -all -rec -archive %s:\
33544              found in file:'(.+)'
33545 .endd
33546 .vitem &%drweb%&
33547 .cindex "virus scanners" "DrWeb"
33548 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33549 takes one option,
33550 either a full path to a UNIX socket,
33551 or host and port specifiers separated by white space.
33552 The host may be a name or an IP address; the port is either a
33553 single number or a pair of numbers with a dash between.
33554 For example:
33555 .code
33556 av_scanner = drweb:/var/run/drwebd.sock
33557 av_scanner = drweb:192.168.2.20 31337
33558 .endd
33559 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33560 is used. Thanks to Alex Miller for contributing the code for this scanner.
33561
33562 .vitem &%f-protd%&
33563 .cindex "virus scanners" "f-protd"
33564 The f-protd scanner is accessed via HTTP over TCP.
33565 One argument is taken, being a space-separated hostname and port number
33566 (or port-range).
33567 For example:
33568 .code
33569 av_scanner = f-protd:localhost 10200-10204
33570 .endd
33571 If you omit the argument, the default values shown above are used.
33572
33573 .vitem &%f-prot6d%&
33574 .cindex "virus scanners" "f-prot6d"
33575 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33576 One argument is taken, being a space-separated hostname and port number.
33577 For example:
33578 .code
33579 av_scanner = f-prot6d:localhost 10200
33580 .endd
33581 If you omit the argument, the default values show above are used.
33582
33583 .vitem &%fsecure%&
33584 .cindex "virus scanners" "F-Secure"
33585 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33586 argument which is the path to a UNIX socket. For example:
33587 .code
33588 av_scanner = fsecure:/path/to/.fsav
33589 .endd
33590 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33591 Thelmen for contributing the code for this scanner.
33592
33593 .vitem &%kavdaemon%&
33594 .cindex "virus scanners" "Kaspersky"
33595 This is the scanner daemon of Kaspersky Version 4. This version of the
33596 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33597 scanner type takes one option, which is the path to the daemon's UNIX socket.
33598 For example:
33599 .code
33600 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33601 .endd
33602 The default path is &_/var/run/AvpCtl_&.
33603
33604 .vitem &%mksd%&
33605 .cindex "virus scanners" "mksd"
33606 This was a daemon type scanner that is aimed mainly at Polish users,
33607 though some documentation was available in English.
33608 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33609 and this appears to be a candidate for removal from Exim, unless
33610 we are informed of other virus scanners which use the same protocol
33611 to integrate.
33612 The only option for this scanner type is
33613 the maximum number of processes used simultaneously to scan the attachments,
33614 provided that mksd has
33615 been run with at least the same number of child processes. For example:
33616 .code
33617 av_scanner = mksd:2
33618 .endd
33619 You can safely omit this option (the default value is 1).
33620
33621 .vitem &%sock%&
33622 .cindex "virus scanners" "simple socket-connected"
33623 This is a general-purpose way of talking to simple scanner daemons
33624 running on the local machine.
33625 There are four options:
33626 an address (which may be an IP address and port, or the path of a Unix socket),
33627 a commandline to send (may include a single %s which will be replaced with
33628 the path to the mail file to be scanned),
33629 an RE to trigger on from the returned data,
33630 and an RE to extract malware_name from the returned data.
33631 For example:
33632 .code
33633 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33634 .endd
33635 Note that surrounding whitespace is stripped from each option, meaning
33636 there is no way to specify a trailing newline.
33637 The socket specifier and both regular-expressions are required.
33638 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33639 specify an empty element to get this.
33640
33641 .vitem &%sophie%&
33642 .cindex "virus scanners" "Sophos and Sophie"
33643 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33644 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33645 for this scanner type is the path to the UNIX socket that Sophie uses for
33646 client communication. For example:
33647 .code
33648 av_scanner = sophie:/tmp/sophie
33649 .endd
33650 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33651 the option.
33652 .endlist
33653
33654 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33655 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33656 ACL.
33657
33658 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33659 makes it possible to use different scanners. See further below for an example.
33660 The &%malware%& condition caches its results, so when you use it multiple times
33661 for the same message, the actual scanning process is only carried out once.
33662 However, using expandable items in &%av_scanner%& disables this caching, in
33663 which case each use of the &%malware%& condition causes a new scan of the
33664 message.
33665
33666 The &%malware%& condition takes a right-hand argument that is expanded before
33667 use and taken as a list, slash-separated by default.
33668 The first element can then be one of
33669
33670 .ilist
33671 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33672 The condition succeeds if a virus was found, and fail otherwise. This is the
33673 recommended usage.
33674 .next
33675 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33676 the condition fails immediately.
33677 .next
33678 A regular expression, in which case the message is scanned for viruses. The
33679 condition succeeds if a virus is found and its name matches the regular
33680 expression. This allows you to take special actions on certain types of virus.
33681 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33682 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33683 .endlist
33684
33685 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33686 messages even if there is a problem with the virus scanner.
33687 Otherwise, such a problem causes the ACL to defer.
33688
33689 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33690 specify a non-default timeout.  The default is two minutes.
33691 For example:
33692 .code
33693 malware = * / defer_ok / tmo=10s
33694 .endd
33695 A timeout causes the ACL to defer.
33696
33697 .vindex "&$callout_address$&"
33698 When a connection is made to the scanner the expansion variable &$callout_address$&
33699 is set to record the actual address used.
33700
33701 .vindex "&$malware_name$&"
33702 When a virus is found, the condition sets up an expansion variable called
33703 &$malware_name$& that contains the name of the virus. You can use it in a
33704 &%message%& modifier that specifies the error returned to the sender, and/or in
33705 logging data.
33706
33707 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33708 imposed by your anti-virus scanner.
33709
33710 Here is a very simple scanning example:
33711 .code
33712 deny malware = *
33713      message = This message contains malware ($malware_name)
33714 .endd
33715 The next example accepts messages when there is a problem with the scanner:
33716 .code
33717 deny malware = */defer_ok
33718      message = This message contains malware ($malware_name)
33719 .endd
33720 The next example shows how to use an ACL variable to scan with both sophie and
33721 aveserver. It assumes you have set:
33722 .code
33723 av_scanner = $acl_m0
33724 .endd
33725 in the main Exim configuration.
33726 .code
33727 deny set acl_m0 = sophie
33728      malware = *
33729      message = This message contains malware ($malware_name)
33730
33731 deny set acl_m0 = aveserver
33732      malware = *
33733      message = This message contains malware ($malware_name)
33734 .endd
33735
33736
33737 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33738 .cindex "content scanning" "for spam"
33739 .cindex "spam scanning"
33740 .cindex "SpamAssassin"
33741 .cindex "Rspamd"
33742 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33743 score and a report for the message.
33744 Support is also provided for Rspamd.
33745
33746 For more information about installation and configuration of SpamAssassin or
33747 Rspamd refer to their respective websites at
33748 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33749
33750 SpamAssassin can be installed with CPAN by running:
33751 .code
33752 perl -MCPAN -e 'install Mail::SpamAssassin'
33753 .endd
33754 SpamAssassin has its own set of configuration files. Please review its
33755 documentation to see how you can tweak it. The default installation should work
33756 nicely, however.
33757
33758 .oindex "&%spamd_address%&"
33759 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33760 intend to use an instance running on the local host you do not need to set
33761 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33762 you must set the &%spamd_address%& option in the global part of the Exim
33763 configuration as follows (example):
33764 .code
33765 spamd_address = 192.168.99.45 783
33766 .endd
33767 The SpamAssassin protocol relies on a TCP half-close from the client.
33768 If your SpamAssassin client side is running a Linux system with an
33769 iptables firewall, consider setting
33770 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33771 timeout, Exim uses when waiting for a response from the SpamAssassin
33772 server (currently defaulting to 120s).  With a lower value the Linux
33773 connection tracking may consider your half-closed connection as dead too
33774 soon.
33775
33776
33777 To use Rspamd (which by default listens on all local addresses
33778 on TCP port 11333)
33779 you should add &%variant=rspamd%& after the address/port pair, for example:
33780 .code
33781 spamd_address = 127.0.0.1 11333 variant=rspamd
33782 .endd
33783
33784 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33785 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33786 filename instead of an address/port pair:
33787 .code
33788 spamd_address = /var/run/spamd_socket
33789 .endd
33790 You can have multiple &%spamd%& servers to improve scalability. These can
33791 reside on other hardware reachable over the network. To specify multiple
33792 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33793 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33794 .code
33795 spamd_address = 192.168.2.10 783 : \
33796                 192.168.2.11 783 : \
33797                 192.168.2.12 783
33798 .endd
33799 Up to 32 &%spamd%& servers are supported.
33800 When a server fails to respond to the connection attempt, all other
33801 servers are tried until one succeeds. If no server responds, the &%spam%&
33802 condition defers.
33803
33804 Unix and TCP socket specifications may be mixed in any order.
33805 Each element of the list is a list itself, space-separated by default
33806 and changeable in the usual way (&<<SECTlistsepchange>>&);
33807 take care to not double the separator.
33808
33809 For TCP socket specifications a host name or IP (v4 or v6, but
33810 subject to list-separator quoting rules) address can be used,
33811 and the port can be one or a dash-separated pair.
33812 In the latter case, the range is tried in strict order.
33813
33814 Elements after the first for Unix sockets, or second for TCP socket,
33815 are options.
33816 The supported options are:
33817 .code
33818 pri=<priority>      Selection priority
33819 weight=<value>      Selection bias
33820 time=<start>-<end>  Use only between these times of day
33821 retry=<timespec>    Retry on connect fail
33822 tmo=<timespec>      Connection time limit
33823 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33824 .endd
33825
33826 The &`pri`& option specifies a priority for the server within the list,
33827 higher values being tried first.
33828 The default priority is 1.
33829
33830 The &`weight`& option specifies a selection bias.
33831 Within a priority set
33832 servers are queried in a random fashion, weighted by this value.
33833 The default value for selection bias is 1.
33834
33835 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33836 in the local time zone; each element being one or more digits.
33837 Either the seconds or both minutes and seconds, plus the leading &`.`&
33838 characters, may be omitted and will be taken as zero.
33839
33840 Timeout specifications for the &`retry`& and &`tmo`& options
33841 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33842
33843 The &`tmo`& option specifies an overall timeout for communication.
33844 The default value is two minutes.
33845
33846 The &`retry`& option specifies a time after which a single retry for
33847 a failed connect is made.
33848 The default is to not retry.
33849
33850 The &%spamd_address%& variable is expanded before use if it starts with
33851 a dollar sign. In this case, the expansion may return a string that is
33852 used as the list so that multiple spamd servers can be the result of an
33853 expansion.
33854
33855 .vindex "&$callout_address$&"
33856 When a connection is made to the server the expansion variable &$callout_address$&
33857 is set to record the actual address used.
33858
33859 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33860 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33861 .code
33862 deny spam = joe
33863      message = This message was classified as SPAM
33864 .endd
33865 The right-hand side of the &%spam%& condition specifies a name. This is
33866 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33867 to scan using a specific profile, but rather use the SpamAssassin system-wide
33868 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33869 Rspamd does not use this setting. However, you must put something on the
33870 right-hand side.
33871
33872 The name allows you to use per-domain or per-user antispam profiles in
33873 principle, but this is not straightforward in practice, because a message may
33874 have multiple recipients, not necessarily all in the same domain. Because the
33875 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33876 read the contents of the message, the variables &$local_part$& and &$domain$&
33877 are not set.
33878 Careful enforcement of single-recipient messages
33879 (e.g. by responding with defer in the recipient ACL for all recipients
33880 after the first),
33881 or the use of PRDR,
33882 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33883 are needed to use this feature.
33884
33885 The right-hand side of the &%spam%& condition is expanded before being used, so
33886 you can put lookups or conditions there. When the right-hand side evaluates to
33887 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33888
33889
33890 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33891 large ones may cause significant performance degradation. As most spam messages
33892 are quite small, it is recommended that you do not scan the big ones. For
33893 example:
33894 .code
33895 deny condition = ${if < {$message_size}{10K}}
33896      spam = nobody
33897      message = This message was classified as SPAM
33898 .endd
33899
33900 The &%spam%& condition returns true if the threshold specified in the user's
33901 SpamAssassin profile has been matched or exceeded. If you want to use the
33902 &%spam%& condition for its side effects (see the variables below), you can make
33903 it always return &"true"& by appending &`:true`& to the username.
33904
33905 .cindex "spam scanning" "returned variables"
33906 When the &%spam%& condition is run, it sets up a number of expansion
33907 variables.
33908 Except for &$spam_report$&,
33909 these variables are saved with the received message so are
33910 available for use at delivery time.
33911
33912 .vlist
33913 .vitem &$spam_score$&
33914 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33915 for inclusion in log or reject messages.
33916
33917 .vitem &$spam_score_int$&
33918 The spam score of the message, multiplied by ten, as an integer value. For
33919 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33920 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33921 The integer value is useful for numeric comparisons in conditions.
33922
33923 .vitem &$spam_bar$&
33924 A string consisting of a number of &"+"& or &"-"& characters, representing the
33925 integer part of the spam score value. A spam score of 4.4 would have a
33926 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33927 headers, since MUAs can match on such strings. The maximum length of the
33928 spam bar is 50 characters.
33929
33930 .vitem &$spam_report$&
33931 A multiline text table, containing the full SpamAssassin report for the
33932 message. Useful for inclusion in headers or reject messages.
33933 This variable is only usable in a DATA-time ACL.
33934 Beware that SpamAssassin may return non-ASCII characters, especially
33935 when running in country-specific locales, which are not legal
33936 unencoded in headers.
33937
33938 .vitem &$spam_action$&
33939 For SpamAssassin either 'reject' or 'no action' depending on the
33940 spam score versus threshold.
33941 For Rspamd, the recommended action.
33942
33943 .endlist
33944
33945 The &%spam%& condition caches its results unless expansion in
33946 spamd_address was used. If you call it again with the same user name, it
33947 does not scan again, but rather returns the same values as before.
33948
33949 The &%spam%& condition returns DEFER if there is any error while running
33950 the message through SpamAssassin or if the expansion of spamd_address
33951 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33952 statement block), append &`/defer_ok`& to the right-hand side of the
33953 spam condition, like this:
33954 .code
33955 deny spam    = joe/defer_ok
33956      message = This message was classified as SPAM
33957 .endd
33958 This causes messages to be accepted even if there is a problem with &%spamd%&.
33959
33960 Here is a longer, commented example of the use of the &%spam%&
33961 condition:
33962 .code
33963 # put headers in all messages (no matter if spam or not)
33964 warn  spam = nobody:true
33965       add_header = X-Spam-Score: $spam_score ($spam_bar)
33966       add_header = X-Spam-Report: $spam_report
33967
33968 # add second subject line with *SPAM* marker when message
33969 # is over threshold
33970 warn  spam = nobody
33971       add_header = Subject: *SPAM* $h_Subject:
33972
33973 # reject spam at high scores (> 12)
33974 deny  spam = nobody:true
33975       condition = ${if >{$spam_score_int}{120}{1}{0}}
33976       message = This message scored $spam_score spam points.
33977 .endd
33978
33979
33980
33981 .section "Scanning MIME parts" "SECTscanmimepart"
33982 .cindex "content scanning" "MIME parts"
33983 .cindex "MIME content scanning"
33984 .oindex "&%acl_smtp_mime%&"
33985 .oindex "&%acl_not_smtp_mime%&"
33986 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33987 each MIME part of an SMTP message, including multipart types, in the sequence
33988 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33989 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33990 options may both refer to the same ACL if you want the same processing in both
33991 cases.
33992
33993 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33994 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33995 the case of a non-SMTP message. However, a MIME ACL is called only if the
33996 message contains a &'Content-Type:'& header line. When a call to a MIME
33997 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33998 result code is sent to the client. In the case of an SMTP message, the
33999 &%acl_smtp_data%& ACL is not called when this happens.
34000
34001 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34002 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34003 condition to match against the raw MIME part. You can also use the
34004 &%mime_regex%& condition to match against the decoded MIME part (see section
34005 &<<SECTscanregex>>&).
34006
34007 At the start of a MIME ACL, a number of variables are set from the header
34008 information for the relevant MIME part. These are described below. The contents
34009 of the MIME part are not by default decoded into a disk file except for MIME
34010 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34011 part into a disk file, you can use the &%decode%& condition. The general
34012 syntax is:
34013 .display
34014 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34015 .endd
34016 The right hand side is expanded before use. After expansion,
34017 the value can be:
34018
34019 .olist
34020 &"0"& or &"false"&, in which case no decoding is done.
34021 .next
34022 The string &"default"&. In that case, the file is put in the temporary
34023 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34024 a sequential filename consisting of the message id and a sequence number. The
34025 full path and name is available in &$mime_decoded_filename$& after decoding.
34026 .next
34027 A full path name starting with a slash. If the full name is an existing
34028 directory, it is used as a replacement for the default directory. The filename
34029 is then sequentially assigned. If the path does not exist, it is used as
34030 the full path and filename.
34031 .next
34032 If the string does not start with a slash, it is used as the
34033 filename, and the default path is then used.
34034 .endlist
34035 The &%decode%& condition normally succeeds. It is only false for syntax
34036 errors or unusual circumstances such as memory shortages. You can easily decode
34037 a file with its original, proposed filename using
34038 .code
34039 decode = $mime_filename
34040 .endd
34041 However, you should keep in mind that &$mime_filename$& might contain
34042 anything. If you place files outside of the default path, they are not
34043 automatically unlinked.
34044
34045 For RFC822 attachments (these are messages attached to messages, with a
34046 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34047 as for the primary message, only that the &$mime_is_rfc822$& expansion
34048 variable is set (see below). Attached messages are always decoded to disk
34049 before being checked, and the files are unlinked once the check is done.
34050
34051 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34052 used to match regular expressions against raw and decoded MIME parts,
34053 respectively. They are described in section &<<SECTscanregex>>&.
34054
34055 .cindex "MIME content scanning" "returned variables"
34056 The following list describes all expansion variables that are
34057 available in the MIME ACL:
34058
34059 .vlist
34060 .vitem &$mime_anomaly_level$& &&&
34061        &$mime_anomaly_text$&
34062 .vindex &$mime_anomaly_level$&
34063 .vindex &$mime_anomaly_text$&
34064 If there are problems decoding, these variables contain information on
34065 the detected issue.
34066
34067 .vitem &$mime_boundary$&
34068 .vindex &$mime_boundary$&
34069 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34070 have a boundary string, which is stored in this variable. If the current part
34071 has no boundary parameter in the &'Content-Type:'& header, this variable
34072 contains the empty string.
34073
34074 .vitem &$mime_charset$&
34075 .vindex &$mime_charset$&
34076 This variable contains the character set identifier, if one was found in the
34077 &'Content-Type:'& header. Examples for charset identifiers are:
34078 .code
34079 us-ascii
34080 gb2312 (Chinese)
34081 iso-8859-1
34082 .endd
34083 Please note that this value is not normalized, so you should do matches
34084 case-insensitively.
34085
34086 .vitem &$mime_content_description$&
34087 .vindex &$mime_content_description$&
34088 This variable contains the normalized content of the &'Content-Description:'&
34089 header. It can contain a human-readable description of the parts content. Some
34090 implementations repeat the filename for attachments here, but they are usually
34091 only used for display purposes.
34092
34093 .vitem &$mime_content_disposition$&
34094 .vindex &$mime_content_disposition$&
34095 This variable contains the normalized content of the &'Content-Disposition:'&
34096 header. You can expect strings like &"attachment"& or &"inline"& here.
34097
34098 .vitem &$mime_content_id$&
34099 .vindex &$mime_content_id$&
34100 This variable contains the normalized content of the &'Content-ID:'& header.
34101 This is a unique ID that can be used to reference a part from another part.
34102
34103 .vitem &$mime_content_size$&
34104 .vindex &$mime_content_size$&
34105 This variable is set only after the &%decode%& modifier (see above) has been
34106 successfully run. It contains the size of the decoded part in kilobytes. The
34107 size is always rounded up to full kilobytes, so only a completely empty part
34108 has a &$mime_content_size$& of zero.
34109
34110 .vitem &$mime_content_transfer_encoding$&
34111 .vindex &$mime_content_transfer_encoding$&
34112 This variable contains the normalized content of the
34113 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34114 type. Typical values are &"base64"& and &"quoted-printable"&.
34115
34116 .vitem &$mime_content_type$&
34117 .vindex &$mime_content_type$&
34118 If the MIME part has a &'Content-Type:'& header, this variable contains its
34119 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34120 are some examples of popular MIME types, as they may appear in this variable:
34121 .code
34122 text/plain
34123 text/html
34124 application/octet-stream
34125 image/jpeg
34126 audio/midi
34127 .endd
34128 If the MIME part has no &'Content-Type:'& header, this variable contains the
34129 empty string.
34130
34131 .vitem &$mime_decoded_filename$&
34132 .vindex &$mime_decoded_filename$&
34133 This variable is set only after the &%decode%& modifier (see above) has been
34134 successfully run. It contains the full path and filename of the file
34135 containing the decoded data.
34136 .endlist
34137
34138 .cindex "RFC 2047"
34139 .vlist
34140 .vitem &$mime_filename$&
34141 .vindex &$mime_filename$&
34142 This is perhaps the most important of the MIME variables. It contains a
34143 proposed filename for an attachment, if one was found in either the
34144 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34145 RFC2047
34146 or RFC2231
34147 decoded, but no additional sanity checks are done.
34148  If no filename was
34149 found, this variable contains the empty string.
34150
34151 .vitem &$mime_is_coverletter$&
34152 .vindex &$mime_is_coverletter$&
34153 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34154 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34155 content in the cover letter, while not restricting attachments at all.
34156
34157 The variable contains 1 (true) for a MIME part believed to be part of the
34158 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34159 follows:
34160
34161 .olist
34162 The outermost MIME part of a message is always a cover letter.
34163
34164 .next
34165 If a multipart/alternative or multipart/related MIME part is a cover letter,
34166 so are all MIME subparts within that multipart.
34167
34168 .next
34169 If any other multipart is a cover letter, the first subpart is a cover letter,
34170 and the rest are attachments.
34171
34172 .next
34173 All parts contained within an attachment multipart are attachments.
34174 .endlist olist
34175
34176 As an example, the following will ban &"HTML mail"& (including that sent with
34177 alternative plain text), while allowing HTML files to be attached. HTML
34178 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34179 .code
34180 deny !condition = $mime_is_rfc822
34181      condition = $mime_is_coverletter
34182      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34183      message = HTML mail is not accepted here
34184 .endd
34185
34186 .vitem &$mime_is_multipart$&
34187 .vindex &$mime_is_multipart$&
34188 This variable has the value 1 (true) when the current part has the main type
34189 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34190 Since multipart entities only serve as containers for other parts, you may not
34191 want to carry out specific actions on them.
34192
34193 .vitem &$mime_is_rfc822$&
34194 .vindex &$mime_is_rfc822$&
34195 This variable has the value 1 (true) if the current part is not a part of the
34196 checked message itself, but part of an attached message. Attached message
34197 decoding is fully recursive.
34198
34199 .vitem &$mime_part_count$&
34200 .vindex &$mime_part_count$&
34201 This variable is a counter that is raised for each processed MIME part. It
34202 starts at zero for the very first part (which is usually a multipart). The
34203 counter is per-message, so it is reset when processing RFC822 attachments (see
34204 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34205 complete, so you can use it in the DATA ACL to determine the number of MIME
34206 parts of a message. For non-MIME messages, this variable contains the value -1.
34207 .endlist
34208
34209
34210
34211 .section "Scanning with regular expressions" "SECTscanregex"
34212 .cindex "content scanning" "with regular expressions"
34213 .cindex "regular expressions" "content scanning with"
34214 You can specify your own custom regular expression matches on the full body of
34215 the message, or on individual MIME parts.
34216
34217 The &%regex%& condition takes one or more regular expressions as arguments and
34218 matches them against the full message (when called in the DATA ACL) or a raw
34219 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34220 linewise, with a maximum line length of 32K characters. That means you cannot
34221 have multiline matches with the &%regex%& condition.
34222
34223 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34224 to 32K of decoded content (the whole content at once, not linewise). If the
34225 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34226 is decoded automatically when &%mime_regex%& is executed (using default path
34227 and filename values). If the decoded data is larger than  32K, only the first
34228 32K characters are checked.
34229
34230 The regular expressions are passed as a colon-separated list. To include a
34231 literal colon, you must double it. Since the whole right-hand side string is
34232 expanded before being used, you must also escape dollar signs and backslashes
34233 with more backslashes, or use the &`\N`& facility to disable expansion.
34234 Here is a simple example that contains two regular expressions:
34235 .code
34236 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34237      message = contains blacklisted regex ($regex_match_string)
34238 .endd
34239 The conditions returns true if any one of the regular expressions matches. The
34240 &$regex_match_string$& expansion variable is then set up and contains the
34241 matching regular expression.
34242 The expansion variables &$regex1$& &$regex2$& etc
34243 are set to any substrings captured by the regular expression.
34244
34245 &*Warning*&: With large messages, these conditions can be fairly
34246 CPU-intensive.
34247
34248 .ecindex IIDcosca
34249
34250
34251
34252
34253 . ////////////////////////////////////////////////////////////////////////////
34254 . ////////////////////////////////////////////////////////////////////////////
34255
34256 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34257          "Local scan function"
34258 .scindex IIDlosca "&[local_scan()]& function" "description of"
34259 .cindex "customizing" "input scan using C function"
34260 .cindex "policy control" "by local scan function"
34261 In these days of email worms, viruses, and ever-increasing spam, some sites
34262 want to apply a lot of checking to messages before accepting them.
34263
34264 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34265 passing messages to external virus and spam scanning software. You can also do
34266 a certain amount in Exim itself through string expansions and the &%condition%&
34267 condition in the ACL that runs after the SMTP DATA command or the ACL for
34268 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34269
34270 To allow for further customization to a site's own requirements, there is the
34271 possibility of linking Exim with a private message scanning function, written
34272 in C. If you want to run code that is written in something other than C, you
34273 can of course use a little C stub to call it.
34274
34275 The local scan function is run once for every incoming message, at the point
34276 when Exim is just about to accept the message.
34277 It can therefore be used to control non-SMTP messages from local processes as
34278 well as messages arriving via SMTP.
34279
34280 Exim applies a timeout to calls of the local scan function, and there is an
34281 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34282 Zero means &"no timeout"&.
34283 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34284 before calling the local scan function, so that the most common types of crash
34285 are caught. If the timeout is exceeded or one of those signals is caught, the
34286 incoming message is rejected with a temporary error if it is an SMTP message.
34287 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34288 code. The incident is logged on the main and reject logs.
34289
34290
34291
34292 .section "Building Exim to use a local scan function" "SECID207"
34293 .cindex "&[local_scan()]& function" "building Exim to use"
34294 To make use of the local scan function feature, you must tell Exim where your
34295 function is before building Exim, by setting
34296 both HAVE_LOCAL_SCAN and
34297 LOCAL_SCAN_SOURCE in your
34298 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34299 directory, so you might set
34300 .code
34301 HAVE_LOCAL_SCAN=yes
34302 LOCAL_SCAN_SOURCE=Local/local_scan.c
34303 .endd
34304 for example. The function must be called &[local_scan()]&;
34305 .new
34306 the source file(s) for it should first #define LOCAL_SCAN
34307 and then #include "local_scan.h".
34308 .wen
34309 It is called by
34310 Exim after it has received a message, when the success return code is about to
34311 be sent. This is after all the ACLs have been run. The return code from your
34312 function controls whether the message is actually accepted or not. There is a
34313 commented template function (that just accepts the message) in the file
34314 _src/local_scan.c_.
34315
34316 If you want to make use of Exim's runtime configuration file to set options
34317 for your &[local_scan()]& function, you must also set
34318 .code
34319 LOCAL_SCAN_HAS_OPTIONS=yes
34320 .endd
34321 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34322
34323
34324
34325
34326 .section "API for local_scan()" "SECTapiforloc"
34327 .cindex "&[local_scan()]& function" "API description"
34328 .cindex &%dlfunc%& "API description"
34329 You must include this line near the start of your code:
34330 .code
34331 #define LOCAL_SCAN
34332 #include "local_scan.h"
34333 .endd
34334 This header file defines a number of variables and other values, and the
34335 prototype for the function itself. Exim is coded to use unsigned char values
34336 almost exclusively, and one of the things this header defines is a shorthand
34337 for &`unsigned char`& called &`uschar`&.
34338 It also makes available the following macro definitions, to simplify casting character
34339 strings and pointers to character strings:
34340 .code
34341 #define CS   (char *)
34342 #define CCS  (const char *)
34343 #define CSS  (char **)
34344 #define US   (unsigned char *)
34345 #define CUS  (const unsigned char *)
34346 #define USS  (unsigned char **)
34347 .endd
34348 The function prototype for &[local_scan()]& is:
34349 .code
34350 extern int local_scan(int fd, uschar **return_text);
34351 .endd
34352 The arguments are as follows:
34353
34354 .ilist
34355 &%fd%& is a file descriptor for the file that contains the body of the message
34356 (the -D file). The file is open for reading and writing, but updating it is not
34357 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34358
34359 The descriptor is positioned at character 19 of the file, which is the first
34360 character of the body itself, because the first 19 characters are the message
34361 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34362 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34363 case this changes in some future version.
34364 .next
34365 &%return_text%& is an address which you can use to return a pointer to a text
34366 string at the end of the function. The value it points to on entry is NULL.
34367 .endlist
34368
34369 The function must return an &%int%& value which is one of the following macros:
34370
34371 .vlist
34372 .vitem &`LOCAL_SCAN_ACCEPT`&
34373 .vindex "&$local_scan_data$&"
34374 The message is accepted. If you pass back a string of text, it is saved with
34375 the message, and made available in the variable &$local_scan_data$&. No
34376 newlines are permitted (if there are any, they are turned into spaces) and the
34377 maximum length of text is 1000 characters.
34378
34379 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34380 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34381 queued without immediate delivery, and is frozen.
34382
34383 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34384 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34385 queued without immediate delivery.
34386
34387 .vitem &`LOCAL_SCAN_REJECT`&
34388 The message is rejected; the returned text is used as an error message which is
34389 passed back to the sender and which is also logged. Newlines are permitted &--
34390 they cause a multiline response for SMTP rejections, but are converted to
34391 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34392 used.
34393
34394 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34395 The message is temporarily rejected; the returned text is used as an error
34396 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34397 problem"& is used.
34398
34399 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34400 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34401 message is not written to the reject log. It has the effect of unsetting the
34402 &%rejected_header%& log selector for just this rejection. If
34403 &%rejected_header%& is already unset (see the discussion of the
34404 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34405 same as LOCAL_SCAN_REJECT.
34406
34407 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34408 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34409 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34410 .endlist
34411
34412 If the message is not being received by interactive SMTP, rejections are
34413 reported by writing to &%stderr%& or by sending an email, as configured by the
34414 &%-oe%& command line options.
34415
34416
34417
34418 .section "Configuration options for local_scan()" "SECTconoptloc"
34419 .cindex "&[local_scan()]& function" "configuration options"
34420 It is possible to have option settings in the main configuration file
34421 that set values in static variables in the &[local_scan()]& module. If you
34422 want to do this, you must have the line
34423 .code
34424 LOCAL_SCAN_HAS_OPTIONS=yes
34425 .endd
34426 in your &_Local/Makefile_& when you build Exim. (This line is in
34427 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34428 file, you must define static variables to hold the option values, and a table
34429 to define them.
34430
34431 The table must be a vector called &%local_scan_options%&, of type
34432 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34433 and a pointer to the variable that holds the value. The entries must appear in
34434 alphabetical order. Following &%local_scan_options%& you must also define a
34435 variable called &%local_scan_options_count%& that contains the number of
34436 entries in the table. Here is a short example, showing two kinds of option:
34437 .code
34438 static int my_integer_option = 42;
34439 static uschar *my_string_option = US"a default string";
34440
34441 optionlist local_scan_options[] = {
34442   { "my_integer", opt_int,       &my_integer_option },
34443   { "my_string",  opt_stringptr, &my_string_option }
34444 };
34445
34446 int local_scan_options_count =
34447   sizeof(local_scan_options)/sizeof(optionlist);
34448 .endd
34449 The values of the variables can now be changed from Exim's runtime
34450 configuration file by including a local scan section as in this example:
34451 .code
34452 begin local_scan
34453 my_integer = 99
34454 my_string = some string of text...
34455 .endd
34456 The available types of option data are as follows:
34457
34458 .vlist
34459 .vitem &*opt_bool*&
34460 This specifies a boolean (true/false) option. The address should point to a
34461 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34462 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34463 whether such a variable has been set at all, you can initialize it to
34464 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34465 values.)
34466
34467 .vitem &*opt_fixed*&
34468 This specifies a fixed point number, such as is used for load averages.
34469 The address should point to a variable of type &`int`&. The value is stored
34470 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34471
34472 .vitem &*opt_int*&
34473 This specifies an integer; the address should point to a variable of type
34474 &`int`&. The value may be specified in any of the integer formats accepted by
34475 Exim.
34476
34477 .vitem &*opt_mkint*&
34478 This is the same as &%opt_int%&, except that when such a value is output in a
34479 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34480 printed with the suffix K or M.
34481
34482 .vitem &*opt_octint*&
34483 This also specifies an integer, but the value is always interpreted as an
34484 octal integer, whether or not it starts with the digit zero, and it is
34485 always output in octal.
34486
34487 .vitem &*opt_stringptr*&
34488 This specifies a string value; the address must be a pointer to a
34489 variable that points to a string (for example, of type &`uschar *`&).
34490
34491 .vitem &*opt_time*&
34492 This specifies a time interval value. The address must point to a variable of
34493 type &`int`&. The value that is placed there is a number of seconds.
34494 .endlist
34495
34496 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34497 out the values of all the &[local_scan()]& options.
34498
34499
34500
34501 .section "Available Exim variables" "SECID208"
34502 .cindex "&[local_scan()]& function" "available Exim variables"
34503 The header &_local_scan.h_& gives you access to a number of C variables. These
34504 are the only ones that are guaranteed to be maintained from release to release.
34505 Note, however, that you can obtain the value of any Exim expansion variable,
34506 including &$recipients$&, by calling &'expand_string()'&. The exported
34507 C variables are as follows:
34508
34509 .vlist
34510 .vitem &*int&~body_linecount*&
34511 This variable contains the number of lines in the message's body.
34512 It is not valid if the &%spool_files_wireformat%& option is used.
34513
34514 .vitem &*int&~body_zerocount*&
34515 This variable contains the number of binary zero bytes in the message's body.
34516 It is not valid if the &%spool_files_wireformat%& option is used.
34517
34518 .vitem &*unsigned&~int&~debug_selector*&
34519 This variable is set to zero when no debugging is taking place. Otherwise, it
34520 is a bitmap of debugging selectors. Two bits are identified for use in
34521 &[local_scan()]&; they are defined as macros:
34522
34523 .ilist
34524 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34525 testing option that is not privileged &-- any caller may set it. All the
34526 other selector bits can be set only by admin users.
34527
34528 .next
34529 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34530 by the &`+local_scan`& debug selector. It is not included in the default set
34531 of debugging bits.
34532 .endlist ilist
34533
34534 Thus, to write to the debugging output only when &`+local_scan`& has been
34535 selected, you should use code like this:
34536 .code
34537 if ((debug_selector & D_local_scan) != 0)
34538   debug_printf("xxx", ...);
34539 .endd
34540 .vitem &*uschar&~*expand_string_message*&
34541 After a failing call to &'expand_string()'& (returned value NULL), the
34542 variable &%expand_string_message%& contains the error message, zero-terminated.
34543
34544 .vitem &*header_line&~*header_list*&
34545 A pointer to a chain of header lines. The &%header_line%& structure is
34546 discussed below.
34547
34548 .vitem &*header_line&~*header_last*&
34549 A pointer to the last of the header lines.
34550
34551 .vitem &*uschar&~*headers_charset*&
34552 The value of the &%headers_charset%& configuration option.
34553
34554 .vitem &*BOOL&~host_checking*&
34555 This variable is TRUE during a host checking session that is initiated by the
34556 &%-bh%& command line option.
34557
34558 .vitem &*uschar&~*interface_address*&
34559 The IP address of the interface that received the message, as a string. This
34560 is NULL for locally submitted messages.
34561
34562 .vitem &*int&~interface_port*&
34563 The port on which this message was received. When testing with the &%-bh%&
34564 command line option, the value of this variable is -1 unless a port has been
34565 specified via the &%-oMi%& option.
34566
34567 .vitem &*uschar&~*message_id*&
34568 This variable contains Exim's message id for the incoming message (the value of
34569 &$message_exim_id$&) as a zero-terminated string.
34570
34571 .vitem &*uschar&~*received_protocol*&
34572 The name of the protocol by which the message was received.
34573
34574 .vitem &*int&~recipients_count*&
34575 The number of accepted recipients.
34576
34577 .vitem &*recipient_item&~*recipients_list*&
34578 .cindex "recipient" "adding in local scan"
34579 .cindex "recipient" "removing in local scan"
34580 The list of accepted recipients, held in a vector of length
34581 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34582 can add additional recipients by calling &'receive_add_recipient()'& (see
34583 below). You can delete recipients by removing them from the vector and
34584 adjusting the value in &%recipients_count%&. In particular, by setting
34585 &%recipients_count%& to zero you remove all recipients. If you then return the
34586 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34587 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34588 and then call &'receive_add_recipient()'& as often as needed.
34589
34590 .vitem &*uschar&~*sender_address*&
34591 The envelope sender address. For bounce messages this is the empty string.
34592
34593 .vitem &*uschar&~*sender_host_address*&
34594 The IP address of the sending host, as a string. This is NULL for
34595 locally-submitted messages.
34596
34597 .vitem &*uschar&~*sender_host_authenticated*&
34598 The name of the authentication mechanism that was used, or NULL if the message
34599 was not received over an authenticated SMTP connection.
34600
34601 .vitem &*uschar&~*sender_host_name*&
34602 The name of the sending host, if known.
34603
34604 .vitem &*int&~sender_host_port*&
34605 The port on the sending host.
34606
34607 .vitem &*BOOL&~smtp_input*&
34608 This variable is TRUE for all SMTP input, including BSMTP.
34609
34610 .vitem &*BOOL&~smtp_batched_input*&
34611 This variable is TRUE for BSMTP input.
34612
34613 .vitem &*int&~store_pool*&
34614 The contents of this variable control which pool of memory is used for new
34615 requests. See section &<<SECTmemhanloc>>& for details.
34616 .endlist
34617
34618
34619 .section "Structure of header lines" "SECID209"
34620 The &%header_line%& structure contains the members listed below.
34621 You can add additional header lines by calling the &'header_add()'& function
34622 (see below). You can cause header lines to be ignored (deleted) by setting
34623 their type to *.
34624
34625
34626 .vlist
34627 .vitem &*struct&~header_line&~*next*&
34628 A pointer to the next header line, or NULL for the last line.
34629
34630 .vitem &*int&~type*&
34631 A code identifying certain headers that Exim recognizes. The codes are printing
34632 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34633 Notice in particular that any header line whose type is * is not transmitted
34634 with the message. This flagging is used for header lines that have been
34635 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34636 lines.) Effectively, * means &"deleted"&.
34637
34638 .vitem &*int&~slen*&
34639 The number of characters in the header line, including the terminating and any
34640 internal newlines.
34641
34642 .vitem &*uschar&~*text*&
34643 A pointer to the text of the header. It always ends with a newline, followed by
34644 a zero byte. Internal newlines are preserved.
34645 .endlist
34646
34647
34648
34649 .section "Structure of recipient items" "SECID210"
34650 The &%recipient_item%& structure contains these members:
34651
34652 .vlist
34653 .vitem &*uschar&~*address*&
34654 This is a pointer to the recipient address as it was received.
34655
34656 .vitem &*int&~pno*&
34657 This is used in later Exim processing when top level addresses are created by
34658 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34659 and must always contain -1 at this stage.
34660
34661 .vitem &*uschar&~*errors_to*&
34662 If this value is not NULL, bounce messages caused by failing to deliver to the
34663 recipient are sent to the address it contains. In other words, it overrides the
34664 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34665 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34666 an unqualified address, Exim qualifies it using the domain from
34667 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34668 is NULL for all recipients.
34669 .endlist
34670
34671
34672
34673 .section "Available Exim functions" "SECID211"
34674 .cindex "&[local_scan()]& function" "available Exim functions"
34675 The header &_local_scan.h_& gives you access to a number of Exim functions.
34676 These are the only ones that are guaranteed to be maintained from release to
34677 release:
34678
34679 .vlist
34680 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34681        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34682
34683 This function creates a child process that runs the command specified by
34684 &%argv%&. The environment for the process is specified by &%envp%&, which can
34685 be NULL if no environment variables are to be passed. A new umask is supplied
34686 for the process in &%newumask%&.
34687
34688 Pipes to the standard input and output of the new process are set up
34689 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34690 standard error is cloned to the standard output. If there are any file
34691 descriptors &"in the way"& in the new process, they are closed. If the final
34692 argument is TRUE, the new process is made into a process group leader.
34693
34694 The function returns the pid of the new process, or -1 if things go wrong.
34695
34696 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34697 This function waits for a child process to terminate, or for a timeout (in
34698 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34699 return value is as follows:
34700
34701 .ilist
34702 >= 0
34703
34704 The process terminated by a normal exit and the value is the process
34705 ending status.
34706
34707 .next
34708 < 0 and > &--256
34709
34710 The process was terminated by a signal and the value is the negation of the
34711 signal number.
34712
34713 .next
34714 &--256
34715
34716 The process timed out.
34717 .next
34718 &--257
34719
34720 The was some other error in wait(); &%errno%& is still set.
34721 .endlist
34722
34723 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34724 This function provide you with a means of submitting a new message to
34725 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34726 want, but this packages it all up for you.) The function creates a pipe,
34727 forks a subprocess that is running
34728 .code
34729 exim -t -oem -oi -f <>
34730 .endd
34731 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34732 that is connected to the standard input. The yield of the function is the PID
34733 of the subprocess. You can then write a message to the file descriptor, with
34734 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34735
34736 When you have finished, call &'child_close()'& to wait for the process to
34737 finish and to collect its ending status. A timeout value of zero is usually
34738 fine in this circumstance. Unless you have made a mistake with the recipient
34739 addresses, you should get a return code of zero.
34740
34741
34742 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34743        *sender_authentication)*&
34744 This function is a more sophisticated version of &'child_open()'&. The command
34745 that it runs is:
34746 .display
34747 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34748 .endd
34749 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34750
34751
34752 .vitem &*void&~debug_printf(char&~*,&~...)*&
34753 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34754 output is written to the standard error stream. If no debugging is selected,
34755 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34756 conditional on the &`local_scan`& debug selector by coding like this:
34757 .code
34758 if ((debug_selector & D_local_scan) != 0)
34759   debug_printf("xxx", ...);
34760 .endd
34761
34762 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34763 This is an interface to Exim's string expansion code. The return value is the
34764 expanded string, or NULL if there was an expansion failure.
34765 The C variable &%expand_string_message%& contains an error message after an
34766 expansion failure. If expansion does not change the string, the return value is
34767 the pointer to the input string. Otherwise, the return value points to a new
34768 block of memory that was obtained by a call to &'store_get()'&. See section
34769 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34770
34771 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34772 This function allows you to an add additional header line at the end of the
34773 existing ones. The first argument is the type, and should normally be a space
34774 character. The second argument is a format string and any number of
34775 substitution arguments as for &[sprintf()]&. You may include internal newlines
34776 if you want, and you must ensure that the string ends with a newline.
34777
34778 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34779         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34780 This function adds a new header line at a specified point in the header
34781 chain. The header itself is specified as for &'header_add()'&.
34782
34783 If &%name%& is NULL, the new header is added at the end of the chain if
34784 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34785 NULL, the header lines are searched for the first non-deleted header that
34786 matches the name. If one is found, the new header is added before it if
34787 &%after%& is false. If &%after%& is true, the new header is added after the
34788 found header and any adjacent subsequent ones with the same name (even if
34789 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34790 option controls where the header is added. If it is true, addition is at the
34791 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34792 headers, or at the top if there are no &'Received:'& headers, you could use
34793 .code
34794 header_add_at_position(TRUE, US"Received", TRUE,
34795   ' ', "X-xxx: ...");
34796 .endd
34797 Normally, there is always at least one non-deleted &'Received:'& header, but
34798 there may not be if &%received_header_text%& expands to an empty string.
34799
34800
34801 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34802 This function removes header lines. If &%occurrence%& is zero or negative, all
34803 occurrences of the header are removed. If occurrence is greater than zero, that
34804 particular instance of the header is removed. If no header(s) can be found that
34805 match the specification, the function does nothing.
34806
34807
34808 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34809         int&~length,&~BOOL&~notdel)*&"
34810 This function tests whether the given header has the given name. It is not just
34811 a string comparison, because white space is permitted between the name and the
34812 colon. If the &%notdel%& argument is true, a false return is forced for all
34813 &"deleted"& headers; otherwise they are not treated specially. For example:
34814 .code
34815 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34816 .endd
34817 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34818 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34819 This function base64-encodes a string, which is passed by address and length.
34820 The text may contain bytes of any value, including zero. The result is passed
34821 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34822 zero-terminated.
34823
34824 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34825 This function decodes a base64-encoded string. Its arguments are a
34826 zero-terminated base64-encoded string and the address of a variable that is set
34827 to point to the result, which is in dynamic memory. The length of the decoded
34828 string is the yield of the function. If the input is invalid base64 data, the
34829 yield is -1. A zero byte is added to the end of the output string to make it
34830 easy to interpret as a C string (assuming it contains no zeros of its own). The
34831 added zero byte is not included in the returned count.
34832
34833 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34834 This function checks for a match in a domain list. Domains are always
34835 matched caselessly. The return value is one of the following:
34836 .display
34837 &`OK     `& match succeeded
34838 &`FAIL   `& match failed
34839 &`DEFER  `& match deferred
34840 .endd
34841 DEFER is usually caused by some kind of lookup defer, such as the
34842 inability to contact a database.
34843
34844 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34845         BOOL&~caseless)*&"
34846 This function checks for a match in a local part list. The third argument
34847 controls case-sensitivity. The return values are as for
34848 &'lss_match_domain()'&.
34849
34850 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34851         BOOL&~caseless)*&"
34852 This function checks for a match in an address list. The third argument
34853 controls the case-sensitivity of the local part match. The domain is always
34854 matched caselessly. The return values are as for &'lss_match_domain()'&.
34855
34856 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34857         uschar&~*list)*&"
34858 This function checks for a match in a host list. The most common usage is
34859 expected to be
34860 .code
34861 lss_match_host(sender_host_name, sender_host_address, ...)
34862 .endd
34863 .vindex "&$sender_host_address$&"
34864 An empty address field matches an empty item in the host list. If the host name
34865 is NULL, the name corresponding to &$sender_host_address$& is automatically
34866 looked up if a host name is required to match an item in the list. The return
34867 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34868 returns ERROR in the case when it had to look up a host name, but the lookup
34869 failed.
34870
34871 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34872         *format,&~...)*&"
34873 This function writes to Exim's log files. The first argument should be zero (it
34874 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34875 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34876 them. It specifies to which log or logs the message is written. The remaining
34877 arguments are a format and relevant insertion arguments. The string should not
34878 contain any newlines, not even at the end.
34879
34880
34881 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34882 This function adds an additional recipient to the message. The first argument
34883 is the recipient address. If it is unqualified (has no domain), it is qualified
34884 with the &%qualify_recipient%& domain. The second argument must always be -1.
34885
34886 This function does not allow you to specify a private &%errors_to%& address (as
34887 described with the structure of &%recipient_item%& above), because it pre-dates
34888 the addition of that field to the structure. However, it is easy to add such a
34889 value afterwards. For example:
34890 .code
34891  receive_add_recipient(US"monitor@mydom.example", -1);
34892  recipients_list[recipients_count-1].errors_to =
34893    US"postmaster@mydom.example";
34894 .endd
34895
34896 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34897 This is a convenience function to remove a named recipient from the list of
34898 recipients. It returns true if a recipient was removed, and false if no
34899 matching recipient could be found. The argument must be a complete email
34900 address.
34901 .endlist
34902
34903
34904 .cindex "RFC 2047"
34905 .vlist
34906 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34907   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34908 This function decodes strings that are encoded according to RFC 2047. Typically
34909 these are the contents of header lines. First, each &"encoded word"& is decoded
34910 from the Q or B encoding into a byte-string. Then, if provided with the name of
34911 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34912 made  to translate the result to the named character set. If this fails, the
34913 binary string is returned with an error message.
34914
34915 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34916 maximum MIME word length is enforced. The third argument is the target
34917 encoding, or NULL if no translation is wanted.
34918
34919 .cindex "binary zero" "in RFC 2047 decoding"
34920 .cindex "RFC 2047" "binary zero in"
34921 If a binary zero is encountered in the decoded string, it is replaced by the
34922 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34923 not be 0 because header lines are handled as zero-terminated strings.
34924
34925 The function returns the result of processing the string, zero-terminated; if
34926 &%lenptr%& is not NULL, the length of the result is set in the variable to
34927 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34928
34929 If an error is encountered, the function returns NULL and uses the &%error%&
34930 argument to return an error message. The variable pointed to by &%error%& is
34931 set to NULL if there is no error; it may be set non-NULL even when the function
34932 returns a non-NULL value if decoding was successful, but there was a problem
34933 with translation.
34934
34935
34936 .vitem &*int&~smtp_fflush(void)*&
34937 This function is used in conjunction with &'smtp_printf()'&, as described
34938 below.
34939
34940 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34941 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34942 output stream. You should use this function only when there is an SMTP output
34943 stream, that is, when the incoming message is being received via interactive
34944 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34945 is FALSE. If you want to test for an incoming message from another host (as
34946 opposed to a local process that used the &%-bs%& command line option), you can
34947 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34948 is involved.
34949
34950 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34951 output function, so it can be used for all forms of SMTP connection.
34952
34953 The second argument is used to request that the data be buffered
34954 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34955 This is advisory only, but likely to save on system-calls and packets
34956 sent when a sequence of calls to the function are made.
34957
34958 The argument was added in Exim version 4.90 - changing the API/ABI.
34959 Nobody noticed until 4.93 was imminent, at which point the
34960 ABI version number was incremented.
34961
34962 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34963 must start with an appropriate response code: 550 if you are going to return
34964 LOCAL_SCAN_REJECT, 451 if you are going to return
34965 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34966 initial lines of a multi-line response, the code must be followed by a hyphen
34967 to indicate that the line is not the final response line. You must also ensure
34968 that the lines you write terminate with CRLF. For example:
34969 .code
34970 smtp_printf("550-this is some extra info\r\n");
34971 return LOCAL_SCAN_REJECT;
34972 .endd
34973 Note that you can also create multi-line responses by including newlines in
34974 the data returned via the &%return_text%& argument. The added value of using
34975 &'smtp_printf()'& is that, for instance, you could introduce delays between
34976 multiple output lines.
34977
34978 The &'smtp_printf()'& function does not return any error indication, because it
34979 does not
34980 guarantee a flush of
34981 pending output, and therefore does not test
34982 the state of the stream. (In the main code of Exim, flushing and error
34983 detection is done when Exim is ready for the next SMTP input command.) If
34984 you want to flush the output and check for an error (for example, the
34985 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34986 arguments. It flushes the output stream, and returns a non-zero value if there
34987 is an error.
34988
34989 .new
34990 .vitem &*void&~*store_get(int,BOOL)*&
34991 This function accesses Exim's internal store (memory) manager. It gets a new
34992 chunk of memory whose size is given by the first argument.
34993 The second argument should be given as TRUE if the memory will be used for
34994 data possibly coming from an attacker (eg. the message content),
34995 FALSE if it is locally-sourced.
34996 Exim bombs out if it ever
34997 runs out of memory. See the next section for a discussion of memory handling.
34998 .wen
34999
35000 .vitem &*void&~*store_get_perm(int,BOOL)*&
35001 This function is like &'store_get()'&, but it always gets memory from the
35002 permanent pool. See the next section for a discussion of memory handling.
35003
35004 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35005 See below.
35006
35007 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35008 See below.
35009
35010 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35011 These three functions create strings using Exim's dynamic memory facilities.
35012 The first makes a copy of an entire string. The second copies up to a maximum
35013 number of characters, indicated by the second argument. The third uses a format
35014 and insertion arguments to create a new string. In each case, the result is a
35015 pointer to a new string in the current memory pool. See the next section for
35016 more discussion.
35017 .endlist
35018
35019
35020
35021 .section "More about Exim's memory handling" "SECTmemhanloc"
35022 .cindex "&[local_scan()]& function" "memory handling"
35023 No function is provided for freeing memory, because that is never needed.
35024 The dynamic memory that Exim uses when receiving a message is automatically
35025 recycled if another message is received by the same process (this applies only
35026 to incoming SMTP connections &-- other input methods can supply only one
35027 message at a time). After receiving the last message, a reception process
35028 terminates.
35029
35030 Because it is recycled, the normal dynamic memory cannot be used for holding
35031 data that must be preserved over a number of incoming messages on the same SMTP
35032 connection. However, Exim in fact uses two pools of dynamic memory; the second
35033 one is not recycled, and can be used for this purpose.
35034
35035 If you want to allocate memory that remains available for subsequent messages
35036 in the same SMTP connection, you should set
35037 .code
35038 store_pool = POOL_PERM
35039 .endd
35040 before calling the function that does the allocation. There is no need to
35041 restore the value if you do not need to; however, if you do want to revert to
35042 the normal pool, you can either restore the previous value of &%store_pool%& or
35043 set it explicitly to POOL_MAIN.
35044
35045 The pool setting applies to all functions that get dynamic memory, including
35046 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35047 There is also a convenience function called &'store_get_perm()'& that gets a
35048 block of memory from the permanent pool while preserving the value of
35049 &%store_pool%&.
35050 .ecindex IIDlosca
35051
35052
35053
35054
35055 . ////////////////////////////////////////////////////////////////////////////
35056 . ////////////////////////////////////////////////////////////////////////////
35057
35058 .chapter "System-wide message filtering" "CHAPsystemfilter"
35059 .scindex IIDsysfil1 "filter" "system filter"
35060 .scindex IIDsysfil2 "filtering all mail"
35061 .scindex IIDsysfil3 "system filter"
35062 The previous chapters (on ACLs and the local scan function) describe checks
35063 that can be applied to messages before they are accepted by a host. There is
35064 also a mechanism for checking messages once they have been received, but before
35065 they are delivered. This is called the &'system filter'&.
35066
35067 The system filter operates in a similar manner to users' filter files, but it
35068 is run just once per message (however many recipients the message has).
35069 It should not normally be used as a substitute for routing, because &%deliver%&
35070 commands in a system router provide new envelope recipient addresses.
35071 The system filter must be an Exim filter. It cannot be a Sieve filter.
35072
35073 The system filter is run at the start of a delivery attempt, before any routing
35074 is done. If a message fails to be completely delivered at the first attempt,
35075 the system filter is run again at the start of every retry.
35076 If you want your filter to do something only once per message, you can make use
35077 of the &%first_delivery%& condition in an &%if%& command in the filter to
35078 prevent it happening on retries.
35079
35080 .vindex "&$domain$&"
35081 .vindex "&$local_part$&"
35082 &*Warning*&: Because the system filter runs just once, variables that are
35083 specific to individual recipient addresses, such as &$local_part$& and
35084 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35085 you want to run a centrally-specified filter for each recipient address
35086 independently, you can do so by setting up a suitable &(redirect)& router, as
35087 described in section &<<SECTperaddfil>>& below.
35088
35089
35090 .section "Specifying a system filter" "SECID212"
35091 .cindex "uid (user id)" "system filter"
35092 .cindex "gid (group id)" "system filter"
35093 The name of the file that contains the system filter must be specified by
35094 setting &%system_filter%&. If you want the filter to run under a uid and gid
35095 other than root, you must also set &%system_filter_user%& and
35096 &%system_filter_group%& as appropriate. For example:
35097 .code
35098 system_filter = /etc/mail/exim.filter
35099 system_filter_user = exim
35100 .endd
35101 If a system filter generates any deliveries directly to files or pipes (via the
35102 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35103 specified by setting &%system_filter_file_transport%& and
35104 &%system_filter_pipe_transport%&, respectively. Similarly,
35105 &%system_filter_reply_transport%& must be set to handle any messages generated
35106 by the &%reply%& command.
35107
35108
35109 .section "Testing a system filter" "SECID213"
35110 You can run simple tests of a system filter in the same way as for a user
35111 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35112 are permitted only in system filters are recognized.
35113
35114 If you want to test the combined effect of a system filter and a user filter,
35115 you can use both &%-bF%& and &%-bf%& on the same command line.
35116
35117
35118
35119 .section "Contents of a system filter" "SECID214"
35120 The language used to specify system filters is the same as for users' filter
35121 files. It is described in the separate end-user document &'Exim's interface to
35122 mail filtering'&. However, there are some additional features that are
35123 available only in system filters; these are described in subsequent sections.
35124 If they are encountered in a user's filter file or when testing with &%-bf%&,
35125 they cause errors.
35126
35127 .cindex "frozen messages" "manual thaw; testing in filter"
35128 There are two special conditions which, though available in users' filter
35129 files, are designed for use in system filters. The condition &%first_delivery%&
35130 is true only for the first attempt at delivering a message, and
35131 &%manually_thawed%& is true only if the message has been frozen, and
35132 subsequently thawed by an admin user. An explicit forced delivery counts as a
35133 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35134
35135 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35136 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35137 succeed, it will not be tried again.
35138 If you want Exim to retry an unseen delivery until it succeeds, you should
35139 arrange to set it up every time the filter runs.
35140
35141 When a system filter finishes running, the values of the variables &$n0$& &--
35142 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35143 users' filter files. Thus a system filter can, for example, set up &"scores"&
35144 to which users' filter files can refer.
35145
35146
35147
35148 .section "Additional variable for system filters" "SECID215"
35149 .vindex "&$recipients$&"
35150 The expansion variable &$recipients$&, containing a list of all the recipients
35151 of the message (separated by commas and white space), is available in system
35152 filters. It is not available in users' filters for privacy reasons.
35153
35154
35155
35156 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35157 .cindex "freezing messages"
35158 .cindex "message" "freezing"
35159 .cindex "message" "forced failure"
35160 .cindex "&%fail%&" "in system filter"
35161 .cindex "&%freeze%& in system filter"
35162 .cindex "&%defer%& in system filter"
35163 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35164 always available in system filters, but are not normally enabled in users'
35165 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35166 for the &(redirect)& router.) These commands can optionally be followed by the
35167 word &%text%& and a string containing an error message, for example:
35168 .code
35169 fail text "this message looks like spam to me"
35170 .endd
35171 The keyword &%text%& is optional if the next character is a double quote.
35172
35173 The &%defer%& command defers delivery of the original recipients of the
35174 message. The &%fail%& command causes all the original recipients to be failed,
35175 and a bounce message to be created. The &%freeze%& command suspends all
35176 delivery attempts for the original recipients. In all cases, any new deliveries
35177 that are specified by the filter are attempted as normal after the filter has
35178 run.
35179
35180 The &%freeze%& command is ignored if the message has been manually unfrozen and
35181 not manually frozen since. This means that automatic freezing by a system
35182 filter can be used as a way of checking out suspicious messages. If a message
35183 is found to be all right, manually unfreezing it allows it to be delivered.
35184
35185 .cindex "log" "&%fail%& command log line"
35186 .cindex "&%fail%&" "log line; reducing"
35187 The text given with a fail command is used as part of the bounce message as
35188 well as being written to the log. If the message is quite long, this can fill
35189 up a lot of log space when such failures are common. To reduce the size of the
35190 log message, Exim interprets the text in a special way if it starts with the
35191 two characters &`<<`& and contains &`>>`& later. The text between these two
35192 strings is written to the log, and the rest of the text is used in the bounce
35193 message. For example:
35194 .code
35195 fail "<<filter test 1>>Your message is rejected \
35196      because it contains attachments that we are \
35197      not prepared to receive."
35198 .endd
35199
35200 .cindex "loop" "caused by &%fail%&"
35201 Take great care with the &%fail%& command when basing the decision to fail on
35202 the contents of the message, because the bounce message will of course include
35203 the contents of the original message and will therefore trigger the &%fail%&
35204 command again (causing a mail loop) unless steps are taken to prevent this.
35205 Testing the &%error_message%& condition is one way to prevent this. You could
35206 use, for example
35207 .code
35208 if $message_body contains "this is spam" and not error_message
35209 then fail text "spam is not wanted here" endif
35210 .endd
35211 though of course that might let through unwanted bounce messages. The
35212 alternative is clever checking of the body and/or headers to detect bounces
35213 generated by the filter.
35214
35215 The interpretation of a system filter file ceases after a
35216 &%defer%&,
35217 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35218 set up earlier in the filter file are honoured, so you can use a sequence such
35219 as
35220 .code
35221 mail ...
35222 freeze
35223 .endd
35224 to send a specified message when the system filter is freezing (or deferring or
35225 failing) a message. The normal deliveries for the message do not, of course,
35226 take place.
35227
35228
35229
35230 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35231 .cindex "header lines" "adding; in system filter"
35232 .cindex "header lines" "removing; in system filter"
35233 .cindex "filter" "header lines; adding/removing"
35234 Two filter commands that are available only in system filters are:
35235 .code
35236 headers add <string>
35237 headers remove <string>
35238 .endd
35239 The argument for the &%headers add%& is a string that is expanded and then
35240 added to the end of the message's headers. It is the responsibility of the
35241 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35242 space is ignored, and if the string is otherwise empty, or if the expansion is
35243 forced to fail, the command has no effect.
35244
35245 You can use &"\n"& within the string, followed by white space, to specify
35246 continued header lines. More than one header may be added in one command by
35247 including &"\n"& within the string without any following white space. For
35248 example:
35249 .code
35250 headers add "X-header-1: ....\n  \
35251              continuation of X-header-1 ...\n\
35252              X-header-2: ...."
35253 .endd
35254 Note that the header line continuation white space after the first newline must
35255 be placed before the backslash that continues the input string, because white
35256 space after input continuations is ignored.
35257
35258 The argument for &%headers remove%& is a colon-separated list of header names.
35259 This command applies only to those headers that are stored with the message;
35260 those that are added at delivery time (such as &'Envelope-To:'& and
35261 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35262 header with the same name, they are all removed.
35263
35264 The &%headers%& command in a system filter makes an immediate change to the set
35265 of header lines that was received with the message (with possible additions
35266 from ACL processing). Subsequent commands in the system filter operate on the
35267 modified set, which also forms the basis for subsequent message delivery.
35268 Unless further modified during routing or transporting, this set of headers is
35269 used for all recipients of the message.
35270
35271 During routing and transporting, the variables that refer to the contents of
35272 header lines refer only to those lines that are in this set. Thus, header lines
35273 that are added by a system filter are visible to users' filter files and to all
35274 routers and transports. This contrasts with the manipulation of header lines by
35275 routers and transports, which is not immediate, but which instead is saved up
35276 until the message is actually being written (see section
35277 &<<SECTheadersaddrem>>&).
35278
35279 If the message is not delivered at the first attempt, header lines that were
35280 added by the system filter are stored with the message, and so are still
35281 present at the next delivery attempt. Header lines that were removed are still
35282 present, but marked &"deleted"& so that they are not transported with the
35283 message. For this reason, it is usual to make the &%headers%& command
35284 conditional on &%first_delivery%& so that the set of header lines is not
35285 modified more than once.
35286
35287 Because header modification in a system filter acts immediately, you have to
35288 use an indirect approach if you want to modify the contents of a header line.
35289 For example:
35290 .code
35291 headers add "Old-Subject: $h_subject:"
35292 headers remove "Subject"
35293 headers add "Subject: new subject (was: $h_old-subject:)"
35294 headers remove "Old-Subject"
35295 .endd
35296
35297
35298
35299 .section "Setting an errors address in a system filter" "SECID217"
35300 .cindex "envelope from"
35301 .cindex "envelope sender"
35302 In a system filter, if a &%deliver%& command is followed by
35303 .code
35304 errors_to <some address>
35305 .endd
35306 in order to change the envelope sender (and hence the error reporting) for that
35307 delivery, any address may be specified. (In a user filter, only the current
35308 user's address can be set.) For example, if some mail is being monitored, you
35309 might use
35310 .code
35311 unseen deliver monitor@spying.example errors_to root@local.example
35312 .endd
35313 to take a copy which would not be sent back to the normal error reporting
35314 address if its delivery failed.
35315
35316
35317
35318 .section "Per-address filtering" "SECTperaddfil"
35319 .vindex "&$domain$&"
35320 .vindex "&$local_part$&"
35321 In contrast to the system filter, which is run just once per message for each
35322 delivery attempt, it is also possible to set up a system-wide filtering
35323 operation that runs once for each recipient address. In this case, variables
35324 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
35325 filter file could be made dependent on them. This is an example of a router
35326 which implements such a filter:
35327 .code
35328 central_filter:
35329   check_local_user
35330   driver = redirect
35331   domains = +local_domains
35332   file = /central/filters/$local_part_data
35333   no_verify
35334   allow_filter
35335   allow_freeze
35336 .endd
35337 The filter is run in a separate process under its own uid. Therefore, either
35338 &%check_local_user%& must be set (as above), in which case the filter is run as
35339 the local user, or the &%user%& option must be used to specify which user to
35340 use. If both are set, &%user%& overrides.
35341
35342 Care should be taken to ensure that none of the commands in the filter file
35343 specify a significant delivery if the message is to go on to be delivered to
35344 its intended recipient. The router will not then claim to have dealt with the
35345 address, so it will be passed on to subsequent routers to be delivered in the
35346 normal way.
35347 .ecindex IIDsysfil1
35348 .ecindex IIDsysfil2
35349 .ecindex IIDsysfil3
35350
35351
35352
35353
35354
35355
35356 . ////////////////////////////////////////////////////////////////////////////
35357 . ////////////////////////////////////////////////////////////////////////////
35358
35359 .chapter "Message processing" "CHAPmsgproc"
35360 .scindex IIDmesproc "message" "general processing"
35361 Exim performs various transformations on the sender and recipient addresses of
35362 all messages that it handles, and also on the messages' header lines. Some of
35363 these are optional and configurable, while others always take place. All of
35364 this processing, except rewriting as a result of routing, and the addition or
35365 removal of header lines while delivering, happens when a message is received,
35366 before it is placed on Exim's queue.
35367
35368 Some of the automatic processing takes place by default only for
35369 &"locally-originated"& messages. This adjective is used to describe messages
35370 that are not received over TCP/IP, but instead are passed to an Exim process on
35371 its standard input. This includes the interactive &"local SMTP"& case that is
35372 set up by the &%-bs%& command line option.
35373
35374 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35375 or ::1) are not considered to be locally-originated. Exim does not treat the
35376 loopback interface specially in any way.
35377
35378 If you want the loopback interface to be treated specially, you must ensure
35379 that there are appropriate entries in your ACLs.
35380
35381
35382
35383
35384 .section "Submission mode for non-local messages" "SECTsubmodnon"
35385 .cindex "message" "submission"
35386 .cindex "submission mode"
35387 Processing that happens automatically for locally-originated messages (unless
35388 &%suppress_local_fixups%& is set) can also be requested for messages that are
35389 received over TCP/IP. The term &"submission mode"& is used to describe this
35390 state. Submission mode is set by the modifier
35391 .code
35392 control = submission
35393 .endd
35394 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35395 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35396 a local submission, and is normally used when the source of the message is
35397 known to be an MUA running on a client host (as opposed to an MTA). For
35398 example, to set submission mode for messages originating on the IPv4 loopback
35399 interface, you could include the following in the MAIL ACL:
35400 .code
35401 warn  hosts = 127.0.0.1
35402       control = submission
35403 .endd
35404 .cindex "&%sender_retain%& submission option"
35405 There are some options that can be used when setting submission mode. A slash
35406 is used to separate options. For example:
35407 .code
35408 control = submission/sender_retain
35409 .endd
35410 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35411 true and &%local_from_check%& false for the current incoming message. The first
35412 of these allows an existing &'Sender:'& header in the message to remain, and
35413 the second suppresses the check to ensure that &'From:'& matches the
35414 authenticated sender. With this setting, Exim still fixes up messages by adding
35415 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35416 attempt to check sender authenticity in header lines.
35417
35418 When &%sender_retain%& is not set, a submission mode setting may specify a
35419 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35420 example:
35421 .code
35422 control = submission/domain=some.domain
35423 .endd
35424 The domain may be empty. How this value is used is described in sections
35425 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35426 that allows you to specify the user's full name for inclusion in a created
35427 &'Sender:'& or &'From:'& header line. For example:
35428 .code
35429 accept authenticated = *
35430        control = submission/domain=wonderland.example/\
35431                             name=${lookup {$authenticated_id} \
35432                                    lsearch {/etc/exim/namelist}}
35433 .endd
35434 Because the name may contain any characters, including slashes, the &%name%&
35435 option must be given last. The remainder of the string is used as the name. For
35436 the example above, if &_/etc/exim/namelist_& contains:
35437 .code
35438 bigegg:  Humpty Dumpty
35439 .endd
35440 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35441 line would be:
35442 .code
35443 Sender: Humpty Dumpty <bigegg@wonderland.example>
35444 .endd
35445 .cindex "return path" "in submission mode"
35446 By default, submission mode forces the return path to the same address as is
35447 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35448 specified, the return path is also left unchanged.
35449
35450 &*Note*&: The changes caused by submission mode take effect after the predata
35451 ACL. This means that any sender checks performed before the fix-ups use the
35452 untrusted sender address specified by the user, not the trusted sender address
35453 specified by submission mode. Although this might be slightly unexpected, it
35454 does mean that you can configure ACL checks to spot that a user is trying to
35455 spoof another's address.
35456
35457 .section "Line endings" "SECTlineendings"
35458 .cindex "line endings"
35459 .cindex "carriage return"
35460 .cindex "linefeed"
35461 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35462 linefeed) is the line ending for messages transmitted over the Internet using
35463 SMTP over TCP/IP. However, within individual operating systems, different
35464 conventions are used. For example, Unix-like systems use just LF, but others
35465 use CRLF or just CR.
35466
35467 Exim was designed for Unix-like systems, and internally, it stores messages
35468 using the system's convention of a single LF as a line terminator. When
35469 receiving a message, all line endings are translated to this standard format.
35470 Originally, it was thought that programs that passed messages directly to an
35471 MTA within an operating system would use that system's convention. Experience
35472 has shown that this is not the case; for example, there are Unix applications
35473 that use CRLF in this circumstance. For this reason, and for compatibility with
35474 other MTAs, the way Exim handles line endings for all messages is now as
35475 follows:
35476
35477 .ilist
35478 LF not preceded by CR is treated as a line ending.
35479 .next
35480 CR is treated as a line ending; if it is immediately followed by LF, the LF
35481 is ignored.
35482 .next
35483 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35484 nor a local message in the state where a line containing only a dot is a
35485 terminator.
35486 .next
35487 If a bare CR is encountered within a header line, an extra space is added after
35488 the line terminator so as not to end the header line. The reasoning behind this
35489 is that bare CRs in header lines are most likely either to be mistakes, or
35490 people trying to play silly games.
35491 .next
35492 If the first header line received in a message ends with CRLF, a subsequent
35493 bare LF in a header line is treated in the same way as a bare CR in a header
35494 line.
35495 .endlist
35496
35497
35498
35499
35500
35501 .section "Unqualified addresses" "SECID218"
35502 .cindex "unqualified addresses"
35503 .cindex "address" "qualification"
35504 By default, Exim expects every envelope address it receives from an external
35505 host to be fully qualified. Unqualified addresses cause negative responses to
35506 SMTP commands. However, because SMTP is used as a means of transporting
35507 messages from MUAs running on personal workstations, there is sometimes a
35508 requirement to accept unqualified addresses from specific hosts or IP networks.
35509
35510 Exim has two options that separately control which hosts may send unqualified
35511 sender or recipient addresses in SMTP commands, namely
35512 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35513 cases, if an unqualified address is accepted, it is qualified by adding the
35514 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35515
35516 .oindex "&%qualify_domain%&"
35517 .oindex "&%qualify_recipient%&"
35518 Unqualified addresses in header lines are automatically qualified for messages
35519 that are locally originated, unless the &%-bnq%& option is given on the command
35520 line. For messages received over SMTP, unqualified addresses in header lines
35521 are qualified only if unqualified addresses are permitted in SMTP commands. In
35522 other words, such qualification is also controlled by
35523 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35524
35525
35526
35527
35528 .section "The UUCP From line" "SECID219"
35529 .cindex "&""From""& line"
35530 .cindex "UUCP" "&""From""& line"
35531 .cindex "sender" "address"
35532 .oindex "&%uucp_from_pattern%&"
35533 .oindex "&%uucp_from_sender%&"
35534 .cindex "envelope from"
35535 .cindex "envelope sender"
35536 .cindex "Sendmail compatibility" "&""From""& line"
35537 Messages that have come from UUCP (and some other applications) often begin
35538 with a line containing the envelope sender and a timestamp, following the word
35539 &"From"&. Examples of two common formats are:
35540 .code
35541 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35542 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35543 .endd
35544 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35545 Exim recognizes such lines at the start of messages that are submitted to it
35546 via the command line (that is, on the standard input). It does not recognize
35547 such lines in incoming SMTP messages, unless the sending host matches
35548 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35549 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35550 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35551 default value matches the two common cases shown above and puts the address
35552 that follows &"From"& into &$1$&.
35553
35554 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35555 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35556 a trusted user, the message's sender address is constructed by expanding the
35557 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35558 then parsed as an RFC 2822 address. If there is no domain, the local part is
35559 qualified with &%qualify_domain%& unless it is the empty string. However, if
35560 the command line &%-f%& option is used, it overrides the &"From"& line.
35561
35562 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35563 sender address is not changed. This is also the case for incoming SMTP messages
35564 that are permitted to contain &"From"& lines.
35565
35566 Only one &"From"& line is recognized. If there is more than one, the second is
35567 treated as a data line that starts the body of the message, as it is not valid
35568 as a header line. This also happens if a &"From"& line is present in an
35569 incoming SMTP message from a source that is not permitted to send them.
35570
35571
35572
35573 .section "Resent- header lines" "SECID220"
35574 .cindex "&%Resent-%& header lines"
35575 .cindex "header lines" "Resent-"
35576 RFC 2822 makes provision for sets of header lines starting with the string
35577 &`Resent-`& to be added to a message when it is resent by the original
35578 recipient to somebody else. These headers are &'Resent-Date:'&,
35579 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35580 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35581
35582 .blockquote
35583 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35584 processing of replies or other such automatic actions on messages.'&
35585 .endblockquote
35586
35587 This leaves things a bit vague as far as other processing actions such as
35588 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35589 follows:
35590
35591 .ilist
35592 A &'Resent-From:'& line that just contains the login id of the submitting user
35593 is automatically rewritten in the same way as &'From:'& (see below).
35594 .next
35595 If there's a rewriting rule for a particular header line, it is also applied to
35596 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35597 &'From:'& also rewrites &'Resent-From:'&.
35598 .next
35599 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35600 also removed.
35601 .next
35602 For a locally-submitted message,
35603 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35604 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35605 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35606 included in log lines in this case.
35607 .next
35608 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35609 &%Resent-%& header lines are present.
35610 .endlist
35611
35612
35613
35614
35615 .section "The Auto-Submitted: header line" "SECID221"
35616 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35617 includes the header line:
35618 .code
35619 Auto-Submitted: auto-replied
35620 .endd
35621
35622 .section "The Bcc: header line" "SECID222"
35623 .cindex "&'Bcc:'& header line"
35624 If Exim is called with the &%-t%& option, to take recipient addresses from a
35625 message's header, it removes any &'Bcc:'& header line that may exist (after
35626 extracting its addresses). If &%-t%& is not present on the command line, any
35627 existing &'Bcc:'& is not removed.
35628
35629
35630 .section "The Date: header line" "SECID223"
35631 .cindex "&'Date:'& header line"
35632 .cindex "header lines" "Date:"
35633 If a locally-generated or submission-mode message has no &'Date:'& header line,
35634 Exim adds one, using the current date and time, unless the
35635 &%suppress_local_fixups%& control has been specified.
35636
35637 .section "The Delivery-date: header line" "SECID224"
35638 .cindex "&'Delivery-date:'& header line"
35639 .oindex "&%delivery_date_remove%&"
35640 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35641 set. Exim can be configured to add them to the final delivery of messages. (See
35642 the generic &%delivery_date_add%& transport option.) They should not be present
35643 in messages in transit. If the &%delivery_date_remove%& configuration option is
35644 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35645 messages.
35646
35647
35648 .section "The Envelope-to: header line" "SECID225"
35649 .cindex "&'Envelope-to:'& header line"
35650 .cindex "header lines" "Envelope-to:"
35651 .oindex "&%envelope_to_remove%&"
35652 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35653 Exim can be configured to add them to the final delivery of messages. (See the
35654 generic &%envelope_to_add%& transport option.) They should not be present in
35655 messages in transit. If the &%envelope_to_remove%& configuration option is set
35656 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35657 messages.
35658
35659
35660 .section "The From: header line" "SECTthefrohea"
35661 .cindex "&'From:'& header line"
35662 .cindex "header lines" "From:"
35663 .cindex "Sendmail compatibility" "&""From""& line"
35664 .cindex "message" "submission"
35665 .cindex "submission mode"
35666 If a submission-mode message does not contain a &'From:'& header line, Exim
35667 adds one if either of the following conditions is true:
35668
35669 .ilist
35670 The envelope sender address is not empty (that is, this is not a bounce
35671 message). The added header line copies the envelope sender address.
35672 .next
35673 .vindex "&$authenticated_id$&"
35674 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35675 .olist
35676 .vindex "&$qualify_domain$&"
35677 If no domain is specified by the submission control, the local part is
35678 &$authenticated_id$& and the domain is &$qualify_domain$&.
35679 .next
35680 If a non-empty domain is specified by the submission control, the local
35681 part is &$authenticated_id$&, and the domain is the specified domain.
35682 .next
35683 If an empty domain is specified by the submission control,
35684 &$authenticated_id$& is assumed to be the complete address.
35685 .endlist
35686 .endlist
35687
35688 A non-empty envelope sender takes precedence.
35689
35690 If a locally-generated incoming message does not contain a &'From:'& header
35691 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35692 containing the sender's address. The calling user's login name and full name
35693 are used to construct the address, as described in section &<<SECTconstr>>&.
35694 They are obtained from the password data by calling &[getpwuid()]& (but see the
35695 &%unknown_login%& configuration option). The address is qualified with
35696 &%qualify_domain%&.
35697
35698 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35699 &'From:'& header line containing just the unqualified login name of the calling
35700 user, this is replaced by an address containing the user's login name and full
35701 name as described in section &<<SECTconstr>>&.
35702
35703
35704 .section "The Message-ID: header line" "SECID226"
35705 .cindex "&'Message-ID:'& header line"
35706 .cindex "header lines" "Message-ID:"
35707 .cindex "message" "submission"
35708 .oindex "&%message_id_header_text%&"
35709 If a locally-generated or submission-mode incoming message does not contain a
35710 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35711 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35712 to the message. If there are any &'Resent-:'& headers in the message, it
35713 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35714 message id, preceded by the letter E to ensure it starts with a letter, and
35715 followed by @ and the primary host name. Additional information can be included
35716 in this header line by setting the &%message_id_header_text%& and/or
35717 &%message_id_header_domain%& options.
35718
35719
35720 .section "The Received: header line" "SECID227"
35721 .cindex "&'Received:'& header line"
35722 .cindex "header lines" "Received:"
35723 A &'Received:'& header line is added at the start of every message. The
35724 contents are defined by the &%received_header_text%& configuration option, and
35725 Exim automatically adds a semicolon and a timestamp to the configured string.
35726
35727 The &'Received:'& header is generated as soon as the message's header lines
35728 have been received. At this stage, the timestamp in the &'Received:'& header
35729 line is the time that the message started to be received. This is the value
35730 that is seen by the DATA ACL and by the &[local_scan()]& function.
35731
35732 Once a message is accepted, the timestamp in the &'Received:'& header line is
35733 changed to the time of acceptance, which is (apart from a small delay while the
35734 -H spool file is written) the earliest time at which delivery could start.
35735
35736
35737 .section "The References: header line" "SECID228"
35738 .cindex "&'References:'& header line"
35739 .cindex "header lines" "References:"
35740 Messages created by the &(autoreply)& transport include a &'References:'&
35741 header line. This is constructed according to the rules that are described in
35742 section 3.64 of RFC 2822 (which states that replies should contain such a
35743 header line), and section 3.14 of RFC 3834 (which states that automatic
35744 responses are not different in this respect). However, because some mail
35745 processing software does not cope well with very long header lines, no more
35746 than 12 message IDs are copied from the &'References:'& header line in the
35747 incoming message. If there are more than 12, the first one and then the final
35748 11 are copied, before adding the message ID of the incoming message.
35749
35750
35751
35752 .section "The Return-path: header line" "SECID229"
35753 .cindex "&'Return-path:'& header line"
35754 .cindex "header lines" "Return-path:"
35755 .oindex "&%return_path_remove%&"
35756 &'Return-path:'& header lines are defined as something an MTA may insert when
35757 it does the final delivery of messages. (See the generic &%return_path_add%&
35758 transport option.) Therefore, they should not be present in messages in
35759 transit. If the &%return_path_remove%& configuration option is set (the
35760 default), Exim removes &'Return-path:'& header lines from incoming messages.
35761
35762
35763
35764 .section "The Sender: header line" "SECTthesenhea"
35765 .cindex "&'Sender:'& header line"
35766 .cindex "message" "submission"
35767 .cindex "header lines" "Sender:"
35768 For a locally-originated message from an untrusted user, Exim may remove an
35769 existing &'Sender:'& header line, and it may add a new one. You can modify
35770 these actions by setting the &%local_sender_retain%& option true, the
35771 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35772 control setting.
35773
35774 When a local message is received from an untrusted user and
35775 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35776 control has not been set, a check is made to see if the address given in the
35777 &'From:'& header line is the correct (local) sender of the message. The address
35778 that is expected has the login name as the local part and the value of
35779 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35780 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35781 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35782 line is added to the message.
35783
35784 If you set &%local_from_check%& false, this checking does not occur. However,
35785 the removal of an existing &'Sender:'& line still happens, unless you also set
35786 &%local_sender_retain%& to be true. It is not possible to set both of these
35787 options true at the same time.
35788
35789 .cindex "submission mode"
35790 By default, no processing of &'Sender:'& header lines is done for messages
35791 received over TCP/IP or for messages submitted by trusted users. However, when
35792 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35793 not specified on the submission control, the following processing takes place:
35794
35795 .vindex "&$authenticated_id$&"
35796 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35797 authenticated, and &$authenticated_id$& is not empty, a sender address is
35798 created as follows:
35799
35800 .ilist
35801 .vindex "&$qualify_domain$&"
35802 If no domain is specified by the submission control, the local part is
35803 &$authenticated_id$& and the domain is &$qualify_domain$&.
35804 .next
35805 If a non-empty domain is specified by the submission control, the local part
35806 is &$authenticated_id$&, and the domain is the specified domain.
35807 .next
35808 If an empty domain is specified by the submission control,
35809 &$authenticated_id$& is assumed to be the complete address.
35810 .endlist
35811
35812 This address is compared with the address in the &'From:'& header line. If they
35813 are different, a &'Sender:'& header line containing the created address is
35814 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35815 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35816
35817 .cindex "return path" "created from &'Sender:'&"
35818 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35819 the message (the envelope sender address) is changed to be the same address,
35820 except in the case of submission mode when &%sender_retain%& is specified.
35821
35822
35823
35824 .section "Adding and removing header lines in routers and transports" &&&
35825          "SECTheadersaddrem"
35826 .cindex "header lines" "adding; in router or transport"
35827 .cindex "header lines" "removing; in router or transport"
35828 When a message is delivered, the addition and removal of header lines can be
35829 specified in a system filter, or on any of the routers and transports that
35830 process the message. Section &<<SECTaddremheasys>>& contains details about
35831 modifying headers in a system filter. Header lines can also be added in an ACL
35832 as a message is received (see section &<<SECTaddheadacl>>&).
35833
35834 In contrast to what happens in a system filter, header modifications that are
35835 specified on routers and transports apply only to the particular recipient
35836 addresses that are being processed by those routers and transports. These
35837 changes do not actually take place until a copy of the message is being
35838 transported. Therefore, they do not affect the basic set of header lines, and
35839 they do not affect the values of the variables that refer to header lines.
35840
35841 &*Note*&: In particular, this means that any expansions in the configuration of
35842 the transport cannot refer to the modified header lines, because such
35843 expansions all occur before the message is actually transported.
35844
35845 For both routers and transports, the argument of a &%headers_add%&
35846 option must be in the form of one or more RFC 2822 header lines, separated by
35847 newlines (coded as &"\n"&). For example:
35848 .code
35849 headers_add = X-added-header: added by $primary_hostname\n\
35850               X-added-second: another added header line
35851 .endd
35852 Exim does not check the syntax of these added header lines.
35853
35854 Multiple &%headers_add%& options for a single router or transport can be
35855 specified; the values will append to a single list of header lines.
35856 Each header-line is separately expanded.
35857
35858 The argument of a &%headers_remove%& option must consist of a colon-separated
35859 list of header names. This is confusing, because header names themselves are
35860 often terminated by colons. In this case, the colons are the list separators,
35861 not part of the names. For example:
35862 .code
35863 headers_remove = return-receipt-to:acknowledge-to
35864 .endd
35865
35866 Multiple &%headers_remove%& options for a single router or transport can be
35867 specified; the arguments will append to a single header-names list.
35868 Each item is separately expanded.
35869 Note that colons in complex expansions which are used to
35870 form all or part of a &%headers_remove%& list
35871 will act as list separators.
35872
35873 When &%headers_add%& or &%headers_remove%& is specified on a router,
35874 items are expanded at routing time,
35875 and then associated with all addresses that are
35876 accepted by that router, and also with any new addresses that it generates. If
35877 an address passes through several routers as a result of aliasing or
35878 forwarding, the changes are cumulative.
35879
35880 .oindex "&%unseen%&"
35881 However, this does not apply to multiple routers that result from the use of
35882 the &%unseen%& option. Any header modifications that were specified by the
35883 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35884
35885 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35886 settings cannot be delivered together in a batch, so a transport is always
35887 dealing with a set of addresses that have the same header-processing
35888 requirements.
35889
35890 The transport starts by writing the original set of header lines that arrived
35891 with the message, possibly modified by the system filter. As it writes out
35892 these lines, it consults the list of header names that were attached to the
35893 recipient address(es) by &%headers_remove%& options in routers, and it also
35894 consults the transport's own &%headers_remove%& option. Header lines whose
35895 names are on either of these lists are not written out. If there are multiple
35896 instances of any listed header, they are all skipped.
35897
35898 After the remaining original header lines have been written, new header
35899 lines that were specified by routers' &%headers_add%& options are written, in
35900 the order in which they were attached to the address. These are followed by any
35901 header lines specified by the transport's &%headers_add%& option.
35902
35903 This way of handling header line modifications in routers and transports has
35904 the following consequences:
35905
35906 .ilist
35907 The original set of header lines, possibly modified by the system filter,
35908 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35909 to it, at all times.
35910 .next
35911 Header lines that are added by a router's
35912 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35913 expansion syntax in subsequent routers or the transport.
35914 .next
35915 Conversely, header lines that are specified for removal by &%headers_remove%&
35916 in a router remain visible to subsequent routers and the transport.
35917 .next
35918 Headers added to an address by &%headers_add%& in a router cannot be removed by
35919 a later router or by a transport.
35920 .next
35921 An added header can refer to the contents of an original header that is to be
35922 removed, even it has the same name as the added header. For example:
35923 .code
35924 headers_remove = subject
35925 headers_add = Subject: new subject (was: $h_subject:)
35926 .endd
35927 .endlist
35928
35929 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35930 for a &(redirect)& router that has the &%one_time%& option set.
35931
35932
35933
35934
35935
35936 .section "Constructed addresses" "SECTconstr"
35937 .cindex "address" "constructed"
35938 .cindex "constructed address"
35939 When Exim constructs a sender address for a locally-generated message, it uses
35940 the form
35941 .display
35942 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35943 .endd
35944 For example:
35945 .code
35946 Zaphod Beeblebrox <zaphod@end.univ.example>
35947 .endd
35948 The user name is obtained from the &%-F%& command line option if set, or
35949 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35950 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35951 ampersand character, this is replaced by the login name with the first letter
35952 upper cased, as is conventional in a number of operating systems. See the
35953 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35954 The &%unknown_username%& option can be used to specify user names in cases when
35955 there is no password file entry.
35956
35957 .cindex "RFC 2047"
35958 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35959 parts of it if necessary. In addition, if it contains any non-printing
35960 characters, it is encoded as described in RFC 2047, which defines a way of
35961 including non-ASCII characters in header lines. The value of the
35962 &%headers_charset%& option specifies the name of the encoding that is used (the
35963 characters are assumed to be in this encoding). The setting of
35964 &%print_topbitchars%& controls whether characters with the top bit set (that
35965 is, with codes greater than 127) count as printing characters or not.
35966
35967
35968
35969 .section "Case of local parts" "SECID230"
35970 .cindex "case of local parts"
35971 .cindex "local part" "case of"
35972 RFC 2822 states that the case of letters in the local parts of addresses cannot
35973 be assumed to be non-significant. Exim preserves the case of local parts of
35974 addresses, but by default it uses a lower-cased form when it is routing,
35975 because on most Unix systems, usernames are in lower case and case-insensitive
35976 routing is required. However, any particular router can be made to use the
35977 original case for local parts by setting the &%caseful_local_part%& generic
35978 router option.
35979
35980 .cindex "mixed-case login names"
35981 If you must have mixed-case user names on your system, the best way to proceed,
35982 assuming you want case-independent handling of incoming email, is to set up
35983 your first router to convert incoming local parts in your domains to the
35984 correct case by means of a file lookup. For example:
35985 .code
35986 correct_case:
35987   driver = redirect
35988   domains = +local_domains
35989   data = ${lookup{$local_part}cdb\
35990               {/etc/usercased.cdb}{$value}fail}\
35991               @$domain
35992 .endd
35993 For this router, the local part is forced to lower case by the default action
35994 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35995 up a new local part in the correct case. If you then set &%caseful_local_part%&
35996 on any subsequent routers which process your domains, they will operate on
35997 local parts with the correct case in a case-sensitive manner.
35998
35999
36000
36001 .section "Dots in local parts" "SECID231"
36002 .cindex "dot" "in local part"
36003 .cindex "local part" "dots in"
36004 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36005 part may not begin or end with a dot, nor have two consecutive dots in the
36006 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36007 empty components for compatibility.
36008
36009
36010
36011 .section "Rewriting addresses" "SECID232"
36012 .cindex "rewriting" "addresses"
36013 Rewriting of sender and recipient addresses, and addresses in headers, can
36014 happen automatically, or as the result of configuration options, as described
36015 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36016 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36017
36018 Automatic rewriting includes qualification, as mentioned above. The other case
36019 in which it can happen is when an incomplete non-local domain is given. The
36020 routing process may cause this to be expanded into the full domain name. For
36021 example, a header such as
36022 .code
36023 To: hare@teaparty
36024 .endd
36025 might get rewritten as
36026 .code
36027 To: hare@teaparty.wonderland.fict.example
36028 .endd
36029 Rewriting as a result of routing is the one kind of message processing that
36030 does not happen at input time, as it cannot be done until the address has
36031 been routed.
36032
36033 Strictly, one should not do &'any'& deliveries of a message until all its
36034 addresses have been routed, in case any of the headers get changed as a
36035 result of routing. However, doing this in practice would hold up many
36036 deliveries for unreasonable amounts of time, just because one address could not
36037 immediately be routed. Exim therefore does not delay other deliveries when
36038 routing of one or more addresses is deferred.
36039 .ecindex IIDmesproc
36040
36041
36042
36043 . ////////////////////////////////////////////////////////////////////////////
36044 . ////////////////////////////////////////////////////////////////////////////
36045
36046 .chapter "SMTP processing" "CHAPSMTP"
36047 .scindex IIDsmtpproc1 "SMTP" "processing details"
36048 .scindex IIDsmtpproc2 "LMTP" "processing details"
36049 Exim supports a number of different ways of using the SMTP protocol, and its
36050 LMTP variant, which is an interactive protocol for transferring messages into a
36051 closed mail store application. This chapter contains details of how SMTP is
36052 processed. For incoming mail, the following are available:
36053
36054 .ilist
36055 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36056 .next
36057 SMTP over the standard input and output (the &%-bs%& option);
36058 .next
36059 Batched SMTP on the standard input (the &%-bS%& option).
36060 .endlist
36061
36062 For mail delivery, the following are available:
36063
36064 .ilist
36065 SMTP over TCP/IP (the &(smtp)& transport);
36066 .next
36067 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36068 &"lmtp"&);
36069 .next
36070 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36071 transport);
36072 .next
36073 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36074 the &%use_bsmtp%& option set).
36075 .endlist
36076
36077 &'Batched SMTP'& is the name for a process in which batches of messages are
36078 stored in or read from files (or pipes), in a format in which SMTP commands are
36079 used to contain the envelope information.
36080
36081
36082
36083 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36084 .cindex "SMTP" "outgoing over TCP/IP"
36085 .cindex "outgoing SMTP over TCP/IP"
36086 .cindex "LMTP" "over TCP/IP"
36087 .cindex "outgoing LMTP over TCP/IP"
36088 .cindex "EHLO"
36089 .cindex "HELO"
36090 .cindex "SIZE" "option on MAIL command"
36091 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36092 The &%protocol%& option selects which protocol is to be used, but the actual
36093 processing is the same in both cases.
36094
36095 .cindex "ESMTP extensions" SIZE
36096 If, in response to its EHLO command, Exim is told that the SIZE
36097 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36098 command. The value of <&'n'&> is the message size plus the value of the
36099 &%size_addition%& option (default 1024) to allow for additions to the message
36100 such as per-transport header lines, or changes made in a
36101 .cindex "transport" "filter"
36102 .cindex "filter" "transport filter"
36103 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36104 suppressed.
36105
36106 If the remote server advertises support for PIPELINING, Exim uses the
36107 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36108 required for the transaction.
36109
36110 If the remote server advertises support for the STARTTLS command, and Exim
36111 was built to support TLS encryption, it tries to start a TLS session unless the
36112 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36113 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36114 is called for verification.
36115
36116 If the remote server advertises support for the AUTH command, Exim scans
36117 the authenticators configuration for any suitable client settings, as described
36118 in chapter &<<CHAPSMTPAUTH>>&.
36119
36120 .cindex "carriage return"
36121 .cindex "linefeed"
36122 Responses from the remote host are supposed to be terminated by CR followed by
36123 LF. However, there are known to be hosts that do not send CR characters, so in
36124 order to be able to interwork with such hosts, Exim treats LF on its own as a
36125 line terminator.
36126
36127 If a message contains a number of different addresses, all those with the same
36128 characteristics (for example, the same envelope sender) that resolve to the
36129 same set of hosts, in the same order, are sent in a single SMTP transaction,
36130 even if they are for different domains, unless there are more than the setting
36131 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36132 they are split into groups containing no more than &%max_rcpt%&s addresses
36133 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36134 in parallel sessions. The order of hosts with identical MX values is not
36135 significant when checking whether addresses can be batched in this way.
36136
36137 When the &(smtp)& transport suffers a temporary failure that is not
36138 message-related, Exim updates its transport-specific database, which contains
36139 records indexed by host name that remember which messages are waiting for each
36140 particular host. It also updates the retry database with new retry times.
36141
36142 .cindex "hints database" "retry keys"
36143 Exim's retry hints are based on host name plus IP address, so if one address of
36144 a multi-homed host is broken, it will soon be skipped most of the time.
36145 See the next section for more detail about error handling.
36146
36147 .cindex "SMTP" "passed connection"
36148 .cindex "SMTP" "batching over TCP/IP"
36149 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36150 looks in the hints database for the transport to see if there are any queued
36151 messages waiting for the host to which it is connected. If it finds one, it
36152 creates a new Exim process using the &%-MC%& option (which can only be used by
36153 a process running as root or the Exim user) and passes the TCP/IP socket to it
36154 so that it can deliver another message using the same socket. The new process
36155 does only those deliveries that are routed to the connected host, and may in
36156 turn pass the socket on to a third process, and so on.
36157
36158 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36159 limit the number of messages sent down a single TCP/IP connection.
36160
36161 .cindex "asterisk" "after IP address"
36162 The second and subsequent messages delivered down an existing connection are
36163 identified in the main log by the addition of an asterisk after the closing
36164 square bracket of the IP address.
36165
36166
36167
36168
36169 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36170 .cindex "error" "in outgoing SMTP"
36171 .cindex "SMTP" "errors in outgoing"
36172 .cindex "host" "error"
36173 Three different kinds of error are recognized for outgoing SMTP: host errors,
36174 message errors, and recipient errors.
36175
36176 .vlist
36177 .vitem "&*Host errors*&"
36178 A host error is not associated with a particular message or with a
36179 particular recipient of a message. The host errors are:
36180
36181 .ilist
36182 Connection refused or timed out,
36183 .next
36184 Any error response code on connection,
36185 .next
36186 Any error response code to EHLO or HELO,
36187 .next
36188 Loss of connection at any time, except after &"."&,
36189 .next
36190 I/O errors at any time,
36191 .next
36192 Timeouts during the session, other than in response to MAIL, RCPT or
36193 the &"."& at the end of the data.
36194 .endlist ilist
36195
36196 For a host error, a permanent error response on connection, or in response to
36197 EHLO, causes all addresses routed to the host to be failed. Any other host
36198 error causes all addresses to be deferred, and retry data to be created for the
36199 host. It is not tried again, for any message, until its retry time arrives. If
36200 the current set of addresses are not all delivered in this run (to some
36201 alternative host), the message is added to the list of those waiting for this
36202 host, so if it is still undelivered when a subsequent successful delivery is
36203 made to the host, it will be sent down the same SMTP connection.
36204
36205 .vitem "&*Message errors*&"
36206 .cindex "message" "error"
36207 A message error is associated with a particular message when sent to a
36208 particular host, but not with a particular recipient of the message. The
36209 message errors are:
36210
36211 .ilist
36212 Any error response code to MAIL, DATA, or the &"."& that terminates
36213 the data,
36214 .next
36215 Timeout after MAIL,
36216 .next
36217 Timeout or loss of connection after the &"."& that terminates the data. A
36218 timeout after the DATA command itself is treated as a host error, as is loss of
36219 connection at any other time.
36220 .endlist ilist
36221
36222 For a message error, a permanent error response (5&'xx'&) causes all addresses
36223 to be failed, and a delivery error report to be returned to the sender. A
36224 temporary error response (4&'xx'&), or one of the timeouts, causes all
36225 addresses to be deferred. Retry data is not created for the host, but instead,
36226 a retry record for the combination of host plus message id is created. The
36227 message is not added to the list of those waiting for this host. This ensures
36228 that the failing message will not be sent to this host again until the retry
36229 time arrives. However, other messages that are routed to the host are not
36230 affected, so if it is some property of the message that is causing the error,
36231 it will not stop the delivery of other mail.
36232
36233 If the remote host specified support for the SIZE parameter in its response
36234 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36235 over-large message will cause a message error because the error arrives as a
36236 response to MAIL.
36237
36238 .vitem "&*Recipient errors*&"
36239 .cindex "recipient" "error"
36240 A recipient error is associated with a particular recipient of a message. The
36241 recipient errors are:
36242
36243 .ilist
36244 Any error response to RCPT,
36245 .next
36246 Timeout after RCPT.
36247 .endlist
36248
36249 For a recipient error, a permanent error response (5&'xx'&) causes the
36250 recipient address to be failed, and a bounce message to be returned to the
36251 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36252 address to be deferred, and routing retry data to be created for it. This is
36253 used to delay processing of the address in subsequent queue runs, until its
36254 routing retry time arrives. This applies to all messages, but because it
36255 operates only in queue runs, one attempt will be made to deliver a new message
36256 to the failing address before the delay starts to operate. This ensures that,
36257 if the failure is really related to the message rather than the recipient
36258 (&"message too big for this recipient"& is a possible example), other messages
36259 have a chance of getting delivered. If a delivery to the address does succeed,
36260 the retry information gets cleared, so all stuck messages get tried again, and
36261 the retry clock is reset.
36262
36263 The message is not added to the list of those waiting for this host. Use of the
36264 host for other messages is unaffected, and except in the case of a timeout,
36265 other recipients are processed independently, and may be successfully delivered
36266 in the current SMTP session. After a timeout it is of course impossible to
36267 proceed with the session, so all addresses get deferred. However, those other
36268 than the one that failed do not suffer any subsequent retry delays. Therefore,
36269 if one recipient is causing trouble, the others have a chance of getting
36270 through when a subsequent delivery attempt occurs before the failing
36271 recipient's retry time.
36272 .endlist
36273
36274 In all cases, if there are other hosts (or IP addresses) available for the
36275 current set of addresses (for example, from multiple MX records), they are
36276 tried in this run for any undelivered addresses, subject of course to their
36277 own retry data. In other words, recipient error retry data does not take effect
36278 until the next delivery attempt.
36279
36280 Some hosts have been observed to give temporary error responses to every
36281 MAIL command at certain times (&"insufficient space"& has been seen). It
36282 would be nice if such circumstances could be recognized, and defer data for the
36283 host itself created, but this is not possible within the current Exim design.
36284 What actually happens is that retry data for every (host, message) combination
36285 is created.
36286
36287 The reason that timeouts after MAIL and RCPT are treated specially is that
36288 these can sometimes arise as a result of the remote host's verification
36289 procedures. Exim makes this assumption, and treats them as if a temporary error
36290 response had been received. A timeout after &"."& is treated specially because
36291 it is known that some broken implementations fail to recognize the end of the
36292 message if the last character of the last line is a binary zero. Thus, it is
36293 helpful to treat this case as a message error.
36294
36295 Timeouts at other times are treated as host errors, assuming a problem with the
36296 host, or the connection to it. If a timeout after MAIL, RCPT,
36297 or &"."& is really a connection problem, the assumption is that at the next try
36298 the timeout is likely to occur at some other point in the dialogue, causing it
36299 then to be treated as a host error.
36300
36301 There is experimental evidence that some MTAs drop the connection after the
36302 terminating &"."& if they do not like the contents of the message for some
36303 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36304 should be given. That is why Exim treats this case as a message rather than a
36305 host error, in order not to delay other messages to the same host.
36306
36307
36308
36309
36310 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36311 .cindex "SMTP" "incoming over TCP/IP"
36312 .cindex "incoming SMTP over TCP/IP"
36313 .cindex "inetd"
36314 .cindex "daemon"
36315 Incoming SMTP messages can be accepted in one of two ways: by running a
36316 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36317 &_/etc/inetd.conf_& should be like this:
36318 .code
36319 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36320 .endd
36321 Exim distinguishes between this case and the case of a locally running user
36322 agent using the &%-bs%& option by checking whether or not the standard input is
36323 a socket. When it is, either the port must be privileged (less than 1024), or
36324 the caller must be root or the Exim user. If any other user passes a socket
36325 with an unprivileged port number, Exim prints a message on the standard error
36326 stream and exits with an error code.
36327
36328 By default, Exim does not make a log entry when a remote host connects or
36329 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36330 unexpected. It can be made to write such log entries by setting the
36331 &%smtp_connection%& log selector.
36332
36333 .cindex "carriage return"
36334 .cindex "linefeed"
36335 Commands from the remote host are supposed to be terminated by CR followed by
36336 LF. However, there are known to be hosts that do not send CR characters. In
36337 order to be able to interwork with such hosts, Exim treats LF on its own as a
36338 line terminator.
36339 Furthermore, because common code is used for receiving messages from all
36340 sources, a CR on its own is also interpreted as a line terminator. However, the
36341 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36342
36343 .cindex "EHLO" "invalid data"
36344 .cindex "HELO" "invalid data"
36345 One area that sometimes gives rise to problems concerns the EHLO or
36346 HELO commands. Some clients send syntactically invalid versions of these
36347 commands, which Exim rejects by default. (This is nothing to do with verifying
36348 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36349 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36350 match the broken hosts that send invalid commands.
36351
36352 .cindex "SIZE option on MAIL command"
36353 .cindex "MAIL" "SIZE option"
36354 The amount of disk space available is checked whenever SIZE is received on
36355 a MAIL command, independently of whether &%message_size_limit%& or
36356 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36357 false. A temporary error is given if there is not enough space. If
36358 &%check_spool_space%& is set, the check is for that amount of space plus the
36359 value given with SIZE, that is, it checks that the addition of the incoming
36360 message will not reduce the space below the threshold.
36361
36362 When a message is successfully received, Exim includes the local message id in
36363 its response to the final &"."& that terminates the data. If the remote host
36364 logs this text it can help with tracing what has happened to a message.
36365
36366 The Exim daemon can limit the number of simultaneous incoming connections it is
36367 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36368 number of simultaneous incoming connections from a single remote host (see the
36369 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36370 rejected using the SMTP temporary error code 421.
36371
36372 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36373 subprocess has finished, as this can get lost at busy times. Instead, it looks
36374 for completed subprocesses every time it wakes up. Provided there are other
36375 things happening (new incoming calls, starts of queue runs), completed
36376 processes will be noticed and tidied away. On very quiet systems you may
36377 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36378 it will be noticed when the daemon next wakes up.
36379
36380 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36381 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36382 high system load &-- for details see the &%smtp_accept_reserve%&,
36383 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36384 applies in both the daemon and &'inetd'& cases.
36385
36386 Exim normally starts a delivery process for each message received, though this
36387 can be varied by means of the &%-odq%& command line option and the
36388 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36389 number of simultaneously running delivery processes started in this way from
36390 SMTP input can be limited by the &%smtp_accept_queue%& and
36391 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36392 subsequently received messages are just put on the input queue without starting
36393 a delivery process.
36394
36395 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36396 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36397 started up from the &'inetd'& daemon, because in that case each connection is
36398 handled by an entirely independent Exim process. Control by load average is,
36399 however, available with &'inetd'&.
36400
36401 Exim can be configured to verify addresses in incoming SMTP commands as they
36402 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36403 to rewrite addresses at this time &-- before any syntax checking is done. See
36404 section &<<SECTrewriteS>>&.
36405
36406 Exim can also be configured to limit the rate at which a client host submits
36407 MAIL and RCPT commands in a single SMTP session. See the
36408 &%smtp_ratelimit_hosts%& option.
36409
36410
36411
36412 .section "Unrecognized SMTP commands" "SECID234"
36413 .cindex "SMTP" "unrecognized commands"
36414 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36415 commands during a single SMTP connection, it drops the connection after sending
36416 the error response to the last command. The default value for
36417 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36418 abuse that subvert web servers into making connections to SMTP ports; in these
36419 circumstances, a number of non-SMTP lines are sent first.
36420
36421
36422 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36423 .cindex "SMTP" "syntax errors"
36424 .cindex "SMTP" "protocol errors"
36425 A syntax error is detected if an SMTP command is recognized, but there is
36426 something syntactically wrong with its data, for example, a malformed email
36427 address in a RCPT command. Protocol errors include invalid command
36428 sequencing such as RCPT before MAIL. If Exim receives more than
36429 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36430 drops the connection after sending the error response to the last command. The
36431 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36432 broken clients that loop sending bad commands (yes, it has been seen).
36433
36434
36435
36436 .section "Use of non-mail SMTP commands" "SECID236"
36437 .cindex "SMTP" "non-mail commands"
36438 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36439 DATA. Exim counts such commands, and drops the connection if there are too
36440 many of them in a single SMTP session. This action catches some
36441 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36442 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36443 defines what &"too many"& means. Its default value is 10.
36444
36445 When a new message is expected, one occurrence of RSET is not counted. This
36446 allows a client to send one RSET between messages (this is not necessary,
36447 but some clients do it). Exim also allows one uncounted occurrence of HELO
36448 or EHLO, and one occurrence of STARTTLS between messages. After
36449 starting up a TLS session, another EHLO is expected, and so it too is not
36450 counted.
36451
36452 The first occurrence of AUTH in a connection, or immediately following
36453 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36454 RCPT, DATA, and QUIT are counted.
36455
36456 You can control which hosts are subject to the limit set by
36457 &%smtp_accept_max_nonmail%& by setting
36458 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36459 the limit apply to all hosts. This option means that you can exclude any
36460 specific badly-behaved hosts that you have to live with.
36461
36462
36463
36464
36465 .section "The VRFY and EXPN commands" "SECID237"
36466 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36467 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36468 appropriate) in order to decide whether the command should be accepted or not.
36469
36470 .cindex "VRFY" "processing"
36471 When no ACL is defined for VRFY, or if it rejects without
36472 setting an explicit response code, the command is accepted
36473 (with a 252 SMTP response code)
36474 in order to support awkward clients that do a VRFY before every RCPT.
36475 When VRFY is accepted, it runs exactly the same code as when Exim is
36476 called with the &%-bv%& option, and returns 250/451/550
36477 SMTP response codes.
36478
36479 .cindex "EXPN" "processing"
36480 If no ACL for EXPN is defined, the command is rejected.
36481 When EXPN is accepted, a single-level expansion of the address is done.
36482 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36483 than a verification (the &%-bv%& option). If an unqualified local part is given
36484 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36485 of VRFY and EXPN commands are logged on the main and reject logs, and
36486 VRFY verification failures are logged on the main log for consistency with
36487 RCPT failures.
36488
36489
36490
36491 .section "The ETRN command" "SECTETRN"
36492 .cindex "ETRN" "processing"
36493 .cindex "ESMTP extensions" ETRN
36494 RFC 1985 describes an ESMTP command called ETRN that is designed to
36495 overcome the security problems of the TURN command (which has fallen into
36496 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36497 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36498 should be accepted or not. If no ACL is defined, the command is rejected.
36499
36500 The ETRN command is concerned with &"releasing"& messages that are awaiting
36501 delivery to certain hosts. As Exim does not organize its message queue by host,
36502 the only form of ETRN that is supported by default is the one where the
36503 text starts with the &"#"& prefix, in which case the remainder of the text is
36504 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36505 the &%-R%& option to happen, with the remainder of the ETRN text as its
36506 argument. For example,
36507 .code
36508 ETRN #brigadoon
36509 .endd
36510 runs the command
36511 .code
36512 exim -R brigadoon
36513 .endd
36514 which causes a delivery attempt on all messages with undelivered addresses
36515 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36516 default), Exim prevents the simultaneous execution of more than one queue run
36517 for the same argument string as a result of an ETRN command. This stops
36518 a misbehaving client from starting more than one queue runner at once.
36519
36520 .cindex "hints database" "ETRN serialization"
36521 Exim implements the serialization by means of a hints database in which a
36522 record is written whenever a process is started by ETRN, and deleted when
36523 the process completes. However, Exim does not keep the SMTP session waiting for
36524 the ETRN process to complete. Once ETRN is accepted, the client is sent
36525 a &"success"& return code. Obviously there is scope for hints records to get
36526 left lying around if there is a system or program crash. To guard against this,
36527 Exim ignores any records that are more than six hours old.
36528
36529 .oindex "&%smtp_etrn_command%&"
36530 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36531 used. This specifies a command that is run whenever ETRN is received,
36532 whatever the form of its argument. For
36533 example:
36534 .code
36535 smtp_etrn_command = /etc/etrn_command $domain \
36536                     $sender_host_address
36537 .endd
36538 .vindex "&$domain$&"
36539 The string is split up into arguments which are independently expanded. The
36540 expansion variable &$domain$& is set to the argument of the ETRN command,
36541 and no syntax checking is done on the contents of this argument. Exim does not
36542 wait for the command to complete, so its status code is not checked. Exim runs
36543 under its own uid and gid when receiving incoming SMTP, so it is not possible
36544 for it to change them before running the command.
36545
36546
36547
36548 .section "Incoming local SMTP" "SECID238"
36549 .cindex "SMTP" "local incoming"
36550 Some user agents use SMTP to pass messages to their local MTA using the
36551 standard input and output, as opposed to passing the envelope on the command
36552 line and writing the message to the standard input. This is supported by the
36553 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36554 messages over TCP/IP (including the use of ACLs), except that the envelope
36555 sender given in a MAIL command is ignored unless the caller is trusted. In
36556 an ACL you can detect this form of SMTP input by testing for an empty host
36557 identification. It is common to have this as the first line in the ACL that
36558 runs for RCPT commands:
36559 .code
36560 accept hosts = :
36561 .endd
36562 This accepts SMTP messages from local processes without doing any other tests.
36563
36564
36565
36566 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36567 .cindex "SMTP" "batched outgoing"
36568 .cindex "batched SMTP output"
36569 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36570 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36571 be output in BSMTP format. No SMTP responses are possible for this form of
36572 delivery. All it is doing is using SMTP commands as a way of transmitting the
36573 envelope along with the message.
36574
36575 The message is written to the file or pipe preceded by the SMTP commands
36576 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36577 the message that start with a dot have an extra dot added. The SMTP command
36578 HELO is not normally used. If it is required, the &%message_prefix%& option
36579 can be used to specify it.
36580
36581 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36582 one recipient address at a time by default. However, you can arrange for them
36583 to handle several addresses at once by setting the &%batch_max%& option. When
36584 this is done for BSMTP, messages may contain multiple RCPT commands. See
36585 chapter &<<CHAPbatching>>& for more details.
36586
36587 .vindex "&$host$&"
36588 When one or more addresses are routed to a BSMTP transport by a router that
36589 sets up a host list, the name of the first host on the list is available to the
36590 transport in the variable &$host$&. Here is an example of such a transport and
36591 router:
36592 .code
36593 begin routers
36594 route_append:
36595   driver = manualroute
36596   transport = smtp_appendfile
36597   route_list = domain.example  batch.host.example
36598
36599 begin transports
36600 smtp_appendfile:
36601   driver = appendfile
36602   directory = /var/bsmtp/$host
36603   batch_max = 1000
36604   use_bsmtp
36605   user = exim
36606 .endd
36607 This causes messages addressed to &'domain.example'& to be written in BSMTP
36608 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36609 message (unless there are more than 1000 recipients).
36610
36611
36612
36613 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36614 .cindex "SMTP" "batched incoming"
36615 .cindex "batched SMTP input"
36616 The &%-bS%& command line option causes Exim to accept one or more messages by
36617 reading SMTP on the standard input, but to generate no responses. If the caller
36618 is trusted, the senders in the MAIL commands are believed; otherwise the
36619 sender is always the caller of Exim. Unqualified senders and receivers are not
36620 rejected (there seems little point) but instead just get qualified. HELO
36621 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36622 as NOOP; QUIT quits.
36623
36624 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36625 ACL is run in the same way as for non-SMTP local input.
36626
36627 If an error is detected while reading a message, including a missing &"."& at
36628 the end, Exim gives up immediately. It writes details of the error to the
36629 standard output in a stylized way that the calling program should be able to
36630 make some use of automatically, for example:
36631 .code
36632 554 Unexpected end of file
36633 Transaction started in line 10
36634 Error detected in line 14
36635 .endd
36636 It writes a more verbose version, for human consumption, to the standard error
36637 file, for example:
36638 .code
36639 An error was detected while processing a file of BSMTP input.
36640 The error message was:
36641
36642 501 '>' missing at end of address
36643
36644 The SMTP transaction started in line 10.
36645 The error was detected in line 12.
36646 The SMTP command at fault was:
36647
36648 rcpt to:<malformed@in.com.plete
36649
36650 1 previous message was successfully processed.
36651 The rest of the batch was abandoned.
36652 .endd
36653 The return code from Exim is zero only if there were no errors. It is 1 if some
36654 messages were accepted before an error was detected, and 2 if no messages were
36655 accepted.
36656 .ecindex IIDsmtpproc1
36657 .ecindex IIDsmtpproc2
36658
36659
36660
36661 . ////////////////////////////////////////////////////////////////////////////
36662 . ////////////////////////////////////////////////////////////////////////////
36663
36664 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36665          "Customizing messages"
36666 When a message fails to be delivered, or remains in the queue for more than a
36667 configured amount of time, Exim sends a message to the original sender, or
36668 to an alternative configured address. The text of these messages is built into
36669 the code of Exim, but it is possible to change it, either by adding a single
36670 string, or by replacing each of the paragraphs by text supplied in a file.
36671
36672 The &'From:'& and &'To:'& header lines are automatically generated; you can
36673 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36674 option. Exim also adds the line
36675 .code
36676 Auto-Submitted: auto-generated
36677 .endd
36678 to all warning and bounce messages,
36679
36680
36681 .section "Customizing bounce messages" "SECID239"
36682 .cindex "customizing" "bounce message"
36683 .cindex "bounce message" "customizing"
36684 If &%bounce_message_text%& is set, its contents are included in the default
36685 message immediately after &"This message was created automatically by mail
36686 delivery software."& The string is not expanded. It is not used if
36687 &%bounce_message_file%& is set.
36688
36689 When &%bounce_message_file%& is set, it must point to a template file for
36690 constructing error messages. The file consists of a series of text items,
36691 separated by lines consisting of exactly four asterisks. If the file cannot be
36692 opened, default text is used and a message is written to the main and panic
36693 logs. If any text item in the file is empty, default text is used for that
36694 item.
36695
36696 .vindex "&$bounce_recipient$&"
36697 .vindex "&$bounce_return_size_limit$&"
36698 Each item of text that is read from the file is expanded, and there are two
36699 expansion variables which can be of use here: &$bounce_recipient$& is set to
36700 the recipient of an error message while it is being created, and
36701 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36702 option, rounded to a whole number.
36703
36704 The items must appear in the file in the following order:
36705
36706 .ilist
36707 The first item is included in the headers, and should include at least a
36708 &'Subject:'& header. Exim does not check the syntax of these headers.
36709 .next
36710 The second item forms the start of the error message. After it, Exim lists the
36711 failing addresses with their error messages.
36712 .next
36713 The third item is used to introduce any text from pipe transports that is to be
36714 returned to the sender. It is omitted if there is no such text.
36715 .next
36716 The fourth, fifth and sixth items will be ignored and may be empty.
36717 The fields exist for back-compatibility
36718 .endlist
36719
36720 The default state (&%bounce_message_file%& unset) is equivalent to the
36721 following file, in which the sixth item is empty. The &'Subject:'& and some
36722 other lines have been split in order to fit them on the page:
36723 .code
36724 Subject: Mail delivery failed
36725   ${if eq{$sender_address}{$bounce_recipient}
36726   {: returning message to sender}}
36727 ****
36728 This message was created automatically by mail delivery software.
36729
36730 A message ${if eq{$sender_address}{$bounce_recipient}
36731   {that you sent }{sent by
36732
36733 <$sender_address>
36734
36735 }}could not be delivered to all of its recipients.
36736 This is a permanent error. The following address(es) failed:
36737 ****
36738 The following text was generated during the delivery attempt(s):
36739 ****
36740 ------ This is a copy of the message, including all the headers.
36741   ------
36742 ****
36743 ------ The body of the message is $message_size characters long;
36744   only the first
36745 ------ $bounce_return_size_limit or so are included here.
36746 ****
36747 .endd
36748 .section "Customizing warning messages" "SECTcustwarn"
36749 .cindex "customizing" "warning message"
36750 .cindex "warning of delay" "customizing the message"
36751 The option &%warn_message_file%& can be pointed at a template file for use when
36752 warnings about message delays are created. In this case there are only three
36753 text sections:
36754
36755 .ilist
36756 The first item is included in the headers, and should include at least a
36757 &'Subject:'& header. Exim does not check the syntax of these headers.
36758 .next
36759 The second item forms the start of the warning message. After it, Exim lists
36760 the delayed addresses.
36761 .next
36762 The third item then ends the message.
36763 .endlist
36764
36765 The default state is equivalent to the following file, except that some lines
36766 have been split here, in order to fit them on the page:
36767 .code
36768 Subject: Warning: message $message_exim_id delayed
36769   $warn_message_delay
36770 ****
36771 This message was created automatically by mail delivery software.
36772
36773 A message ${if eq{$sender_address}{$warn_message_recipients}
36774 {that you sent }{sent by
36775
36776 <$sender_address>
36777
36778 }}has not been delivered to all of its recipients after
36779 more than $warn_message_delay in the queue on $primary_hostname.
36780
36781 The message identifier is:     $message_exim_id
36782 The subject of the message is: $h_subject
36783 The date of the message is:    $h_date
36784
36785 The following address(es) have not yet been delivered:
36786 ****
36787 No action is required on your part. Delivery attempts will
36788 continue for some time, and this warning may be repeated at
36789 intervals if the message remains undelivered. Eventually the
36790 mail delivery software will give up, and when that happens,
36791 the message will be returned to you.
36792 .endd
36793 .vindex "&$warn_message_delay$&"
36794 .vindex "&$warn_message_recipients$&"
36795 However, in the default state the subject and date lines are omitted if no
36796 appropriate headers exist. During the expansion of this file,
36797 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36798 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36799 of recipients for the warning message. There may be more than one if there are
36800 multiple addresses with different &%errors_to%& settings on the routers that
36801 handled them.
36802
36803
36804
36805
36806 . ////////////////////////////////////////////////////////////////////////////
36807 . ////////////////////////////////////////////////////////////////////////////
36808
36809 .chapter "Some common configuration settings" "CHAPcomconreq"
36810 This chapter discusses some configuration settings that seem to be fairly
36811 common. More examples and discussion can be found in the Exim book.
36812
36813
36814
36815 .section "Sending mail to a smart host" "SECID240"
36816 .cindex "smart host" "example router"
36817 If you want to send all mail for non-local domains to a &"smart host"&, you
36818 should replace the default &(dnslookup)& router with a router which does the
36819 routing explicitly:
36820 .code
36821 send_to_smart_host:
36822   driver = manualroute
36823   route_list = !+local_domains smart.host.name
36824   transport = remote_smtp
36825 .endd
36826 You can use the smart host's IP address instead of the name if you wish.
36827 If you are using Exim only to submit messages to a smart host, and not for
36828 receiving incoming messages, you can arrange for it to do the submission
36829 synchronously by setting the &%mua_wrapper%& option (see chapter
36830 &<<CHAPnonqueueing>>&).
36831
36832
36833
36834
36835 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36836 .cindex "mailing lists"
36837 Exim can be used to run simple mailing lists, but for large and/or complicated
36838 requirements, the use of additional specialized mailing list software such as
36839 Majordomo or Mailman is recommended.
36840
36841 The &(redirect)& router can be used to handle mailing lists where each list
36842 is maintained in a separate file, which can therefore be managed by an
36843 independent manager. The &%domains%& router option can be used to run these
36844 lists in a separate domain from normal mail. For example:
36845 .code
36846 lists:
36847   driver = redirect
36848   domains = lists.example
36849   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
36850   forbid_pipe
36851   forbid_file
36852   errors_to = ${quote_local_part:$local_part-request}@lists.example
36853   no_more
36854 .endd
36855 This router is skipped for domains other than &'lists.example'&. For addresses
36856 in that domain, it looks for a file that matches the local part. If there is no
36857 such file, the router declines, but because &%no_more%& is set, no subsequent
36858 routers are tried, and so the whole delivery fails.
36859
36860 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36861 expanded into a filename or a pipe delivery, which is usually inappropriate in
36862 a mailing list.
36863
36864 .oindex "&%errors_to%&"
36865 The &%errors_to%& option specifies that any delivery errors caused by addresses
36866 taken from a mailing list are to be sent to the given address rather than the
36867 original sender of the message. However, before acting on this, Exim verifies
36868 the error address, and ignores it if verification fails.
36869
36870 For example, using the configuration above, mail sent to
36871 &'dicts@lists.example'& is passed on to those addresses contained in
36872 &_/usr/lists/dicts_&, with error reports directed to
36873 &'dicts-request@lists.example'&, provided that this address can be verified.
36874 There could be a file called &_/usr/lists/dicts-request_& containing
36875 the address(es) of this particular list's manager(s), but other approaches,
36876 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36877 or &%local_part_suffix%& options) to handle addresses of the form
36878 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36879
36880
36881
36882 .section "Syntax errors in mailing lists" "SECID241"
36883 .cindex "mailing lists" "syntax errors in"
36884 If an entry in redirection data contains a syntax error, Exim normally defers
36885 delivery of the original address. That means that a syntax error in a mailing
36886 list holds up all deliveries to the list. This may not be appropriate when a
36887 list is being maintained automatically from data supplied by users, and the
36888 addresses are not rigorously checked.
36889
36890 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36891 entries that fail to parse, noting the incident in the log. If in addition
36892 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36893 whenever a broken address is skipped. It is usually appropriate to set
36894 &%syntax_errors_to%& to the same address as &%errors_to%&.
36895
36896
36897
36898 .section "Re-expansion of mailing lists" "SECID242"
36899 .cindex "mailing lists" "re-expansion of"
36900 Exim remembers every individual address to which a message has been delivered,
36901 in order to avoid duplication, but it normally stores only the original
36902 recipient addresses with a message. If all the deliveries to a mailing list
36903 cannot be done at the first attempt, the mailing list is re-expanded when the
36904 delivery is next tried. This means that alterations to the list are taken into
36905 account at each delivery attempt, so addresses that have been added to
36906 the list since the message arrived will therefore receive a copy of the
36907 message, even though it pre-dates their subscription.
36908
36909 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36910 on the &(redirect)& router. If this is done, any addresses generated by the
36911 router that fail to deliver at the first attempt are added to the message as
36912 &"top level"& addresses, and the parent address that generated them is marked
36913 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36914 subsequent delivery attempts. The disadvantage of this is that if any of the
36915 failing addresses are incorrect, correcting them in the file has no effect on
36916 pre-existing messages.
36917
36918 The original top-level address is remembered with each of the generated
36919 addresses, and is output in any log messages. However, any intermediate parent
36920 addresses are not recorded. This makes a difference to the log only if the
36921 &%all_parents%& selector is set, but for mailing lists there is normally only
36922 one level of expansion anyway.
36923
36924
36925
36926 .section "Closed mailing lists" "SECID243"
36927 .cindex "mailing lists" "closed"
36928 The examples so far have assumed open mailing lists, to which anybody may
36929 send mail. It is also possible to set up closed lists, where mail is accepted
36930 from specified senders only. This is done by making use of the generic
36931 &%senders%& option to restrict the router that handles the list.
36932
36933 The following example uses the same file as a list of recipients and as a list
36934 of permitted senders. It requires three routers:
36935 .code
36936 lists_request:
36937   driver = redirect
36938   domains = lists.example
36939   local_part_suffix = -request
36940   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
36941   file = /usr/lists/${local_part_data}-request
36942   no_more
36943
36944 lists_post:
36945   driver = redirect
36946   domains = lists.example
36947   senders = ${if exists {/usr/lists/$local_part}\
36948              {lsearch;/usr/lists/$local_part}{*}}
36949   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
36950   forbid_pipe
36951   forbid_file
36952   errors_to = ${quote_local_part:$local_part-request}@lists.example
36953   no_more
36954
36955 lists_closed:
36956   driver = redirect
36957   domains = lists.example
36958   allow_fail
36959   data = :fail: $local_part@lists.example is a closed mailing list
36960 .endd
36961 All three routers have the same &%domains%& setting, so for any other domains,
36962 they are all skipped. The first router runs only if the local part ends in
36963 &%-request%&. It handles messages to the list manager(s) by means of an open
36964 mailing list.
36965
36966 The second router runs only if the &%senders%& precondition is satisfied. It
36967 checks for the existence of a list that corresponds to the local part, and then
36968 checks that the sender is on the list by means of a linear search. It is
36969 necessary to check for the existence of the file before trying to search it,
36970 because otherwise Exim thinks there is a configuration error. If the file does
36971 not exist, the expansion of &%senders%& is *, which matches all senders. This
36972 means that the router runs, but because there is no list, declines, and
36973 &%no_more%& ensures that no further routers are run. The address fails with an
36974 &"unrouteable address"& error.
36975
36976 The third router runs only if the second router is skipped, which happens when
36977 a mailing list exists, but the sender is not on it. This router forcibly fails
36978 the address, giving a suitable error message.
36979
36980
36981
36982
36983 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36984 .cindex "VERP"
36985 .cindex "Variable Envelope Return Paths"
36986 .cindex "envelope from"
36987 .cindex "envelope sender"
36988 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36989 are a way of helping mailing list administrators discover which subscription
36990 address is the cause of a particular delivery failure. The idea is to encode
36991 the original recipient address in the outgoing envelope sender address, so that
36992 if the message is forwarded by another host and then subsequently bounces, the
36993 original recipient can be extracted from the recipient address of the bounce.
36994
36995 .oindex &%errors_to%&
36996 .oindex &%return_path%&
36997 Envelope sender addresses can be modified by Exim using two different
36998 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36999 list examples), or the &%return_path%& option on a transport. The second of
37000 these is effective only if the message is successfully delivered to another
37001 host; it is not used for errors detected on the local host (see the description
37002 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37003 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37004 .code
37005 verp_smtp:
37006   driver = smtp
37007   max_rcpt = 1
37008   return_path = \
37009     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37010       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37011 .endd
37012 This has the effect of rewriting the return path (envelope sender) on outgoing
37013 SMTP messages, if the local part of the original return path ends in
37014 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37015 local part and domain of the recipient into the return path. Suppose, for
37016 example, that a message whose return path has been set to
37017 &'somelist-request@your.dom.example'& is sent to
37018 &'subscriber@other.dom.example'&. In the transport, the return path is
37019 rewritten as
37020 .code
37021 somelist-request+subscriber=other.dom.example@your.dom.example
37022 .endd
37023 .vindex "&$local_part$&"
37024 For this to work, you must tell Exim to send multiple copies of messages that
37025 have more than one recipient, so that each copy has just one recipient. This is
37026 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37027 might be sent to several different recipients in the same domain, in which case
37028 &$local_part$& is not available in the transport, because it is not unique.
37029
37030 Unless your host is doing nothing but mailing list deliveries, you should
37031 probably use a separate transport for the VERP deliveries, so as not to use
37032 extra resources in making one-per-recipient copies for other deliveries. This
37033 can easily be done by expanding the &%transport%& option in the router:
37034 .code
37035 dnslookup:
37036   driver = dnslookup
37037   domains = ! +local_domains
37038   transport = \
37039     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37040       {verp_smtp}{remote_smtp}}
37041   no_more
37042 .endd
37043 If you want to change the return path using &%errors_to%& in a router instead
37044 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37045 routers that handle mailing list addresses. This will ensure that all delivery
37046 errors, including those detected on the local host, are sent to the VERP
37047 address.
37048
37049 On a host that does no local deliveries and has no manual routing, only the
37050 &(dnslookup)& router needs to be changed. A special transport is not needed for
37051 SMTP deliveries. Every mailing list recipient has its own return path value,
37052 and so Exim must hand them to the transport one at a time. Here is an example
37053 of a &(dnslookup)& router that implements VERP:
37054 .code
37055 verp_dnslookup:
37056   driver = dnslookup
37057   domains = ! +local_domains
37058   transport = remote_smtp
37059   errors_to = \
37060     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37061      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37062   no_more
37063 .endd
37064 Before you start sending out messages with VERPed return paths, you must also
37065 configure Exim to accept the bounce messages that come back to those paths.
37066 Typically this is done by setting a &%local_part_suffix%& option for a
37067 router, and using this to route the messages to wherever you want to handle
37068 them.
37069
37070 The overhead incurred in using VERP depends very much on the size of the
37071 message, the number of recipient addresses that resolve to the same remote
37072 host, and the speed of the connection over which the message is being sent. If
37073 a lot of addresses resolve to the same host and the connection is slow, sending
37074 a separate copy of the message for each address may take substantially longer
37075 than sending a single copy with many recipients (for which VERP cannot be
37076 used).
37077
37078
37079
37080
37081
37082
37083 .section "Virtual domains" "SECTvirtualdomains"
37084 .cindex "virtual domains"
37085 .cindex "domain" "virtual"
37086 The phrase &'virtual domain'& is unfortunately used with two rather different
37087 meanings:
37088
37089 .ilist
37090 A domain for which there are no real mailboxes; all valid local parts are
37091 aliases for other email addresses. Common examples are organizational
37092 top-level domains and &"vanity"& domains.
37093 .next
37094 One of a number of independent domains that are all handled by the same host,
37095 with mailboxes on that host, but where the mailbox owners do not necessarily
37096 have login accounts on that host.
37097 .endlist
37098
37099 The first usage is probably more common, and does seem more &"virtual"& than
37100 the second. This kind of domain can be handled in Exim with a straightforward
37101 aliasing router. One approach is to create a separate alias file for each
37102 virtual domain. Exim can test for the existence of the alias file to determine
37103 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37104 to a router of this form:
37105 .code
37106 virtual:
37107   driver = redirect
37108   domains = dsearch;/etc/mail/virtual
37109   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37110   no_more
37111 .endd
37112 .new
37113 The &%domains%& option specifies that the router is to be skipped, unless there
37114 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37115 domain that is being processed.
37116 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37117 being placed into the &$domain_data$& variable.
37118 .wen
37119
37120 When the router runs, it looks up the local
37121 part in the file to find a new address (or list of addresses). The &%no_more%&
37122 setting ensures that if the lookup fails (leading to &%data%& being an empty
37123 string), Exim gives up on the address without trying any subsequent routers.
37124
37125 This one router can handle all the virtual domains because the alias filenames
37126 follow a fixed pattern. Permissions can be arranged so that appropriate people
37127 can edit the different alias files. A successful aliasing operation results in
37128 a new envelope recipient address, which is then routed from scratch.
37129
37130 The other kind of &"virtual"& domain can also be handled in a straightforward
37131 way. One approach is to create a file for each domain containing a list of
37132 valid local parts, and use it in a router like this:
37133 .code
37134 my_domains:
37135   driver = accept
37136   domains = dsearch;/etc/mail/domains
37137   local_parts = lsearch;/etc/mail/domains/$domain
37138   transport = my_mailboxes
37139 .endd
37140 The address is accepted if there is a file for the domain, and the local part
37141 can be found in the file. The &%domains%& option is used to check for the
37142 file's existence because &%domains%& is tested before the &%local_parts%&
37143 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37144 because that option is tested after &%local_parts%&. The transport is as
37145 follows:
37146 .code
37147 my_mailboxes:
37148   driver = appendfile
37149   file = /var/mail/$domain/$local_part_data
37150   user = mail
37151 .endd
37152 This uses a directory of mailboxes for each domain. The &%user%& setting is
37153 required, to specify which uid is to be used for writing to the mailboxes.
37154
37155 The configuration shown here is just one example of how you might support this
37156 requirement. There are many other ways this kind of configuration can be set
37157 up, for example, by using a database instead of separate files to hold all the
37158 information about the domains.
37159
37160
37161
37162 .section "Multiple user mailboxes" "SECTmulbox"
37163 .cindex "multiple mailboxes"
37164 .cindex "mailbox" "multiple"
37165 .cindex "local part" "prefix"
37166 .cindex "local part" "suffix"
37167 Heavy email users often want to operate with multiple mailboxes, into which
37168 incoming mail is automatically sorted. A popular way of handling this is to
37169 allow users to use multiple sender addresses, so that replies can easily be
37170 identified. Users are permitted to add prefixes or suffixes to their local
37171 parts for this purpose. The wildcard facility of the generic router options
37172 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37173 example, consider this router:
37174 .code
37175 userforward:
37176   driver = redirect
37177   check_local_user
37178   file = $home/.forward
37179   local_part_suffix = -*
37180   local_part_suffix_optional
37181   allow_filter
37182 .endd
37183 .vindex "&$local_part_suffix$&"
37184 It runs a user's &_.forward_& file for all local parts of the form
37185 &'username-*'&. Within the filter file the user can distinguish different
37186 cases by testing the variable &$local_part_suffix$&. For example:
37187 .code
37188 if $local_part_suffix contains -special then
37189 save /home/$local_part/Mail/special
37190 endif
37191 .endd
37192 If the filter file does not exist, or does not deal with such addresses, they
37193 fall through to subsequent routers, and, assuming no subsequent use of the
37194 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37195 control over which suffixes are valid.
37196
37197 Alternatively, a suffix can be used to trigger the use of a different
37198 &_.forward_& file &-- which is the way a similar facility is implemented in
37199 another MTA:
37200 .code
37201 userforward:
37202   driver = redirect
37203   check_local_user
37204   local_part_suffix = -*
37205   local_part_suffix_optional
37206   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37207   allow_filter
37208 .endd
37209 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37210 example, &_.forward-special_& is used. Once again, if the appropriate file
37211 does not exist, or does not deal with the address, it is passed on to
37212 subsequent routers, which could, if required, look for an unqualified
37213 &_.forward_& file to use as a default.
37214
37215
37216
37217 .section "Simplified vacation processing" "SECID244"
37218 .cindex "vacation processing"
37219 The traditional way of running the &'vacation'& program is for a user to set up
37220 a pipe command in a &_.forward_& file
37221 (see section &<<SECTspecitredli>>& for syntax details).
37222 This is prone to error by inexperienced users. There are two features of Exim
37223 that can be used to make this process simpler for users:
37224
37225 .ilist
37226 A local part prefix such as &"vacation-"& can be specified on a router which
37227 can cause the message to be delivered directly to the &'vacation'& program, or
37228 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37229 &_.forward_& file are then much simpler. For example:
37230 .code
37231 spqr, vacation-spqr
37232 .endd
37233 .next
37234 The &%require_files%& generic router option can be used to trigger a
37235 vacation delivery by checking for the existence of a certain file in the
37236 user's home directory. The &%unseen%& generic option should also be used, to
37237 ensure that the original delivery also proceeds. In this case, all the user has
37238 to do is to create a file called, say, &_.vacation_&, containing a vacation
37239 message.
37240 .endlist
37241
37242 Another advantage of both these methods is that they both work even when the
37243 use of arbitrary pipes by users is locked out.
37244
37245
37246
37247 .section "Taking copies of mail" "SECID245"
37248 .cindex "message" "copying every"
37249 Some installations have policies that require archive copies of all messages to
37250 be made. A single copy of each message can easily be taken by an appropriate
37251 command in a system filter, which could, for example, use a different file for
37252 each day's messages.
37253
37254 There is also a shadow transport mechanism that can be used to take copies of
37255 messages that are successfully delivered by local transports, one copy per
37256 delivery. This could be used, &'inter alia'&, to implement automatic
37257 notification of delivery by sites that insist on doing such things.
37258
37259
37260
37261 .section "Intermittently connected hosts" "SECID246"
37262 .cindex "intermittently connected hosts"
37263 It has become quite common (because it is cheaper) for hosts to connect to the
37264 Internet periodically rather than remain connected all the time. The normal
37265 arrangement is that mail for such hosts accumulates on a system that is
37266 permanently connected.
37267
37268 Exim was designed for use on permanently connected hosts, and so it is not
37269 particularly well-suited to use in an intermittently connected environment.
37270 Nevertheless there are some features that can be used.
37271
37272
37273 .section "Exim on the upstream server host" "SECID247"
37274 It is tempting to arrange for incoming mail for the intermittently connected
37275 host to remain in Exim's queue until the client connects. However, this
37276 approach does not scale very well. Two different kinds of waiting message are
37277 being mixed up in the same queue &-- those that cannot be delivered because of
37278 some temporary problem, and those that are waiting for their destination host
37279 to connect. This makes it hard to manage the queue, as well as wasting
37280 resources, because each queue runner scans the entire queue.
37281
37282 A better approach is to separate off those messages that are waiting for an
37283 intermittently connected host. This can be done by delivering these messages
37284 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37285 format, from where they are transmitted by other software when their
37286 destination connects. This makes it easy to collect all the mail for one host
37287 in a single directory, and to apply local timeout rules on a per-message basis
37288 if required.
37289
37290 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37291 you are doing this, you should configure Exim with a long retry period for the
37292 intermittent host. For example:
37293 .code
37294 cheshire.wonderland.fict.example    *   F,5d,24h
37295 .endd
37296 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37297 which messages it has queued up for that host. Once the intermittent host comes
37298 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37299 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37300 causes all the queued up messages to be delivered, often down a single SMTP
37301 connection. While the host remains connected, any new messages get delivered
37302 immediately.
37303
37304 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37305 issued with a different IP address each time it connects, Exim's retry
37306 mechanisms on the holding host get confused, because the IP address is normally
37307 used as part of the key string for holding retry information. This can be
37308 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37309 Since this has disadvantages for permanently connected hosts, it is best to
37310 arrange a separate transport for the intermittently connected ones.
37311
37312
37313
37314 .section "Exim on the intermittently connected client host" "SECID248"
37315 The value of &%smtp_accept_queue_per_connection%& should probably be
37316 increased, or even set to zero (that is, disabled) on the intermittently
37317 connected host, so that all incoming messages down a single connection get
37318 delivered immediately.
37319
37320 .cindex "SMTP" "passed connection"
37321 .cindex "SMTP" "multiple deliveries"
37322 .cindex "multiple SMTP deliveries"
37323 .cindex "first pass routing"
37324 Mail waiting to be sent from an intermittently connected host will probably
37325 not have been routed, because without a connection DNS lookups are not
37326 possible. This means that if a normal queue run is done at connection time,
37327 each message is likely to be sent in a separate SMTP session. This can be
37328 avoided by starting the queue run with a command line option beginning with
37329 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37330 first pass, routing is done but no deliveries take place. The second pass is a
37331 normal queue run; since all the messages have been previously routed, those
37332 destined for the same host are likely to get sent as multiple deliveries in a
37333 single SMTP connection.
37334
37335
37336
37337 . ////////////////////////////////////////////////////////////////////////////
37338 . ////////////////////////////////////////////////////////////////////////////
37339
37340 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37341          "Exim as a non-queueing client"
37342 .cindex "client, non-queueing"
37343 .cindex "smart host" "suppressing queueing"
37344 On a personal computer, it is a common requirement for all
37345 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37346 configured to operate that way, for all the popular operating systems.
37347 However, there are some MUAs for Unix-like systems that cannot be so
37348 configured: they submit messages using the command line interface of
37349 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37350 messages this way.
37351
37352 If the personal computer runs continuously, there is no problem, because it can
37353 run a conventional MTA that handles delivery to the smart host, and deal with
37354 any delays via its queueing mechanism. However, if the computer does not run
37355 continuously or runs different operating systems at different times, queueing
37356 email is not desirable.
37357
37358 There is therefore a requirement for something that can provide the
37359 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37360 any queueing or retrying facilities. Furthermore, the delivery to the smart
37361 host should be synchronous, so that if it fails, the sending MUA is immediately
37362 informed. In other words, we want something that extends an MUA that submits
37363 to a local MTA via the command line so that it behaves like one that submits
37364 to a remote smart host using TCP/SMTP.
37365
37366 There are a number of applications (for example, there is one called &'ssmtp'&)
37367 that do this job. However, people have found them to be lacking in various
37368 ways. For instance, you might want to allow aliasing and forwarding to be done
37369 before sending a message to the smart host.
37370
37371 Exim already had the necessary infrastructure for doing this job. Just a few
37372 tweaks were needed to make it behave as required, though it is somewhat of an
37373 overkill to use a fully-featured MTA for this purpose.
37374
37375 .oindex "&%mua_wrapper%&"
37376 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37377 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37378 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37379 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37380 compatible router and transport configuration. Typically there will be just one
37381 router and one transport, sending everything to a smart host.
37382
37383 When run in MUA wrapping mode, the behaviour of Exim changes in the
37384 following ways:
37385
37386 .ilist
37387 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37388 In other words, the only way to submit messages is via the command line.
37389 .next
37390 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37391 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37392 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37393 does not finish until the delivery attempt is complete. If the delivery is
37394 successful, a zero return code is given.
37395 .next
37396 Address redirection is permitted, but the final routing for all addresses must
37397 be to the same remote transport, and to the same list of hosts. Furthermore,
37398 the return address (envelope sender) must be the same for all recipients, as
37399 must any added or deleted header lines. In other words, it must be possible to
37400 deliver the message in a single SMTP transaction, however many recipients there
37401 are.
37402 .next
37403 If these conditions are not met, or if routing any address results in a
37404 failure or defer status, or if Exim is unable to deliver all the recipients
37405 successfully to one of the smart hosts, delivery of the entire message fails.
37406 .next
37407 Because no queueing is allowed, all failures are treated as permanent; there
37408 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37409 smart host. Furthermore, because only a single yes/no response can be given to
37410 the caller, it is not possible to deliver to some recipients and not others. If
37411 there is an error (temporary or permanent) for any recipient, all are failed.
37412 .next
37413 If more than one smart host is listed, Exim will try another host after a
37414 connection failure or a timeout, in the normal way. However, if this kind of
37415 failure happens for all the hosts, the delivery fails.
37416 .next
37417 When delivery fails, an error message is written to the standard error stream
37418 (as well as to Exim's log), and Exim exits to the caller with a return code
37419 value 1. The message is expunged from Exim's spool files. No bounce messages
37420 are ever generated.
37421 .next
37422 No retry data is maintained, and any retry rules are ignored.
37423 .next
37424 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37425 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37426 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37427 .endlist
37428
37429 The overall effect is that Exim makes a single synchronous attempt to deliver
37430 the message, failing if there is any kind of problem. Because no local
37431 deliveries are done and no daemon can be run, Exim does not need root
37432 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37433 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37434 the advantages and disadvantages of running without root privilege.
37435
37436
37437
37438
37439 . ////////////////////////////////////////////////////////////////////////////
37440 . ////////////////////////////////////////////////////////////////////////////
37441
37442 .chapter "Log files" "CHAPlog"
37443 .scindex IIDloggen "log" "general description"
37444 .cindex "log" "types of"
37445 Exim writes three different logs, referred to as the main log, the reject log,
37446 and the panic log:
37447
37448 .ilist
37449 .cindex "main log"
37450 The main log records the arrival of each message and each delivery in a single
37451 line in each case. The format is as compact as possible, in an attempt to keep
37452 down the size of log files. Two-character flag sequences make it easy to pick
37453 out these lines. A number of other events are recorded in the main log. Some of
37454 them are optional, in which case the &%log_selector%& option controls whether
37455 they are included or not. A Perl script called &'eximstats'&, which does simple
37456 analysis of main log files, is provided in the Exim distribution (see section
37457 &<<SECTmailstat>>&).
37458 .next
37459 .cindex "reject log"
37460 The reject log records information from messages that are rejected as a result
37461 of a configuration option (that is, for policy reasons).
37462 The first line of each rejection is a copy of the line that is also written to
37463 the main log. Then, if the message's header has been read at the time the log
37464 is written, its contents are written to this log. Only the original header
37465 lines are available; header lines added by ACLs are not logged. You can use the
37466 reject log to check that your policy controls are working correctly; on a busy
37467 host this may be easier than scanning the main log for rejection messages. You
37468 can suppress the writing of the reject log by setting &%write_rejectlog%&
37469 false.
37470 .next
37471 .cindex "panic log"
37472 .cindex "system log"
37473 When certain serious errors occur, Exim writes entries to its panic log. If the
37474 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37475 are usually written to the main log as well, but can get lost amid the mass of
37476 other entries. The panic log should be empty under normal circumstances. It is
37477 therefore a good idea to check it (or to have a &'cron'& script check it)
37478 regularly, in order to become aware of any problems. When Exim cannot open its
37479 panic log, it tries as a last resort to write to the system log (syslog). This
37480 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37481 message itself is written at priority LOG_CRIT.
37482 .endlist
37483
37484 Every log line starts with a timestamp, in the format shown in the following
37485 example. Note that many of the examples shown in this chapter are line-wrapped.
37486 In the log file, this would be all on one line:
37487 .code
37488 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37489   by QUIT
37490 .endd
37491 By default, the timestamps are in the local timezone. There are two
37492 ways of changing this:
37493
37494 .ilist
37495 You can set the &%timezone%& option to a different time zone; in particular, if
37496 you set
37497 .code
37498 timezone = UTC
37499 .endd
37500 the timestamps will be in UTC (aka GMT).
37501 .next
37502 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37503 example:
37504 .code
37505 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37506 .endd
37507 .endlist
37508
37509 .cindex "log" "process ids in"
37510 .cindex "pid (process id)" "in log lines"
37511 Exim does not include its process id in log lines by default, but you can
37512 request that it does so by specifying the &`pid`& log selector (see section
37513 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37514 brackets, immediately after the time and date.
37515
37516
37517
37518
37519 .section "Where the logs are written" "SECTwhelogwri"
37520 .cindex "log" "destination"
37521 .cindex "log" "to file"
37522 .cindex "log" "to syslog"
37523 .cindex "syslog"
37524 The logs may be written to local files, or to syslog, or both. However, it
37525 should be noted that many syslog implementations use UDP as a transport, and
37526 are therefore unreliable in the sense that messages are not guaranteed to
37527 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37528 It has also been reported that on large log files (tens of megabytes) you may
37529 need to tweak syslog to prevent it syncing the file with each write &-- on
37530 Linux this has been seen to make syslog take 90% plus of CPU time.
37531
37532 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37533 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37534 configuration. This latter string is expanded, so it can contain, for example,
37535 references to the host name:
37536 .code
37537 log_file_path = /var/log/$primary_hostname/exim_%slog
37538 .endd
37539 It is generally advisable, however, to set the string in &_Local/Makefile_&
37540 rather than at runtime, because then the setting is available right from the
37541 start of Exim's execution. Otherwise, if there's something it wants to log
37542 before it has read the configuration file (for example, an error in the
37543 configuration file) it will not use the path you want, and may not be able to
37544 log at all.
37545
37546 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37547 list, currently limited to at most two items. This is one option where the
37548 facility for changing a list separator may not be used. The list must always be
37549 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37550 otherwise the item must either be an absolute path, containing &`%s`& at the
37551 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37552 implying the use of a default path.
37553
37554 When Exim encounters an empty item in the list, it searches the list defined by
37555 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37556 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37557 mean &"use the path specified at build time"&. It no such item exists, log
37558 files are written in the &_log_& subdirectory of the spool directory. This is
37559 equivalent to the setting:
37560 .code
37561 log_file_path = $spool_directory/log/%slog
37562 .endd
37563 If you do not specify anything at build time or runtime,
37564 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37565 that is where the logs are written.
37566
37567 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37568 are in use &-- see section &<<SECTdatlogfil>>& below.
37569
37570 Here are some examples of possible settings:
37571 .display
37572 &`LOG_FILE_PATH=syslog                    `& syslog only
37573 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37574 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37575 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37576 .endd
37577 If there are more than two paths in the list, the first is used and a panic
37578 error is logged.
37579
37580
37581
37582 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37583 .cindex "log" "cycling local files"
37584 .cindex "cycling logs"
37585 .cindex "&'exicyclog'&"
37586 .cindex "log" "local files; writing to"
37587 Some operating systems provide centralized and standardized methods for cycling
37588 log files. For those that do not, a utility script called &'exicyclog'& is
37589 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37590 main and reject logs each time it is called. The maximum number of old logs to
37591 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37592
37593 An Exim delivery process opens the main log when it first needs to write to it,
37594 and it keeps the file open in case subsequent entries are required &-- for
37595 example, if a number of different deliveries are being done for the same
37596 message. However, remote SMTP deliveries can take a long time, and this means
37597 that the file may be kept open long after it is renamed if &'exicyclog'& or
37598 something similar is being used to rename log files on a regular basis. To
37599 ensure that a switch of log files is noticed as soon as possible, Exim calls
37600 &[stat()]& on the main log's name before reusing an open file, and if the file
37601 does not exist, or its inode has changed, the old file is closed and Exim
37602 tries to open the main log from scratch. Thus, an old log file may remain open
37603 for quite some time, but no Exim processes should write to it once it has been
37604 renamed.
37605
37606
37607
37608 .section "Datestamped log files" "SECTdatlogfil"
37609 .cindex "log" "datestamped files"
37610 Instead of cycling the main and reject log files by renaming them
37611 periodically, some sites like to use files whose names contain a datestamp,
37612 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37613 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37614 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37615 point where the datestamp is required. For example:
37616 .code
37617 log_file_path = /var/spool/exim/log/%slog-%D
37618 log_file_path = /var/log/exim-%s-%D.log
37619 log_file_path = /var/spool/exim/log/%D-%slog
37620 log_file_path = /var/log/exim/%s.%M
37621 .endd
37622 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37623 examples of names generated by the above examples:
37624 .code
37625 /var/spool/exim/log/mainlog-20021225
37626 /var/log/exim-reject-20021225.log
37627 /var/spool/exim/log/20021225-mainlog
37628 /var/log/exim/main.200212
37629 .endd
37630 When this form of log file is specified, Exim automatically switches to new
37631 files at midnight. It does not make any attempt to compress old logs; you
37632 will need to write your own script if you require this. You should not
37633 run &'exicyclog'& with this form of logging.
37634
37635 The location of the panic log is also determined by &%log_file_path%&, but it
37636 is not datestamped, because rotation of the panic log does not make sense.
37637 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37638 the string. In addition, if it immediately follows a slash, a following
37639 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37640 character is removed. Thus, the four examples above would give these panic
37641 log names:
37642 .code
37643 /var/spool/exim/log/paniclog
37644 /var/log/exim-panic.log
37645 /var/spool/exim/log/paniclog
37646 /var/log/exim/panic
37647 .endd
37648
37649
37650 .section "Logging to syslog" "SECID249"
37651 .cindex "log" "syslog; writing to"
37652 The use of syslog does not change what Exim logs or the format of its messages,
37653 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37654 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37655 that, the same strings are written to syslog as to log files. The syslog
37656 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37657 by default, but you can change these by setting the &%syslog_facility%& and
37658 &%syslog_processname%& options, respectively. If Exim was compiled with
37659 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37660 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37661 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37662 the time and host name to each line.
37663 The three log streams are mapped onto syslog priorities as follows:
37664
37665 .ilist
37666 &'mainlog'& is mapped to LOG_INFO
37667 .next
37668 &'rejectlog'& is mapped to LOG_NOTICE
37669 .next
37670 &'paniclog'& is mapped to LOG_ALERT
37671 .endlist
37672
37673 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37674 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37675 these are routed by syslog to the same place. You can suppress this duplication
37676 by setting &%syslog_duplication%& false.
37677
37678 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37679 entries contain multiple lines when headers are included. To cope with both
37680 these cases, entries written to syslog are split into separate &[syslog()]&
37681 calls at each internal newline, and also after a maximum of
37682 870 data characters. (This allows for a total syslog line length of 1024, when
37683 additions such as timestamps are added.) If you are running a syslog
37684 replacement that can handle lines longer than the 1024 characters allowed by
37685 RFC 3164, you should set
37686 .code
37687 SYSLOG_LONG_LINES=yes
37688 .endd
37689 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37690 lines, but it still splits at internal newlines in &'reject'& log entries.
37691
37692 To make it easy to re-assemble split lines later, each component of a split
37693 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37694 where <&'n'&> is the component number and <&'m'&> is the total number of
37695 components in the entry. The / delimiter is used when the line was split
37696 because it was too long; if it was split because of an internal newline, the \
37697 delimiter is used. For example, supposing the length limit to be 50 instead of
37698 870, the following would be the result of a typical rejection message to
37699 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37700 name, and pid as added by syslog:
37701 .code
37702 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37703 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37704 [3/5]  when scanning for sender: missing or malformed lo
37705 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37706 [5/5] mple>)
37707 .endd
37708 The same error might cause the following lines to be written to &"rejectlog"&
37709 (LOG_NOTICE):
37710 .code
37711 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37712 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37713 [3/18] er when scanning for sender: missing or malformed
37714 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37715 [5\18] .example>)
37716 [6\18] Recipients: ph10@some.domain.cam.example
37717 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37718 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37719 [9\18]        id 16RdAL-0006pc-00
37720 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37721 [11\18] 09:43 +0100
37722 [12\18] F From: <>
37723 [13\18]   Subject: this is a test header
37724 [18\18]   X-something: this is another header
37725 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37726 [16\18] le>
37727 [17\18] B Bcc:
37728 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37729 .endd
37730 Log lines that are neither too long nor contain newlines are written to syslog
37731 without modification.
37732
37733 If only syslog is being used, the Exim monitor is unable to provide a log tail
37734 display, unless syslog is routing &'mainlog'& to a file on the local host and
37735 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37736 where it is.
37737
37738
37739
37740 .section "Log line flags" "SECID250"
37741 One line is written to the main log for each message received, and for each
37742 successful, unsuccessful, and delayed delivery. These lines can readily be
37743 picked out by the distinctive two-character flags that immediately follow the
37744 timestamp. The flags are:
37745 .display
37746 &`<=`&     message arrival
37747 &`(=`&     message fakereject
37748 &`=>`&     normal message delivery
37749 &`->`&     additional address in same delivery
37750 &`>>`&     cutthrough message delivery
37751 &`*>`&     delivery suppressed by &%-N%&
37752 &`**`&     delivery failed; address bounced
37753 &`==`&     delivery deferred; temporary problem
37754 .endd
37755
37756
37757 .section "Logging message reception" "SECID251"
37758 .cindex "log" "reception line"
37759 The format of the single-line entry in the main log that is written for every
37760 message received is shown in the basic example below, which is split over
37761 several lines in order to fit it on the page:
37762 .code
37763 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37764   H=mailer.fict.example [192.168.123.123] U=exim
37765   P=smtp S=5678 id=<incoming message id>
37766 .endd
37767 The address immediately following &"<="& is the envelope sender address. A
37768 bounce message is shown with the sender address &"<>"&, and if it is locally
37769 generated, this is followed by an item of the form
37770 .code
37771 R=<message id>
37772 .endd
37773 which is a reference to the message that caused the bounce to be sent.
37774
37775 .cindex "HELO"
37776 .cindex "EHLO"
37777 For messages from other hosts, the H and U fields identify the remote host and
37778 record the RFC 1413 identity of the user that sent the message, if one was
37779 received. The number given in square brackets is the IP address of the sending
37780 host. If there is a single, unparenthesized  host name in the H field, as
37781 above, it has been verified to correspond to the IP address (see the
37782 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37783 by the remote host in the SMTP HELO or EHLO command, and has not been
37784 verified. If verification yields a different name to that given for HELO or
37785 EHLO, the verified name appears first, followed by the HELO or EHLO
37786 name in parentheses.
37787
37788 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37789 without brackets, in the HELO or EHLO command, leading to entries in
37790 the log containing text like these examples:
37791 .code
37792 H=(10.21.32.43) [192.168.8.34]
37793 H=([10.21.32.43]) [192.168.8.34]
37794 .endd
37795 This can be confusing. Only the final address in square brackets can be relied
37796 on.
37797
37798 For locally generated messages (that is, messages not received over TCP/IP),
37799 the H field is omitted, and the U field contains the login name of the caller
37800 of Exim.
37801
37802 .cindex "authentication" "logging"
37803 .cindex "AUTH" "logging"
37804 For all messages, the P field specifies the protocol used to receive the
37805 message. This is the value that is stored in &$received_protocol$&. In the case
37806 of incoming SMTP messages, the value indicates whether or not any SMTP
37807 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37808 session was encrypted, there is an additional X field that records the cipher
37809 suite that was used.
37810
37811 .cindex log protocol
37812 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37813 hosts that have authenticated themselves using the SMTP AUTH command. The first
37814 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37815 there is an additional item A= followed by the name of the authenticator that
37816 was used. If an authenticated identification was set up by the authenticator's
37817 &%server_set_id%& option, this is logged too, separated by a colon from the
37818 authenticator name.
37819
37820 .cindex "size" "of message"
37821 The id field records the existing message id, if present. The size of the
37822 received message is given by the S field. When the message is delivered,
37823 headers may be removed or added, so that the size of delivered copies of the
37824 message may not correspond with this value (and indeed may be different to each
37825 other).
37826
37827 The &%log_selector%& option can be used to request the logging of additional
37828 data when a message is received. See section &<<SECTlogselector>>& below.
37829
37830
37831
37832 .section "Logging deliveries" "SECID252"
37833 .cindex "log" "delivery line"
37834 The format of the single-line entry in the main log that is written for every
37835 delivery is shown in one of the examples below, for local and remote
37836 deliveries, respectively. Each example has been split into multiple lines in order
37837 to fit it on the page:
37838 .code
37839 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37840   <marv@hitch.fict.example> R=localuser T=local_delivery
37841 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37842   monk@holistic.fict.example R=dnslookup T=remote_smtp
37843   H=holistic.fict.example [192.168.234.234]
37844 .endd
37845 For ordinary local deliveries, the original address is given in angle brackets
37846 after the final delivery address, which might be a pipe or a file. If
37847 intermediate address(es) exist between the original and the final address, the
37848 last of these is given in parentheses after the final address. The R and T
37849 fields record the router and transport that were used to process the address.
37850
37851 If SMTP AUTH was used for the delivery there is an additional item A=
37852 followed by the name of the authenticator that was used.
37853 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37854 option, this is logged too, separated by a colon from the authenticator name.
37855
37856 If a shadow transport was run after a successful local delivery, the log line
37857 for the successful delivery has an item added on the end, of the form
37858 .display
37859 &`ST=<`&&'shadow transport name'&&`>`&
37860 .endd
37861 If the shadow transport did not succeed, the error message is put in
37862 parentheses afterwards.
37863
37864 .cindex "asterisk" "after IP address"
37865 When more than one address is included in a single delivery (for example, two
37866 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37867 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37868 down a single SMTP connection, an asterisk follows the IP address in the log
37869 lines for the second and subsequent messages.
37870 When two or more messages are delivered down a single TLS connection, the
37871 DNS and some TLS-related information logged for the first message delivered
37872 will not be present in the log lines for the second and subsequent messages.
37873 TLS cipher information is still available.
37874
37875 .cindex "delivery" "cutthrough; logging"
37876 .cindex "cutthrough" "logging"
37877 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37878 line precedes the reception line, since cutthrough waits for a possible
37879 rejection from the destination in case it can reject the sourced item.
37880
37881 The generation of a reply message by a filter file gets logged as a
37882 &"delivery"& to the addressee, preceded by &">"&.
37883
37884 The &%log_selector%& option can be used to request the logging of additional
37885 data when a message is delivered. See section &<<SECTlogselector>>& below.
37886
37887
37888 .section "Discarded deliveries" "SECID253"
37889 .cindex "discarded messages"
37890 .cindex "message" "discarded"
37891 .cindex "delivery" "discarded; logging"
37892 When a message is discarded as a result of the command &"seen finish"& being
37893 obeyed in a filter file which generates no deliveries, a log entry of the form
37894 .code
37895 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37896   <low.club@bridge.example> R=userforward
37897 .endd
37898 is written, to record why no deliveries are logged. When a message is discarded
37899 because it is aliased to &":blackhole:"& the log line is like this:
37900 .code
37901 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37902   <hole@nowhere.example> R=blackhole_router
37903 .endd
37904
37905
37906 .section "Deferred deliveries" "SECID254"
37907 When a delivery is deferred, a line of the following form is logged:
37908 .code
37909 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37910   R=dnslookup T=smtp defer (146): Connection refused
37911 .endd
37912 In the case of remote deliveries, the error is the one that was given for the
37913 last IP address that was tried. Details of individual SMTP failures are also
37914 written to the log, so the above line would be preceded by something like
37915 .code
37916 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37917   mail1.endrest.example [192.168.239.239]: Connection refused
37918 .endd
37919 When a deferred address is skipped because its retry time has not been reached,
37920 a message is written to the log, but this can be suppressed by setting an
37921 appropriate value in &%log_selector%&.
37922
37923
37924
37925 .section "Delivery failures" "SECID255"
37926 .cindex "delivery" "failure; logging"
37927 If a delivery fails because an address cannot be routed, a line of the
37928 following form is logged:
37929 .code
37930 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37931   <jim@trek99.example>: unknown mail domain
37932 .endd
37933 If a delivery fails at transport time, the router and transport are shown, and
37934 the response from the remote host is included, as in this example:
37935 .code
37936 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37937   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37938   after pipelined RCPT TO:<ace400@pb.example>: host
37939   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37940   <ace400@pb.example>...Addressee unknown
37941 .endd
37942 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37943 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37944 disabling PIPELINING. The log lines for all forms of delivery failure are
37945 flagged with &`**`&.
37946
37947
37948
37949 .section "Fake deliveries" "SECID256"
37950 .cindex "delivery" "fake; logging"
37951 If a delivery does not actually take place because the &%-N%& option has been
37952 used to suppress it, a normal delivery line is written to the log, except that
37953 &"=>"& is replaced by &"*>"&.
37954
37955
37956
37957 .section "Completion" "SECID257"
37958 A line of the form
37959 .code
37960 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37961 .endd
37962 is written to the main log when a message is about to be removed from the spool
37963 at the end of its processing.
37964
37965
37966
37967
37968 .section "Summary of Fields in Log Lines" "SECID258"
37969 .cindex "log" "summary of fields"
37970 A summary of the field identifiers that are used in log lines is shown in
37971 the following table:
37972 .display
37973 &`A   `&        authenticator name (and optional id and sender)
37974 &`C   `&        SMTP confirmation on delivery
37975 &`    `&        command list for &"no mail in SMTP session"&
37976 &`CV  `&        certificate verification status
37977 &`D   `&        duration of &"no mail in SMTP session"&
37978 &`DKIM`&        domain verified in incoming message
37979 &`DN  `&        distinguished name from peer certificate
37980 &`DS  `&        DNSSEC secured lookups
37981 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
37982 &`F   `&        sender address (on delivery lines)
37983 &`H   `&        host name and IP address
37984 &`I   `&        local interface used
37985 &`id  `&        message id (from header) for incoming message
37986 &`K   `&        CHUNKING extension used
37987 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37988 &`M8S `&        8BITMIME status for incoming message
37989 &`P   `&        on &`<=`& lines: protocol used
37990 &`    `&        on &`=>`& and &`**`& lines: return path
37991 &`PRDR`&        PRDR extension used
37992 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37993 &`Q   `&        alternate queue name
37994 &`QT  `&        on &`=>`& lines: time spent on queue so far
37995 &`    `&        on &"Completed"& lines: time spent on queue
37996 &`R   `&        on &`<=`& lines: reference for local bounce
37997 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37998 &`RT  `&        on &`<=`& lines: time taken for reception
37999 &`S   `&        size of message in bytes
38000 &`SNI `&        server name indication from TLS client hello
38001 &`ST  `&        shadow transport name
38002 &`T   `&        on &`<=`& lines: message subject (topic)
38003 &`TFO `&        connection took advantage of TCP Fast Open
38004 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38005 &`U   `&        local user or RFC 1413 identity
38006 &`X   `&        TLS cipher suite
38007 .endd
38008
38009
38010 .section "Other log entries" "SECID259"
38011 Various other types of log entry are written from time to time. Most should be
38012 self-explanatory. Among the more common are:
38013
38014 .ilist
38015 .cindex "retry" "time not reached"
38016 &'retry time not reached'&&~&~An address previously suffered a temporary error
38017 during routing or local delivery, and the time to retry has not yet arrived.
38018 This message is not written to an individual message log file unless it happens
38019 during the first delivery attempt.
38020 .next
38021 &'retry time not reached for any host'&&~&~An address previously suffered
38022 temporary errors during remote delivery, and the retry time has not yet arrived
38023 for any of the hosts to which it is routed.
38024 .next
38025 .cindex "spool directory" "file locked"
38026 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38027 some other Exim process is already working on the message. This can be quite
38028 common if queue running processes are started at frequent intervals. The
38029 &'exiwhat'& utility script can be used to find out what Exim processes are
38030 doing.
38031 .next
38032 .cindex "error" "ignored"
38033 &'error ignored'&&~&~There are several circumstances that give rise to this
38034 message:
38035 .olist
38036 Exim failed to deliver a bounce message whose age was greater than
38037 &%ignore_bounce_errors_after%&. The bounce was discarded.
38038 .next
38039 A filter file set up a delivery using the &"noerror"& option, and the delivery
38040 failed. The delivery was discarded.
38041 .next
38042 A delivery set up by a router configured with
38043 . ==== As this is a nested list, any displays it contains must be indented
38044 . ==== as otherwise they are too far to the left.
38045 .code
38046     errors_to = <>
38047 .endd
38048 failed. The delivery was discarded.
38049 .endlist olist
38050 .next
38051 .cindex DKIM "log line"
38052 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38053 logging and the message has a DKIM signature header.
38054 .endlist ilist
38055
38056
38057
38058
38059
38060 .section "Reducing or increasing what is logged" "SECTlogselector"
38061 .cindex "log" "selectors"
38062 By setting the &%log_selector%& global option, you can disable some of Exim's
38063 default logging, or you can request additional logging. The value of
38064 &%log_selector%& is made up of names preceded by plus or minus characters. For
38065 example:
38066 .code
38067 log_selector = +arguments -retry_defer
38068 .endd
38069 The list of optional log items is in the following table, with the default
38070 selection marked by asterisks:
38071 .display
38072 &` 8bitmime                   `&  received 8BITMIME status
38073 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38074 &` address_rewrite            `&  address rewriting
38075 &` all_parents                `&  all parents in => lines
38076 &` arguments                  `&  command line arguments
38077 &`*connection_reject          `&  connection rejections
38078 &`*delay_delivery             `&  immediate delivery delayed
38079 &` deliver_time               `&  time taken to attempt delivery
38080 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38081 &`*dkim                       `&  DKIM verified domain on <= lines
38082 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38083 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38084 &` dnssec                     `&  DNSSEC secured lookups
38085 &`*etrn                       `&  ETRN commands
38086 &`*host_lookup_failed         `&  as it says
38087 &` ident_timeout              `&  timeout for ident connection
38088 &` incoming_interface         `&  local interface on <= and => lines
38089 &` incoming_port              `&  remote port on <= lines
38090 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38091 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38092 &`*msg_id                     `&  on <= lines, Message-ID: header value
38093 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38094 &` outgoing_interface         `&  local interface on => lines
38095 &` outgoing_port              `&  add remote port to => lines
38096 &`*queue_run                  `&  start and end queue runs
38097 &` queue_time                 `&  time on queue for one recipient
38098 &` queue_time_overall         `&  time on queue for whole message
38099 &` pid                        `&  Exim process id
38100 &` pipelining                 `&  PIPELINING use, on <= and => lines
38101 &` proxy                      `&  proxy address on <= and => lines
38102 &` receive_time               `&  time taken to receive message
38103 &` received_recipients        `&  recipients on <= lines
38104 &` received_sender            `&  sender on <= lines
38105 &`*rejected_header            `&  header contents on reject log
38106 &`*retry_defer                `&  &"retry time not reached"&
38107 &` return_path_on_delivery    `&  put return path on => and ** lines
38108 &` sender_on_delivery         `&  add sender to => lines
38109 &`*sender_verify_fail         `&  sender verification failures
38110 &`*size_reject                `&  rejection because too big
38111 &`*skip_delivery              `&  delivery skipped in a queue run
38112 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38113 &` smtp_connection            `&  incoming SMTP connections
38114 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38115 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38116 &` smtp_no_mail               `&  session with no MAIL commands
38117 &` smtp_protocol_error        `&  SMTP protocol errors
38118 &` smtp_syntax_error          `&  SMTP syntax errors
38119 &` subject                    `&  contents of &'Subject:'& on <= lines
38120 &`*tls_certificate_verified   `&  certificate verification status
38121 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38122 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38123 &` tls_sni                    `&  TLS SNI on <= lines
38124 &` unknown_in_list            `&  DNS lookup failed in list match
38125
38126 &` all                        `&  all of the above
38127 .endd
38128 See also the &%slow_lookup_log%& main configuration option,
38129 section &<<SECID99>>&
38130
38131 More details on each of these items follows:
38132
38133 .ilist
38134 .cindex "8BITMIME"
38135 .cindex "log" "8BITMIME"
38136 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38137 which may help in tracking down interoperability issues with ancient MTAs
38138 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38139 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38140 &`7BIT`& and &`8BITMIME`& respectively.
38141 .next
38142 .cindex "&%warn%& ACL verb" "log when skipping"
38143 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38144 its conditions cannot be evaluated, a log line to this effect is written if
38145 this log selector is set.
38146 .next
38147 .cindex "log" "rewriting"
38148 .cindex "rewriting" "logging"
38149 &%address_rewrite%&: This applies both to global rewrites and per-transport
38150 rewrites, but not to rewrites in filters run as an unprivileged user (because
38151 such users cannot access the log).
38152 .next
38153 .cindex "log" "full parentage"
38154 &%all_parents%&: Normally only the original and final addresses are logged on
38155 delivery lines; with this selector, intermediate parents are given in
38156 parentheses between them.
38157 .next
38158 .cindex "log" "Exim arguments"
38159 .cindex "Exim arguments, logging"
38160 &%arguments%&: This causes Exim to write the arguments with which it was called
38161 to the main log, preceded by the current working directory. This is a debugging
38162 feature, added to make it easier to find out how certain MUAs call
38163 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38164 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38165 that are empty or that contain white space are quoted. Non-printing characters
38166 are shown as escape sequences. This facility cannot log unrecognized arguments,
38167 because the arguments are checked before the configuration file is read. The
38168 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38169 between the caller and Exim.
38170 .next
38171 .cindex "log" "connection rejections"
38172 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38173 connection is rejected, for whatever reason.
38174 .next
38175 .cindex "log" "delayed delivery"
38176 .cindex "delayed delivery, logging"
38177 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38178 started for an incoming message because the load is too high or too many
38179 messages were received on one connection. Logging does not occur if no delivery
38180 process is started because &%queue_only%& is set or &%-odq%& was used.
38181 .next
38182 .cindex "log" "delivery duration"
38183 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38184 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38185 If millisecond logging is enabled, short times will be shown with greater
38186 precision, eg. &`DT=0.304s`&.
38187 .next
38188 .cindex "log" "message size on delivery"
38189 .cindex "size" "of message"
38190 &%delivery_size%&: For each delivery, the size of message delivered is added to
38191 the &"=>"& line, tagged with S=.
38192 .next
38193 .cindex log "DKIM verification"
38194 .cindex DKIM "verification logging"
38195 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38196 verifies successfully a tag of DKIM is added, with one of the verified domains.
38197 .next
38198 .cindex log "DKIM verification"
38199 .cindex DKIM "verification logging"
38200 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38201 .next
38202 .cindex "log" "dnslist defer"
38203 .cindex "DNS list" "logging defer"
38204 .cindex "black list (DNS)"
38205 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38206 DNS black list suffers a temporary error.
38207 .next
38208 .cindex log dnssec
38209 .cindex dnssec logging
38210 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38211 dns lookups gave secure results a tag of DS is added.
38212 For acceptance this covers the reverse and forward lookups for host name verification.
38213 It does not cover helo-name verification.
38214 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38215 .next
38216 .cindex "log" "ETRN commands"
38217 .cindex "ETRN" "logging"
38218 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38219 is run to determine whether or not it is actually accepted. An invalid ETRN
38220 command, or one received within a message transaction is not logged by this
38221 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38222 .next
38223 .cindex "log" "host lookup failure"
38224 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38225 any addresses, or when a lookup of an IP address fails to find a host name, a
38226 log line is written. This logging does not apply to direct DNS lookups when
38227 routing email addresses, but it does apply to &"byname"& lookups.
38228 .next
38229 .cindex "log" "ident timeout"
38230 .cindex "RFC 1413" "logging timeout"
38231 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38232 client's ident port times out.
38233 .next
38234 .cindex "log" "incoming interface"
38235 .cindex "log" "local interface"
38236 .cindex "log" "local address and port"
38237 .cindex "TCP/IP" "logging local address and port"
38238 .cindex "interface" "logging"
38239 &%incoming_interface%&: The interface on which a message was received is added
38240 to the &"<="& line as an IP address in square brackets, tagged by I= and
38241 followed by a colon and the port number. The local interface and port are also
38242 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38243 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
38244 The latter can be disabled by turning off the &%outgoing_interface%& option.
38245 .next
38246 .cindex log "incoming proxy address"
38247 .cindex proxy "logging proxy address"
38248 .cindex "TCP/IP" "logging proxy address"
38249 &%proxy%&: The internal (closest to the system running Exim) IP address
38250 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38251 on a proxied connection
38252 or the &"=>"& line for a message delivered on a proxied connection.
38253 See &<<SECTproxyInbound>>& for more information.
38254 .next
38255 .cindex "log" "incoming remote port"
38256 .cindex "port" "logging remote"
38257 .cindex "TCP/IP" "logging incoming remote port"
38258 .vindex "&$sender_fullhost$&"
38259 .vindex "&$sender_rcvhost$&"
38260 &%incoming_port%&: The remote port number from which a message was received is
38261 added to log entries and &'Received:'& header lines, following the IP address
38262 in square brackets, and separated from it by a colon. This is implemented by
38263 changing the value that is put in the &$sender_fullhost$& and
38264 &$sender_rcvhost$& variables. Recording the remote port number has become more
38265 important with the widening use of NAT (see RFC 2505).
38266 .next
38267 .cindex "log" "dropped connection"
38268 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38269 connection is unexpectedly dropped.
38270 .next
38271 .cindex "log" "millisecond timestamps"
38272 .cindex millisecond logging
38273 .cindex timestamps "millisecond, in logs"
38274 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38275 appended to the seconds value.
38276 .next
38277 .cindex "log" "message id"
38278 &%msg_id%&: The value of the Message-ID: header.
38279 .next
38280 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38281 This will be either because the message is a bounce, or was submitted locally
38282 (submission mode) without one.
38283 The field identifier will have an asterix appended: &"id*="&.
38284 .next
38285 .cindex "log" "outgoing interface"
38286 .cindex "log" "local interface"
38287 .cindex "log" "local address and port"
38288 .cindex "TCP/IP" "logging local address and port"
38289 .cindex "interface" "logging"
38290 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38291 interface on which a message was sent is added to delivery lines as an I= tag
38292 followed by IP address in square brackets. You can disable this by turning
38293 off the &%outgoing_interface%& option.
38294 .next
38295 .cindex "log" "outgoing remote port"
38296 .cindex "port" "logging outgoing remote"
38297 .cindex "TCP/IP" "logging outgoing remote port"
38298 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38299 containing => tags) following the IP address.
38300 The local port is also added if &%incoming_interface%& and
38301 &%outgoing_interface%& are both enabled.
38302 This option is not included in the default setting, because for most ordinary
38303 configurations, the remote port number is always 25 (the SMTP port), and the
38304 local port is a random ephemeral port.
38305 .next
38306 .cindex "log" "process ids in"
38307 .cindex "pid (process id)" "in log lines"
38308 &%pid%&: The current process id is added to every log line, in square brackets,
38309 immediately after the time and date.
38310 .next
38311 .cindex log pipelining
38312 .cindex pipelining "logging outgoing"
38313 &%pipelining%&: A field is added to delivery and accept
38314 log lines when the ESMTP PIPELINING extension was used.
38315 The field is a single "L".
38316
38317 On accept lines, where PIPELINING was offered but not used by the client,
38318 the field has a minus appended.
38319
38320 .cindex "pipelining" "early connection"
38321 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38322 accept "L" fields have a period appended if the feature was
38323 offered but not used, or an asterisk appended if used.
38324 Delivery "L" fields have an asterisk appended if used.
38325
38326 .next
38327 .cindex "log" "queue run"
38328 .cindex "queue runner" "logging"
38329 &%queue_run%&: The start and end of every queue run are logged.
38330 .next
38331 .cindex "log" "queue time"
38332 &%queue_time%&: The amount of time the message has been in the queue on the
38333 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38334 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38335 includes reception time as well as the delivery time for the current address.
38336 This means that it may be longer than the difference between the arrival and
38337 delivery log line times, because the arrival log line is not written until the
38338 message has been successfully received.
38339 If millisecond logging is enabled, short times will be shown with greater
38340 precision, eg. &`QT=1.578s`&.
38341 .next
38342 &%queue_time_overall%&: The amount of time the message has been in the queue on
38343 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38344 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38345 message, so it includes reception time as well as the total delivery time.
38346 .next
38347 .cindex "log" "receive duration"
38348 &%receive_time%&: For each message, the amount of real time it has taken to
38349 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38350 If millisecond logging is enabled, short times will be shown with greater
38351 precision, eg. &`RT=0.204s`&.
38352 .next
38353 .cindex "log" "recipients"
38354 &%received_recipients%&: The recipients of a message are listed in the main log
38355 as soon as the message is received. The list appears at the end of the log line
38356 that is written when a message is received, preceded by the word &"for"&. The
38357 addresses are listed after they have been qualified, but before any rewriting
38358 has taken place.
38359 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38360 in the list.
38361 .next
38362 .cindex "log" "sender reception"
38363 &%received_sender%&: The unrewritten original sender of a message is added to
38364 the end of the log line that records the message's arrival, after the word
38365 &"from"& (before the recipients if &%received_recipients%& is also set).
38366 .next
38367 .cindex "log" "header lines for rejection"
38368 &%rejected_header%&: If a message's header has been received at the time a
38369 rejection is written to the reject log, the complete header is added to the
38370 log. Header logging can be turned off individually for messages that are
38371 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38372 .next
38373 .cindex "log" "retry defer"
38374 &%retry_defer%&: A log line is written if a delivery is deferred because a
38375 retry time has not yet been reached. However, this &"retry time not reached"&
38376 message is always omitted from individual message logs after the first delivery
38377 attempt.
38378 .next
38379 .cindex "log" "return path"
38380 &%return_path_on_delivery%&: The return path that is being transmitted with
38381 the message is included in delivery and bounce lines, using the tag P=.
38382 This is omitted if no delivery actually happens, for example, if routing fails,
38383 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38384 .next
38385 .cindex "log" "sender on delivery"
38386 &%sender_on_delivery%&: The message's sender address is added to every delivery
38387 and bounce line, tagged by F= (for &"from"&).
38388 This is the original sender that was received with the message; it is not
38389 necessarily the same as the outgoing return path.
38390 .next
38391 .cindex "log" "sender verify failure"
38392 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38393 gives details of a sender verification failure is not written. Log lines for
38394 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38395 detail is lost.
38396 .next
38397 .cindex "log" "size rejection"
38398 &%size_reject%&: A log line is written whenever a message is rejected because
38399 it is too big.
38400 .next
38401 .cindex "log" "frozen messages; skipped"
38402 .cindex "frozen messages" "logging skipping"
38403 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38404 queue run because it is frozen or because another process is already delivering
38405 it.
38406 .cindex "&""spool file is locked""&"
38407 The message that is written is &"spool file is locked"&.
38408 .next
38409 .cindex "log" "smtp confirmation"
38410 .cindex "SMTP" "logging confirmation"
38411 .cindex "LMTP" "logging confirmation"
38412 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38413 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38414 A number of MTAs (including Exim) return an identifying string in this
38415 response.
38416 .next
38417 .cindex "log" "SMTP connections"
38418 .cindex "SMTP" "logging connections"
38419 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38420 established or closed, unless the connection is from a host that matches
38421 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38422 only when the closure is unexpected.) This applies to connections from local
38423 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38424 dropped in the middle of a message, a log line is always written, whether or
38425 not this selector is set, but otherwise nothing is written at the start and end
38426 of connections unless this selector is enabled.
38427
38428 For TCP/IP connections to an Exim daemon, the current number of connections is
38429 included in the log message for each new connection, but note that the count is
38430 reset if the daemon is restarted.
38431 Also, because connections are closed (and the closure is logged) in
38432 subprocesses, the count may not include connections that have been closed but
38433 whose termination the daemon has not yet noticed. Thus, while it is possible to
38434 match up the opening and closing of connections in the log, the value of the
38435 logged counts may not be entirely accurate.
38436 .next
38437 .cindex "log" "SMTP transaction; incomplete"
38438 .cindex "SMTP" "logging incomplete transactions"
38439 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38440 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38441 and the message sender plus any accepted recipients are included in the log
38442 line. This can provide evidence of dictionary attacks.
38443 .next
38444 .cindex "log" "non-MAIL SMTP sessions"
38445 .cindex "MAIL" "logging session without"
38446 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38447 connection terminates without having issued a MAIL command. This includes both
38448 the case when the connection is dropped, and the case when QUIT is used. It
38449 does not include cases where the connection is rejected right at the start (by
38450 an ACL, or because there are too many connections, or whatever). These cases
38451 already have their own log lines.
38452
38453 The log line that is written contains the identity of the client in the usual
38454 way, followed by D= and a time, which records the duration of the connection.
38455 If the connection was authenticated, this fact is logged exactly as it is for
38456 an incoming message, with an A= item. If the connection was encrypted, CV=,
38457 DN=, and X= items may appear as they do for an incoming message, controlled by
38458 the same logging options.
38459
38460 Finally, if any SMTP commands were issued during the connection, a C= item
38461 is added to the line, listing the commands that were used. For example,
38462 .code
38463 C=EHLO,QUIT
38464 .endd
38465 shows that the client issued QUIT straight after EHLO. If there were fewer
38466 than 20 commands, they are all listed. If there were more than 20 commands,
38467 the last 20 are listed, preceded by &"..."&. However, with the default
38468 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38469 have been aborted before 20 non-mail commands are processed.
38470 .next
38471 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38472 colon-separated, is appended to the A= item for a message arrival or delivery
38473 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38474 was accepted or used.
38475 .next
38476 .cindex "log" "SMTP protocol error"
38477 .cindex "SMTP" "logging protocol error"
38478 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38479 encountered. Exim does not have perfect detection of all protocol errors
38480 because of transmission delays and the use of pipelining. If PIPELINING has
38481 been advertised to a client, an Exim server assumes that the client will use
38482 it, and therefore it does not count &"expected"& errors (for example, RCPT
38483 received after rejecting MAIL) as protocol errors.
38484 .next
38485 .cindex "SMTP" "logging syntax errors"
38486 .cindex "SMTP" "syntax errors; logging"
38487 .cindex "SMTP" "unknown command; logging"
38488 .cindex "log" "unknown SMTP command"
38489 .cindex "log" "SMTP syntax error"
38490 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38491 encountered. An unrecognized command is treated as a syntax error. For an
38492 external connection, the host identity is given; for an internal connection
38493 using &%-bs%& the sender identification (normally the calling user) is given.
38494 .next
38495 .cindex "log" "subject"
38496 .cindex "subject, logging"
38497 &%subject%&: The subject of the message is added to the arrival log line,
38498 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38499 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38500 specifies whether characters with values greater than 127 should be logged
38501 unchanged, or whether they should be rendered as escape sequences.
38502 .next
38503 .cindex "log" "certificate verification"
38504 .cindex log DANE
38505 .cindex DANE logging
38506 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38507 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38508 verified
38509 using a CA trust anchor,
38510 &`CA=dane`& if using a DNS trust anchor,
38511 and &`CV=no`& if not.
38512 .next
38513 .cindex "log" "TLS cipher"
38514 .cindex "TLS" "logging cipher"
38515 &%tls_cipher%&: When a message is sent or received over an encrypted
38516 connection, the cipher suite used is added to the log line, preceded by X=.
38517 .next
38518 .cindex "log" "TLS peer DN"
38519 .cindex "TLS" "logging peer DN"
38520 &%tls_peerdn%&: When a message is sent or received over an encrypted
38521 connection, and a certificate is supplied by the remote host, the peer DN is
38522 added to the log line, preceded by DN=.
38523 .next
38524 .cindex "log" "TLS SNI"
38525 .cindex "TLS" "logging SNI"
38526 &%tls_sni%&: When a message is received over an encrypted connection, and
38527 the remote host provided the Server Name Indication extension, the SNI is
38528 added to the log line, preceded by SNI=.
38529 .next
38530 .cindex "log" "DNS failure in list"
38531 &%unknown_in_list%&: This setting causes a log entry to be written when the
38532 result of a list match is failure because a DNS lookup failed.
38533 .endlist
38534
38535
38536 .section "Message log" "SECID260"
38537 .cindex "message" "log file for"
38538 .cindex "log" "message log; description of"
38539 .cindex "&_msglog_& directory"
38540 .oindex "&%preserve_message_logs%&"
38541 In addition to the general log files, Exim writes a log file for each message
38542 that it handles. The names of these per-message logs are the message ids, and
38543 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38544 message log contains copies of the log lines that apply to the message. This
38545 makes it easier to inspect the status of an individual message without having
38546 to search the main log. A message log is deleted when processing of the message
38547 is complete, unless &%preserve_message_logs%& is set, but this should be used
38548 only with great care because they can fill up your disk very quickly.
38549
38550 On a heavily loaded system, it may be desirable to disable the use of
38551 per-message logs, in order to reduce disk I/O. This can be done by setting the
38552 &%message_logs%& option false.
38553 .ecindex IIDloggen
38554
38555
38556
38557
38558 . ////////////////////////////////////////////////////////////////////////////
38559 . ////////////////////////////////////////////////////////////////////////////
38560
38561 .chapter "Exim utilities" "CHAPutils"
38562 .scindex IIDutils "utilities"
38563 A number of utility scripts and programs are supplied with Exim and are
38564 described in this chapter. There is also the Exim Monitor, which is covered in
38565 the next chapter. The utilities described here are:
38566
38567 .itable none 0 0 3  7* left  15* left  40* left
38568 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38569   "list what Exim processes are doing"
38570 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38571 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38572 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38573 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38574                                                 various criteria"
38575 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38576 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38577   "extract statistics from the log"
38578 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38579   "check address acceptance from given IP"
38580 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38581 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38582 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38583 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38584 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38585 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38586 .endtable
38587
38588 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38589 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38590 &url(https://duncanthrax.net/exilog/) for details.
38591
38592
38593
38594
38595 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38596 .cindex "&'exiwhat'&"
38597 .cindex "process, querying"
38598 .cindex "SIGUSR1"
38599 On operating systems that can restart a system call after receiving a signal
38600 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38601 a line describing what it is doing to the file &_exim-process.info_& in the
38602 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38603 processes it can find, having first emptied the file. It then waits for one
38604 second to allow the Exim processes to react before displaying the results. In
38605 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38606 send the signal to the Exim processes, so it is normally run as root.
38607
38608 &*Warning*&: This is not an efficient process. It is intended for occasional
38609 use by system administrators. It is not sensible, for example, to set up a
38610 script that sends SIGUSR1 signals to Exim processes at short intervals.
38611
38612
38613 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38614 varies in different operating systems. Not only are different options used,
38615 but the format of the output is different. For this reason, there are some
38616 system configuration options that configure exactly how &'exiwhat'& works. If
38617 it doesn't seem to be working for you, check the following compile-time
38618 options:
38619 .display
38620 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38621 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38622 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38623 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38624 .endd
38625 An example of typical output from &'exiwhat'& is
38626 .code
38627 164 daemon: -q1h, listening on port 25
38628 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38629 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38630   [10.19.42.42] (editor@ref.example)
38631 10592 handling incoming call from [192.168.243.242]
38632 10628 accepting a local non-SMTP message
38633 .endd
38634 The first number in the output line is the process number. The third line has
38635 been split here, in order to fit it on the page.
38636
38637
38638
38639 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38640 .cindex "&'exiqgrep'&"
38641 .cindex "queue" "grepping"
38642 This utility is a Perl script contributed by Matt Hubbard. It runs
38643 .code
38644 exim -bpu
38645 .endd
38646 or (in case &*-a*& switch is specified)
38647 .code
38648 exim -bp
38649 .endd
38650 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38651 contain alternate exim configuration the queue management might be using.
38652
38653 to obtain a queue listing, and then greps the output to select messages
38654 that match given criteria. The following selection options are available:
38655
38656 .vlist
38657 .vitem &*-f*&&~<&'regex'&>
38658 Match the sender address using a case-insensitive search. The field that is
38659 tested is enclosed in angle brackets, so you can test for bounce messages with
38660 .code
38661 exiqgrep -f '^<>$'
38662 .endd
38663 .vitem &*-r*&&~<&'regex'&>
38664 Match a recipient address using a case-insensitive search. The field that is
38665 tested is not enclosed in angle brackets.
38666
38667 .vitem &*-s*&&~<&'regex'&>
38668 Match against the size field.
38669
38670 .vitem &*-y*&&~<&'seconds'&>
38671 Match messages that are younger than the given time.
38672
38673 .vitem &*-o*&&~<&'seconds'&>
38674 Match messages that are older than the given time.
38675
38676 .vitem &*-z*&
38677 Match only frozen messages.
38678
38679 .vitem &*-x*&
38680 Match only non-frozen messages.
38681
38682 .vitem &*-G*&&~<&'queuename'&>
38683 Match only messages in the given queue.  Without this, the default queue is searched.
38684 .endlist
38685
38686 The following options control the format of the output:
38687
38688 .vlist
38689 .vitem &*-c*&
38690 Display only the count of matching messages.
38691
38692 .vitem &*-l*&
38693 Long format &-- display the full message information as output by Exim. This is
38694 the default.
38695
38696 .vitem &*-i*&
38697 Display message ids only.
38698
38699 .vitem &*-b*&
38700 Brief format &-- one line per message.
38701
38702 .vitem &*-R*&
38703 Display messages in reverse order.
38704
38705 .vitem &*-a*&
38706 Include delivered recipients in queue listing.
38707 .endlist
38708
38709 There is one more option, &%-h%&, which outputs a list of options.
38710
38711
38712
38713 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38714 .cindex "&'exiqsumm'&"
38715 .cindex "queue" "summary"
38716 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38717 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38718 running a command such as
38719 .code
38720 exim -bp | exiqsumm
38721 .endd
38722 The output consists of one line for each domain that has messages waiting for
38723 it, as in the following example:
38724 .code
38725 3   2322   74m   66m  msn.com.example
38726 .endd
38727 Each line lists the number of pending deliveries for a domain, their total
38728 volume, and the length of time that the oldest and the newest messages have
38729 been waiting. Note that the number of pending deliveries is greater than the
38730 number of messages when messages have more than one recipient.
38731
38732 A summary line is output at the end. By default the output is sorted on the
38733 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38734 the output to be sorted by oldest message and by count of messages,
38735 respectively. There are also three options that split the messages for each
38736 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38737 separates frozen messages, and &%-s%& separates messages according to their
38738 sender.
38739
38740 The output of &'exim -bp'& contains the original addresses in the message, so
38741 this also applies to the output from &'exiqsumm'&. No domains from addresses
38742 generated by aliasing or forwarding are included (unless the &%one_time%&
38743 option of the &(redirect)& router has been used to convert them into &"top
38744 level"& addresses).
38745
38746
38747
38748
38749 .section "Extracting specific information from the log (exigrep)" &&&
38750          "SECTextspeinf"
38751 .cindex "&'exigrep'&"
38752 .cindex "log" "extracts; grepping for"
38753 The &'exigrep'& utility is a Perl script that searches one or more main log
38754 files for entries that match a given pattern. When it finds a match, it
38755 extracts all the log entries for the relevant message, not just those that
38756 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38757 given message, or all mail for a given user, or for a given host, for example.
38758 The input files can be in Exim log format or syslog format.
38759 If a matching log line is not associated with a specific message, it is
38760 included in &'exigrep'&'s output without any additional lines. The usage is:
38761 .display
38762 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38763 .endd
38764 If no log filenames are given on the command line, the standard input is read.
38765
38766 The &%-t%& argument specifies a number of seconds. It adds an additional
38767 condition for message selection. Messages that are complete are shown only if
38768 they spent more than <&'n'&> seconds in the queue.
38769
38770 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38771 makes it case-sensitive. This may give a performance improvement when searching
38772 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38773 option; with &%-I%& they do not. In both cases it is possible to change the
38774 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38775
38776 The &%-l%& option means &"literal"&, that is, treat all characters in the
38777 pattern as standing for themselves. Otherwise the pattern must be a Perl
38778 regular expression.
38779
38780 The &%-v%& option inverts the matching condition. That is, a line is selected
38781 if it does &'not'& match the pattern.
38782
38783 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38784 that are generated as a result/response to a message that &'exigrep'& matched
38785 normally.
38786
38787 Example of &%-M%&:
38788 user_a sends a message to user_b, which generates a bounce back to user_b. If
38789 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38790 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38791 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38792 when searching for &"user_a"& will show both messages since the bounce is
38793 &"related"& to or a &"result"& of the first message that was found by the
38794 search term.
38795
38796 If the location of a &'zcat'& command is known from the definition of
38797 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38798 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38799 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38800 autodetection of some well known compression extensions.
38801
38802
38803 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38804 .cindex "&'exipick'&"
38805 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38806 lists messages from the queue according to a variety of criteria. For details
38807 of &'exipick'&'s facilities, run &'exipick'& with
38808 the &%--help%& option.
38809
38810
38811 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38812 .cindex "log" "cycling local files"
38813 .cindex "cycling logs"
38814 .cindex "&'exicyclog'&"
38815 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38816 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38817 you are using log files with datestamps in their names (see section
38818 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38819 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38820 There are two command line options for &'exicyclog'&:
38821 .ilist
38822 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38823 default that is set when Exim is built. The default default is 10.
38824 .next
38825 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38826 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38827 overriding the script's default, which is to find the setting from Exim's
38828 configuration.
38829 .endlist
38830
38831 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38832 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38833 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38834 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38835 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38836 logs are handled similarly.
38837
38838 If the limit is greater than 99, the script uses 3-digit numbers such as
38839 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38840 to one that is greater, or &'vice versa'&, you will have to fix the names of
38841 any existing log files.
38842
38843 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38844 the end are deleted. All files with numbers greater than 01 are compressed,
38845 using a compression command which is configured by the COMPRESS_COMMAND
38846 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38847 root &%crontab%& entry of the form
38848 .code
38849 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38850 .endd
38851 assuming you have used the name &"exim"& for the Exim user. You can run
38852 &'exicyclog'& as root if you wish, but there is no need.
38853
38854
38855
38856 .section "Mail statistics (eximstats)" "SECTmailstat"
38857 .cindex "statistics"
38858 .cindex "&'eximstats'&"
38859 A Perl script called &'eximstats'& is provided for extracting statistical
38860 information from log files. The output is either plain text, or HTML.
38861 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38862 . --- 404 error and everything else points to that.
38863
38864 The &'eximstats'& script has been hacked about quite a bit over time. The
38865 latest version is the result of some extensive revision by Steve Campbell. A
38866 lot of information is given by default, but there are options for suppressing
38867 various parts of it. Following any options, the arguments to the script are a
38868 list of files, which should be main log files. For example:
38869 .code
38870 eximstats -nr /var/spool/exim/log/mainlog.01
38871 .endd
38872 By default, &'eximstats'& extracts information about the number and volume of
38873 messages received from or delivered to various hosts. The information is sorted
38874 both by message count and by volume, and the top fifty hosts in each category
38875 are listed on the standard output. Similar information, based on email
38876 addresses or domains instead of hosts can be requested by means of various
38877 options. For messages delivered and received locally, similar statistics are
38878 also produced per user.
38879
38880 The output also includes total counts and statistics about delivery errors, and
38881 histograms showing the number of messages received and deliveries made in each
38882 hour of the day. A delivery with more than one address in its envelope (for
38883 example, an SMTP transaction with more than one RCPT command) is counted
38884 as a single delivery by &'eximstats'&.
38885
38886 Though normally more deliveries than receipts are reported (as messages may
38887 have multiple recipients), it is possible for &'eximstats'& to report more
38888 messages received than delivered, even though the queue is empty at the start
38889 and end of the period in question. If an incoming message contains no valid
38890 recipients, no deliveries are recorded for it. A bounce message is handled as
38891 an entirely separate message.
38892
38893 &'eximstats'& always outputs a grand total summary giving the volume and number
38894 of messages received and deliveries made, and the number of hosts involved in
38895 each case. It also outputs the number of messages that were delayed (that is,
38896 not completely delivered at the first attempt), and the number that had at
38897 least one address that failed.
38898
38899 The remainder of the output is in sections that can be independently disabled
38900 or modified by various options. It consists of a summary of deliveries by
38901 transport, histograms of messages received and delivered per time interval
38902 (default per hour), information about the time messages spent in the queue,
38903 a list of relayed messages, lists of the top fifty sending hosts, local
38904 senders, destination hosts, and destination local users by count and by volume,
38905 and a list of delivery errors that occurred.
38906
38907 The relay information lists messages that were actually relayed, that is, they
38908 came from a remote host and were directly delivered to some other remote host,
38909 without being processed (for example, for aliasing or forwarding) locally.
38910
38911 There are quite a few options for &'eximstats'& to control exactly what it
38912 outputs. These are documented in the Perl script itself, and can be extracted
38913 by running the command &(perldoc)& on the script. For example:
38914 .code
38915 perldoc /usr/exim/bin/eximstats
38916 .endd
38917
38918 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38919 .cindex "&'exim_checkaccess'&"
38920 .cindex "policy control" "checking access"
38921 .cindex "checking access"
38922 The &%-bh%& command line argument allows you to run a fake SMTP session with
38923 debugging output, in order to check what Exim is doing when it is applying
38924 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38925 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38926 sometimes you just want to answer the question &"Does this address have
38927 access?"& without bothering with any further details.
38928
38929 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38930 two arguments, an IP address and an email address:
38931 .code
38932 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38933 .endd
38934 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38935 given email address would be accepted in a RCPT command in a TCP/IP
38936 connection from the host with the given IP address. The output of the utility
38937 is either the word &"accepted"&, or the SMTP error response, for example:
38938 .code
38939 Rejected:
38940 550 Relay not permitted
38941 .endd
38942 When running this test, the utility uses &`<>`& as the envelope sender address
38943 for the MAIL command, but you can change this by providing additional
38944 options. These are passed directly to the Exim command. For example, to specify
38945 that the test is to be run with the sender address &'himself@there.example'&
38946 you can use:
38947 .code
38948 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38949                  -f himself@there.example
38950 .endd
38951 Note that these additional Exim command line items must be given after the two
38952 mandatory arguments.
38953
38954 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38955 while running its checks. You can run checks that include callouts by using
38956 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38957
38958
38959
38960 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38961 .cindex "DBM" "building dbm files"
38962 .cindex "building DBM files"
38963 .cindex "&'exim_dbmbuild'&"
38964 .cindex "lower casing"
38965 .cindex "binary zero" "in lookup key"
38966 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38967 the format used by the &(lsearch)& lookup (see section
38968 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38969 names as keys and the remainder of the information as data. The lower-casing
38970 can be prevented by calling the program with the &%-nolc%& option.
38971
38972 A terminating zero is included as part of the key string. This is expected by
38973 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38974 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38975 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38976 files.
38977
38978 The program requires two arguments: the name of the input file (which can be a
38979 single hyphen to indicate the standard input), and the name of the output file.
38980 It creates the output under a temporary name, and then renames it if all went
38981 well.
38982
38983 .cindex "USE_DB"
38984 If the native DB interface is in use (USE_DB is set in a compile-time
38985 configuration file &-- this is common in free versions of Unix) the two
38986 filenames must be different, because in this mode the Berkeley DB functions
38987 create a single output file using exactly the name given. For example,
38988 .code
38989 exim_dbmbuild /etc/aliases /etc/aliases.db
38990 .endd
38991 reads the system alias file and creates a DBM version of it in
38992 &_/etc/aliases.db_&.
38993
38994 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38995 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38996 environment, the suffixes are added to the second argument of
38997 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38998 when the Berkeley functions are used in compatibility mode (though this is not
38999 recommended), because in that case it adds a &_.db_& suffix to the filename.
39000
39001 If a duplicate key is encountered, the program outputs a warning, and when it
39002 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39003 option is used. By default, only the first of a set of duplicates is used &--
39004 this makes it compatible with &(lsearch)& lookups. There is an option
39005 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39006 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39007 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39008 return code is 2.
39009
39010
39011
39012
39013 .section "Finding individual retry times (exinext)" "SECTfinindret"
39014 .cindex "retry" "times"
39015 .cindex "&'exinext'&"
39016 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39017 fish specific information out of the retry database. Given a mail domain (or a
39018 complete address), it looks up the hosts for that domain, and outputs any retry
39019 information for the hosts or for the domain. At present, the retry information
39020 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39021 output. For example:
39022 .code
39023 $ exinext piglet@milne.fict.example
39024 kanga.milne.example:192.168.8.1 error 146: Connection refused
39025   first failed: 21-Feb-1996 14:57:34
39026   last tried:   21-Feb-1996 14:57:34
39027   next try at:  21-Feb-1996 15:02:34
39028 roo.milne.example:192.168.8.3 error 146: Connection refused
39029   first failed: 20-Jan-1996 13:12:08
39030   last tried:   21-Feb-1996 11:42:03
39031   next try at:  21-Feb-1996 19:42:03
39032   past final cutoff time
39033 .endd
39034 You can also give &'exinext'& a local part, without a domain, and it
39035 will give any retry information for that local part in your default domain.
39036 A message id can be used to obtain retry information pertaining to a specific
39037 message. This exists only when an attempt to deliver a message to a remote host
39038 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39039 &'exinext'& is not particularly efficient, but then it is not expected to be
39040 run very often.
39041
39042 The &'exinext'& utility calls Exim to find out information such as the location
39043 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39044 passed on to the &'exim'& commands. The first specifies an alternate Exim
39045 configuration file, and the second sets macros for use within the configuration
39046 file. These features are mainly to help in testing, but might also be useful in
39047 environments where more than one configuration file is in use.
39048
39049
39050
39051 .section "Hints database maintenance" "SECThindatmai"
39052 .cindex "hints database" "maintenance"
39053 .cindex "maintaining Exim's hints database"
39054 Three utility programs are provided for maintaining the DBM files that Exim
39055 uses to contain its delivery hint information. Each program requires two
39056 arguments. The first specifies the name of Exim's spool directory, and the
39057 second is the name of the database it is to operate on. These are as follows:
39058
39059 .ilist
39060 &'retry'&: the database of retry information
39061 .next
39062 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39063 for remote hosts
39064 .next
39065 &'callout'&: the callout cache
39066 .next
39067 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39068 .next
39069 &'misc'&: other hints data
39070 .endlist
39071
39072 The &'misc'& database is used for
39073
39074 .ilist
39075 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39076 .next
39077 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39078 &(smtp)& transport)
39079 .next
39080 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39081 in a transport)
39082 .endlist
39083
39084
39085
39086 .section "exim_dumpdb" "SECID261"
39087 .cindex "&'exim_dumpdb'&"
39088 The entire contents of a database are written to the standard output by the
39089 &'exim_dumpdb'& program, which has no options or arguments other than the
39090 spool and database names. For example, to dump the retry database:
39091 .code
39092 exim_dumpdb /var/spool/exim retry
39093 .endd
39094 Two lines of output are produced for each entry:
39095 .code
39096 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39097 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39098 .endd
39099 The first item on the first line is the key of the record. It starts with one
39100 of the letters R, or T, depending on whether it refers to a routing or
39101 transport retry. For a local delivery, the next part is the local address; for
39102 a remote delivery it is the name of the remote host, followed by its failing IP
39103 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39104 transport). If the remote port is not the standard one (port 25), it is added
39105 to the IP address. Then there follows an error code, an additional error code,
39106 and a textual description of the error.
39107
39108 The three times on the second line are the time of first failure, the time of
39109 the last delivery attempt, and the computed time for the next attempt. The line
39110 ends with an asterisk if the cutoff time for the last retry rule has been
39111 exceeded.
39112
39113 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39114 consists of a host name followed by a list of ids for messages that are or were
39115 waiting to be delivered to that host. If there are a very large number for any
39116 one host, continuation records, with a sequence number added to the host name,
39117 may be seen. The data in these records is often out of date, because a message
39118 may be routed to several alternative hosts, and Exim makes no effort to keep
39119 cross-references.
39120
39121
39122
39123 .section "exim_tidydb" "SECID262"
39124 .cindex "&'exim_tidydb'&"
39125 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39126 database. If run with no options, it removes all records that are more than 30
39127 days old. The age is calculated from the date and time that the record was last
39128 updated. Note that, in the case of the retry database, it is &'not'& the time
39129 since the first delivery failure. Information about a host that has been down
39130 for more than 30 days will remain in the database, provided that the record is
39131 updated sufficiently often.
39132
39133 The cutoff date can be altered by means of the &%-t%& option, which must be
39134 followed by a time. For example, to remove all records older than a week from
39135 the retry database:
39136 .code
39137 exim_tidydb -t 7d /var/spool/exim retry
39138 .endd
39139 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39140 message ids. In the former these appear as data in records keyed by host &--
39141 they were messages that were waiting for that host &-- and in the latter they
39142 are the keys for retry information for messages that have suffered certain
39143 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39144 message ids in database records are those of messages that are still on the
39145 queue. Message ids for messages that no longer exist are removed from
39146 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39147 For the &'retry'& database, records whose keys are non-existent message ids are
39148 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39149 whenever it removes information from the database.
39150
39151 Certain records are automatically removed by Exim when they are no longer
39152 needed, but others are not. For example, if all the MX hosts for a domain are
39153 down, a retry record is created for each one. If the primary MX host comes back
39154 first, its record is removed when Exim successfully delivers to it, but the
39155 records for the others remain because Exim has not tried to use those hosts.
39156
39157 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39158 hints databases. You should do this at a quiet time of day, because it requires
39159 a database to be locked (and therefore inaccessible to Exim) while it does its
39160 work. Removing records from a DBM file does not normally make the file smaller,
39161 but all the common DBM libraries are able to re-use the space that is released.
39162 After an initial phase of increasing in size, the databases normally reach a
39163 point at which they no longer get any bigger, as long as they are regularly
39164 tidied.
39165
39166 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39167 databases is likely to keep on increasing.
39168
39169
39170
39171
39172 .section "exim_fixdb" "SECID263"
39173 .cindex "&'exim_fixdb'&"
39174 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39175 Its main use is for testing Exim, but it might also be occasionally useful for
39176 getting round problems in a live system. It has no options, and its interface
39177 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39178 key of a database record can then be entered, and the data for that record is
39179 displayed.
39180
39181 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39182 except the &'retry'& database, that is the only operation that can be carried
39183 out. For the &'retry'& database, each field is output preceded by a number, and
39184 data for individual fields can be changed by typing the field number followed
39185 by new data, for example:
39186 .code
39187 > 4 951102:1000
39188 .endd
39189 resets the time of the next delivery attempt. Time values are given as a
39190 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39191 used as optional separators.
39192
39193
39194
39195
39196 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39197 .cindex "mailbox" "maintenance"
39198 .cindex "&'exim_lock'&"
39199 .cindex "locking mailboxes"
39200 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39201 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39202 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39203 a user agent while investigating a problem. The utility requires the name of
39204 the file as its first argument. If the locking is successful, the second
39205 argument is run as a command (using C's &[system()]& function); if there is no
39206 second argument, the value of the SHELL environment variable is used; if this
39207 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39208 is unlocked and the utility ends. The following options are available:
39209
39210 .vlist
39211 .vitem &%-fcntl%&
39212 Use &[fcntl()]& locking on the open mailbox.
39213
39214 .vitem &%-flock%&
39215 Use &[flock()]& locking on the open mailbox, provided the operating system
39216 supports it.
39217
39218 .vitem &%-interval%&
39219 This must be followed by a number, which is a number of seconds; it sets the
39220 interval to sleep between retries (default 3).
39221
39222 .vitem &%-lockfile%&
39223 Create a lock file before opening the mailbox.
39224
39225 .vitem &%-mbx%&
39226 Lock the mailbox using MBX rules.
39227
39228 .vitem &%-q%&
39229 Suppress verification output.
39230
39231 .vitem &%-retries%&
39232 This must be followed by a number; it sets the number of times to try to get
39233 the lock (default 10).
39234
39235 .vitem &%-restore_time%&
39236 This option causes &%exim_lock%& to restore the modified and read times to the
39237 locked file before exiting. This allows you to access a locked mailbox (for
39238 example, to take a backup copy) without disturbing the times that the user
39239 subsequently sees.
39240
39241 .vitem &%-timeout%&
39242 This must be followed by a number, which is a number of seconds; it sets a
39243 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39244 default), a non-blocking call is used.
39245
39246 .vitem &%-v%&
39247 Generate verbose output.
39248 .endlist
39249
39250 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39251 default is to create a lock file and also to use &[fcntl()]& locking on the
39252 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39253 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39254 requires that the directory containing the file be writeable. Locking by lock
39255 file does not last forever; Exim assumes that a lock file is expired if it is
39256 more than 30 minutes old.
39257
39258 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39259 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39260 to be taken out on the open mailbox, and an exclusive lock on the file
39261 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39262 number of the mailbox file. When the locking is released, if an exclusive lock
39263 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39264
39265 The default output contains verification of the locking that takes place. The
39266 &%-v%& option causes some additional information to be given. The &%-q%& option
39267 suppresses all output except error messages.
39268
39269 A command such as
39270 .code
39271 exim_lock /var/spool/mail/spqr
39272 .endd
39273 runs an interactive shell while the file is locked, whereas
39274 .display
39275 &`exim_lock -q /var/spool/mail/spqr <<End`&
39276 <&'some commands'&>
39277 &`End`&
39278 .endd
39279 runs a specific non-interactive sequence of commands while the file is locked,
39280 suppressing all verification output. A single command can be run by a command
39281 such as
39282 .code
39283 exim_lock -q /var/spool/mail/spqr \
39284   "cp /var/spool/mail/spqr /some/where"
39285 .endd
39286 Note that if a command is supplied, it must be entirely contained within the
39287 second argument &-- hence the quotes.
39288 .ecindex IIDutils
39289
39290
39291 . ////////////////////////////////////////////////////////////////////////////
39292 . ////////////////////////////////////////////////////////////////////////////
39293
39294 .chapter "The Exim monitor" "CHAPeximon"
39295 .scindex IIDeximon "Exim monitor" "description"
39296 .cindex "X-windows"
39297 .cindex "&'eximon'&"
39298 .cindex "Local/eximon.conf"
39299 .cindex "&_exim_monitor/EDITME_&"
39300 The Exim monitor is an application which displays in an X window information
39301 about the state of Exim's queue and what Exim is doing. An admin user can
39302 perform certain operations on messages from this GUI interface; however all
39303 such facilities are also available from the command line, and indeed, the
39304 monitor itself makes use of the command line to perform any actions requested.
39305
39306
39307
39308 .section "Running the monitor" "SECID264"
39309 The monitor is started by running the script called &'eximon'&. This is a shell
39310 script that sets up a number of environment variables, and then runs the
39311 binary called &_eximon.bin_&. The default appearance of the monitor window can
39312 be changed by editing the &_Local/eximon.conf_& file created by editing
39313 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39314 parameters are for.
39315
39316 The parameters that get built into the &'eximon'& script can be overridden for
39317 a particular invocation by setting up environment variables of the same names,
39318 preceded by &`EXIMON_`&. For example, a shell command such as
39319 .code
39320 EXIMON_LOG_DEPTH=400 eximon
39321 .endd
39322 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39323 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39324 overrides the Exim log file configuration. This makes it possible to have
39325 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39326 syslog messages are routed to a file on the local host.
39327
39328 X resources can be used to change the appearance of the window in the normal
39329 way. For example, a resource setting of the form
39330 .code
39331 Eximon*background: gray94
39332 .endd
39333 changes the colour of the background to light grey rather than white. The
39334 stripcharts are drawn with both the data lines and the reference lines in
39335 black. This means that the reference lines are not visible when on top of the
39336 data. However, their colour can be changed by setting a resource called
39337 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39338 For example, if your X server is running Unix, you could set up lighter
39339 reference lines in the stripcharts by obeying
39340 .code
39341 xrdb -merge <<End
39342 Eximon*highlight: gray
39343 End
39344 .endd
39345 .cindex "admin user"
39346 In order to see the contents of messages in the queue, and to operate on them,
39347 &'eximon'& must either be run as root or by an admin user.
39348
39349 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39350 contain X11 resource parameters interpreted by the X11 library.  In addition,
39351 if the first parameter starts with the string "gdb" then it is removed and the
39352 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39353 versioned variants of gdb can be invoked).
39354
39355 The monitor's window is divided into three parts. The first contains one or
39356 more stripcharts and two action buttons, the second contains a &"tail"& of the
39357 main log file, and the third is a display of the queue of messages awaiting
39358 delivery, with two more action buttons. The following sections describe these
39359 different parts of the display.
39360
39361
39362
39363
39364 .section "The stripcharts" "SECID265"
39365 .cindex "stripchart"
39366 The first stripchart is always a count of messages in the queue. Its name can
39367 be configured by setting QUEUE_STRIPCHART_NAME in the
39368 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39369 configuration script by regular expression matches on log file entries, making
39370 it possible to display, for example, counts of messages delivered to certain
39371 hosts or using certain transports. The supplied defaults display counts of
39372 received and delivered messages, and of local and SMTP deliveries. The default
39373 period between stripchart updates is one minute; this can be adjusted by a
39374 parameter in the &_Local/eximon.conf_& file.
39375
39376 The stripchart displays rescale themselves automatically as the value they are
39377 displaying changes. There are always 10 horizontal lines in each chart; the
39378 title string indicates the value of each division when it is greater than one.
39379 For example, &"x2"& means that each division represents a value of 2.
39380
39381 It is also possible to have a stripchart which shows the percentage fullness of
39382 a particular disk partition, which is useful when local deliveries are confined
39383 to a single partition.
39384
39385 .cindex "&%statvfs%& function"
39386 This relies on the availability of the &[statvfs()]& function or equivalent in
39387 the operating system. Most, but not all versions of Unix that support Exim have
39388 this. For this particular stripchart, the top of the chart always represents
39389 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39390 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39391 &_Local/eximon.conf_& file.
39392
39393
39394
39395
39396 .section "Main action buttons" "SECID266"
39397 .cindex "size" "of monitor window"
39398 .cindex "Exim monitor" "window size"
39399 .cindex "window size"
39400 Below the stripcharts there is an action button for quitting the monitor. Next
39401 to this is another button marked &"Size"&. They are placed here so that
39402 shrinking the window to its default minimum size leaves just the queue count
39403 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39404 the window to expand to its maximum size, unless it is already at the maximum,
39405 in which case it is reduced to its minimum.
39406
39407 When expanding to the maximum, if the window cannot be fully seen where it
39408 currently is, it is moved back to where it was the last time it was at full
39409 size. When it is expanding from its minimum size, the old position is
39410 remembered, and next time it is reduced to the minimum it is moved back there.
39411
39412 The idea is that you can keep a reduced window just showing one or two
39413 stripcharts at a convenient place on your screen, easily expand it to show
39414 the full window when required, and just as easily put it back to what it was.
39415 The idea is copied from what the &'twm'& window manager does for its
39416 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39417 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39418
39419 Normally, the monitor starts up with the window at its full size, but it can be
39420 built so that it starts up with the window at its smallest size, by setting
39421 START_SMALL=yes in &_Local/eximon.conf_&.
39422
39423
39424
39425 .section "The log display" "SECID267"
39426 .cindex "log" "tail of; in monitor"
39427 The second section of the window is an area in which a display of the tail of
39428 the main log is maintained.
39429 To save space on the screen, the timestamp on each log line is shortened by
39430 removing the date and, if &%log_timezone%& is set, the timezone.
39431 The log tail is not available when the only destination for logging data is
39432 syslog, unless the syslog lines are routed to a local file whose name is passed
39433 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39434
39435 The log sub-window has a scroll bar at its lefthand side which can be used to
39436 move back to look at earlier text, and the up and down arrow keys also have a
39437 scrolling effect. The amount of log that is kept depends on the setting of
39438 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39439 to use. When this is full, the earlier 50% of data is discarded &-- this is
39440 much more efficient than throwing it away line by line. The sub-window also has
39441 a horizontal scroll bar for accessing the ends of long log lines. This is the
39442 only means of horizontal scrolling; the right and left arrow keys are not
39443 available. Text can be cut from this part of the window using the mouse in the
39444 normal way. The size of this subwindow is controlled by parameters in the
39445 configuration file &_Local/eximon.conf_&.
39446
39447 Searches of the text in the log window can be carried out by means of the ^R
39448 and ^S keystrokes, which default to a reverse and a forward search,
39449 respectively. The search covers only the text that is displayed in the window.
39450 It cannot go further back up the log.
39451
39452 The point from which the search starts is indicated by a caret marker. This is
39453 normally at the end of the text in the window, but can be positioned explicitly
39454 by pointing and clicking with the left mouse button, and is moved automatically
39455 by a successful search. If new text arrives in the window when it is scrolled
39456 back, the caret remains where it is, but if the window is not scrolled back,
39457 the caret is moved to the end of the new text.
39458
39459 Pressing ^R or ^S pops up a window into which the search text can be typed.
39460 There are buttons for selecting forward or reverse searching, for carrying out
39461 the search, and for cancelling. If the &"Search"& button is pressed, the search
39462 happens and the window remains so that further searches can be done. If the
39463 &"Return"& key is pressed, a single search is done and the window is closed. If
39464 ^C is typed the search is cancelled.
39465
39466 The searching facility is implemented using the facilities of the Athena text
39467 widget. By default this pops up a window containing both &"search"& and
39468 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39469 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39470 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39471 provided version of &%TextPop%& when the remaining parts of the text widget
39472 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39473 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39474 on these systems, at the expense of having unwanted items in the search popup
39475 window.
39476
39477
39478
39479 .section "The queue display" "SECID268"
39480 .cindex "queue" "display in monitor"
39481 The bottom section of the monitor window contains a list of all messages that
39482 are in the queue, which includes those currently being received or delivered,
39483 as well as those awaiting delivery. The size of this subwindow is controlled by
39484 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39485 at which it is updated is controlled by another parameter in the same file &--
39486 the default is 5 minutes, since queue scans can be quite expensive. However,
39487 there is an &"Update"& action button just above the display which can be used
39488 to force an update of the queue display at any time.
39489
39490 When a host is down for some time, a lot of pending mail can build up for it,
39491 and this can make it hard to deal with other messages in the queue. To help
39492 with this situation there is a button next to &"Update"& called &"Hide"&. If
39493 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39494 type anything in here and press &"Return"&, the text is added to a chain of
39495 such texts, and if every undelivered address in a message matches at least one
39496 of the texts, the message is not displayed.
39497
39498 If there is an address that does not match any of the texts, all the addresses
39499 are displayed as normal. The matching happens on the ends of addresses so, for
39500 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39501 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39502 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39503 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39504 a hide request is automatically cancelled after one hour.
39505
39506 While the dialogue box is displayed, you can't press any buttons or do anything
39507 else to the monitor window. For this reason, if you want to cut text from the
39508 queue display to use in the dialogue box, you have to do the cutting before
39509 pressing the &"Hide"& button.
39510
39511 The queue display contains, for each unhidden queued message, the length of
39512 time it has been in the queue, the size of the message, the message id, the
39513 message sender, and the first undelivered recipient, all on one line. If it is
39514 a bounce message, the sender is shown as &"<>"&. If there is more than one
39515 recipient to which the message has not yet been delivered, subsequent ones are
39516 listed on additional lines, up to a maximum configured number, following which
39517 an ellipsis is displayed. Recipients that have already received the message are
39518 not shown.
39519
39520 .cindex "frozen messages" "display"
39521 If a message is frozen, an asterisk is displayed at the left-hand side.
39522
39523 The queue display has a vertical scroll bar, and can also be scrolled by means
39524 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39525 The text searching facilities, as described above for the log window, are also
39526 available, but the caret is always moved to the end of the text when the queue
39527 display is updated.
39528
39529
39530
39531 .section "The queue menu" "SECID269"
39532 .cindex "queue" "menu in monitor"
39533 If the &%shift%& key is held down and the left button is clicked when the mouse
39534 pointer is over the text for any message, an action menu pops up, and the first
39535 line of the queue display for the message is highlighted. This does not affect
39536 any selected text.
39537
39538 If you want to use some other event for popping up the menu, you can set the
39539 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39540 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39541 value set in this parameter is a standard X event description. For example, to
39542 run eximon using &%ctrl%& rather than &%shift%& you could use
39543 .code
39544 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39545 .endd
39546 The title of the menu is the message id, and it contains entries which act as
39547 follows:
39548
39549 .ilist
39550 &'message log'&: The contents of the message log for the message are displayed
39551 in a new text window.
39552 .next
39553 &'headers'&: Information from the spool file that contains the envelope
39554 information and headers is displayed in a new text window. See chapter
39555 &<<CHAPspool>>& for a description of the format of spool files.
39556 .next
39557 &'body'&: The contents of the spool file containing the body of the message are
39558 displayed in a new text window. There is a default limit of 20,000 bytes to the
39559 amount of data displayed. This can be changed by setting the BODY_MAX
39560 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39561 .next
39562 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39563 delivery of the message. This causes an automatic thaw if the message is
39564 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39565 a new text window. The delivery is run in a separate process, to avoid holding
39566 up the monitor while the delivery proceeds.
39567 .next
39568 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39569 that the message be frozen.
39570 .next
39571 .cindex "thawing messages"
39572 .cindex "unfreezing messages"
39573 .cindex "frozen messages" "thawing"
39574 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39575 that the message be thawed.
39576 .next
39577 .cindex "delivery" "forcing failure"
39578 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39579 that Exim gives up trying to deliver the message. A bounce message is generated
39580 for any remaining undelivered addresses.
39581 .next
39582 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39583 that the message be deleted from the system without generating a bounce
39584 message.
39585 .next
39586 &'add recipient'&: A dialog box is displayed into which a recipient address can
39587 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39588 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39589 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39590 causes a call to Exim to be made using the &%-Mar%& option to request that an
39591 additional recipient be added to the message, unless the entry box is empty, in
39592 which case no action is taken.
39593 .next
39594 &'mark delivered'&: A dialog box is displayed into which a recipient address
39595 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39596 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39597 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39598 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39599 recipient address as already delivered, unless the entry box is empty, in which
39600 case no action is taken.
39601 .next
39602 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39603 mark all recipient addresses as already delivered.
39604 .next
39605 &'edit sender'&: A dialog box is displayed initialized with the current
39606 sender's address. Pressing RETURN causes a call to Exim to be made using the
39607 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39608 in which case no action is taken. If you want to set an empty sender (as in
39609 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39610 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39611 the address is qualified with that domain.
39612 .endlist
39613
39614 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39615 other cases when a call to Exim is made, if there is any output from Exim (in
39616 particular, if the command fails) a window containing the command and the
39617 output is displayed. Otherwise, the results of the action are normally apparent
39618 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39619 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39620 if no output is generated.
39621
39622 The queue display is automatically updated for actions such as freezing and
39623 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39624 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39625 force an update of the display after one of these actions.
39626
39627 In any text window that is displayed as result of a menu action, the normal
39628 cut-and-paste facility is available, and searching can be carried out using ^R
39629 and ^S, as described above for the log tail window.
39630 .ecindex IIDeximon
39631
39632
39633
39634
39635
39636 . ////////////////////////////////////////////////////////////////////////////
39637 . ////////////////////////////////////////////////////////////////////////////
39638
39639 .chapter "Security considerations" "CHAPsecurity"
39640 .scindex IIDsecurcon "security" "discussion of"
39641 This chapter discusses a number of issues concerned with security, some of
39642 which are also covered in other parts of this manual.
39643
39644 For reasons that this author does not understand, some people have promoted
39645 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39646 existence of this chapter in the documentation. However, the intent of the
39647 chapter is simply to describe the way Exim works in relation to certain
39648 security concerns, not to make any specific claims about the effectiveness of
39649 its security as compared with other MTAs.
39650
39651 What follows is a description of the way Exim is supposed to be. Best efforts
39652 have been made to try to ensure that the code agrees with the theory, but an
39653 absence of bugs can never be guaranteed. Any that are reported will get fixed
39654 as soon as possible.
39655
39656
39657 .section "Building a more &""hardened""& Exim" "SECID286"
39658 .cindex "security" "build-time features"
39659 There are a number of build-time options that can be set in &_Local/Makefile_&
39660 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39661 Exim administrator who does not have the root password, or by someone who has
39662 penetrated the Exim (but not the root) account. These options are as follows:
39663
39664 .ilist
39665 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39666 start of any filenames used with the &%-C%& option. When it is set, these
39667 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39668 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39669 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39670 default setting for &%ALT_CONFIG_PREFIX%&.
39671
39672 If the permitted configuration files are confined to a directory to
39673 which only root has access, this guards against someone who has broken
39674 into the Exim account from running a privileged Exim with an arbitrary
39675 configuration file, and using it to break into other accounts.
39676 .next
39677
39678 If a non-trusted configuration file (i.e. not the default configuration file
39679 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39680 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39681 the next item), then root privilege is retained only if the caller of Exim is
39682 root. This locks out the possibility of testing a configuration using &%-C%&
39683 right through message reception and delivery, even if the caller is root. The
39684 reception works, but by that time, Exim is running as the Exim user, so when
39685 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39686 privilege to be lost. However, root can test reception and delivery using two
39687 separate commands.
39688
39689 .next
39690 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39691 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39692 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39693 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39694 the restrictive side.  Requiring build-time selection of safe macros is onerous
39695 but this option is intended solely as a transition mechanism to permit
39696 previously-working configurations to continue to work after release 4.73.
39697 .next
39698 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39699 is disabled.
39700 .next
39701 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39702 never to be used for any deliveries. This is like the &%never_users%& runtime
39703 option, but it cannot be overridden; the runtime option adds additional users
39704 to the list. The default setting is &"root"&; this prevents a non-root user who
39705 is permitted to modify the runtime file from using Exim as a way to get root.
39706 .endlist
39707
39708
39709
39710 .section "Root privilege" "SECID270"
39711 .cindex "setuid"
39712 .cindex "root privilege"
39713 The Exim binary is normally setuid to root, which means that it gains root
39714 privilege (runs as root) when it starts execution. In some special cases (for
39715 example, when the daemon is not in use and there are no local deliveries), it
39716 may be possible to run Exim setuid to some user other than root. This is
39717 discussed in the next section. However, in most installations, root privilege
39718 is required for two things:
39719
39720 .ilist
39721 To set up a socket connected to the standard SMTP port (25) when initialising
39722 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39723 not required.
39724 .next
39725 To be able to change uid and gid in order to read users' &_.forward_& files and
39726 perform local deliveries as the receiving user or as specified in the
39727 configuration.
39728 .endlist
39729
39730 It is not necessary to be root to do any of the other things Exim does, such as
39731 receiving messages and delivering them externally over SMTP, and it is
39732 obviously more secure if Exim does not run as root except when necessary.
39733 For this reason, a user and group for Exim to use must be defined in
39734 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39735 group"&. Their values can be changed by the runtime configuration, though this
39736 is not recommended. Often a user called &'exim'& is used, but some sites use
39737 &'mail'& or another user name altogether.
39738
39739 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39740 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39741 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39742
39743 After a new Exim process has interpreted its command line options, it changes
39744 uid and gid in the following cases:
39745
39746 .ilist
39747 .oindex "&%-C%&"
39748 .oindex "&%-D%&"
39749 If the &%-C%& option is used to specify an alternate configuration file, or if
39750 the &%-D%& option is used to define macro values for the configuration, and the
39751 calling process is not running as root, the uid and gid are changed to those of
39752 the calling process.
39753 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39754 option may not be used at all.
39755 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39756 can be supplied if the calling process is running as root, the Exim run-time
39757 user or CONFIGURE_OWNER, if defined.
39758 .next
39759 .oindex "&%-be%&"
39760 .oindex "&%-bf%&"
39761 .oindex "&%-bF%&"
39762 If the expansion test option (&%-be%&) or one of the filter testing options
39763 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39764 calling process.
39765 .next
39766 If the process is not a daemon process or a queue runner process or a delivery
39767 process or a process for testing address routing (started with &%-bt%&), the
39768 uid and gid are changed to the Exim user and group. This means that Exim always
39769 runs under its own uid and gid when receiving messages. This also applies when
39770 testing address verification
39771 .oindex "&%-bv%&"
39772 .oindex "&%-bh%&"
39773 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39774 option).
39775 .next
39776 For a daemon, queue runner, delivery, or address testing process, the uid
39777 remains as root at this stage, but the gid is changed to the Exim group.
39778 .endlist
39779
39780 The processes that initially retain root privilege behave as follows:
39781
39782 .ilist
39783 A daemon process changes the gid to the Exim group and the uid to the Exim
39784 user after setting up one or more listening sockets. The &[initgroups()]&
39785 function is called, so that if the Exim user is in any additional groups, they
39786 will be used during message reception.
39787 .next
39788 A queue runner process retains root privilege throughout its execution. Its
39789 job is to fork a controlled sequence of delivery processes.
39790 .next
39791 A delivery process retains root privilege throughout most of its execution,
39792 but any actual deliveries (that is, the transports themselves) are run in
39793 subprocesses which always change to a non-root uid and gid. For local
39794 deliveries this is typically the uid and gid of the owner of the mailbox; for
39795 remote deliveries, the Exim uid and gid are used. Once all the delivery
39796 subprocesses have been run, a delivery process changes to the Exim uid and gid
39797 while doing post-delivery tidying up such as updating the retry database and
39798 generating bounce and warning messages.
39799
39800 While the recipient addresses in a message are being routed, the delivery
39801 process runs as root. However, if a user's filter file has to be processed,
39802 this is done in a subprocess that runs under the individual user's uid and
39803 gid. A system filter is run as root unless &%system_filter_user%& is set.
39804 .next
39805 A process that is testing addresses (the &%-bt%& option) runs as root so that
39806 the routing is done in the same environment as a message delivery.
39807 .endlist
39808
39809
39810
39811
39812 .section "Running Exim without privilege" "SECTrunexiwitpri"
39813 .cindex "privilege, running without"
39814 .cindex "unprivileged running"
39815 .cindex "root privilege" "running without"
39816 Some installations like to run Exim in an unprivileged state for more of its
39817 operation, for added security. Support for this mode of operation is provided
39818 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39819 gid are changed to the Exim user and group at the start of a delivery process
39820 (and also queue runner and address testing processes). This means that address
39821 routing is no longer run as root, and the deliveries themselves cannot change
39822 to any other uid.
39823
39824 .cindex SIGHUP
39825 .cindex "daemon" "restarting"
39826 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39827 that the daemon can still be started in the usual way, and it can respond
39828 correctly to SIGHUP because the re-invocation regains root privilege.
39829
39830 An alternative approach is to make Exim setuid to the Exim user and also setgid
39831 to the Exim group. If you do this, the daemon must be started from a root
39832 process. (Calling Exim from a root process makes it behave in the way it does
39833 when it is setuid root.) However, the daemon cannot restart itself after a
39834 SIGHUP signal because it cannot regain privilege.
39835
39836 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39837 stops Exim from trying to re-invoke itself to do a delivery after a message has
39838 been received. Such a re-invocation is a waste of resources because it has no
39839 effect.
39840
39841 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39842 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39843 to the Exim user seems a clean approach, but there is one complication:
39844
39845 In this style of operation, Exim is running with the real uid and gid set to
39846 those of the calling process, and the effective uid/gid set to Exim's values.
39847 Ideally, any association with the calling process' uid/gid should be dropped,
39848 that is, the real uid/gid should be reset to the effective values so as to
39849 discard any privileges that the caller may have. While some operating systems
39850 have a function that permits this action for a non-root effective uid, quite a
39851 number of them do not. Because of this lack of standardization, Exim does not
39852 address this problem at this time.
39853
39854 For this reason, the recommended approach for &"mostly unprivileged"& running
39855 is to keep the Exim binary setuid to root, and to set
39856 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39857 be used in the most straightforward way.
39858
39859 If you configure Exim not to run delivery processes as root, there are a
39860 number of restrictions on what you can do:
39861
39862 .ilist
39863 You can deliver only as the Exim user/group. You should  explicitly use the
39864 &%user%& and &%group%& options to override routers or local transports that
39865 normally deliver as the recipient. This makes sure that configurations that
39866 work in this mode function the same way in normal mode. Any implicit or
39867 explicit specification of another user causes an error.
39868 .next
39869 Use of &_.forward_& files is severely restricted, such that it is usually
39870 not worthwhile to include them in the configuration.
39871 .next
39872 Users who wish to use &_.forward_& would have to make their home directory and
39873 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39874 and their equivalents in Exim filters, cannot be used. While they could be
39875 enabled in the Exim user's name, that would be insecure and not very useful.
39876 .next
39877 Unless the local user mailboxes are all owned by the Exim user (possible in
39878 some POP3 or IMAP-only environments):
39879
39880 .olist
39881 They must be owned by the Exim group and be writeable by that group. This
39882 implies you must set &%mode%& in the appendfile configuration, as well as the
39883 mode of the mailbox files themselves.
39884 .next
39885 You must set &%no_check_owner%&, since most or all of the files will not be
39886 owned by the Exim user.
39887 .next
39888 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39889 on a newly created mailbox when unprivileged. This also implies that new
39890 mailboxes need to be created manually.
39891 .endlist olist
39892 .endlist ilist
39893
39894
39895 These restrictions severely restrict what can be done in local deliveries.
39896 However, there are no restrictions on remote deliveries. If you are running a
39897 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39898 gives more security at essentially no cost.
39899
39900 If you are using the &%mua_wrapper%& facility (see chapter
39901 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39902
39903
39904
39905
39906 .section "Delivering to local files" "SECID271"
39907 Full details of the checks applied by &(appendfile)& before it writes to a file
39908 are given in chapter &<<CHAPappendfile>>&.
39909
39910
39911
39912 .section "Running local commands" "SECTsecconslocalcmds"
39913 .cindex "security" "local commands"
39914 .cindex "security" "command injection attacks"
39915 There are a number of ways in which an administrator can configure Exim to run
39916 commands based upon received, untrustworthy, data. Further, in some
39917 configurations a user who can control a &_.forward_& file can also arrange to
39918 run commands. Configuration to check includes, but is not limited to:
39919
39920 .ilist
39921 Use of &%use_shell%& in the pipe transport: various forms of shell command
39922 injection may be possible with this option present. It is dangerous and should
39923 be used only with considerable caution. Consider constraints which whitelist
39924 allowed characters in a variable which is to be used in a pipe transport that
39925 has &%use_shell%& enabled.
39926 .next
39927 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39928 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39929 &_.forward_& files in a redirect router. If Exim is running on a central mail
39930 hub to which ordinary users do not have shell access, but home directories are
39931 NFS mounted (for instance) then administrators should review the list of these
39932 forbid options available, and should bear in mind that the options that may
39933 need forbidding can change as new features are added between releases.
39934 .next
39935 The &%${run...}%& expansion item does not use a shell by default, but
39936 administrators can configure use of &_/bin/sh_& as part of the command.
39937 Such invocations should be viewed with prejudicial suspicion.
39938 .next
39939 Administrators who use embedded Perl are advised to explore how Perl's
39940 taint checking might apply to their usage.
39941 .next
39942 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39943 administrators are well advised to view its use with suspicion, in case (for
39944 instance) it allows a local-part to contain embedded Exim directives.
39945 .next
39946 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39947 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39948 each can reference arbitrary lists and files, rather than just being a list
39949 of opaque strings.
39950 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39951 real-world security vulnerabilities caused by its use with untrustworthy data
39952 injected in, for SQL injection attacks.
39953 Consider the use of the &%inlisti%& expansion condition instead.
39954 .endlist
39955
39956
39957
39958
39959 .section "Trust in configuration data" "SECTsecconfdata"
39960 .cindex "security" "data sources"
39961 .cindex "security" "regular expressions"
39962 .cindex "regular expressions" "security"
39963 .cindex "PCRE" "security"
39964 If configuration data for Exim can come from untrustworthy sources, there
39965 are some issues to be aware of:
39966
39967 .ilist
39968 Use of &%${expand...}%& may provide a path for shell injection attacks.
39969 .next
39970 Letting untrusted data provide a regular expression is unwise.
39971 .next
39972 Using &%${match...}%& to apply a fixed regular expression against untrusted
39973 data may result in pathological behaviour within PCRE.  Be aware of what
39974 "backtracking" means and consider options for being more strict with a regular
39975 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39976 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39977 possessive quantifiers or just not using regular expressions against untrusted
39978 data.
39979 .next
39980 It can be important to correctly use &%${quote:...}%&,
39981 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39982 items to ensure that data is correctly constructed.
39983 .next
39984 Some lookups might return multiple results, even though normal usage is only
39985 expected to yield one result.
39986 .endlist
39987
39988
39989
39990
39991 .section "IPv4 source routing" "SECID272"
39992 .cindex "source routing" "in IP packets"
39993 .cindex "IP source routing"
39994 Many operating systems suppress IP source-routed packets in the kernel, but
39995 some cannot be made to do this, so Exim does its own check. It logs incoming
39996 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39997 IPv6. No special checking is currently done.
39998
39999
40000
40001 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40002 Support for these SMTP commands is disabled by default. If required, they can
40003 be enabled by defining suitable ACLs.
40004
40005
40006
40007
40008 .section "Privileged users" "SECID274"
40009 .cindex "trusted users"
40010 .cindex "admin user"
40011 .cindex "privileged user"
40012 .cindex "user" "trusted"
40013 .cindex "user" "admin"
40014 Exim recognizes two sets of users with special privileges. Trusted users are
40015 able to submit new messages to Exim locally, but supply their own sender
40016 addresses and information about a sending host. For other users submitting
40017 local messages, Exim sets up the sender address from the uid, and doesn't
40018 permit a remote host to be specified.
40019
40020 .oindex "&%-f%&"
40021 However, an untrusted user is permitted to use the &%-f%& command line option
40022 in the special form &%-f <>%& to indicate that a delivery failure for the
40023 message should not cause an error report. This affects the message's envelope,
40024 but it does not affect the &'Sender:'& header. Untrusted users may also be
40025 permitted to use specific forms of address with the &%-f%& option by setting
40026 the &%untrusted_set_sender%& option.
40027
40028 Trusted users are used to run processes that receive mail messages from some
40029 other mail domain and pass them on to Exim for delivery either locally, or over
40030 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40031 as any user listed in the &%trusted_users%& configuration option, or under any
40032 group listed in the &%trusted_groups%& option.
40033
40034 Admin users are permitted to do things to the messages on Exim's queue. They
40035 can freeze or thaw messages, cause them to be returned to their senders, remove
40036 them entirely, or modify them in various ways. In addition, admin users can run
40037 the Exim monitor and see all the information it is capable of providing, which
40038 includes the contents of files on the spool.
40039
40040 .oindex "&%-M%&"
40041 .oindex "&%-q%&"
40042 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40043 delivery of messages on its queue is restricted to admin users. This
40044 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40045 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40046 queue is also restricted to admin users. This restriction can be relaxed by
40047 setting &%no_queue_list_requires_admin%&.
40048
40049 Exim recognizes an admin user if the calling process is running as root or as
40050 the Exim user or if any of the groups associated with the calling process is
40051 the Exim group. It is not necessary actually to be running under the Exim
40052 group. However, if admin users who are not root or the Exim user are to access
40053 the contents of files on the spool via the Exim monitor (which runs
40054 unprivileged), Exim must be built to allow group read access to its spool
40055 files.
40056
40057 By default, regular users are trusted to perform basic testing and
40058 introspection commands, as themselves.  This setting can be tightened by
40059 setting the &%commandline_checks_require_admin%& option.
40060 This affects most of the checking options,
40061 such as &%-be%& and anything else &%-b*%&.
40062
40063
40064 .section "Spool files" "SECID275"
40065 .cindex "spool directory" "files"
40066 Exim's spool directory and everything it contains is owned by the Exim user and
40067 set to the Exim group. The mode for spool files is defined in the
40068 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40069 any user who is a member of the Exim group can access these files.
40070
40071
40072
40073 .section "Use of argv[0]" "SECID276"
40074 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40075 of specific strings, Exim assumes certain options. For example, calling Exim
40076 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40077 to calling it with the option &%-bS%&. There are no security implications in
40078 this.
40079
40080
40081
40082 .section "Use of %f formatting" "SECID277"
40083 The only use made of &"%f"& by Exim is in formatting load average values. These
40084 are actually stored in integer variables as 1000 times the load average.
40085 Consequently, their range is limited and so therefore is the length of the
40086 converted output.
40087
40088
40089
40090 .section "Embedded Exim path" "SECID278"
40091 Exim uses its own path name, which is embedded in the code, only when it needs
40092 to re-exec in order to regain root privilege. Therefore, it is not root when it
40093 does so. If some bug allowed the path to get overwritten, it would lead to an
40094 arbitrary program's being run as exim, not as root.
40095
40096
40097
40098 .section "Dynamic module directory" "SECTdynmoddir"
40099 Any dynamically loadable modules must be installed into the directory
40100 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40101 loading it.
40102
40103
40104 .section "Use of sprintf()" "SECID279"
40105 .cindex "&[sprintf()]&"
40106 A large number of occurrences of &"sprintf"& in the code are actually calls to
40107 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40108 The intermediate formatting is done into a large fixed buffer by a function
40109 that runs through the format string itself, and checks the length of each
40110 conversion before performing it, thus preventing buffer overruns.
40111
40112 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40113 the output buffer is known to be sufficiently long to contain the converted
40114 string.
40115
40116
40117
40118 .section "Use of debug_printf() and log_write()" "SECID280"
40119 Arbitrary strings are passed to both these functions, but they do their
40120 formatting by calling the function &'string_vformat()'&, which runs through
40121 the format string itself, and checks the length of each conversion.
40122
40123
40124
40125 .section "Use of strcat() and strcpy()" "SECID281"
40126 These are used only in cases where the output buffer is known to be large
40127 enough to hold the result.
40128 .ecindex IIDsecurcon
40129
40130
40131
40132
40133 . ////////////////////////////////////////////////////////////////////////////
40134 . ////////////////////////////////////////////////////////////////////////////
40135
40136 .chapter "Format of spool files" "CHAPspool"
40137 .scindex IIDforspo1 "format" "spool files"
40138 .scindex IIDforspo2 "spool directory" "format of files"
40139 .scindex IIDforspo3 "spool files" "format of"
40140 .cindex "spool files" "editing"
40141 A message on Exim's queue consists of two files, whose names are the message id
40142 followed by -D and -H, respectively. The data portion of the message is kept in
40143 the -D file on its own. The message's envelope, status, and headers are all
40144 kept in the -H file, whose format is described in this chapter. Each of these
40145 two files contains the final component of its own name as its first line. This
40146 is insurance against disk crashes where the directory is lost but the files
40147 themselves are recoverable.
40148
40149 The file formats may be changed, or new formats added, at any release.
40150 Spool files are not intended as an interface to other programs
40151 and should not be used as such.
40152
40153 Some people are tempted into editing -D files in order to modify messages. You
40154 need to be extremely careful if you do this; it is not recommended and you are
40155 on your own if you do it. Here are some of the pitfalls:
40156
40157 .ilist
40158 You must ensure that Exim does not try to deliver the message while you are
40159 fiddling with it. The safest way is to take out a write lock on the -D file,
40160 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40161 place, the lock will be retained. If you write a new file and rename it, the
40162 lock will be lost at the instant of rename.
40163 .next
40164 .vindex "&$body_linecount$&"
40165 If you change the number of lines in the file, the value of
40166 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40167 cause incomplete transmission of messages or undeliverable messages.
40168 .next
40169 If the message is in MIME format, you must take care not to break it.
40170 .next
40171 If the message is cryptographically signed, any change will invalidate the
40172 signature.
40173 .endlist
40174 All in all, modifying -D files is fraught with danger.
40175
40176 Files whose names end with -J may also be seen in the &_input_& directory (or
40177 its subdirectories when &%split_spool_directory%& is set). These are journal
40178 files, used to record addresses to which the message has been delivered during
40179 the course of a delivery attempt. If there are still undelivered recipients at
40180 the end, the -H file is updated, and the -J file is deleted. If, however, there
40181 is some kind of crash (for example, a power outage) before this happens, the -J
40182 file remains in existence. When Exim next processes the message, it notices the
40183 -J file and uses it to update the -H file before starting the next delivery
40184 attempt.
40185
40186 Files whose names end with -K or .eml may also be seen in the spool.
40187 These are temporaries used for DKIM or malware processing, when that is used.
40188 They should be tidied up by normal operations; any old ones are probably
40189 relics of crashes and can be removed.
40190
40191 .section "Format of the -H file" "SECID282"
40192 .cindex "uid (user id)" "in spool file"
40193 .cindex "gid (group id)" "in spool file"
40194 The second line of the -H file contains the login name for the uid of the
40195 process that called Exim to read the message, followed by the numerical uid and
40196 gid. For a locally generated message, this is normally the user who sent the
40197 message. For a message received over TCP/IP via the daemon, it is
40198 normally the Exim user.
40199
40200 The third line of the file contains the address of the message's sender as
40201 transmitted in the envelope, contained in angle brackets. The sender address is
40202 empty for bounce messages. For incoming SMTP mail, the sender address is given
40203 in the MAIL command. For locally generated mail, the sender address is
40204 created by Exim from the login name of the current user and the configured
40205 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40206 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40207 &"<>"& or an address that matches &%untrusted_set_senders%&.
40208
40209 The fourth line contains two numbers. The first is the time that the message
40210 was received, in the conventional Unix form &-- the number of seconds since the
40211 start of the epoch. The second number is a count of the number of messages
40212 warning of delayed delivery that have been sent to the sender.
40213
40214 There follow a number of lines starting with a hyphen. These can appear in any
40215 order, and are omitted when not relevant:
40216
40217 .vlist
40218 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40219 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40220 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40221 recognized, to provide backward compatibility. In the old format, a line of
40222 this form is present for every ACL variable that is not empty. The number
40223 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40224 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40225 the data string for the variable. The string itself starts at the beginning of
40226 the next line, and is followed by a newline character. It may contain internal
40227 newlines.
40228
40229 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40230 A line of this form is present for every ACL connection variable that is
40231 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40232 The length is the length of the data string for the variable. The string itself
40233 starts at the beginning of the next line, and is followed by a newline
40234 character. It may contain internal newlines.
40235
40236 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40237 A line of this form is present for every ACL message variable that is defined.
40238 Note that there is a space between &%-aclm%& and the rest of the name. The
40239 length is the length of the data string for the variable. The string itself
40240 starts at the beginning of the next line, and is followed by a newline
40241 character. It may contain internal newlines.
40242
40243 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40244 This is present if, when the message was received over SMTP, the value of
40245 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40246
40247 .vitem &%-allow_unqualified_recipient%&
40248 This is present if unqualified recipient addresses are permitted in header
40249 lines (to stop such addresses from being qualified if rewriting occurs at
40250 transport time). Local messages that were input using &%-bnq%& and remote
40251 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40252
40253 .vitem &%-allow_unqualified_sender%&
40254 This is present if unqualified sender addresses are permitted in header lines
40255 (to stop such addresses from being qualified if rewriting occurs at transport
40256 time). Local messages that were input using &%-bnq%& and remote messages from
40257 hosts that match &%sender_unqualified_hosts%& set this flag.
40258
40259 .vitem "&%-auth_id%&&~<&'text'&>"
40260 The id information for a message received on an authenticated SMTP connection
40261 &-- the value of the &$authenticated_id$& variable.
40262
40263 .vitem "&%-auth_sender%&&~<&'address'&>"
40264 The address of an authenticated sender &-- the value of the
40265 &$authenticated_sender$& variable.
40266
40267 .vitem "&%-body_linecount%&&~<&'number'&>"
40268 This records the number of lines in the body of the message, and is
40269 present unless &%-spool_file_wireformat%& is.
40270
40271 .vitem "&%-body_zerocount%&&~<&'number'&>"
40272 This records the number of binary zero bytes in the body of the message, and is
40273 present if the number is greater than zero.
40274
40275 .vitem &%-deliver_firsttime%&
40276 This is written when a new message is first added to the spool. When the spool
40277 file is updated after a deferral, it is omitted.
40278
40279 .vitem "&%-frozen%&&~<&'time'&>"
40280 .cindex "frozen messages" "spool data"
40281 The message is frozen, and the freezing happened at <&'time'&>.
40282
40283 .vitem "&%-helo_name%&&~<&'text'&>"
40284 This records the host name as specified by a remote host in a HELO or EHLO
40285 command.
40286
40287 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40288 This records the IP address of the host from which the message was received and
40289 the remote port number that was used. It is omitted for locally generated
40290 messages.
40291
40292 .vitem "&%-host_auth%&&~<&'text'&>"
40293 If the message was received on an authenticated SMTP connection, this records
40294 the name of the authenticator &-- the value of the
40295 &$sender_host_authenticated$& variable.
40296
40297 .vitem &%-host_lookup_failed%&
40298 This is present if an attempt to look up the sending host's name from its IP
40299 address failed. It corresponds to the &$host_lookup_failed$& variable.
40300
40301 .vitem "&%-host_name%&&~<&'text'&>"
40302 .cindex "reverse DNS lookup"
40303 .cindex "DNS" "reverse lookup"
40304 This records the name of the remote host from which the message was received,
40305 if the host name was looked up from the IP address when the message was being
40306 received. It is not present if no reverse lookup was done.
40307
40308 .vitem "&%-ident%&&~<&'text'&>"
40309 For locally submitted messages, this records the login of the originating user,
40310 unless it was a trusted user and the &%-oMt%& option was used to specify an
40311 ident value. For messages received over TCP/IP, this records the ident string
40312 supplied by the remote host, if any.
40313
40314 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40315 This records the IP address of the local interface and the port number through
40316 which a message was received from a remote host. It is omitted for locally
40317 generated messages.
40318
40319 .vitem &%-local%&
40320 The message is from a local sender.
40321
40322 .vitem &%-localerror%&
40323 The message is a locally-generated bounce message.
40324
40325 .vitem "&%-local_scan%&&~<&'string'&>"
40326 This records the data string that was returned by the &[local_scan()]& function
40327 when the message was received &-- the value of the &$local_scan_data$&
40328 variable. It is omitted if no data was returned.
40329
40330 .vitem &%-manual_thaw%&
40331 The message was frozen but has been thawed manually, that is, by an explicit
40332 Exim command rather than via the auto-thaw process.
40333
40334 .vitem &%-N%&
40335 A testing delivery process was started using the &%-N%& option to suppress any
40336 actual deliveries, but delivery was deferred. At any further delivery attempts,
40337 &%-N%& is assumed.
40338
40339 .vitem &%-received_protocol%&
40340 This records the value of the &$received_protocol$& variable, which contains
40341 the name of the protocol by which the message was received.
40342
40343 .vitem &%-sender_set_untrusted%&
40344 The envelope sender of this message was set by an untrusted local caller (used
40345 to ensure that the caller is displayed in queue listings).
40346
40347 .vitem "&%-spam_score_int%&&~<&'number'&>"
40348 If a message was scanned by SpamAssassin, this is present. It records the value
40349 of &$spam_score_int$&.
40350
40351 .vitem &%-spool_file_wireformat%&
40352 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40353 rather than Unix-format.
40354 The line-ending is CRLF rather than newline.
40355 There is still, however, no leading-dot-stuffing.
40356
40357 .vitem &%-tls_certificate_verified%&
40358 A TLS certificate was received from the client that sent this message, and the
40359 certificate was verified by the server.
40360
40361 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40362 When the message was received over an encrypted connection, this records the
40363 name of the cipher suite that was used.
40364
40365 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40366 When the message was received over an encrypted connection, and a certificate
40367 was received from the client, this records the Distinguished Name from that
40368 certificate.
40369 .endlist
40370
40371 Any of the above may have an extra hyphen prepended, to indicate the the
40372 corresponding data is untrusted.
40373
40374 Following the options there is a list of those addresses to which the message
40375 is not to be delivered. This set of addresses is initialized from the command
40376 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40377 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40378 the address is added to this set. The addresses are kept internally as a
40379 balanced binary tree, and it is a representation of that tree which is written
40380 to the spool file. If an address is expanded via an alias or forward file, the
40381 original address is added to the tree when deliveries to all its child
40382 addresses are complete.
40383
40384 If the tree is empty, there is a single line in the spool file containing just
40385 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40386 Y or N, followed by an address. The address is the value for the node of the
40387 tree, and the letters indicate whether the node has a left branch and/or a
40388 right branch attached to it, respectively. If branches exist, they immediately
40389 follow. Here is an example of a three-node tree:
40390 .code
40391 YY darcy@austen.fict.example
40392 NN alice@wonderland.fict.example
40393 NN editor@thesaurus.ref.example
40394 .endd
40395 After the non-recipients tree, there is a list of the message's recipients.
40396 This is a simple list, preceded by a count. It includes all the original
40397 recipients of the message, including those to whom the message has already been
40398 delivered. In the simplest case, the list contains one address per line. For
40399 example:
40400 .code
40401 4
40402 editor@thesaurus.ref.example
40403 darcy@austen.fict.example
40404 rdo@foundation
40405 alice@wonderland.fict.example
40406 .endd
40407 However, when a child address has been added to the top-level addresses as a
40408 result of the use of the &%one_time%& option on a &(redirect)& router, each
40409 line is of the following form:
40410 .display
40411 <&'top-level address'&> <&'errors_to address'&> &&&
40412   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40413 .endd
40414 The 01 flag bit indicates the presence of the three other fields that follow
40415 the top-level address. Other bits may be used in future to support additional
40416 fields. The <&'parent number'&> is the offset in the recipients list of the
40417 original parent of the &"one time"& address. The first two fields are the
40418 envelope sender that is associated with this address and its length. If the
40419 length is zero, there is no special envelope sender (there are then two space
40420 characters in the line). A non-empty field can arise from a &(redirect)& router
40421 that has an &%errors_to%& setting.
40422
40423
40424 A blank line separates the envelope and status information from the headers
40425 which follow. A header may occupy several lines of the file, and to save effort
40426 when reading it in, each header is preceded by a number and an identifying
40427 character. The number is the number of characters in the header, including any
40428 embedded newlines and the terminating newline. The character is one of the
40429 following:
40430
40431 .table2 50pt
40432 .row <&'blank'&>         "header in which Exim has no special interest"
40433 .row &`B`&               "&'Bcc:'& header"
40434 .row &`C`&               "&'Cc:'& header"
40435 .row &`F`&               "&'From:'& header"
40436 .row &`I`&               "&'Message-id:'& header"
40437 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40438 .row &`R`&               "&'Reply-To:'& header"
40439 .row &`S`&               "&'Sender:'& header"
40440 .row &`T`&               "&'To:'& header"
40441 .row &`*`&               "replaced or deleted header"
40442 .endtable
40443
40444 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40445 purposes. They are not transmitted when the message is delivered. Here is a
40446 typical set of headers:
40447 .code
40448 111P Received: by hobbit.fict.example with local (Exim 4.00)
40449 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40450 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40451 038* X-rewrote-sender: bb@hobbit.fict.example
40452 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40453 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40454 099* To: alice@wonderland.fict.example, rdo@foundation,
40455 darcy@austen.fict.example, editor@thesaurus.ref.example
40456 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40457 darcy@austen.fict.example, editor@thesaurus.ref.example
40458 038  Date: Fri, 11 May 2001 10:28:59 +0100
40459 .endd
40460 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40461 &'To:'& header have been rewritten, the last one because routing expanded the
40462 unqualified domain &'foundation'&.
40463 .ecindex IIDforspo1
40464 .ecindex IIDforspo2
40465 .ecindex IIDforspo3
40466
40467 .section "Format of the -D file" "SECID282a"
40468 The data file is traditionally in Unix-standard format: lines are ended with
40469 an ASCII newline character.
40470 However, when the &%spool_wireformat%& main option is used some -D files
40471 can have an alternate format.
40472 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40473 The -D file lines (not including the first name-component line) are
40474 suitable for direct copying to the wire when transmitting using the
40475 ESMTP CHUNKING option, meaning lower processing overhead.
40476 Lines are terminated with an ASCII CRLF pair.
40477 There is no dot-stuffing (and no dot-termination).
40478
40479 . ////////////////////////////////////////////////////////////////////////////
40480 . ////////////////////////////////////////////////////////////////////////////
40481
40482 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
40483          "DKIM, SPF and DMARC Support"
40484
40485 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40486 .cindex "DKIM"
40487
40488 DKIM is a mechanism by which messages sent by some entity can be provably
40489 linked to a domain which that entity controls.  It permits reputation to
40490 be tracked on a per-domain basis, rather than merely upon source IP address.
40491 DKIM is documented in RFC 6376.
40492
40493 As DKIM relies on the message being unchanged in transit, messages handled
40494 by a mailing-list (which traditionally adds to the message) will not match
40495 any original DKIM signature.
40496
40497 DKIM support is compiled into Exim by default if TLS support is present.
40498 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40499
40500 Exim's DKIM implementation allows for
40501 .olist
40502 Signing outgoing messages: This function is implemented in the SMTP transport.
40503 It can co-exist with all other Exim features
40504 (including transport filters)
40505 except cutthrough delivery.
40506 .next
40507 Verifying signatures in incoming messages: This is implemented by an additional
40508 ACL (acl_smtp_dkim), which can be called several times per message, with
40509 different signature contexts.
40510 .endlist
40511
40512 In typical Exim style, the verification implementation does not include any
40513 default "policy". Instead it enables you to build your own policy using
40514 Exim's standard controls.
40515
40516 Please note that verification of DKIM signatures in incoming mail is turned
40517 on by default for logging (in the <= line) purposes.
40518
40519 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40520 When set, for each signature in incoming email,
40521 exim will log a line displaying the most important signature details, and the
40522 signature status. Here is an example (with line-breaks added for clarity):
40523 .code
40524 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40525     d=facebookmail.com s=q1-2009b
40526     c=relaxed/relaxed a=rsa-sha1
40527     i=@facebookmail.com t=1252484542 [verification succeeded]
40528 .endd
40529
40530 You might want to turn off DKIM verification processing entirely for internal
40531 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40532 control modifier. This should typically be done in the RCPT ACL, at points
40533 where you accept mail from relay sources (internal hosts or authenticated
40534 senders).
40535
40536
40537 .section "Signing outgoing messages" "SECDKIMSIGN"
40538 .cindex "DKIM" "signing"
40539
40540 For signing to be usable you must have published a DKIM record in DNS.
40541 Note that RFC 8301 (which does not cover EC keys) says:
40542 .code
40543 rsa-sha1 MUST NOT be used for signing or verifying.
40544
40545 Signers MUST use RSA keys of at least 1024 bits for all keys.
40546 Signers SHOULD use RSA keys of at least 2048 bits.
40547 .endd
40548
40549 Note also that the key content (the 'p=' field)
40550 in the DNS record is different between RSA and EC keys;
40551 for the former it is the base64 of the ASN.1 for the RSA public key
40552 (equivalent to the private-key .pem with the header/trailer stripped)
40553 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40554
40555 Signing is enabled by setting private options on the SMTP transport.
40556 These options take (expandable) strings as arguments.
40557
40558 .option dkim_domain smtp string list&!! unset
40559 The domain(s) you want to sign with.
40560 After expansion, this can be a list.
40561 Each element in turn,
40562 lowercased,
40563 is put into the &%$dkim_domain%& expansion variable
40564 while expanding the remaining signing options.
40565 If it is empty after expansion, DKIM signing is not done,
40566 and no error will result even if &%dkim_strict%& is set.
40567
40568 .option dkim_selector smtp string list&!! unset
40569 This sets the key selector string.
40570 After expansion, which can use &$dkim_domain$&, this can be a list.
40571 Each element in turn is put in the expansion
40572 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40573 option along with &%$dkim_domain%&.
40574 If the option is empty after expansion, DKIM signing is not done for this domain,
40575 and no error will result even if &%dkim_strict%& is set.
40576
40577 .option dkim_private_key smtp string&!! unset
40578 This sets the private key to use.
40579 You can use the &%$dkim_domain%& and
40580 &%$dkim_selector%& expansion variables to determine the private key to use.
40581 The result can either
40582 .ilist
40583 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40584 .next
40585 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40586 be a valid Ed25519 private key (same format as above)
40587 .next
40588 start with a slash, in which case it is treated as a file that contains
40589 the private key
40590 .next
40591 be "0", "false" or the empty string, in which case the message will not
40592 be signed. This case will not result in an error, even if &%dkim_strict%&
40593 is set.
40594 .endlist
40595
40596 To generate keys under OpenSSL:
40597 .code
40598 openssl genrsa -out dkim_rsa.private 2048
40599 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40600 .endd
40601 The result file from the first command should be retained, and
40602 this option set to use it.
40603 Take the base-64 lines from the output of the second command, concatenated,
40604 for the DNS TXT record.
40605 See section 3.6 of RFC6376 for the record specification.
40606
40607 Under GnuTLS:
40608 .code
40609 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40610 certtool --load-privkey=dkim_rsa.private --pubkey-info
40611 .endd
40612
40613 Note that RFC 8301 says:
40614 .code
40615 Signers MUST use RSA keys of at least 1024 bits for all keys.
40616 Signers SHOULD use RSA keys of at least 2048 bits.
40617 .endd
40618
40619 EC keys for DKIM are defined by RFC 8463.
40620 They are considerably smaller than RSA keys for equivalent protection.
40621 As they are a recent development, users should consider dual-signing
40622 (by setting a list of selectors, and an expansion for this option)
40623 for some transition period.
40624 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40625 for EC keys.
40626
40627 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40628 .code
40629 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40630 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40631 .endd
40632
40633 To produce the required public key value for a DNS record:
40634 .code
40635 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40636 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40637 .endd
40638
40639 Exim also supports an alternate format
40640 of Ed25519 keys in DNS which was a candidate during development
40641 of the standard, but not adopted.
40642 A future release will probably drop that support.
40643
40644 .option dkim_hash smtp string&!! sha256
40645 Can be set to any one of the supported hash methods, which are:
40646 .ilist
40647 &`sha1`& &-- should not be used, is old and insecure
40648 .next
40649 &`sha256`& &-- the default
40650 .next
40651 &`sha512`& &-- possibly more secure but less well supported
40652 .endlist
40653
40654 Note that RFC 8301 says:
40655 .code
40656 rsa-sha1 MUST NOT be used for signing or verifying.
40657 .endd
40658
40659 .option dkim_identity smtp string&!! unset
40660 If set after expansion, the value is used to set an "i=" tag in
40661 the signing header.  The DKIM standards restrict the permissible
40662 syntax of this optional tag to a mail address, with possibly-empty
40663 local part, an @, and a domain identical to or subdomain of the "d="
40664 tag value.  Note that Exim does not check the value.
40665
40666 .option dkim_canon smtp string&!! unset
40667 This option sets the canonicalization method used when signing a message.
40668 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40669 The option defaults to "relaxed" when unset. Note: the current implementation
40670 only supports signing with the same canonicalization method for both headers and body.
40671
40672 .option dkim_strict smtp string&!! unset
40673 This  option  defines  how  Exim  behaves  when  signing a message that
40674 should be signed fails for some reason.  When the expansion evaluates to
40675 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
40676 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40677 variables here.
40678
40679 .option dkim_sign_headers smtp string&!! "see below"
40680 If set, this option must expand to a colon-separated
40681 list of header names.
40682 Headers with these names, or the absence or such a header, will be included
40683 in the message signature.
40684 When unspecified, the header names listed in RFC4871 will be used,
40685 whether or not each header is present in the message.
40686 The default list is available for the expansion in the macro
40687 &"_DKIM_SIGN_HEADERS"&
40688 .new
40689 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
40690 .wen
40691
40692 If a name is repeated, multiple headers by that name (or the absence thereof)
40693 will be signed.  The textually later headers in the headers part of the
40694 message are signed first, if there are multiples.
40695
40696 A name can be prefixed with either an &"="& or a &"+"& character.
40697 If an &"="& prefix is used, all headers that are present with this name
40698 will be signed.
40699 If a &"+"& prefix if used, all headers that are present with this name
40700 will be signed, and one signature added for a missing header with the
40701 name will be appended.
40702
40703 .option dkim_timestamps smtp integer&!! unset
40704 This option controls the inclusion of timestamp information in the signature.
40705 If not set, no such information will be included.
40706 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40707 for the expiry tag
40708 (eg. 1209600 for two weeks);
40709 both creation (t=) and expiry (x=) tags will be included.
40710
40711 RFC 6376 lists these tags as RECOMMENDED.
40712
40713
40714 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40715 .cindex "DKIM" "verification"
40716
40717 Verification of DKIM signatures in SMTP incoming email is done for all
40718 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40719 .cindex DKIM "selecting signature algorithms"
40720 Individual classes of signature algorithm can be ignored by changing
40721 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40722 The &%dkim_verify_minimal%& option can be set to cease verification
40723 processing for a message once the first passing signature is found.
40724
40725 .cindex authentication "expansion item"
40726 Performing verification sets up information used by the
40727 &%authresults%& expansion item.
40728
40729 For most purposes the default option settings suffice and the remainder
40730 of this section can be ignored.
40731
40732 The results of verification are made available to the
40733 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40734 A missing ACL definition defaults to accept.
40735 By default, the ACL is called once for each
40736 syntactically(!) correct signature in the incoming message.
40737 If any ACL call does not accept, the message is not accepted.
40738 If a cutthrough delivery was in progress for the message, that is
40739 summarily dropped (having wasted the transmission effort).
40740
40741 To evaluate the verification result in the ACL
40742 a large number of expansion variables
40743 containing the signature status and its details are set up during the
40744 runtime of the ACL.
40745
40746 Calling the ACL only for existing signatures is not sufficient to build
40747 more advanced policies. For that reason, the main option
40748 &%dkim_verify_signers%&, and an expansion variable
40749 &%$dkim_signers%& exist.
40750
40751 The main option &%dkim_verify_signers%& can be set to a colon-separated
40752 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40753 called. It is expanded when the message has been received. At this point,
40754 the expansion variable &%$dkim_signers%& already contains a colon-separated
40755 list of signer domains and identities for the message. When
40756 &%dkim_verify_signers%& is not specified in the main configuration,
40757 it defaults as:
40758 .code
40759 dkim_verify_signers = $dkim_signers
40760 .endd
40761 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40762 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40763 call the ACL for known domains or identities. This would be achieved as follows:
40764 .code
40765 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40766 .endd
40767 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40768 and "ebay.com", plus all domains and identities that have signatures in the message.
40769 You can also be more creative in constructing your policy. For example:
40770 .code
40771 dkim_verify_signers = $sender_address_domain:$dkim_signers
40772 .endd
40773
40774 If a domain or identity is listed several times in the (expanded) value of
40775 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40776
40777 Note that if the option is set using untrustworthy data
40778 (such as the From: header)
40779 care should be taken to force lowercase for domains
40780 and for the domain part if identities.
40781 The default setting can be regarded as trustworthy in this respect.
40782
40783 If multiple signatures match a domain (or identity), the ACL is called once
40784 for each matching signature.
40785
40786
40787 Inside the DKIM ACL, the following expansion variables are
40788 available (from most to least important):
40789
40790
40791 .vlist
40792 .vitem &%$dkim_cur_signer%&
40793 The signer that is being evaluated in this ACL run. This can be a domain or
40794 an identity. This is one of the list items from the expanded main option
40795 &%dkim_verify_signers%& (see above).
40796
40797 .vitem &%$dkim_verify_status%&
40798 Within the DKIM ACL,
40799 a string describing the general status of the signature. One of
40800 .ilist
40801 &%none%&: There is no signature in the message for the current domain or
40802 identity (as reflected by &%$dkim_cur_signer%&).
40803 .next
40804 &%invalid%&: The signature could not be verified due to a processing error.
40805 More detail is available in &%$dkim_verify_reason%&.
40806 .next
40807 &%fail%&: Verification of the signature failed.  More detail is
40808 available in &%$dkim_verify_reason%&.
40809 .next
40810 &%pass%&: The signature passed verification. It is valid.
40811 .endlist
40812
40813 This variable can be overwritten using an ACL 'set' modifier.
40814 This might, for instance, be done to enforce a policy restriction on
40815 hash-method or key-size:
40816 .code
40817   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40818        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40819        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40820                                   {< {$dkim_key_length}{1024}}}}
40821        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40822        set dkim_verify_status = fail
40823        set dkim_verify_reason = hash too weak or key too short
40824 .endd
40825
40826 So long as a DKIM ACL is defined (it need do no more than accept),
40827 after all the DKIM ACL runs have completed, the value becomes a
40828 colon-separated list of the values after each run.
40829 This is maintained for the mime, prdr and data ACLs.
40830
40831 .vitem &%$dkim_verify_reason%&
40832 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40833 "fail" or "invalid". One of
40834 .ilist
40835 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40836 key for the domain could not be retrieved. This may be a temporary problem.
40837 .next
40838 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40839 record for the domain is syntactically invalid.
40840 .next
40841 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40842 body hash does not match the one specified in the signature header. This
40843 means that the message body was modified in transit.
40844 .next
40845 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40846 could not be verified. This may mean that headers were modified,
40847 re-written or otherwise changed in a way which is incompatible with
40848 DKIM verification. It may of course also mean that the signature is forged.
40849 .endlist
40850
40851 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40852
40853 .vitem &%$dkim_domain%&
40854 The signing domain. IMPORTANT: This variable is only populated if there is
40855 an actual signature in the message for the current domain or identity (as
40856 reflected by &%$dkim_cur_signer%&).
40857
40858 .vitem &%$dkim_identity%&
40859 The signing identity, if present. IMPORTANT: This variable is only populated
40860 if there is an actual signature in the message for the current domain or
40861 identity (as reflected by &%$dkim_cur_signer%&).
40862
40863 .vitem &%$dkim_selector%&
40864 The key record selector string.
40865
40866 .vitem &%$dkim_algo%&
40867 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40868 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40869 may also be 'ed25519-sha256'.
40870 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40871 for EC keys.
40872
40873 Note that RFC 8301 says:
40874 .code
40875 rsa-sha1 MUST NOT be used for signing or verifying.
40876
40877 DKIM signatures identified as having been signed with historic
40878 algorithms (currently, rsa-sha1) have permanently failed evaluation
40879 .endd
40880
40881 To enforce this you must either have a DKIM ACL which checks this variable
40882 and overwrites the &$dkim_verify_status$& variable as discussed above,
40883 or have set the main option &%dkim_verify_hashes%& to exclude
40884 processing of such signatures.
40885
40886 .vitem &%$dkim_canon_body%&
40887 The body canonicalization method. One of 'relaxed' or 'simple'.
40888
40889 .vitem &%$dkim_canon_headers%&
40890 The header canonicalization method. One of 'relaxed' or 'simple'.
40891
40892 .vitem &%$dkim_copiedheaders%&
40893 A transcript of headers and their values which are included in the signature
40894 (copied from the 'z=' tag of the signature).
40895 Note that RFC6376 requires that verification fail if the From: header is
40896 not included in the signature.  Exim does not enforce this; sites wishing
40897 strict enforcement should code the check explicitly.
40898
40899 .vitem &%$dkim_bodylength%&
40900 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40901 limit was set by the signer, "9999999999999" is returned. This makes sure
40902 that this variable always expands to an integer value.
40903 &*Note:*& The presence of the signature tag specifying a signing body length
40904 is one possible route to spoofing of valid DKIM signatures.
40905 A paranoid implementation might wish to regard signature where this variable
40906 shows less than the "no limit" return as being invalid.
40907
40908 .vitem &%$dkim_created%&
40909 UNIX timestamp reflecting the date and time when the signature was created.
40910 When this was not specified by the signer, "0" is returned.
40911
40912 .vitem &%$dkim_expires%&
40913 UNIX timestamp reflecting the date and time when the signer wants the
40914 signature to be treated as "expired". When this was not specified by the
40915 signer, "9999999999999" is returned. This makes it possible to do useful
40916 integer size comparisons against this value.
40917 Note that Exim does not check this value.
40918
40919 .vitem &%$dkim_headernames%&
40920 A colon-separated list of names of headers included in the signature.
40921
40922 .vitem &%$dkim_key_testing%&
40923 "1" if the key record has the "testing" flag set, "0" if not.
40924
40925 .vitem &%$dkim_key_nosubdomains%&
40926 "1" if the key record forbids subdomaining, "0" otherwise.
40927
40928 .vitem &%$dkim_key_srvtype%&
40929 Service type (tag s=) from the key record. Defaults to "*" if not specified
40930 in the key record.
40931
40932 .vitem &%$dkim_key_granularity%&
40933 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40934 in the key record.
40935
40936 .vitem &%$dkim_key_notes%&
40937 Notes from the key record (tag n=).
40938
40939 .vitem &%$dkim_key_length%&
40940 Number of bits in the key.
40941 .new
40942 Valid only once the key is loaded, which is at the time the header signature
40943 is verified, which is after the body hash is.
40944 .wen
40945
40946 Note that RFC 8301 says:
40947 .code
40948 Verifiers MUST NOT consider signatures using RSA keys of
40949 less than 1024 bits as valid signatures.
40950 .endd
40951
40952 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
40953 option.
40954
40955 .endlist
40956
40957 In addition, two ACL conditions are provided:
40958
40959 .vlist
40960 .vitem &%dkim_signers%&
40961 ACL condition that checks a colon-separated list of domains or identities
40962 for a match against the domain or identity that the ACL is currently verifying
40963 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40964 verb to a group of domains or identities. For example:
40965
40966 .code
40967 # Warn when Mail purportedly from GMail has no gmail signature
40968 warn sender_domains = gmail.com
40969      dkim_signers = gmail.com
40970      dkim_status = none
40971      log_message = GMail sender without gmail.com DKIM signature
40972 .endd
40973
40974 Note that the above does not check for a total lack of DKIM signing;
40975 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40976
40977 .vitem &%dkim_status%&
40978 ACL condition that checks a colon-separated list of possible DKIM verification
40979 results against the actual result of verification. This is typically used
40980 to restrict an ACL verb to a list of verification outcomes, for example:
40981
40982 .code
40983 deny sender_domains = paypal.com:paypal.de
40984      dkim_signers = paypal.com:paypal.de
40985      dkim_status = none:invalid:fail
40986      message = Mail from Paypal with invalid/missing signature
40987 .endd
40988
40989 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40990 see the documentation of the &%$dkim_verify_status%& expansion variable above
40991 for more information of what they mean.
40992 .endlist
40993
40994
40995
40996
40997 .section "SPF (Sender Policy Framework)" SECSPF
40998 .cindex SPF verification
40999
41000 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41001 messages with its domain in the envelope from, documented by RFC 7208.
41002 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41003 the &url(http://openspf.org).
41004 . --- 2019-10-28: still not https, open-spf.org is told to be a
41005 . --- web-archive copy of the now dead openspf.org site
41006 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41007 . --- discussion.
41008
41009 Messages sent by a system not authorised will fail checking of such assertions.
41010 This includes retransmissions done by traditional forwarders.
41011
41012 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41013 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41014 &url(https://www.libspf2.org/).
41015 There is no Exim involvement in the transmission of messages;
41016 publishing certain DNS records is all that is required.
41017
41018 For verification, an ACL condition and an expansion lookup are provided.
41019 .cindex authentication "expansion item"
41020 Performing verification sets up information used by the
41021 &%authresults%& expansion item.
41022
41023
41024 .cindex SPF "ACL condition"
41025 .cindex ACL "spf condition"
41026 The ACL condition "spf" can be used at or after the MAIL ACL.
41027 It takes as an argument a list of strings giving the outcome of the SPF check,
41028 and will succeed for any matching outcome.
41029 Valid strings are:
41030 .vlist
41031 .vitem &%pass%&
41032 The SPF check passed, the sending host is positively verified by SPF.
41033
41034 .vitem &%fail%&
41035 The SPF check failed, the sending host is NOT allowed to send mail for the
41036 domain in the envelope-from address.
41037
41038 .vitem &%softfail%&
41039 The SPF check failed, but the queried domain can't absolutely confirm that this
41040 is a forgery.
41041
41042 .vitem &%none%&
41043 The queried domain does not publish SPF records.
41044
41045 .vitem &%neutral%&
41046 The SPF check returned a "neutral" state.  This means the queried domain has
41047 published a SPF record, but wants to allow outside servers to send mail under
41048 its domain as well.  This should be treated like "none".
41049
41050 .vitem &%permerror%&
41051 This indicates a syntax error in the SPF record of the queried domain.
41052 You may deny messages when this occurs.
41053
41054 .vitem &%temperror%&
41055 This indicates a temporary error during all processing, including Exim's
41056 SPF processing.  You may defer messages when this occurs.
41057 .endlist
41058
41059 You can prefix each string with an exclamation mark to  invert
41060 its meaning,  for example  "!fail" will  match all  results but
41061 "fail".  The  string  list is  evaluated  left-to-right,  in a
41062 short-circuit fashion.
41063
41064 Example:
41065 .code
41066 deny spf = fail
41067      message = $sender_host_address is not allowed to send mail from \
41068                ${if def:sender_address_domain \
41069                     {$sender_address_domain}{$sender_helo_name}}.  \
41070                Please see http://www.open-spf.org/Why;\
41071                identity=${if def:sender_address_domain \
41072                              {$sender_address}{$sender_helo_name}};\
41073                ip=$sender_host_address
41074 .endd
41075
41076 Note: The above mentioned URL may not be as helpful as expected. You are
41077 encouraged to replace the link with a link to a site with more
41078 explanations.
41079
41080 When the spf condition has run, it sets up several expansion
41081 variables:
41082
41083 .cindex SPF "verification variables"
41084 .vlist
41085 .vitem &$spf_header_comment$&
41086 .vindex &$spf_header_comment$&
41087   This contains a human-readable string describing the outcome
41088   of the SPF check. You can add it to a custom header or use
41089   it for logging purposes.
41090
41091 .vitem &$spf_received$&
41092 .vindex &$spf_received$&
41093   This contains a complete Received-SPF: header that can be
41094   added to the message. Please note that according to the SPF
41095   draft, this header must be added at the top of the header
41096   list. Please see section 10 on how you can do this.
41097
41098   Note: in case of "Best-guess" (see below), the convention is
41099   to put this string in a header called X-SPF-Guess: instead.
41100
41101 .vitem &$spf_result$&
41102 .vindex &$spf_result$&
41103   This contains the outcome of the SPF check in string form,
41104   one of pass, fail, softfail, none, neutral, permerror or
41105   temperror.
41106
41107 .vitem &$spf_result_guessed$&
41108 .vindex &$spf_result_guessed$&
41109   This boolean is true only if a best-guess operation was used
41110   and required in order to obtain a result.
41111
41112 .vitem &$spf_smtp_comment$&
41113 .vindex &$spf_smtp_comment$&
41114 .vindex &%spf_smtp_comment_template%&
41115   This contains a string that can be used in a SMTP response
41116   to the calling party. Useful for "fail".
41117 .new
41118   The string is generated by the SPF library from the template configured in the main config
41119   option &%spf_smtp_comment_template%&.
41120 .wen
41121 .endlist
41122
41123
41124 .cindex SPF "ACL condition"
41125 .cindex ACL "spf_guess condition"
41126 .cindex SPF "best guess"
41127 In addition to SPF, you can also perform checks for so-called
41128 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41129 SPF, but it is supported by the same framework that enables SPF
41130 capability.
41131 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41132 for a description of what it means.
41133 . --- 2019-10-28: still not https:
41134
41135 To access this feature, simply use the spf_guess condition in place
41136 of the spf one.  For example:
41137
41138 .code
41139 deny spf_guess = fail
41140      message = $sender_host_address doesn't look trustworthy to me
41141 .endd
41142
41143 In case you decide to reject messages based on this check, you
41144 should note that although it uses the same framework, "Best-guess"
41145 is not SPF, and therefore you should not mention SPF at all in your
41146 reject message.
41147
41148 When the spf_guess condition has run, it sets up the same expansion
41149 variables as when spf condition is run, described above.
41150
41151 Additionally, since Best-guess is not standardized, you may redefine
41152 what "Best-guess" means to you by redefining the main configuration
41153 &%spf_guess%& option.
41154 For example, the following:
41155
41156 .code
41157 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41158 .endd
41159
41160 would relax host matching rules to a broader network range.
41161
41162
41163 .cindex SPF "lookup expansion"
41164 .cindex lookup spf
41165 A lookup expansion is also available. It takes an email
41166 address as the key and an IP address
41167 (v4 or v6)
41168 as the database:
41169
41170 .code
41171   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41172 .endd
41173
41174 The lookup will return the same result strings as can appear in
41175 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41176
41177
41178
41179
41180
41181 .section DMARC SECDMARC
41182 .cindex DMARC verification
41183
41184 DMARC combines feedback from SPF, DKIM, and header From: in order
41185 to attempt to provide better indicators of the authenticity of an
41186 email.  This document does not explain the fundamentals; you
41187 should read and understand how it works by visiting the website at
41188 &url(http://www.dmarc.org/).
41189
41190 If Exim is built with DMARC support,
41191 the libopendmarc library is used.
41192
41193 For building Exim yourself, obtain the library from
41194 &url(http://sourceforge.net/projects/opendmarc/)
41195 to obtain a copy, or find it in your favorite package
41196 repository.  You will need to attend to the local/Makefile feature
41197 SUPPORT_DMARC and the associated LDFLAGS addition.
41198 This description assumes
41199 that headers will be in /usr/local/include, and that the libraries
41200 are in /usr/local/lib.
41201
41202 . subsection
41203
41204 There are three main-configuration options:
41205 .cindex DMARC "configuration options"
41206
41207 The &%dmarc_tld_file%& option
41208 .oindex &%dmarc_tld_file%&
41209 defines the location of a text file of valid
41210 top level domains the opendmarc library uses
41211 during domain parsing. Maintained by Mozilla,
41212 the most current version can be downloaded
41213 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41214 See also the util/renew-opendmarc-tlds.sh script.
41215 .new
41216 The default for the option is unset.
41217 If not set, DMARC processing is disabled.
41218 .wen
41219
41220
41221 The &%dmarc_history_file%& option, if set
41222 .oindex &%dmarc_history_file%&
41223 defines the location of a file to log results
41224 of dmarc verification on inbound emails. The
41225 contents are importable by the opendmarc tools
41226 which will manage the data, send out DMARC
41227 reports, and expire the data. Make sure the
41228 directory of this file is writable by the user
41229 exim runs as.
41230 The default is unset.
41231
41232 The &%dmarc_forensic_sender%& option
41233 .oindex &%dmarc_forensic_sender%&
41234 defines an alternate email address to use when sending a
41235 forensic report detailing alignment failures
41236 if a sender domain's dmarc record specifies it
41237 and you have configured Exim to send them.
41238 If set, this is expanded and used for the
41239 From: header line; the address is extracted
41240 from it and used for the envelope from.
41241 If not set (the default), the From: header is expanded from
41242 the dsn_from option, and <> is used for the
41243 envelope from.
41244
41245 . I wish we had subsections...
41246
41247 .cindex DMARC controls
41248 By default, the DMARC processing will run for any remote,
41249 non-authenticated user.  It makes sense to only verify DMARC
41250 status of messages coming from remote, untrusted sources.  You can
41251 use standard conditions such as hosts, senders, etc, to decide that
41252 DMARC verification should *not* be performed for them and disable
41253 DMARC with an ACL control modifier:
41254 .code
41255   control = dmarc_disable_verify
41256 .endd
41257 A DMARC record can also specify a "forensic address", which gives
41258 exim an email address to submit reports about failed alignment.
41259 Exim does not do this by default because in certain conditions it
41260 results in unintended information leakage (what lists a user might
41261 be subscribed to, etc).  You must configure exim to submit forensic
41262 reports to the owner of the domain.  If the DMARC record contains a
41263 forensic address and you specify the control statement below, then
41264 exim will send these forensic emails.  It is also advised that you
41265 configure a &%dmarc_forensic_sender%& because the default sender address
41266 construction might be inadequate.
41267 .code
41268   control = dmarc_enable_forensic
41269 .endd
41270 (AGAIN: You can choose not to send these forensic reports by simply
41271 not putting the dmarc_enable_forensic control line at any point in
41272 your exim config.  If you don't tell exim to send them, it will not
41273 send them.)
41274
41275 There are no options to either control.  Both must appear before
41276 the DATA acl.
41277
41278 . subsection
41279
41280 DMARC checks cam be run on incoming SMTP  messages by using the
41281 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41282 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41283 condition.  Putting this condition in the ACLs is required in order
41284 for a DMARC check to actually occur.  All of the variables are set
41285 up before the DATA ACL, but there is no actual DMARC check that
41286 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41287
41288 The &"dmarc_status"& condition takes a list of strings on its
41289 right-hand side.  These strings describe recommended action based
41290 on the DMARC check.  To understand what the policy recommendations
41291 mean, refer to the DMARC website above.  Valid strings are:
41292 .display
41293 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41294 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41295 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41296 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41297 &'norecord    '& No policy section in the DMARC record for this sender domain.
41298 &'nofrom      '& Unable to determine the domain of the sender.
41299 &'temperror   '& Library error or dns error.
41300 &'off         '& The DMARC check was disabled for this email.
41301 .endd
41302 You can prefix each string with an exclamation mark to invert its
41303 meaning, for example "!accept" will match all results but
41304 "accept".  The string list is evaluated left-to-right in a
41305 short-circuit fashion.  When a string matches the outcome of the
41306 DMARC check, the condition succeeds.  If none of the listed
41307 strings matches the outcome of the DMARC check, the condition
41308 fails.
41309
41310 Of course, you can also use any other lookup method that Exim
41311 supports, including LDAP, Postgres, MySQL, etc, as long as the
41312 result is a list of colon-separated strings.
41313
41314 Performing the check sets up information used by the
41315 &%authresults%& expansion item.
41316
41317 Several expansion variables are set before the DATA ACL is
41318 processed, and you can use them in this ACL.  The following
41319 expansion variables are available:
41320
41321 .vlist
41322 .vitem &$dmarc_status$&
41323 .vindex &$dmarc_status$&
41324 .cindex DMARC result
41325 A one word status indicating what the DMARC library
41326 thinks of the email.  It is a combination of the results of
41327 DMARC record lookup and the SPF/DKIM/DMARC processing results
41328 (if a DMARC record was found).  The actual policy declared
41329 in the DMARC record is in a separate expansion variable.
41330
41331 .vitem &$dmarc_status_text$&
41332 .vindex &$dmarc_status_text$&
41333 Slightly longer, human readable status.
41334
41335 .vitem &$dmarc_used_domain$&
41336 .vindex &$dmarc_used_domain$&
41337 The domain which DMARC used to look up the DMARC policy record.
41338
41339 .vitem &$dmarc_domain_policy$&
41340 .vindex &$dmarc_domain_policy$&
41341 The policy declared in the DMARC record.  Valid values
41342 are "none", "reject" and "quarantine".  It is blank when there
41343 is any error, including no DMARC record.
41344 .endlist
41345
41346 . subsection
41347
41348 By default, Exim's DMARC configuration is intended to be
41349 non-intrusive and conservative.  To facilitate this, Exim will not
41350 create any type of logging files without explicit configuration by
41351 you, the admin.  Nor will Exim send out any emails/reports about
41352 DMARC issues without explicit configuration by you, the admin (other
41353 than typical bounce messages that may come about due to ACL
41354 processing or failure delivery issues).
41355
41356 In order to log statistics suitable to be imported by the opendmarc
41357 tools, you need to:
41358 .ilist
41359 Configure the global option &%dmarc_history_file%&
41360 .next
41361 Configure cron jobs to call the appropriate opendmarc history
41362 import scripts and truncating the dmarc_history_file
41363 .endlist
41364
41365 In order to send forensic reports, you need to:
41366 .ilist
41367 Configure the global option &%dmarc_forensic_sender%&
41368 .next
41369 Configure, somewhere before the DATA ACL, the control option to
41370 enable sending DMARC forensic reports
41371 .endlist
41372
41373 . subsection
41374
41375 Example usage:
41376 .code
41377 (RCPT ACL)
41378   warn    domains        = +local_domains
41379           hosts          = +local_hosts
41380           control        = dmarc_disable_verify
41381
41382   warn    !domains       = +screwed_up_dmarc_records
41383           control        = dmarc_enable_forensic
41384
41385   warn    condition      = (lookup if destined to mailing list)
41386           set acl_m_mailing_list = 1
41387
41388 (DATA ACL)
41389   warn    dmarc_status   = accept : none : off
41390           !authenticated = *
41391           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41392
41393   warn    dmarc_status   = !accept
41394           !authenticated = *
41395           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41396
41397   warn    dmarc_status   = quarantine
41398           !authenticated = *
41399           set $acl_m_quarantine = 1
41400           # Do something in a transport with this flag variable
41401
41402   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41403           condition      = ${if eq{$acl_m_mailing_list}{1}}
41404           message        = Messages from $dmarc_used_domain break mailing lists
41405
41406   deny    dmarc_status   = reject
41407           !authenticated = *
41408           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41409
41410   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41411 .endd
41412
41413
41414
41415
41416
41417 . ////////////////////////////////////////////////////////////////////////////
41418 . ////////////////////////////////////////////////////////////////////////////
41419
41420 .chapter "Proxies" "CHAPproxies" &&&
41421          "Proxy support"
41422 .cindex "proxy support"
41423 .cindex "proxy" "access via"
41424
41425 A proxy is an intermediate system through which communication is passed.
41426 Proxies may provide a security, availability or load-distribution function.
41427
41428
41429 .section "Inbound proxies" SECTproxyInbound
41430 .cindex proxy inbound
41431 .cindex proxy "server side"
41432 .cindex proxy "Proxy protocol"
41433 .cindex "Proxy protocol" proxy
41434
41435 Exim has support for receiving inbound SMTP connections via a proxy
41436 that uses &"Proxy Protocol"& to speak to it.
41437 To include this support, include &"SUPPORT_PROXY=yes"&
41438 in Local/Makefile.
41439
41440 It was built on the HAProxy specification, found at
41441 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41442
41443 The purpose of this facility is so that an application load balancer,
41444 such as HAProxy, can sit in front of several Exim servers
41445 to distribute load.
41446 Exim uses the local protocol communication with the proxy to obtain
41447 the remote SMTP system IP address and port information.
41448 There is no logging if a host passes or
41449 fails Proxy Protocol negotiation, but it can easily be determined and
41450 recorded in an ACL (example is below).
41451
41452 Use of a proxy is enabled by setting the &%hosts_proxy%&
41453 main configuration option to a hostlist; connections from these
41454 hosts will use Proxy Protocol.
41455 Exim supports both version 1 and version 2 of the Proxy Protocol and
41456 automatically determines which version is in use.
41457
41458 The Proxy Protocol header is the first data received on a TCP connection
41459 and is inserted before any TLS-on-connect handshake from the client; Exim
41460 negotiates TLS between Exim-as-server and the remote client, not between
41461 Exim and the proxy server.
41462
41463 The following expansion variables are usable
41464 (&"internal"& and &"external"& here refer to the interfaces
41465 of the proxy):
41466 .display
41467 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41468 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41469 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41470 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41471 &'proxy_session            '& boolean: SMTP connection via proxy
41472 .endd
41473 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41474 there was a protocol error.
41475 The variables &$sender_host_address$& and &$sender_host_port$&
41476 will have values for the actual client system, not the proxy.
41477
41478 Since the real connections are all coming from the proxy, and the
41479 per host connection tracking is done before Proxy Protocol is
41480 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41481 handle all of the parallel volume you expect per inbound proxy.
41482 With the option set so high, you lose the ability
41483 to protect your server from many connections from one IP.
41484 In order to prevent your server from overload, you
41485 need to add a per connection ratelimit to your connect ACL.
41486 A possible solution is:
41487 .display
41488   # Set max number of connections per host
41489   LIMIT   = 5
41490   # Or do some kind of IP lookup in a flat file or database
41491   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41492
41493   defer   ratelimit      = LIMIT / 5s / per_conn / strict
41494           message        = Too many connections from this IP right now
41495 .endd
41496
41497
41498
41499 .section "Outbound proxies" SECTproxySOCKS
41500 .cindex proxy outbound
41501 .cindex proxy "client side"
41502 .cindex proxy SOCKS
41503 .cindex SOCKS proxy
41504 Exim has support for sending outbound SMTP via a proxy
41505 using a protocol called SOCKS5 (defined by RFC1928).
41506 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41507 Local/Makefile.
41508
41509 Use of a proxy is enabled by setting the &%socks_proxy%& option
41510 on an smtp transport.
41511 The option value is expanded and should then be a list
41512 (colon-separated by default) of proxy specifiers.
41513 Each proxy specifier is a list
41514 (space-separated by default) where the initial element
41515 is an IP address and any subsequent elements are options.
41516
41517 Options are a string <name>=<value>.
41518 The list of options is in the following table:
41519 .display
41520 &'auth   '& authentication method
41521 &'name   '& authentication username
41522 &'pass   '& authentication password
41523 &'port   '& tcp port
41524 &'tmo    '& connection timeout
41525 &'pri    '& priority
41526 &'weight '& selection bias
41527 .endd
41528
41529 More details on each of these options follows:
41530
41531 .ilist
41532 .cindex authentication "to proxy"
41533 .cindex proxy authentication
41534 &%auth%&: Either &"none"& (default) or &"name"&.
41535 Using &"name"& selects username/password authentication per RFC 1929
41536 for access to the proxy.
41537 Default is &"none"&.
41538 .next
41539 &%name%&: sets the username for the &"name"& authentication method.
41540 Default is empty.
41541 .next
41542 &%pass%&: sets the password for the &"name"& authentication method.
41543 Default is empty.
41544 .next
41545 &%port%&: the TCP port number to use for the connection to the proxy.
41546 Default is 1080.
41547 .next
41548 &%tmo%&: sets a connection timeout in seconds for this proxy.
41549 Default is 5.
41550 .next
41551 &%pri%&: specifies a priority for the proxy within the list,
41552 higher values being tried first.
41553 The default priority is 1.
41554 .next
41555 &%weight%&: specifies a selection bias.
41556 Within a priority set servers are queried in a random fashion,
41557 weighted by this value.
41558 The default value for selection bias is 1.
41559 .endlist
41560
41561 Proxies from the list are tried according to their priority
41562 and weight settings until one responds.  The timeout for the
41563 overall connection applies to the set of proxied attempts.
41564
41565 .section Logging SECTproxyLog
41566 To log the (local) IP of a proxy in the incoming or delivery logline,
41567 add &"+proxy"& to the &%log_selector%& option.
41568 This will add a component tagged with &"PRX="& to the line.
41569
41570 . ////////////////////////////////////////////////////////////////////////////
41571 . ////////////////////////////////////////////////////////////////////////////
41572
41573 .chapter "Internationalisation" "CHAPi18n" &&&
41574          "Internationalisation""
41575 .cindex internationalisation "email address"
41576 .cindex EAI
41577 .cindex i18n
41578 .cindex utf8 "mail name handling"
41579
41580 Exim has support for Internationalised mail names.
41581 To include this it must be built with SUPPORT_I18N and the libidn library.
41582 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41583
41584 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41585 instead of it) then IDNA2008 is supported; this adds an extra library
41586 requirement, upon libidn2.
41587
41588 .section "MTA operations" SECTi18nMTA
41589 .cindex SMTPUTF8 "ESMTP option"
41590 .cindex "ESMTP extensions" SMTPUTF8
41591 The main configuration option &%smtputf8_advertise_hosts%& specifies
41592 a host list.  If this matches the sending host and
41593 accept_8bitmime is true (the default) then the ESMTP option
41594 SMTPUTF8 will be advertised.
41595
41596 If the sender specifies the SMTPUTF8 option on a MAIL command
41597 international handling for the message is enabled and
41598 the expansion variable &$message_smtputf8$& will have value TRUE.
41599
41600 The option &%allow_utf8_domains%& is set to true for this
41601 message. All DNS lookups are converted to a-label form
41602 whatever the setting of &%allow_utf8_domains%&
41603 when Exim is built with SUPPORT_I18N.
41604
41605 Both localparts and domain are maintained as the original
41606 UTF-8 form internally; any comparison or regular-expression use will
41607 require appropriate care.  Filenames created, eg. by
41608 the appendfile transport, will have UTF-8 names.
41609
41610 HELO names sent by the smtp transport will have any UTF-8
41611 components expanded to a-label form,
41612 and any certificate name checks will be done using the a-label
41613 form of the name.
41614
41615 .cindex log protocol
41616 .cindex SMTPUTF8 logging
41617 .cindex i18n logging
41618 Log lines and Received-by: header lines will acquire a "utf8"
41619 prefix on the protocol element, eg. utf8esmtp.
41620
41621 The following expansion operators can be used:
41622 .code
41623 ${utf8_domain_to_alabel:str}
41624 ${utf8_domain_from_alabel:str}
41625 ${utf8_localpart_to_alabel:str}
41626 ${utf8_localpart_from_alabel:str}
41627 .endd
41628
41629 .cindex utf8 "address downconversion"
41630 .cindex i18n "utf8 address downconversion"
41631 The RCPT ACL
41632 may use the following modifier:
41633 .display
41634 control = utf8_downconvert
41635 control = utf8_downconvert/<value>
41636 .endd
41637 This sets a flag requiring that envelope addresses are converted to
41638 a-label form before smtp delivery.
41639 This is usually for use in a Message Submission Agent context,
41640 but could be used for any message.
41641
41642 If a value is appended it may be:
41643 .display
41644 &`1  `& mandatory downconversion
41645 &`0  `& no downconversion
41646 &`-1 `& if SMTPUTF8 not supported by destination host
41647 .endd
41648 If no value is given, 1 is used.
41649
41650 If mua_wrapper is set, the utf8_downconvert control
41651 is initially set to -1.
41652
41653 The smtp transport has an option &%utf8_downconvert%&.
41654 If set it must expand to one of the three values described above,
41655 or an empty string.
41656 If non-empty it overrides value previously set
41657 (due to mua_wrapper or by an ACL control).
41658
41659
41660 There is no explicit support for VRFY and EXPN.
41661 Configurations supporting these should inspect
41662 &$smtp_command_argument$& for an SMTPUTF8 argument.
41663
41664 There is no support for LMTP on Unix sockets.
41665 Using the "lmtp" protocol option on an smtp transport,
41666 for LMTP over TCP, should work as expected.
41667
41668 There is no support for DSN unitext handling,
41669 and no provision for converting logging from or to UTF-8.
41670
41671
41672
41673 .section "MDA operations" SECTi18nMDA
41674 To aid in constructing names suitable for IMAP folders
41675 the following expansion operator can be used:
41676 .code
41677 ${imapfolder {<string>} {<sep>} {<specials>}}
41678 .endd
41679
41680 The string is converted from the charset specified by
41681 the "headers charset" command (in a filter file)
41682 or &%headers_charset%& main configuration option (otherwise),
41683 to the
41684 modified UTF-7 encoding specified by RFC 2060,
41685 with the following exception: All occurrences of <sep>
41686 (which has to be a single character)
41687 are replaced with periods ("."), and all periods and slashes that are not
41688 <sep> and are not in the <specials> string are BASE64 encoded.
41689
41690 The third argument can be omitted, defaulting to an empty string.
41691 The second argument can be omitted, defaulting to "/".
41692
41693 This is the encoding used by Courier for Maildir names on disk, and followed
41694 by many other IMAP servers.
41695
41696 Examples:
41697 .display
41698 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41699 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41700 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41701 .endd
41702
41703 Note that the source charset setting is vital, and also that characters
41704 must be representable in UTF-16.
41705
41706
41707 . ////////////////////////////////////////////////////////////////////////////
41708 . ////////////////////////////////////////////////////////////////////////////
41709
41710 .chapter "Events" "CHAPevents" &&&
41711          "Events"
41712 .cindex events
41713
41714 The events mechanism in Exim can be used to intercept processing at a number
41715 of points.  It was originally invented to give a way to do customised logging
41716 actions (for example, to a database) but can also be used to modify some
41717 processing actions.
41718
41719 Most installations will never need to use Events.
41720 The support can be left out of a build by defining DISABLE_EVENT=yes
41721 in &_Local/Makefile_&.
41722
41723 There are two major classes of events: main and transport.
41724 The main configuration option &%event_action%& controls reception events;
41725 a transport option &%event_action%& controls delivery events.
41726
41727 Both options are a string which is expanded when the event fires.
41728 An example might look like:
41729 .cindex logging custom
41730 .code
41731 event_action = ${if eq {msg:delivery}{$event_name} \
41732 {${lookup pgsql {SELECT * FROM record_Delivery( \
41733     '${quote_pgsql:$sender_address_domain}',\
41734     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41735     '${quote_pgsql:$domain}', \
41736     '${quote_pgsql:${lc:$local_part}}', \
41737     '${quote_pgsql:$host_address}', \
41738     '${quote_pgsql:${lc:$host}}', \
41739     '${quote_pgsql:$message_exim_id}')}} \
41740 } {}}
41741 .endd
41742
41743 Events have names which correspond to the point in process at which they fire.
41744 The name is placed in the variable &$event_name$& and the event action
41745 expansion must check this, as it will be called for every possible event type.
41746
41747 .new
41748 The current list of events is:
41749 .wen
41750 .display
41751 &`dane:fail              after    transport  `& per connection
41752 &`msg:complete           after    main       `& per message
41753 &`msg:defer              after    transport  `& per message per delivery try
41754 &`msg:delivery           after    transport  `& per recipient
41755 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41756 &`msg:rcpt:defer         after    transport  `& per recipient
41757 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41758 &`msg:fail:delivery      after    transport  `& per recipient
41759 &`msg:fail:internal      after    main       `& per recipient
41760 &`tcp:connect            before   transport  `& per connection
41761 &`tcp:close              after    transport  `& per connection
41762 &`tls:cert               before   both       `& per certificate in verification chain
41763 &`smtp:connect           after    transport  `& per connection
41764 &`smtp:ehlo              after    transport  `& per connection
41765 .endd
41766 New event types may be added in future.
41767
41768 The event name is a colon-separated list, defining the type of
41769 event in a tree of possibilities.  It may be used as a list
41770 or just matched on as a whole.  There will be no spaces in the name.
41771
41772 The second column in the table above describes whether the event fires
41773 before or after the action is associates with.  Those which fire before
41774 can be used to affect that action (more on this below).
41775
41776 The third column in the table above says what section of the configuration
41777 should define the event action.
41778
41779 An additional variable, &$event_data$&, is filled with information varying
41780 with the event type:
41781 .display
41782 &`dane:fail            `& failure reason
41783 &`msg:defer            `& error string
41784 &`msg:delivery         `& smtp confirmation message
41785 &`msg:fail:internal    `& failure reason
41786 &`msg:fail:delivery    `& smtp error message
41787 &`msg:host:defer       `& error string
41788 &`msg:rcpt:host:defer  `& error string
41789 &`msg:rcpt:defer       `& error string
41790 &`tls:cert             `& verification chain depth
41791 &`smtp:connect         `& smtp banner
41792 &`smtp:ehlo            `& smtp ehlo response
41793 .endd
41794
41795 The :defer events populate one extra variable: &$event_defer_errno$&.
41796
41797 For complex operations an ACL expansion can be used in &%event_action%&
41798 however due to the multiple contexts that Exim operates in during
41799 the course of its processing:
41800 .ilist
41801 variables set in transport events will not be visible outside that
41802 transport call
41803 .next
41804 acl_m variables in a server context are lost on a new connection,
41805 and after smtp helo/ehlo/mail/starttls/rset commands
41806 .endlist
41807 Using an ACL expansion with the logwrite modifier can be
41808 a useful way of writing to the main log.
41809
41810 The expansion of the event_action option should normally
41811 return an empty string.  Should it return anything else the
41812 following will be forced:
41813 .display
41814 &`tcp:connect      `&  do not connect
41815 &`tls:cert         `&  refuse verification
41816 &`smtp:connect     `&  close connection
41817 .endd
41818 All other message types ignore the result string, and
41819 no other use is made of it.
41820
41821 For a tcp:connect event, if the connection is being made to a proxy
41822 then the address and port variables will be that of the proxy and not
41823 the target system.
41824
41825 For tls:cert events, if GnuTLS is in use this will trigger only per
41826 chain element received on the connection.
41827 For OpenSSL it will trigger for every chain element including those
41828 loaded locally.
41829
41830 . ////////////////////////////////////////////////////////////////////////////
41831 . ////////////////////////////////////////////////////////////////////////////
41832
41833 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41834          "Adding drivers or lookups"
41835 .cindex "adding drivers"
41836 .cindex "new drivers, adding"
41837 .cindex "drivers" "adding new"
41838 The following actions have to be taken in order to add a new router, transport,
41839 authenticator, or lookup type to Exim:
41840
41841 .olist
41842 Choose a name for the driver or lookup type that does not conflict with any
41843 existing name; I will use &"newdriver"& in what follows.
41844 .next
41845 Add to &_src/EDITME_& the line:
41846 .display
41847 <&'type'&>&`_NEWDRIVER=yes`&
41848 .endd
41849 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41850 code is not to be included in the binary by default, comment this line out. You
41851 should also add any relevant comments about the driver or lookup type.
41852 .next
41853 Add to &_src/config.h.defaults_& the line:
41854 .code
41855 #define <type>_NEWDRIVER
41856 .endd
41857 .next
41858 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41859 and create a table entry as is done for all the other drivers and lookup types.
41860 .next
41861 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41862 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41863 Add your &`NEWDRIVER`& to that list.
41864 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41865 simple form that most lookups have.
41866 .next
41867 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41868 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41869 driver or lookup type and add it to the definition of OBJ.
41870 .next
41871 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41872 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41873 .next
41874 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41875 &_src_&.
41876 .next
41877 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41878 as for other drivers and lookups.
41879 .endlist
41880
41881 Then all you need to do is write the code! A good way to start is to make a
41882 proforma by copying an existing module of the same type, globally changing all
41883 occurrences of the name, and cutting out most of the code. Note that any
41884 options you create must be listed in alphabetical order, because the tables are
41885 searched using a binary chop procedure.
41886
41887 There is a &_README_& file in each of the sub-directories of &_src_& describing
41888 the interface that is expected.
41889
41890
41891
41892
41893 . ////////////////////////////////////////////////////////////////////////////
41894 . ////////////////////////////////////////////////////////////////////////////
41895
41896 . /////////////////////////////////////////////////////////////////////////////
41897 . These lines are processing instructions for the Simple DocBook Processor that
41898 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41899 . PDFs than using xmlto and fop. They will be ignored by all other XML
41900 . processors.
41901 . /////////////////////////////////////////////////////////////////////////////
41902
41903 .literal xml
41904 <?sdop
41905   format="newpage"
41906   foot_right_recto="&chaptertitle;"
41907   foot_right_verso="&chaptertitle;"
41908 ?>
41909 .literal off
41910
41911 .makeindex "Options index"   "option"
41912 .makeindex "Variables index" "variable"
41913 .makeindex "Concept index"   "concept"
41914
41915
41916 . /////////////////////////////////////////////////////////////////////////////
41917 . /////////////////////////////////////////////////////////////////////////////